Difference between revisions of "Creating PDF templates"

From OpenKM Documentation
Jump to: navigation, search
 
(16 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
* [http://pdfformsdesigne.sourceforge.net/index.html PDF Forms Designer]
 
* [http://pdfformsdesigne.sourceforge.net/index.html PDF Forms Designer]
  
{{Warning|This section is under construction.}}
+
{{Note|Starting from OpenKM 5.1.8 you can also use FreeMarker expressions in PDF templates. Just set the expression as field value (default text if you create the PDF templates from OpenOffice).}}
  
In order to make a relation between the template form field and the property group, you have to name them following a naming convention.
+
{{Advice|Every PDF form field name need to be unique, so you can't set the same property vale to several form fields. When converting from OpenOffice document to PDF, repeated form fileds are rename to ''original_name_2'', ''original_name_3'', etc.
 +
<br/>If you need to put the same property value in several fields, try [[Creating_OpenOffice_templates|OpenOffice templates]].
 +
<br/>Since OpenKM 6.2.5 Professional and 6.2.1 Community you can use template expressions to avoid this limitation.}}
 +
 
 +
In order to make a relation between the template form field and the property group, you have to name them following a naming convention: replace ":" and "." by "_". Here you can see the matching between both fields:
 +
 
 +
 
 +
{| align="center" border="0" cellpadding="5" cellspacing="0" style="width: 600px"
 +
! align="left"| PROPERTY GROUP NAME !! align="left"| TEMPLATE FIELD NAME !! align="left"| TEMPLATE FIELD VALUE
 +
|-
 +
|okp:tpl.name      || okp_tpl_name      || ${okp_tpl_name!}
 +
|-
 +
|okp:tpl.bird_date || okp_tpl_bird_date || ${okp_tpl_bird_date!}
 +
|-
 +
|okp:tpl.language  || okp_tpl_language  || ${okp_tpl_language!}
 +
|-
 +
|}
 +
 
 +
 
 +
To create a template in OpenOffice.org go to '''View''' > '''Toolbars''' > '''Form Controls'''. The a new dialog will appear and you will be able to add form elements to the document. This dialog contains form stuff such as Labels, Text Boxes, Check Boxes, etc.
 +
 
 +
 
 +
<center>[[File:Pdf Templates 001.png|655px]]</center>
 +
 
 +
 
 +
Once the form has been created, go to '''File''' > '''Export as PDF''' to generate a PDF with these form fields. This is the final result:
 +
 
 +
<center>[[File:Pdf templates 002.png]]</center>
 +
 
 +
Here you have the generated PDF file [[File:Tpl.pdf]] and this is the ODT source [[File:Tpl pdf.odt]].
 +
 
 +
== Data format ==
 +
OpenKM uses FreeMarker inside, so you can take advantage of the FreeMarker formatting flexibilities. For example you can set date format by this way:
 +
 
 +
  ${okp_tpl_bird_date?string("yyyy-MM-dd")}
 +
 
 +
Learn more about FreeMarker formatting at [http://freemarker.sourceforge.net/docs/ref_builtins.html Built-in Reference].
  
 
[[Category: Installation Guide]]
 
[[Category: Installation Guide]]
[[Category: OKM Network]]
 

Latest revision as of 10:57, 24 December 2012

You can create PDF template forms with several applications:


Nota clasica.png Starting from OpenKM 5.1.8 you can also use FreeMarker expressions in PDF templates. Just set the expression as field value (default text if you create the PDF templates from OpenOffice).


Nota idea.png Every PDF form field name need to be unique, so you can't set the same property vale to several form fields. When converting from OpenOffice document to PDF, repeated form fileds are rename to original_name_2, original_name_3, etc.


If you need to put the same property value in several fields, try OpenOffice templates.


Since OpenKM 6.2.5 Professional and 6.2.1 Community you can use template expressions to avoid this limitation.

In order to make a relation between the template form field and the property group, you have to name them following a naming convention: replace ":" and "." by "_". Here you can see the matching between both fields:


PROPERTY GROUP NAME TEMPLATE FIELD NAME TEMPLATE FIELD VALUE
okp:tpl.name okp_tpl_name ${okp_tpl_name!}
okp:tpl.bird_date okp_tpl_bird_date ${okp_tpl_bird_date!}
okp:tpl.language okp_tpl_language ${okp_tpl_language!}


To create a template in OpenOffice.org go to View > Toolbars > Form Controls. The a new dialog will appear and you will be able to add form elements to the document. This dialog contains form stuff such as Labels, Text Boxes, Check Boxes, etc.


Pdf Templates 001.png


Once the form has been created, go to File > Export as PDF to generate a PDF with these form fields. This is the final result:

Pdf templates 002.png

Here you have the generated PDF file File:Tpl.pdf and this is the ODT source File:Tpl pdf.odt.

Data format

OpenKM uses FreeMarker inside, so you can take advantage of the FreeMarker formatting flexibilities. For example you can set date format by this way:

 ${okp_tpl_bird_date?string("yyyy-MM-dd")}

Learn more about FreeMarker formatting at Built-in Reference.