Difference between revisions of "Attach a PDF to a Web Page View"
From SmartWiki
(→Syntax) |
|||
| Line 7: | Line 7: | ||
To attach a PDF file to the beginning or the end of the [[Web Page View]]: | To attach a PDF file to the beginning or the end of the [[Web Page View]]: | ||
:<font size="3">'''<!--@ssattach(''position'';''pdf file location'')-->'''</font> | :<font size="3">'''<!--@ssattach(''position'';''pdf file location'')-->'''</font> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
'''Where:''' | '''Where:''' | ||
| − | * ''position'' is either '''before''' | + | * ''position'' is either '''before''' or '''after'''. |
| − | |||
| − | |||
* ''pdf file location'' is: | * ''pdf file location'' is: | ||
:{|cellpadding="5" cellspacing="0" border="1" | :{|cellpadding="5" cellspacing="0" border="1" | ||
| Line 45: | Line 34: | ||
* Single or Multiple file fields on parent/grandparent levels can also be included using: | * Single or Multiple file fields on parent/grandparent levels can also be included using: | ||
::* @parent.''Custom Field Name''.value@, @parent.parent.''Custom Field Name''.files@, etc. | ::* @parent.''Custom Field Name''.value@, @parent.parent.''Custom Field Name''.files@, etc. | ||
| − | |||
| − | |||
==Examples== | ==Examples== | ||
Revision as of 12:13, 22 July 2013
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 Comments Smart Folder /files/folder1/folder2/File_Name.pdf To obtain select View URL from the File Options combo box next to the relevant file in the Smart Folder.
The first part of the URL should be omitted: the location specified should begin with "/files/..." as in the examples below.
Single File Custom Field @Custom Field Name.value@ Multiple Files Custom Field @Custom Field Name.files@ All PDF files stored in field will be attached.
Notes:
- Single or Multiple file fields on parent/grandparent levels can also be included using:
- @parent.Custom Field Name.value@, @parent.parent.Custom Field Name.files@, etc.
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
- Insert all PDF files stored in a Multiple Files Custom Field called "AttachManyPDFFiles" at page 4 of the current Web Page View Field page:.
<!--@ssattach(insert;@AttachManyPDFFiles.files@;4)-->
- Note: Don't forget to include .files
- 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
- To 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
- IMPORTANT Any PDF files that have security restriction in place such as Content Copying or Content Copying or Extraction have been encrypted and cannot be included.
- The settings can be viewed by opening the PDF and clicking File > Document Properties > Security (steps may vary depending on the version of your PDF reader)
- See also: Display Additional File Attributes for PDF Documents
- 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 statements:
<!--@sslogic('@type@'='contact')-->
<!--@ssattach(after;@parent.contract.value@)-->
<!--@else-->
<!--@ssattach(after;@parent.othercontract.value@)-->
<!--@end-->
