Changes

Custom Field Type: Special - Web Page View

24,798 bytes added, 15:58, 26 November 2018

no edit summary

~~~~==General Description==A '''~~Field Display~~Web Page View'''~~~~ field is used to create a “document” based on underlying [[Entity|entity]] data. The field type has a wide variety of document management options associated including the conversion to '''PDF'''.

~~'''~~==Field ~~View'''~~Illustrated====Field Options==All common options: [[Custom Fields - General Information#General_Settings|General Settings]] [[Custom Fields - General Information#Permissions & Availability|Permissions & Availability]] [[Custom Fields - General Information#Classic Options|Classic Options]] For further information, please refer to [[Custom Fields – General Information]]. Options listed below are specific to this particular field type (if applicable).

* '''HTML Template''' – the body of the document combined with variables from the underlying [[Entity|entity]]. The content of this field should conform to any [[Accessibility legislation]].* '''SmartFields Sample Template''' - this link adds the SmartFields HTML template. This template renders custom fields in a format that can be easily reviewed, converted to PDF and printed.{{CustomFieldIDs}} ===Document Options=======General Options====* '''Open in Modal Window''' - displays the document in a Modal Window.* '''Enable Printing''' – adds a print button that uses your browser's built-in print functionality to print the screen. Instead of using this setting, we suggest you use the SmartFields HTML template and enable '''Export as PDF''', followed by printing from the PDF.* '''Enable Editing''' – adds an edit button that allows the user to temporarily edit the HTML of the web page view. Any changes made are not saved.* '''Enable Switching Language''' - adds a Language dropdown to the modal window which allows the user to switch the language of your web page view. Language translations for custom fields will display when you change the drop down. The languages that appear in the drop down are dependent on the translations you have entered for the web page view field: [[Image:~~Cf19~~Cf-wpv-3.png|link=|150px]] * '''Render As XML Document ~~Window~~ ''' – ~~all~~ indicates that the document is to be prepared as an [[XML]] output.* '''Default User ID as File Name''' - when using the PDF or HTML '''Save to Multiple File Field''' options (explained below) the filename of the file stored within the [[Multiple Files]] field will be named with the [[userid]] of the current user. See also the '''File Name''' PDF option below.*: '''Note:''' if a file with that name already exists in the [[Multiple Files]] field it will be replaced with the new one, unless the '''Keep Version''' setting is enabled on the Multiple Files field.* '''Enable HCAI''' - See [[HCAI Overview]] for additional information.* '''HCAI Automatically Redirect''' - See [[HCAI Overview]] for additional information.* '''Enable Field Selection for SmartFields''' - select a subset of fields to appear on the Web Page View.* '''Hide Instructions''' - instructions found in custom field captions as well as the display - Instructions custom field will not appear in the exported PDF if this setting is toggled on. {{PDFOptions}} ====PDF Page Options ~~enabled~~====* '''Fit to Page''' - Compresses the content to fit onto one PDF page.* '''Landscape Mode''' - allows the PDF to be presented in Landscape mode, as opposed to Portait mode. ====Paper Size====* '''Letter''' - the standard 8.5 x 11-inch size.* '''Legal''' - 8 x 13 inches.* '''Ledger''' - 11 x 17 inches.* '''A4'''- 297 millimetres x 210 millimetres. ====Maximum Page Length====* Specifies the maximum number of pages of the resultant PDF permitted to be stored into a [[Multiple Files]] field if the [[Save to Server]] setting is enabled. This includes pages attached using [[ssattach]]. If the PDF document is too long it will not be stored.{{HTMLOptions}}

~~[[Image:Cf20.png]]~~ ~~'''General Description'''~~ {{WordOptions}}

~~A '''Web Page View''' field is~~ ====Exported File Name====* Specify a filename to be used ~~to create a “document” based on underlying [[Entity|entity]] data. The field type has a wide variety of document management options associated including~~ if the ~~conversion~~ user chooses to ~~'''PDF''' or '''XML'''~~export. ~~'''Field Options'''~~

* '''Allow Empty''': N/A* '''Default Text''': N/A* '''Options''': HTML Template* '''Track Changes''': N/A* '''Store To ==Value~~''': N/A~~ Storage==~~'''Special Options for Field'''~~ {{ValueStoresTo}}

* '''~~Show Menu~~Enforce Selection''' ~~– check box that defines if a~~ - makes the [[~~Menu|menu~~Multiple Files]] ~~should be shown in~~ custom field selected as the ~~document window.~~* '''~~HTML Template~~Value Storage''' – field the ~~body of~~ only field the ~~document combined with variables from the underlying [[Entity|entity]]~~file can be stored to.

~~'''General Options'''~~

* '''Allow Printing''' – enables the [[User|user]] to print the resultant document.

* '''Allow Editing''' – enables the [[User|user]]to edit the document with the HTML Editor

* '''Allow New Window''' – displays the document in a new window so the [[Browser|browser’s]] print function can be used.

* '''Is XML''' – indicates that the document is to be prepared as an '''XML''' output.

~~'''PDF Options'''~~* '''Enable Password Protection''' – enables the [[User|user]] to [[Password|password]] protect the document (generally used when the document is going to be emailed).* '''Send as Email''' – enables the [[User|user]] to send the PDF as an attachment to an email message.* '''Save to Multiple File Field''' – enables the [[User|user]] to save the document as a PDF into any multiple file

~~'''HTML Options'''~~

* '''Send as Email''' – enables the [[User|user]] to send the document as the body of an email message.

* '''Save to Multiple File Field''' – enables the [[User|user]] to save the document as a HTML document into any multiple file type fields in the related [[Entity|entity]].

* '''Save to Local Disk''' – enables the [[User|user]] to save a local copy of the HTML document.

~~'''Field Validation'''~~

* '''Type''': N/A* '''JavaScript Validation''': N/A==Notes==* '''~~Message~~sslogic'''~~: N/A~~Web Page View fields can use a unique SmartSimple logic interpreter. Web page logic gives you the ability to display certain content or perform certain actions only when specified conditions are met.* '''HTML Tag'''SmartSimple logic follows the following template: ~~N/A~~ ~~'''Field Formatting Options'''~~

* '''Height''': N/A '''Measure''': '''Default''': <nowiki> The content ~~window set~~ to ~~800 * 600 Pixels.~~* '''Width''': N/A '''Measure''': '''Default''': N/A* '''Number Format''': N/Abe displayed when condition is true* '''Style''': N/A* '''Tool Tip''': N/A <u!--@end-->~~'''Logic'''~~</unowiki>

~~Web Page View fields can use a unique SmartSimple logic interpreter~~See [[sslogic|SSLogic]] for further details. ~~Web page logic gives you the ability to display certain content or perform certain actions only when specified conditions are met.SmartSimple logic follows the following template:  The content to be displayed when condition is true  ~~

'''~~Condition~~Hyperlink to Web Page View''' ~~is replaced with~~ You can create a link to a web page view field using the ~~logical condition that your case calls for. The~~ following ~~code sample will display a Christmas tree image if and only if it is currently December~~syntax:~~  <img src='images/xmasstree.jpg'>  ~~

~~Note that~~ <a href="@''wpv''.value@">Open WPV</a>Where '''wpv''' is the ~~content to be displayed (~~name of the ~~middle line) can either be in plaintext or in HTML~~Web Page View field.

~~Often, you will want to display one of two texts~~==Multi-Line Text==To include Multi-~~one text~~ Line Text fields in ~~the case that~~ a ~~condition is met and another in~~ {{WPV}} you need use the ~~case~~ following syntax to ensure that line breaks are displayed correctly when the ~~condition~~ page is ~~not met~~converted to PDF format. ~~This is achieved through the use of an "else" operator.The following sample code will display one message if a user is male and another if the user is female:  You are a guy.  You are a girl.  ~~

<udiv style="display: block; pd4ml-display: none; white-space: pre-wrap;">~~'''Notes'''~~~Narrative~</udiv> <div style="display: none; pd4ml-display: block; white-space: pre; word-wrap: break-word;">~Narrative~</div>The first div displays correctly in the {{WPV}} and the second div displays correctly in the PDF version

~~This field type has extensive additional options that can be found in this wiki.~~==See Also==* [[SmartField View]]* [[Accessibility legislation]]* [[Web Page View Field]]~~See~~ * [[Web Page View Field Variables]]* [[Updateable Web Page View Fields]]* [[Changing the Status from a Web Page View]]* [[sslogic]]* [[sscalculation]]* [[:Category:PDF|PDF Category]]* [[PDF Writer Custom Tags]]* [[Adding JavaScript JS files to Web Page View Pages]]* [[Using Special Characters in Web Page View]]

~~[[Category:Custom Fields]]~~{{CustomFieldPageFooter}}

← Older edit

Nancy Sabo

Smartstaff, administrator

421

edits

Changes

Custom Field Type: Special - Web Page View

SmartWiki