Common specs for pdfs

From UG

(Difference between revisions)

Jump to: navigation, search

Revision as of 19:53, 5 October 2009

Paper size

Requirements

ps1) Any document could be printed in any office.
ps2) Some offices use A4 and some use Letter. (see for example http://desktoppub.about.com/cs/intermediate/a/measure_paper.htm to understand difference)

Design and Specs

?? How to solve this problem? Is it easy?

Standard Header

It consists of:

Jag Office Logo (left)
Jag Office Address (right)

Domestic vs International Address

ss1 // For user logins from non-NY offices we need radio box on template that gives choices: Domestic and International. If Domestic then Address in *top right corner* must come from login operator office and Logo must be for that office. If International then Address in top right corner must be Jaguar NY and Logo must be for Jag NY.

ss2 // Below listed are the only documents that require that:
- sales invoice, credit note pdfs

Standard Labels boxes etc

[lvb0] Most documents share same “Standard Labels, Values, Boxes” style
[lvb1] All labels must be bold and have ":" after them
[lvb2] all values in boxes must be left aligned. They should start not immediately after the vertical line but after some margin.
[lvb3] all labels must be - all capital letters
[lvb4] all labels must be on a gray background
[lvb5] example link: TBD
[lvb6] exact CSS definitions link: TBD

Date and Year

[dy1] Must be always in the following format (Example): 15 May 2009

Prepared by

[pb1] Must be always at the bottom of the page (on every page?) and in the following format (Example): "Prepared by: Robert Link "

Textbox or Textarea input validation

see below

Textbox size validation

Q: How to handle situation when string entered/populated into textbox / textarea (Example: Special Instructions) above does not fit into the correspondent space on pdf?

A: In this case (as on any pdf) for each single or multiline textbox/textarea there must be a max number of characters/lines determined and:

displayed (next to the label) (example: "max 70 chars on one line, max 4 lines")
validator must be added that "prevents user from entering more" OR "displays pop-up indicating that max reached". Any other alternative ideas?

Textbox size

newss The size of the textbox (number of visible characters) on template must be equal to the size on pdf. This size could be discovered by experimenting with different pdf outputs. --Alex 03:38, 30 June 2009 (UTC)

Pdf zul template layout and size

1] Must mimic layout on pdf
2] Size of textboxes must reflect space on pdf

Commodity Table Section

See this article: Commodity Table for Pdfs

Common bugs and changes

1] correct: CBM, wrong: CB
2] correct: PCS, not HU (table header)
3] correct: "TOTAL:", not "TOTALS:"
4] correct: PICK-UP / XXXX wrong: PICK UP/XXX
5] HU on pdf not aligned vertically
6] print: Marks & Numbers, not: "CONTAINER NR"
7] no need for "AS AGENTS FOR:" on pdf footer (footer that has name/signature/date)
8] replace "FOR DELIVERY TO:" with "DELIVERY TO:"

PO logic

Added: --Alex 23:13, 21 June 2009 (UTC)

PO list comes into template from Commod Table (from one or multiple CTs if Group Generate)
pre-fill PO field on template based on this logic:
- if one PO then display it
- if 2 PO then display both separated by ",". Example: a112233, a1234
- if more than 2 PO then display first two separated by "," and "++" after . Example: a112233, a1234, ++
display only first 30 chars on pdf and ignore the rest, do not display any errors
on template next to "P.O. Numbers:" add label in red "(max 30 chars will be displayed on pdf)"

Instructions page

created:--Alex 23:28, 21 June 2009 (UTC)

1] Some documents have so called "Instructions page" (formerly "Page 2").
2] On template it is represented by checkbox and 1 page large teaxtarea
3] on pdf this would always print as last page
4] on pdf text must be surrounded by a single line (be printed inside rectangle)
5] at the top of this page doc header must be printed

Multipage logic

created --Alex 23:28, 21 June 2009 (UTC)

1] In some cases document would consist of more than one page. Examples:
- #Instructions page is enabled
- Commodity table section is too large to fit on 1 page
- TOC is too large to fit on 1 page

2] Print "Page x of y" - at the top right below header on each page
3] Print "see next page" - at the bottom right
4] print special header for each additional page (see specific doc spec)
5] print special footer for each additional page (see specific doc spec)

Standard Footer

started --Alex 00:40, 22 June 2009 (UTC)

At this point the only footer we use is centered gray sentence: "www.jaguarfreight.com"

Special instructions

1] It is page wide, several lines tall textarea.
2] must appear once at the bottom of last page

Received in good order by

1] section consists of "Issued by: ..." sub-section on th left and "Name / Signature / Date" on the right
2] must appear once at the bottom of last page

RFC Terms and Conditions footer

It was suggested to have “Terms and Conditions section” to be a part of a pdf footer.

Q: We need to define: 1) what exactly to print 2) on what documents.

Blocking pdf gen

In some case system must block pdf generation:

some contents are unassigned in commod table

Rel 1.1

chg: 'Blocking pdf gen' feature

ss1 // . The “block” for issuing documentation, when not all contents are assigned to a container (ocean) should be for HBL only.(marc). In docs where commod table is structured "per container" apply logic:
- If at least one line in CT.ContTab.CommodTable is unassigned then print nothing in "Marks and Numbers" column and in "Description" column in pdf all numbers (# of pallets, etc) for entire would be totals for all commodities for CT/group (assigned and unassigned)

new: 'Domestic vs International Address' feature

ss1 // For user logins from non-NY offices we need radio box on template that gives choices: Domestic and International. If Domestic then Address in *top right corner* must come from login operator office and Logo must be for that office. If International then Address in top right corner must be Jaguar NY and Logo must be for Jag NY.

ss2 // on pdf in this address first line should say "Please mail payment to:"

Please mail payment to:
10 Fifth Street, 3rd Floor
Valley Stream, NY 11581
USA

ss3 // Below listed are the only documents that require that:
- sales invoice, credit note pdfs

ss4 // invoice sequence in this case is different:
- for invoices issued in UK it is: UK-US1, UK-US2, ...
- for invoices issued in FR it is: FR-US1, FR-US2, ...

ss5 // also: set Default “grand total” currency to default to USD for FRUS invoices

@@ Line 148: / Line 148: @@
   USA
-* ss2 // Below listed are the only documents that require that:
+* ss3 // Below listed are the only documents that require that:
 ** sales invoice, credit note pdfs
-* ss3 // invoice sequence in this case is different:
+* ss4 // invoice sequence in this case is different:
 ** for invoices issued in UK it is: UK-US1, UK-US2, ...
 ** for invoices issued in FR it is: FR-US1, FR-US2, ...
-* ss4 // also: set Default “grand total” currency to default to USD for FRUS invoices
+* ss5 // also: set Default “grand total” currency to default to USD for FRUS invoices
 [[Category:OpsPdfs]]