Brian's patch to fancy-invoice to parameterize everything.

* src/business/business-utils/business-prefs.scm:
	* src/business/business-utils/business-utils.scm:
	  Add a bunch of new File -> Properties to describe the business.
	* src/business/business-reports/fancy-invoice.scm:
	  Parameterize all the various settings in the report so
	  they can all be set through the options or file->properties
	  settings.  Patch by "Brian", but slightly modified to not
	  hard-code some strings.



git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@13237 57a11ea4-9604-0410-9ed3-97b8803252fd

ChangeLog

@@ -11,6 +11,15 @@
 	  Change the font of the client company name to match the
 	  owner company name.  Fixes #327545.
 
+	* src/business/business-utils/business-prefs.scm:
+	* src/business/business-utils/business-utils.scm:
+	  Add a bunch of new File -> Properties to describe the business.
+	* src/business/business-reports/fancy-invoice.scm:
+	  Parameterize all the various settings in the report so
+	  they can all be set through the options or file->properties
+	  settings.  Patch by "Brian", but slightly modified to not
+	  hard-code some strings.
+
 2006-02-11  Derek Atkins  <derek@ihtfp.com>
 
 	* src/report/report-gnome/gnc-plugin-page-report.c:

src/business/business-reports/fancy-invoice.scm

@@ -43,6 +43,9 @@
 ;; template. The most common used templates will be distributed with
 ;; gnucash.
 
+;; Modifed to use settable options instead of the hard coded ones.
+;; modified by Brian Dolbec <dol-sen at telus dot net> Feb. 6, 2006
+
 (define-module (gnucash report fancy-invoice))
 
 (use-modules (srfi srfi-1))
@@ -330,19 +333,50 @@
     (N_ "Display") (N_ "Payments")
     "tc" (N_ "Display the payments applied to this invoice?") #f))
 
+  (gnc:register-inv-option
+   (gnc:make-number-range-option
+    (N_ "Display") (N_ "Minimum # of entries")
+    "u" (N_ "The minimum number of invoice entries to display. (-1)") 23
+    4 23 3 1))
+
   (gnc:register-inv-option
    (gnc:make-text-option
     (N_ "Display") (N_ "Extra Notes")
      "u" (N_ "Extra notes to put on the invoice")
-     ;; oli-custom - Extra notes to add on each invoice, invoice-independent
+     ""))
-     ;; yes, I was too lazy to (get-company-name) ;)
+
-     "Make all cheques payable to: Company Name Inc.\nDirect all inquiries to: Mr. Accounting Contact"))
+  (gnc:register-inv-option
+   (gnc:make-complex-boolean-option
+    (N_ "Display") (N_ "Payable to")
+     "ua1" (N_ "Display the Payable to: information") #t #f
+     (lambda (x) (gnc:option-db-set-option-selectable-by-name
+		  gnc:*report-options* "Display" "Payable to string" x))))
 
   (gnc:register-inv-option
    (gnc:make-string-option
-    (N_ "Display") (N_ "Today Date Format")
+    (N_ "Display") (N_ "Payable to string")
-    "v" (N_ "The format for the date->string conversion for today's date.")
+    "ua2" (N_ "The phrase for specifying to whom payments should be made")
-    "%B %e, %Y"))
+    (_ "Make all cheques Payable to")))
+     
+  (gnc:register-inv-option
+   (gnc:make-complex-boolean-option
+    (N_ "Display") (N_ "Company contact")
+     "ub1" (N_ "Display the Company contact information") #t #f
+     (lambda (x) (gnc:option-db-set-option-selectable-by-name
+		  gnc:*report-options* "Display" "Company contact string" x))))
+
+  (gnc:register-inv-option
+   (gnc:make-string-option
+    (N_ "Display") (N_ "Company contact string")
+    "ub2" (N_ "The phrase used to introduce the company contact")
+    (_ "Direct all inquiries to")))
+
+; not used
+;  (gnc:register-inv-option
+;   (gnc:make-string-option
+;    (N_ "Display") (N_ "Today Date Format")
+;    "v" (N_ "The format for the date->string conversion for today's date.")
+;    "%B %e, %Y"))
 
   (gnc:options-set-default-section gnc:*report-options* "General")
 
