Page Parameters
Tagging page parameters refers specifically to the fields editable under Properties > Parameters. These are typically built out at the beginning of the TMPL or PCF page content, after the <headcode>, <bodycode>, and <footcode> tags.
<?xml version="1.0" encoding="UTF-8"?> <?pcf-stylesheet path="/_resources/xsl/_widgets/header.xsl" title="Homepage Header" extension="inc"?> <!DOCTYPE document SYSTEM "http://commons.omniupdate.com/dtd/standard.dtd"> <document xmlns:ouc="http://omniupdate.com/XSL/Variables"> <headcode></headcode> <!-- before closing head tag --> <bodycode></bodycode> <!-- after opening body tag --> <footcode></footcode> <!-- before closing body tag --> <ouc:properties label="config"></ouc:properties> <ouc:div label="search-page-location" group="Everyone" button="hide"> <ouc:multiedit type="text" prompt="Search Page Location" alt="Form action attribute value."/>/search/</ouc:div> </document>PropertiesLink to this section
The <ouc:properties> tag contains all page parameters found when editing. These include title, description, tags, and keywords, as well as any custom parameters you set. Content in the <meta> and <title> tags displays under the "Title and Metadata" header while content in the <parameter> tags displays under "Custom Settings."
<ouc:properties label="metadata"> <title>Interior</title> <meta name="Description" content=" /> <meta name="Keywords" content=" /> </ouc:properties> <ouc:properties label="config"> <parameter name="heading" type="text" group="Everyone" prompt="Page Heading" alt="Please enter the page heading.">Super Template </parameter> <parameter name="breadcrumb" type="text" group="Everyone" prompt="Breadcrumb" alt="Please enter the breadcrumb text. This is not used on index pages.">Interior Breadcrumb</parameter> </ouc:properties>However, a pcf-to-include file (such as a header) might not need its own metadata, since it is to become part of another page, presumably with its own metadata.
Custom ParametersLink to this section
The <parameters> tag exists inside of <ouc:properties>, and defines any custom parameters. You can leave it outside of <ouc:properties> if you don't want editors to edit it from Properties, making it only customizable from the source code.
<ouc:properties> <parameter name="heading" type="text" group="Everyone" prompt="Page Heading" alt="Please enter the page heading.">Accounting, B.S.</parameter> </ouc:properties> <parameter name="internal-param">hidden from page properties</parameter>When defining a parameters, you build a form for page editors. The tags used define the type of form field (single line text, checkbox, etc.) that the page editor sees, and any potential answers if applicable. The input that the page editor provides is then inserted into the page source code, to be transformed along with the rest of the page content by the XSL on save.
Parameters create variability in page layout, for example turning sidebars on and off, different display options for image galleries, and more. See the Reference Guide for parameters and attributes.
Here's an example of page parameters code:
<ouc:properties label="config"> <parameter name="heading" type="text" group="Everyone" prompt="Page Heading" alt="Please enter the page heading.">Page Properties</parameter> <parameter name="breadcrumb" type="text" group="Everyone" prompt="Breadcrumb" alt="Please enter the breadcrumb text. This is not used on index pages.">Properties</parameter> <parameter name="right-column" type="checkbox" group="Everyone" prompt="Right Column" alt="Enable/Disable the right column sidebar."> <option value="enabled" selected="true">Show</option> </parameter> <parameter name="left-column" type="checkbox" group="Everyone" prompt="Left Column" alt="Enable/Disable the entire left sidebar."> <option value="enabled" selected="true">Show</option> </parameter> <parameter name="related-content" type="checkbox" group="Everyone" prompt="Related Content" alt="Enable/Disable the Related Content region in the left sidebar."> <option value="enabled" selected="true">Show</option> </parameter> <parameter name="prefooter" type="select" group="Everyone" prompt="Prefooter" alt="Choose prefooter source. If set to “Include”, refer to the “prefooter-include” directory variable for the include file's location." section="Prefooter"> <option value="feedback" selected="true">Feedback Form</option> <option value="include" selected="false">Include</option> </parameter> </ouc:properties>And here's what those same parameters look like for editing:
