Difference between revisions of "Attach a PDF to a Web Page View"
From SmartWiki
Line 15: | Line 15: | ||
|- | |- | ||
| [[Smart Folder]] | | [[Smart Folder]] | ||
− | | /files/'' | + | | /files/''folder1''/''folder2''/''File_Name''.pdf |
|- | |- | ||
| [[Single File]] Custom Field | | [[Single File]] Custom Field | ||
− | | @''Custom Field Name'.value@ | + | | @''Custom Field Name''.value@ |
|- | |- | ||
| [[Multiple Files]] Custom Field | | [[Multiple Files]] Custom Field | ||
| @''Custom Field Name''.files@ | | @''Custom Field Name''.files@ | ||
|} | |} | ||
+ | |||
:'''Note:''' when a [[Multiple Files]] field is specified, all PDF files stored in that field will be attached where specified. | :'''Note:''' when a [[Multiple Files]] field is specified, all PDF files stored in that field will be attached where specified. | ||
+ | : Single or Multiple file fields on parent levels can be access using: | ||
+ | ::* @parent.''Custom Field Name''.value@ | ||
+ | ::* @parent.parent.''Custom Field Name''.files@ | ||
To attach a PDF file to a defined page location within the [[Web Page View]]: | To attach a PDF file to a defined page location within the [[Web Page View]]: |
Revision as of 14:36, 17 May 2010
You can use the ssattach function to append one or more PDF documents stored in either a Single File Field or Smart Folder to a Web Page View Field.
Note: The attached PDF file(s) will not be visible when viewing the web page in HTML mode, but will be appended when exported as a PDF, saved as a PDF, emailed as PDF or created by a Workflow as attachment.
Syntax
To attach a PDF file to the beginning or the end of the Web Page View:
- <!--@ssattach(position;pdf file location)-->
Where:
- position is either before or after
- pdf file location is:
File Source Syntax Smart Folder /files/folder1/folder2/File_Name.pdf Single File Custom Field @Custom Field Name.value@ Multiple Files Custom Field @Custom Field Name.files@
- Note: when a Multiple Files field is specified, all PDF files stored in that field will be attached where specified.
- Single or Multiple file fields on parent levels can be access using:
- @parent.Custom Field Name.value@
- @parent.parent.Custom Field Name.files@
To attach a PDF file to a defined page location within the Web Page View:
- <!--@ssattach(insert;pdf file location;page number)-->
Examples
- Append a PDF file from a Smart Folder before the current Web Page View Field page:
<!--@ssattach(before;/files/1234/123/myfile.pdf )-->
- Append a PDF file from a Smart Folder after the current Web Page View Field page:
<!--@ssattach(after;/files/1234/123/myfile.pdf )-->
- Append a PDF file from a Single File Custom Field called "AttachPDFFile" before the current Web Page View Field page:.
<!--@ssattach(before;@AttachPDFFile.value@)-->
- Note: Don't forget to include .value
- Attach PDF files to a Level 1 Web Page View from the UTA Role Custom Fields on the contact section:
[#(?object=contact;)<!--@ssattach(after;$?opr_123456.value$)-->#]
Where 123456 is the Custom Field ID
- You can also control the format settings of the PDF that is output by using the following syntax. The PDF file referenced should be a blank one-page pdf file which has the format settings you wish your PDF document to have. The Web Page View will be inserted onto this template:
<!--@ssattach(setting;/files/1234/123/myfile.pdf)-->
Additional Information
- The ssattach function can be placed anywhere inside the Web Page View Field
- All PDF page settings will driven by the first PDF document file, whether it is a static file or one generated by SmartSimple
- Multiple PDF files can be attached from different sources by using multiple ssattach statements:
<!--@ssattach(before;/files/1234/123/myfileheader.pdf )--> <!--@ssattach(after;/files/1234/123/myfilefooter.pdf )--> <!--@ssattach(after;/files/1234/123/myfileappendix.pdf )--> <html><body> My Pdf file </body></html>
- SSlogic can be used if the PDF file(s) to be attached needs to be varied using conditional statments:
<!--@sslogic('@type@'='contact')--> <!--@ssattach(after;@parent.contract.value@)--> <!--@else--> <!--@ssattach(after;@parent.othercontract.value@)--> <!--@end-->