@@ -385,7 +419,8 @@
 		    (gnc:html-table-append-row/markup! 
 		     table
 		     subtotal-style
-		     ;; oli-custom modified to colspan the subtotal labels instead of the data fields
+		     ;; oli-custom modified to colspan the subtotal labels
+		     ;; instead of the data fields
 		     (append (cons (gnc:make-html-table-cell/size/markup
 				    0 (colspan currency used-columns)
 				    "total-label-cell" subtotal-label)
@@ -435,13 +470,16 @@
 				    acct-hash)
       (if (null? entries)
 	  (begin
-	    ;; oli-custom - modified to have a minimum of entries per table, currently at 24
+	    ;; oli-custom - modified to have a minimum of entries per table,
-	    ;; currently doesn't count payment rows and stuff
+	    ;; currently defaults to 24
+	    ;; also, doesn't count payment rows and stuff
 	    (do ((entries-added entries-added (+ entries-added 1))
 		 (odd-row? odd-row? (not odd-row?)))
-		;; oli-custom - here you put the minimum number of rows minus one
+		((> entries-added (opt-val "Display" "Minimum # of entries" )))
-		((> entries-added 23))
+		(gnc:html-table-append-row/markup!
-		(gnc:html-table-append-row/markup! table (if odd-row? "normal-row" "alternate-row") (string->list (make-string (num-columns-required used-columns) #\space)))
+		 table (if odd-row? "normal-row" "alternate-row")
+		 (string->list (make-string (num-columns-required used-columns)
+					    #\space)))
 		)
 	    (add-subtotal-row table used-columns value-collector
 			      "grand-total" (_ "Subtotal"))
@@ -454,7 +492,8 @@
 			 (name (gnc:account-get-name acct)))
 		     (collector 'add commodity value)
 		     (add-subtotal-row table used-columns collector
-				       "grand-total" (string-expand name #\space "&nbsp;"))))
+				       "grand-total" (string-expand
+						      name #\space "&nbsp;"))))
 		 acct-hash)
 
 		; nope, just show the total tax.
@@ -476,7 +515,8 @@
 		   splits)))
 
 	    (add-subtotal-row table used-columns total-collector
-			      "grand-total" (string-expand (_ "Amount Due") #\space "&nbsp;")))
+			      "grand-total" (string-expand (_ "Amount Due")
+							   #\space "&nbsp;")))
 
 	  ;;
 	  ;; End of BEGIN -- now here's the code to handle all the entries!
@@ -605,7 +645,8 @@
    table
    (list
     (string-append label ":&nbsp;")
-    ;; oli-custom - modified to display a custom format for the invoice date/due date fields
+    ;; oli-custom - modified to display a custom format
+    ;; for the invoice date/due date fields
     ;; I could have taken the format from the report options, but... ;)
     (string-expand (strftime "%B %e, %Y" (localtime (car date))) #\space "&nbsp;")
     ;;(string-expand (gnc:print-date date) #\space "&nbsp;")
@@ -628,15 +669,32 @@
 	 (name (gnc:kvp-frame-get-slot-path
 		slots (append gnc:*kvp-option-path*
 			      (list gnc:*business-label* gnc:*company-name*))))
+;;	 (contact (gnc:kvp-frame-get-slot-path
+;;		slots (append gnc:*kvp-option-path*
+;;			      (list gnc:*business-label* gnc:*company-contact*))))
 	 (addy (gnc:kvp-frame-get-slot-path
 		slots (append gnc:*kvp-option-path*
 			      (list gnc:*business-label* gnc:*company-addy*))))
+	 (id (gnc:kvp-frame-get-slot-path
+		slots (append gnc:*kvp-option-path*
+			      (list gnc:*business-label* gnc:*company-id*))))
+	 (phone (gnc:kvp-frame-get-slot-path
+		slots (append gnc:*kvp-option-path*
+			      (list gnc:*business-label* gnc:*company-phone*))))
+	 (fax (gnc:kvp-frame-get-slot-path
+		slots (append gnc:*kvp-option-path*
+			      (list gnc:*business-label* gnc:*company-fax*))))
+	 (url (gnc:kvp-frame-get-slot-path
+		slots (append gnc:*kvp-option-path*
+			      (list gnc:*business-label* gnc:*company-url*))))
 	 (invoice-cell (gnc:make-html-table-cell))
 	 (name-cell (gnc:make-html-table-cell))
 
 	)
-    ;; oli-custom - modified the name table to increase the font size of the company name
+    ;; oli-custom - modified the name table to increase the
-    ;; and add an "INVOICE" title to the upper right, also, put some contact information in the middle
+    ;; font size of the company name
+    ;; and add an "INVOICE" title to the upper right, also,
+    ;; put some contact information in the middle
     ;; FIXME: "INVOICE" should be translated and support bills/expense vouchers
     (gnc:html-table-set-style!
      table "table"
@@ -645,7 +703,7 @@
      'attribute (list "cellpadding" 0)
      'attribute (list "width" "100%"))
     (gnc:html-table-cell-append-objects!
-	invoice-cell "INVOICE")
+	invoice-cell (_"INVOICE"))
     (gnc:html-table-cell-set-style!
 	invoice-cell "td"
 	'font-size "+2")
@@ -663,10 +721,20 @@
 	table 2 "td"
 	'attribute (list "align" "right")
 	'attribute (list "width" "33%"))
-    (gnc:html-table-append-row! table (list (string-expand
+    (gnc:html-table-append-row!
-					     (if addy addy "")
+     table (list (string-expand (if addy addy "") #\newline "<br>")
-					     #\newline "<br>") "Phone: (111) 222-3333<br>Web: http://companysite.com" ""))
+		 (string-expand
-;; oli-custom - I didn't want today's date on the invoice. The invoice already has a date.
+		  (string-append (if phone
+				     (string-append (_ "Phone:") " " phone)
+				     "")
+				 (if fax (string-append (if phone "\n" "")
+							(_ "Fax:") " " fax)
+				     ""))
+		  #\newline "<br>" )
+		 (if url (string-append (_ "Web:") " " url) "")))
+
+;; oli-custom - I didn't want today's date on the invoice.
+;; The invoice already has a date.
 ;; Today's date can be in the email, fax or letter accompanying the invoice.
 ;;    (gnc:html-table-append-row! table (list
 ;;				       (strftime
@@ -713,11 +781,13 @@
 	       (set! title (_ "Expense Voucher")))))
 	  (set! title (string-append title " #"
 				     (gnc:invoice-get-id invoice)))))
-    ;; oli-custom - title redundant, "Invoice" moved to myname-table, invoice number moved below
+    ;; oli-custom - title redundant, "Invoice" moved to myname-table,
+    ;; invoice number moved below
     ;;(gnc:html-document-set-title! document title)
 
     (if invoice
-	(let ((book (gnc:invoice-get-book invoice))
+	(let* ((book (gnc:invoice-get-book invoice))
+	      (slots (gnc:book-get-slots book))
 	      (date-object #f)
 	      (helper-table (gnc:make-html-table)))
 	  (set! table (make-entry-table invoice
@@ -730,24 +800,33 @@
 	   'attribute (list "cellspacing" 0)
 	   'attribute (list "cellpadding" 4)
 	   ;; oli-custom - make table as wide as possible
-	   ;; works fine with simple style sheet templates, doesn't work quite right with fancy ones
+	   ;; works fine with simple style sheet templates,
-	   ;; probably supplying the style sheet with a wide image for the header (even if transparent/white) would fix it
+	   ;; doesn't work quite right with fancy ones
+	   ;; probably supplying the style sheet with a wide image
+	   ;; for the header (even if transparent/white) would fix it
 	   'attribute (list "width" "100%"))
 
 	  ;; oli-custom - make the description column big
-	  ;; 50% or 60%, depending on whether the first column is displayed or not
+	  ;; 50% or 60%, depending on whether the first column is
-	  ;; should actually be something more complicated, it's a really ugly hack right now :)
+	  ;; displayed or not
+	  ;; should actually be something more complicated,
+	  ;; it's a really ugly hack right now :)
 	  (gnc:html-table-set-col-style!
 	   table (if (opt-val "Display Columns" "Date") 1 0) "td"
-	   'attribute (list "width" (if (opt-val "Display Columns" "Date") "50%" "60%")))
+	   'attribute (list "width" (if (opt-val "Display Columns" "Date")
+					"50%" "60%")))
 
-	  (gnc:html-document-add-object! document (make-myname-table book (opt-val "Display" "Today Date Format")))
+	  (gnc:html-document-add-object!
+	   document (make-myname-table
+		     book ;;(opt-val "Display" "Today Date Format")))
+		     ""))
 
 	  (make-break! document)
 	  (make-break! document)
 	  (make-break! document)
 
-	  ;; oli-custom - client table and table with invoice number/date/due date both inserted into a table
+	  ;; oli-custom - client table and table with invoice
+	  ;; number/date/due date both inserted into a table
 	  (gnc:html-table-set-style!
 	   helper-table "table"
 	   'attribute (list "border" 0)
@@ -763,12 +842,15 @@
 		(begin
 		  (set! date-table (make-date-table))
 		  ;; oli-custom - moved invoice number here
-		  (gnc:html-table-append-row! date-table (list "Invoice&nbsp;#&nbsp;" (gnc:invoice-get-id invoice)))
+		  (gnc:html-table-append-row!
+		   date-table (list "Invoice&nbsp;#&nbsp;"
+				    (gnc:invoice-get-id invoice)))
 		  (make-date-row! date-table (_ "Invoice&nbsp;Date") post-date)
 		  (make-date-row! date-table (_ "Due&nbsp;Date") due-date)
 		  date-table)
 		(gnc:make-html-text
-		  ;; oli-custom - FIXME: I have a feeling I broke a translation by not using string-expand for &nbsp;
+		  ;; oli-custom - FIXME: I have a feeling I broke a
+		 ;; translation by not using string-expand for &nbsp;
 		  (string-append title (N_ "<br>Invoice&nbsp;in&nbsp;progress...."))))))
 	  
 	  (gnc:html-table-append-row!
@@ -783,7 +865,8 @@
 	  	helper-table 1 "td"
 		'attribute (list "valign" "top")
 		'attribute (list "align" "right")
-		;; oli-custom - "squeeze" the date table, or else it's spaced out
+		;; oli-custom - "squeeze" the date table,
+		;; or else it's spaced out
 		'attribute (list "width" "1%"))
 
 	  (gnc:html-document-add-object!
@@ -831,6 +914,34 @@
 	  
 	  (make-break! document)
 
+	  (if (opt-val "Display" "Payable to")
+	      (let* ((name (gnc:kvp-frame-get-slot-path
+			    slots (append gnc:*kvp-option-path*
+					  (list gnc:*business-label*
+						gnc:*company-name*))))
+		     (name-str (opt-val "Display" "Payable to string")))
+		(if (and name (> (string-length name) 0))
+		(gnc:html-document-add-object!
+		 document
+		 (gnc:make-html-text
+		  (string-append name-str  ":&nbsp;"
+		  (string-expand name #\newline "<br>")))))))
+
+	  (make-break! document)
+
+	  (if (opt-val "Display" "Company contact")
+	      (let* ((contact (gnc:kvp-frame-get-slot-path
+			       slots (append gnc:*kvp-option-path*
+					     (list gnc:*business-label*
+						   gnc:*company-contact*))))
+		     (contact-str (opt-val "Display" "Company contact string")))
+		(if (and contact (> (string-length contact) 0))
+	        (gnc:html-document-add-object!
+		 document
+		 (gnc:make-html-text
+		  (string-append contact-str  ":&nbsp;"
+		  (string-expand contact #\newline "<br>")))))))
+
 	  (gnc:html-document-add-object!
 	   document
 	   (gnc:make-html-text

src/business/business-utils/business-prefs.scm

@@ -33,10 +33,35 @@
     gnc:*business-label* gnc:*company-addy*
     "b1" (N_ "The address of your business") ""))
 
+  (reg-option
+   (gnc:make-string-option
+    gnc:*business-label* gnc:*company-contact*
+    "b2" (N_ "The contact person to print on invoices") ""))
+
+  (reg-option
+   (gnc:make-string-option
+    gnc:*business-label* gnc:*company-phone*
+    "c1" (N_ "The phone number of your business") ""))
+
+  (reg-option
+   (gnc:make-string-option
+    gnc:*business-label* gnc:*company-fax*
+    "c2" (N_ "The fax number of your business") ""))
+
+  (reg-option
+   (gnc:make-string-option
+    gnc:*business-label* gnc:*company-email*
+    "c3" (N_ "The email address of your business") ""))
+
+  (reg-option
+   (gnc:make-string-option
+    gnc:*business-label* gnc:*company-url*
+    "c4" (N_ "The URL address of your website") ""))
+
   (reg-option
    (gnc:make-string-option
     gnc:*business-label* gnc:*company-id*
-    "b2" (N_ "The ID for your company (eg 'Tax-ID: 00-000000)")
+    "c5" (N_ "The ID for your company (eg 'Tax-ID: 00-000000)")
     ""))
  
   (reg-option

src/business/business-utils/business-utils.scm

@@ -8,8 +8,15 @@
 (define gnc:*company-name* (N_ "Company Name"))
 (define gnc:*company-addy* (N_ "Company Address"))
 (define gnc:*company-id* (N_ "Company ID"))
+(define gnc:*company-phone* (N_ "Company Phone Number"))
+(define gnc:*company-fax* (N_ "Company Fax Number"))
+(define gnc:*company-url* (N_ "Company Website URL"))
+(define gnc:*company-email* (N_ "Company Email Address"))
+(define gnc:*company-contact* (N_ "Company Contact Person"))
 
-(export gnc:*business-label* gnc:*company-name* gnc:*company-addy* gnc:*company-id*)
+(export gnc:*business-label* gnc:*company-name* gnc:*company-addy* gnc:*company-id*
+            gnc:*company-phone* gnc:*company-fax* gnc:*company-url*
+            gnc:*company-email* gnc:*company-contact*)
 
 (load-from-path "business-options.scm")
 (load-from-path "business-prefs.scm")