Changes

Custom Field Type: Special - Web Page View

25,632 bytes added, 15:58, 26 November 2018

no edit summary

~~{{CustomFieldPageHeader}}~~==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 [[~~Image:Cf20~~Save to Server]] setting is enabled.~~png~~This includes pages attached using [[ssattach]]. If the PDF document is too long it will not be stored. ~~'''General Description'''~~ {{HTMLOptions}}

A '''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''' or '''XML'''. {{~~FieldOptions}}{{ButtonLabel}}{{AppearMandatory}}{{LabelAboveField}}{{HideFieldForNewRecord}}{{VisibilityCondition}}{{FieldPermissionMatrix}}{{ValueStoresTo}}~~* '''Enforce Selection''' - makes the [[Multiple Files]] custom field selected as the '''Value Stores To''' field the only field the file can be stored to.~~{{FieldFormattingOptions~~WordOptions}}

====Exported File Name====~~'''Special Options for Field'''~~ * Specify a filename to be used if the user chooses to export.

* '''HTML Template''' – the body of the document combined with variables from the underlying [[Entity|entity]]==Value Storage=={{ValueStoresTo}}

~~'''Document 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.~~* '''Allow New Window Automatically''' – automatically displays the document in a new window so the [[Browser|browser’s]] print function can be used.* '''Allow Switching LanguageEnforce Selection''' - * '''Is XML''' – indicates that the document is to be prepared as an '''XML''' output.* '''Automatically Use 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 makes the [[Multiple Files]] custom field ~~will be named with the [[userid]] of~~ selected as the ~~current user.~~::'''~~Note:~~Value Storage''' ~~if a file with that name already exists in~~ field the ~~[[Multiple Files]]~~ only field ~~it will~~ the file can be ~~replaced with the new one, unless the '''Keep Version''' setting is enabled~~stored to.* '''HCAI Enabled''' - * '''HCAI Automatically Redirect''' -

~~{{PDFOptions}}~~

~~{{FieldPermissions}}~~

==Notes==

~~===~~'''sslogic~~===~~'''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.

SmartSimple logic follows the following template:

The content to be displayed when condition is true

</nowiki>

See [[sslogic|~~here~~SSLogic]] for further details.

~~===~~'''Hyperlink to Web Page View~~===~~'''

You can create a link to a web page view field using the following syntax:

~~<nowiki>~~<a href="@''wpv''.value@">Open WPV</a~~></nowiki~~>

Where '''wpv''' is the name of the Web Page View field.

==Multi-Line Text==

To include Multi-Line Text fields in a {{WPV}} you need use the following syntax to ensure that line breaks are displayed correctly when the page is converted to PDF format.

<div style="display: block; pd4ml-display: none; white-space: pre-wrap;">~Narrative~</div>

<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

==See Also==

* [[SmartField View]]

* [[Accessibility legislation]]

* [[Web Page View Field]]

* [[Web Page View Field Variables]]

← Older edit

Nancy Sabo

Smartstaff, administrator

421

edits

Changes

Custom Field Type: Special - Web Page View

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools