Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / conf / invoice_latex
1 %% file: Standard Multipage.tex\r
2 %% Purpose: Multipage bill template for e-Bills\r
3 %% \r
4 %% Created by Mark Asplen-Taylor\r
5 %% Asplen Management Ltd\r
6 %% www.asplen.co.uk\r
7 %%\r
8 %% Modified for Freeside by Kristian Hoffman\r
9 %%\r
10 %% Changes\r
11 %%      0.1     4/12/00 Created\r
12 %%      0.2     18/10/01        More fields added\r
13 %%      1.0     16/11/01        RELEASED\r
14 %%      1.2     16/10/02        Invoice number added\r
15 %%      1.3     2/12/02 Logo graphic added\r
16 %%      1.4     7/2/03  Multipage headers/footers added\r
17 %%      n/a     forked for Freeside; checked into CVS\r
18 %%\r
19 \r
20 \documentclass[letterpaper]{article}\r
21 \r
22 \usepackage{fancyhdr,lastpage,ifthen,array,longtable,afterpage,caption,multirow,bigstrut}\r
23 \usepackage{graphicx}                   % required for logo graphic\r
24 \usepackage[utf8]{inputenc}             % multilanguage support\r
25 \usepackage[T1]{fontenc}\r
26 \r
27 \addtolength{\voffset}{-0.0cm}          % top margin to top of header\r
28 \addtolength{\hoffset}{-0.6cm}          % left margin on page\r
29 \addtolength{\topmargin}{[@-- defined($topmargin) ? $topmargin : '-1.25cm' --@]}\r
30 \setlength{\headheight}{2.0cm}          % height of header\r
31 \setlength{\headsep}{[@-- defined($headsep) ? $headsep : '1.0cm' --@]}\r
32 \setlength{\footskip}{1.0cm}            % bottom of footer from bottom of text\r
33 \r
34 %\addtolength{\textwidth}{2.1in}        % width of text\r
35 \setlength{\textwidth}{19.5cm}\r
36 \setlength{\textheight}{[@-- defined($textheight) ? $textheight : '19.5cm' --@]}\r
37 \setlength{\oddsidemargin}{-0.9cm}      % odd page left margin\r
38 \setlength{\evensidemargin}{-0.9cm}     % even page left margin\r
39 \r
40 \LTchunksize=40\r
41 \r
42 \renewcommand{\headrulewidth}{0pt}\r
43 \renewcommand{\footrulewidth}{1pt}\r
44 \r
45 \renewcommand{\footrule}{\r
46 [@--\r
47   $coupon ? '\ifthenelse{\equal{\thepage}{1}}' : '';\r
48 --@]\r
49   {\r
50   }\r
51   {\r
52     \vbox to 0pt{\rule{\headwidth}{\footrulewidth}\vss}\r
53   }\r
54 }\r
55 \r
56 \newcommand{\extracouponspace}{[@-- defined($extracouponspace) ? $extracouponspace : '3.6cm' --@]}\r
57 \r
58 % Adjust the inset of the mailing address\r
59 \newcommand{\addressinset}[1][]{\hspace{1.0cm}}\r
60 \r
61 % Adjust the inset of the return address and logo\r
62 \newcommand{\returninset}[1][]{\hspace{-0.25cm}}\r
63 \r
64 % New command for address lines i.e. skip them if blank\r
65 \newcommand{\addressline}[1]{\ifthenelse{\equal{#1}{}}{}{#1\\}}\r
66 \r
67 % Inserts dollar symbol\r
68 \newcommand{\dollar}[1][]{\symbol{36}}\r
69 \r
70 % Remove plain style header/footer\r
71 \fancypagestyle{plain}{\r
72   \fancyhead{}\r
73 }\r
74 \fancyhf{}\r
75 \r
76 % Define fancy header/footer for first and subsequent pages\r
77 \fancyfoot[C]{\r
78   \ifthenelse{\equal{\thepage}{1}}\r
79   { % First page\r
80 [@--\r
81   if ($coupon) {\r
82     $OUT .= '\vspace{-\extracouponspace}';\r
83     $OUT .= '\rule[0.5em]{\textwidth}{\footrulewidth}\\\\';\r
84     $OUT .= $coupon;\r
85     $OUT .= '\vspace{'. $couponfootsep. '}' if defined($couponfootsep);\r
86   }\r
87   '';\r
88 --@] [@-- $smallerfooter ? '\scriptsize{' : '\small{' --@]\r
89 [@-- $footer --@]\r
90     }[@-- $coupon ? '\vspace{\extracouponspace}' : '' --@]\r
91   }\r
92   { % ... pages\r
93     [@-- $smallerfooter ? '\scriptsize{' : '\small{' --@]\r
94 [@-- $smallfooter --@]\r
95     }\r
96   }\r
97 }\r
98 \r
99 \fancyfoot[R]{\r
100   \ifthenelse{\equal{\thepage}{1}}\r
101   { % First page\r
102   }\r
103   { % ... pages\r
104     \small{\thepage\ of \pageref{LastPage}}\r
105   }\r
106 }\r
107 \r
108 \fancyhead[L]{\r
109   \ifthenelse{\equal{\thepage}{1}}\r
110   { % First page\r
111     \returninset\r
112     \makebox{\r
113       \begin{tabular}{ll}\r
114         \includegraphics{[@-- $logo_file --@]} & [@-- $verticalreturnaddress ? '\\\\' : '' --@]\r
115         \begin{minipage}[b]{5.5cm}\r
116 [@-- $returnaddress --@]\r
117         \end{minipage}\\\r
118       \end{tabular}\r
119     }\r
120   }\r
121   { % ... pages\r
122     %\includegraphics{[@-- $logo_file --@]}     % Uncomment if you want the logo on all pages.\r
123   }\r
124 }\r
125 \r
126 \fancyhead[R]{\r
127   \ifthenelse{\equal{\thepage}{1}}\r
128   { % First page\r
129     \begin{tabular}{ccc}\r
130     [@-- join(' & ', ( $no_date   ? '' : emt('Invoice date') ),\r
131                      ( $no_number ? '' : emt('Invoice #')    ),\r
132                      emt('Customer #')\r
133              )\r
134     --@]\\\r
135     \vspace{0.2cm}\r
136     \textbf{[@-- $date --@]} & \textbf{[@-- $invnum --@]} & \textbf{[@-- $custnum --@]} \\\hline\r
137     \rule{0pt}{5ex} &~~ \huge{\textsc{[@-- emt($notice_name) --@]}} & \\\r
138     \vspace{-0.2cm}\r
139      & & \\\hline\r
140     \end{tabular}\r
141   }\r
142   { % ... pages\r
143     \small{\r
144       \begin{tabular}{lll}\r
145       [@-- join(' & ', emt('Invoice date'), emt('Invoice #'), emt('Customer #') ) --@]\\\r
146       \textbf{[@-- $date --@]} & \textbf{[@-- $invnum --@]} & \textbf{[@-- $custnum --@]}\\\r
147       \end{tabular}\r
148     }\r
149   }\r
150 }\r
151 \r
152 \pagestyle{fancy}\r
153 \r
154 \r
155 %% Font options are:\r
156 %%      bch     Bitsream Charter\r
157 %%      put     Utopia\r
158 %%      phv     Adobe Helvetica\r
159 %%      pnc     New Century Schoolbook\r
160 %%      ptm     Times\r
161 %%      pcr     Courier\r
162 \r
163 \renewcommand{\familydefault}{phv}\r
164 \r
165 \r
166 % Commands for freeside table header...\r
167 \r
168 \newcommand{\FSdescriptionlength} { [@-- $unitprices ? '8.2cm' : '12.8cm' --@] }\r
169 \newcommand{\FSdescriptioncolumncount} { [@-- $unitprices ? '4' : '6' --@] }\r
170 \newcommand{\FSunitcolumns}{ [@-- \r
171   $unitprices\r
172   ? '\makebox[2.5cm][r]{\textbf{~~' . emt('Unit Price') . '}} &' .\r
173     '\makebox[1.4cm]{\textbf{~' . emt('Quantity') . '}} & ' \r
174   : '' --@] }\r
175 \r
176 \newcommand{\FShead}{\r
177   \hline\r
178   \rule{0pt}{2.5ex}\r
179   \makebox[1.4cm]{\textbf{Ref}} &\r
180   \multicolumn{\FSdescriptioncolumncount}{l}{\makebox[\FSdescriptionlength][l]{\textbf{[@-- emt('Description') --@]}}}&\r
181   \FSunitcolumns\r
182   \makebox[1.6cm][r]{\textbf{[@-- emt('Amount') --@]}} \\\r
183   \hline\r
184 }\r
185 \r
186 % ...description...\r
187 \newcommand{\FSdesc}[5]{\r
188   \multicolumn{1}{c}{\rule{0pt}{2.5ex}\textbf{#1}} &\r
189   \multicolumn{[@-- $unitprices ? '4' : '6' --@]}{l}{\textbf{#2}} &\r
190 [@-- $unitprices ? '  \multicolumn{1}{r}{\textbf{#3}} &'."\n".\r
191                    '  \multicolumn{1}{r}{\textbf{#4}} &'."\n"\r
192                  : ''\r
193 --@]\r
194   \multicolumn{1}{r}{\textbf{#5}}\\\r
195 }\r
196 % ...extended description...\r
197 \newcommand{\FSextdesc}[1]{\r
198   \multicolumn{1}{l}{\rule{0pt}{1.0ex}} &\r
199 %%  \multicolumn{2}{l}{\small{~-~#1}}\\\r
200 #1\\\r
201 }\r
202 % ...and total line items.\r
203 \newcommand{\FStotaldesc}[2]{\r
204   & \multicolumn{6}{l}{#1} & #2\\\r
205 }\r
206 \r
207 \r
208 \begin{document}\r
209 %       Headers and footers defined for the first page\r
210 \addressinset \rule{0.5cm}{0cm} \r
211 \makebox{\r
212 \begin{minipage}[t]{7.0cm}\r
213 \vspace{[@-- defined($addresssep) ? $addresssep : '0.25cm' --@]}\r
214 \textbf{[@-- $payname --@]}\\\r
215 \addressline{[@-- $company --@]}\r
216 \addressline{[@-- $address1 --@]}\r
217 \addressline{[@-- $address2 --@]}\r
218 \addressline{[@-- $city --@], [@-- $state --@]~~[@-- $zip --@]}\r
219 \addressline{[@-- $country --@]}\r
220 \end{minipage}}\r
221 \hfill\r
222 \makebox{\r
223 \begin{minipage}[t]{6.4cm}\r
224 [@--\r
225   if ($ship_enable) {\r
226     $OUT .= '\textbf{' . emt('Service Address') . '}\\\\';\r
227     $OUT .= "\\addressline{$ship_company}";\r
228     $OUT .= "\\addressline{$ship_address1}";\r
229     $OUT .= "\\addressline{$ship_address2}";\r
230     $OUT .= "\\addressline{$ship_city, $ship_state~~$ship_zip}";\r
231     $OUT .= "\\addressline{$ship_country}";\r
232     $OUT .= '~\\\\';\r
233   }else{\r
234     $OUT .= '';\r
235   }\r
236 --@]\r
237 \begin{flushright}\r
238 [@-- $terms ? emt('Terms') .": $terms" : '' --@]\\\r
239 [@-- $po_line --@]\\\r
240 \end{flushright}\r
241 \end{minipage}}\r
242 \vspace{1.5cm}\r
243 %\r
244 [@-- $summary --@]\r
245 %\r
246 \section*{}\r
247 [@--\r
248   foreach my $section ( grep { !$summary || $_->{description} ne $finance_section } @sections ) {\r
249     if ($section->{'pretotal'} && !$summary) {\r
250       $OUT .= '\begin{flushright}';\r
251       $OUT .= '\large\textsc{'. $section->{'pretotal'}. '}\\\\';\r
252       $OUT .= '\\end{flushright}';\r
253     }\r
254     $OUT .= '\pagebreak' if $section->{'post_total'};\r
255     unless ($section->{'summarized'} ) {\r
256       $OUT .= '\captionsetup{singlelinecheck=false,justification=raggedright,font={Large,sc,bf}}';\r
257       $OUT .= '\ifthenelse{\equal{\thepage}{1}}{\setlength{\LTextracouponspace}{\extracouponspace}}{\setlength{\LTextracouponspace}{0pt}}'\r
258         if $coupon;\r
259       $OUT .= '\begin{longtable}{cllllllr}';\r
260       $OUT .= '\caption*{ ';\r
261       if ($section->{'location'}) {\r
262         $OUT .= $section->{'location'}{'label_prefix'}. ': '\r
263           if length($section->{'location'}{'label_prefix'});\r
264         $OUT .= $section->{'location'}{'address1'};\r
265         $OUT .= ', ' . $section->{'location'}{'address2'}\r
266           if length($section->{'location'}{'address2'});\r
267         $OUT .= ', ' .\r
268                 $section->{'location'}{'city'} . ', ' .\r
269                 $section->{'location'}{'state'} . '~' .\r
270                 $section->{'location'}{'zip'};\r
271       } elsif ( $section->{'description'} ) {\r
272         $OUT .= ($section->{'description'});\r
273       } else {\r
274         $OUT .= emt('Charges');\r
275       }\r
276       $OUT .= '}\\\\';\r
277       if ($section->{header_generator}) {\r
278         $OUT .= &{$section->{header_generator}}();\r
279       } else {\r
280         $OUT .= '\FShead';\r
281       }\r
282       $OUT .= '\endfirsthead';\r
283       $OUT .= '\multicolumn{7}{r}{\rule{0pt}{2.5ex}'.emt('Continued from previous page').'}\\\\';\r
284       if ($section->{header_generator}) {\r
285         $OUT .= &{$section->{header_generator}}();\r
286       } else {\r
287         $OUT .= '\FShead';\r
288       }\r
289       $OUT .= '\endhead';\r
290       $OUT .= '\multicolumn{7}{r}{\rule{0pt}{2.5ex}'.emt('Continued on next page...').'}\\\\';\r
291       $OUT .= '\endfoot';\r
292       $OUT .= '\hline';\r
293 \r
294       if (scalar(@sections) > 1 and !$section->{no_subtotal}) {\r
295         if ($section->{total_generator}) {\r
296           $OUT .= &{$section->{total_generator}}($section);\r
297         } else {\r
298           $OUT .= '\FStotaldesc{' . $section->{'description'} . ' Total}' .\r
299                   '{' . $section->{'subtotal'} . '}' . "\n";\r
300         }\r
301       }\r
302 \r
303       #if ($section == $sections[$#sections]) {\r
304         foreach my $line (grep {$_->{section}->{description} eq $section->{description}} @total_items) {\r
305           if ($section->{total_line_generator}) {\r
306             $OUT .= &{$section->{total_line_generator}}($line);\r
307           } else {\r
308             $OUT .= '\FStotaldesc{' . $line->{'total_item'} . '}' .\r
309                     '{' . $line->{'total_amount'} . '}' . "\n";\r
310           }\r
311         }\r
312       #}\r
313 \r
314       $OUT .= '\hline';\r
315       $OUT .= '\endlastfoot';\r
316 \r
317       my $lastref = 0;\r
318       foreach my $line (\r
319         grep { ( scalar( @sections ) > 1 \r
320                ? $section->{'description'} eq $_->{'section'}->{'description'}\r
321                : 1\r
322              ) }\r
323         @detail_items )\r
324       {\r
325         my $ext_description = $line->{'ext_description'};\r
326   \r
327         # Don't break-up small packages.\r
328         my $rowbreak = @$ext_description < 5 ? '*' : '';\r
329   \r
330         $OUT .= "\\hline\n" if ($line->{'ref'} && $line->{'ref'} ne $lastref);\r
331         if ($section->{description_generator}) {\r
332           $OUT .= &{$section->{description_generator}}($line);\r
333         } else {\r
334           $OUT .= '\FSdesc'.\r
335                   '{' . ( $line->{'ref'} ne $lastref ? $line->{'ref'} : '' ) . '}'.\r
336                   '{' . $line->{'description'} . '}' ;\r
337           if ( $unitprices and length($line->{'unit_amount'}) ) {\r
338             # then show the unit amount and quantity\r
339             $OUT .= \r
340                 '{\\dollar' . $line->{'unit_amount'} . '}'.\r
341                 '{'         . $line->{'quantity'}    . '}';\r
342           } else {\r
343             # leave those columns blank\r
344             $OUT .= '{}{}';\r
345           }\r
346           $OUT .= '{\\dollar' . $line->{'amount'} . "}${rowbreak}\n";\r
347         }\r
348         $lastref = $line->{'ref'};\r
349 \r
350         foreach my $ext_desc (@$ext_description) {\r
351           if ($section->{extended_description_generator}) {\r
352             $OUT .= &{$section->{extended_description_generator}}($ext_desc);\r
353           } else {\r
354             if ( $ext_desc !~ /[^\\]&/ ) {\r
355               $ext_desc = substr($ext_desc, 0, 80) . '...'\r
356                 if (length($ext_desc) > 80);\r
357               $ext_desc = '\multicolumn{6}{l}{\small{~~~'. $ext_desc. '}}';\r
358             }else{\r
359               $ext_desc = "~~~$ext_desc";\r
360             }\r
361             $OUT .= '\FSextdesc{' . $ext_desc . '}' . "${rowbreak}\n";\r
362           }\r
363         }\r
364 \r
365       }\r
366 \r
367       $OUT .= '\end{longtable}';\r
368     }\r
369     if ($section->{'posttotal'}) {\r
370       $OUT .= '\begin{flushright}';\r
371       $OUT .= '\normalfont\large\bfseries\textsc{'. $section->{'posttotal'}. '}\\\\';\r
372       $OUT .= '\\end{flushright}';\r
373     }\r
374   }\r
375 \r
376 --@]\r
377 \vfill\r
378 \begin{minipage}[t]{\textwidth}\r
379   [@-- length($summary)\r
380          ? ''\r
381         : ( $smallernotes\r
382               ? '\scriptsize{ '.$notes.' }'\r
383               : $notes\r
384           )\r
385   --@]\r
386   [@-- $coupon ? '\ifthenelse{\equal{\thepage}{1}}{\rule{0pt}{\extracouponspace}}{}' : '' --@]\r
387 \end{minipage}\r
388 \end{document}\r