Difference between revisions of "Attach a PDF to a Web Page View"

From SmartWiki
Jump to: navigation, search
Line 6: Line 6:
 
==Syntax==
 
==Syntax==
 
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">'''&lt;!--@ssattach(''position'';''pdf file location'')'''</font>
+
:<font size="3">'''&lt;!--@ssattach(''position'';''pdf file location'')-->'''</font>
 +
'''Where:'''
 +
* ''position'' is either '''before''' or '''after'''
 +
* ''pdf file location'' is:
 +
:{|cellpadding="5" cellspacing="0" border="1"
 +
| '''File Source'''
 +
| '''Syntax'''
 +
|-
 +
| [[Smart Folder]]
 +
| /files/''folder''/''folder''/''filename''.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.
  
 
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]]:
−
:<font size="3">'''&lt;!--@ssattach(insert;''pdf file location'';''page number'')'''</font>
+
:<font size="3">'''&lt;!--@ssattach(insert;''pdf file location'';''page number'')-->'''</font>
  
  

Revision as of 14:31, 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/folder/folder/filename.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.

To attach a PDF file to a defined page location within the Web Page View:

<!--@ssattach(insert;pdf file location;page number)-->


Examples

<!--@ssattach(before;/files/1234/123/myfile.pdf )-->



<!--@ssattach(after;/files/1234/123/myfile.pdf )-->



<!--@ssattach(before;@AttachPDFFile.value@)-->
  • Note: Don't forget to include .value


[#(?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-->


See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Attach_a_PDF_to_a_Web_Page_View&oldid=9770’