Overview
This page includes a reference for the OU Campus comment tags as well as the OUC node style XML, and the attributes and values that can be used with each. For more information about
comment tags, transitional, and short-style tags, see:
Page Tagging
The following are included on this page:
Datetime Tag
The datetime tag provides a date/time stamp. This can appear anywhere on the page
but can only appear once per page. In the event of two occurrences on a page, only
the first one is processed.
Comment Style Tagging
Datetime Tag Syntax
<!-- com.omniupdate.date --> <!-- /com.omniupdate.date -->
Datetime Tag Example
<!-- com.omniupdate.date type="datetime" style="short" --> <!-- /com.omniupdate.date -->
-
style
Description
Style of the datetime stamp. There are four possible values, the choice of which determines
the format of the date and time. By default, it is "short".
|
Values
- full
Example: Tuesday, April 12, 1952 AD or 3:30:42pm PST
- long
Example: January 12, 1952 or 3:30:32pm
- medium
Example: Jan 12, 1952
- short
(default) Example: 12.13.52 or 3:30pm
Example
style="short"
-
type
Description
Specifies the type of datetime stamp. The default is "datetime", which provides both
the date and time.
|
Values
- datetime (default)
- date
- time
Example
type="datetime"
DirectEdit
The DirectEdit tag is inserted by the system at the location of this tag at publish
time and provides the method for users to log in directly to a page in order to edit
it. This code cannot reside within an editable region tag.
OUC Node Style Tagging
DirectEdit Syntax
<ouc:ob />
DirectEdit In-Context Example
<small>
<ouc:ob /> <a href="http://themeforest.net/item/rising-fully-responsive-html5-css3-theme/703187?ref=der">Rising</a>. An <abbr title="HyperText Markup Language">HTML5</abbr> & <abbr title="Cascading Stylesheets">CSS3</abbr> theme by <a href="http://der-design.com">der</a>.
</small>
DirectEdit Attributes
There are no attributes for the DirectEdit tag.
DirectEdit Comment Style Tagging
DirectEdit Syntax
<!-- com.omniupdate.ob --> <!-- /com.omniupdate.ob -->
DirectEdit In-Context Example
This example is included in the default.xsl and utilizes the <xsl:comment>. Added
to the XSL (common.xsl or default.xsl) before the closing </body> tag.
<xsl:comment> com.omniupdate.ob </xsl:comment><xsl:comment> /com.omniupdate.ob </xsl:comment>
DirectEdit Attributes
There are no attributes for the DirectEdit tag.
Edit Full Page Tag (EFP)
The placement of this tag provides control over where on a given page the Edit Full
Page Source button is placed. This is useful on pages that rely heavily on CSS with
absolute positioned and floated divs.
Edit Full Page Tag Syntax
<!-- com.omniupdate.efp --> <!-- /com.omniupdate.efp -->
Edit Full Page Tag Example with XSL Commenting
<xsl:comment> com.omniupdate.efp </xsl:comment><xsl:comment> /com.omniupdate.efp </xsl:comment>
Edit Full Page Tag Attributes
There are no attributes for the Edit Full Page tag.
Editable Regions (Div & Editor Tags)
The div element defines an editable region. The div tag starts the editable region
and the corresponding div tag closes it. Within the div tag the editor tag can be
included. This can be used to customize the WYSIWYG Editor.

Div Tags
The div tag is used by OU Campus to define the beginning and end of a specific editable regions. An editable region
can only be assigned one editor (ouc:editor or ouc:multiedit), but not both at the
same time. There can be multiple editable regions on a page and typically created
editable regions corresponding to page divisions such as header, footer, left navigation,
right navigation, sidebar, local navigation.
Div Tags OUC Node Style Tagging
Div Tags Syntax
<ouc:div></ouc:div>
Div Tags Example
<ouc:div
label="sidecontent"
group="Everyone"
button="707"
break="break">
<ouc:editor
csspath="/_resources/ou/editor/maincontent.css"
cssmenu="/_resources/ou/editor/menu.txt"
width="955"
wysiwyg-class="maincontent"/>
<p>Lorem lorem lorem.</p>
</ouc:div>
Div Tags Comment Style Tagging
Div Tags Syntax
<!-- com.omniupdate.div --> <!-- /com.omniupdate.div -->
Div Tags Example
<!-- com.omniupdate.div
label="Text Full"
group="Everyone"
padding="3"
button="106"
bgcolor="white"
border="#33FF00"
break="break"
--><!-- /com.omniupdate.div -->
Difference Between Usage of Button and Hide Attributes
Note the difference between the attributes: button and hide; button="hide" hides the button, and hide="true" hides the content.
Settings |
Results |
button="hide" and hide="true" |
Hides the button and content. |
button="707" and hide="true"
|
Hides the content, but shows the button. |
button="hide" and hide="false" |
Hides the button, but keeps the content. |
button="707" and hide="false" |
Shows both! |
-
bgcolor
Description
Optional attribute to define the background color of the editing area. The value of
color can be specified by name ("white") or hex ("#FFFFFF"). This applies a background
color to the editable area. The bgcolor can be very helpful when there is an existing
background color that you would like to match. This only affects the editable area
when viewed within OmniUpdate.
|
Works With
Works with
Values
Notes
color name — Color name like green or red.color Hex — Hexadecimal value for a color
(#FF00CC).
Example
bgcolor="color name | color Hex"
-
border
Description
Border color of editing area (Optional): Value of color can be a hex number (such
as: "#FFFFFF") or the color name (such as: "white"). The border applies a colored
rectangle surrounding the editable area. In the Gallena example above, the border
color is set to purple in for the footer area and green in the main body text area.
|
Values
- color name — Color name like green or red.
- color Hex — Hexadecimal value for a color (#FF00CC).
Notes
color - Color name like green or red.color Hex - Hexadecimal value for a color (#FF00CC)
Example
border="color name | color Hex"
-
break
Description
Break after button (Optional): The break adds a carriage return (br) after the editing
button. This is completely cosmetic, but can be very useful depending on the size
of the button being used.
|
Values
Example
break="break"
-
button
Description
Editing Graphic or Button type (Optional): Numeric value (more information can be
found here). If the Button is not used, the default button graphic is displayed: Edit Date
New button graphics can also be added -- feel free to make a request.
|
Values
- button id — The id or name of a button.
- hide — Hides the button. This is used in conjunction with the MultiEdit tag, found here. Not to be confused with the hide attribute, which when used can hide content for an editable region (hide="true"
Example
button="button id | hide"
-
button-class
Description
Provides default styling using CSS rather than using the button attribute to call
a .gif.
|
Works With
Supported by all tagging styles.
Values
- Takes a class defined in the CSS. E.g., class="oucEditButton"
Example
<ouc:div label="sidecontent" group="Everyone" button-class="oucEditButton" button-text="Side Content" break="break">
-
button-color
Description
Changes the color of a button styled with CSS (i.e., one that does not use the button
attribute).
|
Works With
Supported by all tagging styles.
Values
- Hexadecimal color. E.g., button-color="#D19DFF"
Example
<ouc:div label="maincontent" group="Everyone" button-class="oucEditButton" button-text="Main Content" button-color="#D19DFF" break="break">
-
button-text
Description
Changes the color of a button styled with CSS (i.e., one that does not use the button
attribute).
|
Works With
Supported by all tagging styles.
Values
- String: E.g.,button-text="Side Content"
Example
<ouc:div label="sidecontent" group="Everyone" button-class="oucEditButton" button-text="Side Content" break="break">
-
group
Description
Editing group that can edit this area (Optional): The group identifies which group
has access to edit the specific tagged area. If you do not include a group there will
be no editing button shown — even for administrators. Level-9 and 10 users will only
see the editing buttons on tagged areas that have a valid group defined. All other
editors will only see the editing buttons on tagged areas that have a valid group
defined — assuming they are also a member of the specified group.
It is often helpful to use the default group "Everyone" for the main body area of
the page, then unique groups such as "Side Navbar Editors" for the side navigation
area and so on. Because the group "Everyone" contains all users you'll be able to
quickly assign page access to any specific sub-group without changing the group tag
in the code. Remember that only people assigned access to a page can access and edit
that page — regardless of the "Group" assigned to selective areas.
Note: to exclude individuals from gaining access to a specific area (such as a block
of scripted code, image maps, or Java applets), tag the area and do not include the
"Group". This exclusionary method is very useful for areas you want to ensure are
"hands-off" to all but administrative (Level 9 and 10) users.
|
Values
- Everyone - All users
- group name — A group name as configured within OmniUpdate’s group setup.
Example
group="Everyone | group name"
-
hide
Description
When used in conjunction with the path parameter, this parameter allows for omission of included text. Omit parameter for
default behavior.
Also, hide="true" can be used to hide the content of an editable region.
|
Values
Example
hide="yes | true | hide"
-
label (Required)
Description
Name of tag (required, and must be unique per page). Never assign the same label name
to multiple areas on the same page. Choose any name, but do not use any punctuation
characters.
|
Values
unique name or id — A unique-per-page identifier for a editable region.
Example
label="unique name or id"
-
padding
Description
|
Values
pixel number — Padding in number of pixels
Example
padding="pixel number
-
path
Description
The path to the actual Include file: This must be an absolute link and begin with
"/". Without the include tag you have a static area or inline area that occurs within
the page itself.
|
Values
staging absolute path — An absolute path relative to the root of the staging server.
Example
path="staging absolute path"
-
position
Description
Position of button (Optional): The position allows you to specify the position of
the button relative to the selective content area itself. The default behavior of
the button is to position itself at the top of the editable content (just above the
content), but it can be useful to force the button to follow directly after the content.
For instance, if the position's value is set to "bottom" and you've assigned no "break"
value (see above) then the actual position of the button will be to the right following
the content.
|
Values
Example
position="bottom | top"
-
wysiwyg-class
Description
The attribute "wysiwyg-class" can be used with node style tagging (in either the ouc:div
or ouc:editor) tags to specify a class to be inserted into the <body> tag of the WYSIWYG
Editor. In the case that both elements use the attribute, the classes are combined.
In the case of any duplicated CSS classes, precedence is decided by what exists in
the CSS not the ordering of the classes. In other words, <body class="dark left interior">
has the same behavior as <body class="interior left dark">.
|
Works With
ouc:div or ouc:editor tags
Values
A defined CSS class:
wysiwyg-class="ouc-editor"
Example
<ouc:editor csspath="/_resources/ou/editor/maincontent.css" cssmenu="/_resources/ou/editor/styles.txt" wysiwyg-class="ouc-editor"/>
Editor Tag
Allows customization of various attributes of the WYSIWYG Editor. The editor tag is optional. It is frequently included within a div tag, but
can also be used alone for files that are includes. If it is included within a div
element, it can contain variables that determine the following:
- The path to the CSS stylesheet to be pulled into the editor while a user is editing
this region
- The path to the text file that contains "instructions" for the editor concerning which
CSS-driven styles to display in the editor's "Styles" drop-down menu
- The width of the editor
Note: This tag is self closing and does not require a closing equivalent.
Editor Tag OUC Node Style Tagging
Editor Tag Syntax
<ouc:editor />
Editor Tag Example
<ouc:editor csspath="/_resources/ou/editor/maincontent.css" cssmenu="/_resources/ou/editor/menu.txt" width="955" wysiwyg-class="maincontent"/>
Editor Tag Comment Style Tagging
Editor Tag Syntax
<!-- com.omniupdate.editor -->
Editor Tag Example
<!-- com.omniupdate.editor
csspath="/omnistyles/mainbodythird.css"
cssmenu="/omnistyles/mainbody.txt"
width="799"
-->
-
cssmenu (optional)
Description
The "cssmenu" attribute refers to a shortcut of CSS classes that are available to
users within the WYSIWYG Editor. The content of the cssmenu attribute is the path
from the root to the file containing the CSS classes list. This file contains a short
list of css classes that the user can select from the Styles drop-down of the WYSIWYG
toolbar. The actual style classes are placed in a CSS file that is located at the
path defined in the "csspath" attribute.
Usage: cssmenu="/path/from_root/css/cssmenufile.txt"
The format of this text file consists of the class name followed by a TAB and then
a short friendly name. Users see this name. This can optionally be followed by a TAB
and "block" to denote that this CSS class will be applied to any selected content
as a block level tag.
Usage: .css_selector{single tab}Friendly Name{single tab}block
.class_name{single tab}Friendly name .another_class{single tab}Block-level friendly name {single tab}block
The .txt menu file is nothing more than the actual css style selector followed by
the friendly name and an optional "block" declaration (each separated by a TAB character).
When the block declaration is set, the editor will apply the style to the innermost
block-level element that contains the selection.
When no block declaration is set, the style will be applied to the selection with
a surrounding span element. Multiple styles should be separated by a single carriage
return. The file must be free of anything but carriage returns and tabs.
|
Works With
Requires csspath attribute pointing to a CSS file for this to have any effect.
Values
- path from the root of the production website — An absolute path relative to the root of the production server. Do not include a protocol or domain. (http://omniupdate.com)
Notes
Typically, the text file used for the cssmenu is provided in the following location:
/_resources/ou/editor/styles.txt
Example
cssmenu="/_resources/ou/editor/styles.txt"
-
csspath (optional)
Description
The "csspath" attribute refers to the path to a CSS file (absolute from the root of
the web site) that is used by the WYSIWYG Editor to style the text to match what is
used for that area on the published page. It can include a body CSS tag and background
image with margins to help give an "in-context" view.
If the requirement is to have the WYSIWYG Editor content visually match the published
page content, the CSS file must contain all the text styling CSS that is needed to
have the content of the WYSIWYG Editor match what is used on the same region of the
published page.
If the "cssmenu" is used, the CSS file that is used in this path must contain the
CSS styling classes to match what is listed in the cssmenu TXT file.
This CSS file should not contain any layout CSS that is used for the production web
page. The only layout control in this CSS can be the body tag with background and
margins controls.
|
Works With
Works with cssmenu, but does not require cssmenu.
Values
- path from the root of the production website — An absolute path relative to the root of the production server. Do not include a protocol or domain. (http://omniupdate.com)
Notes
Typically, the path used for the csspath is provided in the following location: /_resources/ou/editor/The
CSS file at this location can import CSS files that are used for the site.
Example
csspath="/_resources/ou/editor/maincontent.css"
-
div (Deprecated)
Description
The div attribute (optional) assigns a div to the editing area in the check-out page
screen within the OmniUpdate system.
#OUPreview{ width:534px; } This class should be added to the CSS file for that editing
area.
|
Values
Example
div="css class"
-
editor (Deprecated)
Description
Provides the ability to specifically select a certain editor to be used for the editable
region where it is defined.
|
Values
0 - ActiveX + EOPro
1 - ActiveX
2 - EOPro
3 - OmniDev + EOPro
4 - EditLive
5 - OmniDev + EditLive
6 - Universal Editor v2 (IE, Fx) + v1 (Safari)
Example
editor="0 | 1 | 2 | 3 | 4 | 5 | 6"
-
parag (optional)
Description
The parag attribute forces the editor to use <br> tags instead of using paragraph
<p> tags. This is useful for regions that make heavy use of CSS; for example, navigation
files.
Note: By default the parag attribute is omitted and when omitted or when setting the
value to "on", paragraphs with <p> tags are created by pressing Enter in the WYSIWYG
Editor.
|
Values
- no — The editor will use <br> instead of <p>
- on — The editor will use <p> instead of <br>. (Note: Shift-Enter can be used to insert <br> tags in the WYSIWYG Editor when the value is on.)
Example
Source view example:
<!-- ouc:editor csspath="/_resources/ou/editor/maincontent.css" cssmenu="/_resources/ou/editor/styles.txt" width="955" parag="no"/ --><br /><br />lorem<br /><br /><br /><br />more lorem<br />
-
reflow (optional)
Description
The reflow attribute will force the editor to structure the page by adding line breaks
to the code where necessary. This is useful to keep the code structured in a readable
way. Having code crunched together without line breaks makes the code harder to read
and harder to debug. By default, the reflow attribute is omitted and when omitted
or when setting the value to "yes", then the region is conveniently restructured.
|
Values
- no — The editor does not restructure the page.
- yes — The editor adds structure in the form of line breaks to the page.
Example
reflow="no"
-
tags
Description
Used in conjunction with wysiwyg="asset" or wysiwyg="gallery." Allows tags to narrow
down the Assets displayed in the Asset Chooser or Gallery Chooser. To filter by site,
sytnax is site:NAME_OF_SITE. To filter by type of asset (for the Asset Chooser), syntax
is: type:Web Content type:Plain Text type:Source Code type:Image Gallery type:Managed Form
|
Values
Example
tags="tag name"
-
toolbar
Description
The toolbar (optional) attribute specify a particular toolbar for an editable region.
This will cause the page area to load with the toolbar named "toolbar_name" regardless
of what level the user is or what toolbar is assigned to that user.
NOTE: If this is not used, the editor will load the default toolbar for the user account
irrespective of user level.
|
Values
Example
toolbar="toolbar name"
-
width
Description
The width (optional) attribute controls the width of the editor itself in pixels.
This is useful when the page structure has a right border that you wish to represent
while users are editing text areas.
|
Values
pixel number — A numeric value representing the pixel width of the editor when loaded.
Example
width="pixel number"
-
wysiwyg
Description
By default certain file types, based on file extensions are opened with the appropriate
type of editor. The wysywig (optional) attribute can specify different types of editors
for the editing area.
NOTE: If this is not used, the editor loaded will be the default editor for the account.
Accounts can be set up in the super admin to load particular editor types.
|
Values
noie — This will force the editor to load the applet editor even in Windows with Internet Explorer
yes — This will force the editor to load the omnidev editor when the browser is Internet Explorer on Windows and the applet when it is not.
no — This will skip the editor altogether, loading the HTML editor.
asset — This will present an Asset Chooser only.
gallery — This will present the image gallery Assets that have been created.
Example
wysiwyg="noie | yes | no | asset | gallery"
-
wysiwyg-class
Description
The attribute "wysiwyg-class" can be used with node style tagging (in either the ouc:div
or ouc:editor) tags to specify a class to be inserted into the <body> tag of the Classic
WYSIWYG Editor. In the case that both elements use the attribute, the classes are
combined. In the case of any duplicated CSS classes, precedence is decided by what
exists in the CSS not the ordering of the classes. In other words, <body class="dark
left interior"> has the same behavior as <body class="interior left dark">.
|
Works With
ouc:div or ouc:editor tags
Values
A defined CSS class:
wysiwyg-class="ouc-editor"
Notes
This attribute only works in the classic WYSIWYG Editor. JustEdit will not apply a
class.
Example
<ouc:editor csspath="/_resources/ou/editor/maincontent.css" cssmenu="/_resources/ou/editor/styles.txt" wysiwyg-class="ouc-editor"/>
MultiEdit Tag
Overview
A MultiEdit tag is nested in the <div> tag and works with the <div> tag to create
an editable region that must be edited in a specific manner, in this case with MultiEdit
form editing. All three OmniUpdate tagging styles are supported when implementing
the tag. The opening <div> tag that helps enclose the MultiEdit field must have the
button attribute set to "hide". A <div> tag can only include one editor tag; that
is, either the tag for the WYSIWYG Editor or for MultiEdit. As a side note, the <div> tag does not have to specify an
editor. The MultiEdit tag is self-closing or does not have an end tag (depending upon
the tagging style in use). If a web page has a MultiEdit tag, then JustEdit is disabled automatically for that page.
OUC Style Syntax
<ouc:multiedit />
In-Context Example
<ouc:div label="title" group="Everyone" button="hide">
<ouc:multiedit type="text" prompt="Title" alt="Enter your title "/>Professor of Encryption</ouc:div>
Transitional Syntax
<!-- ouc:multiedit -->
Comment Style Syntax
<!-- com.omniupdate.multiedit -->
Comment Style Example
<!-- com.omniupdate.div label="education" group="Everyone" button="hide" --><!-- com.omniupdate.multiedit type="text" prompt="Education" alt="Enter your education information." -->
<!-- /com.omniupdate.div -->
For more information about using the MultiEdit tag and its attributes, see:
MultiEdit Tag
Properties Tag
The properties tag encapsulates metdata tags and configuration parameters, both of
which can be edited via the OU Campus interface given the proper permission. All types of content; that is, pages, assets, and binary files have a Properties screen that provides access to, at the most,
access settings, metadata properties and configuration parameters, and the log file.
But as far as the properties tag is concerned, the use is to allow for the metadata
and configuration parameters to be editable by certain users for pages.
Properties can be accessed for checked out content via the Pages or Assets list views > Edit menu > Properties. The properties can also be accessed via an
actions view from the actions toolbar by clicking the Properties button on the toolbar.
In this case, again, the content must be checked out and the user must have the inherent
authority for this editing right. Note that a user will not see the Parameters item
on the left navigation if the content is not checked out or if they do not have the
given authority.
That being said, the use of properties can be very valuable within an implementation
to provide configuration flexibilty for a user while at the same time providing an
easy to use and familar type of of editing--that is with the use of form-type elements.
Once properties tags are used to encapsulate other HTML markup, the user will be presented with form fields or form elements with preconfigured
options.
Within a properties tag the following element nodes can be used:
- title: <title>Gallena University</title>
- meta: <meta name="description" content="Page about Gallena U." /meta>
- parameter: <parameter name="pagetype" prompt="Page Type" alt="page type xsl template">interior</parameter>
Any other nodes in the properties tagging is ignored. Additionally, a function is
available that can be used in the XSL to obtain the value of the parameter node.
OUC Node Syntax for the Properties Tag
<ouc:properties></ouc:properties>
OUC Node Example for the Properties Tag
<ouc:properties label="metadata">
<title>Gallena University</title>
<meta name="description" content="Gallena Cafe is nested within the Gallena Walled Garden." />
</ouc:properties>
Comment Style Tagging for Properties
<!-- com.omniupdate.properties --> <!-- /com.omniupdate.properties -->
Properties Tag Examples (In Context of a TMPL)
<document>
<config>
<!-- com.omniupdate.properties -->
<meta name="breadcrumb" content="true" />
<meta name="pagetype" content="<!--%echo var="pagetype" -->" />
<parameter name="department" prompt="Department" type="select" alt="Pick a department from the dropdown." section="Department">
<option value="Academics">Academics</option>
<option value="Admissions">Admissions</option>
<option value="Administration">Administration</option>
<option value="Athletics">Athletics</option>
<option value="Alumni">Alumni</option>
<option value="Financial Aid">Financial Aid</option>
<option value="Library">Library</option>
</parameter>
<!-- /com.omniupdate.properties -->
</config>
<!-- com.omniupdate.properties -->
<title>Properties Test</title>
<!-- /com.omniupdate.properties -->
<metadata>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" section="Meta Data" /> //pre-HTML5
(or <meta charset="UTF-8">)
<!-- com.omniupdate.properties -->
<meta name="keywords" content="keyword, keywords, keywords" />
<meta name="description" content="This is a description." />
<!-- /com.omniupdate.properties -->
</metadata>
</document>
-
section
Description
Utilizing section inserts a horizontal rule above the parameter or meta tag in order
to create sections within page properties. Entering optional content creates a section
header after the horizontal rule.
|
Values
- (a space) — Including a space between quotes creates a horizontal rule above the parameter or meta tag in which it is entered.
- Optional Text — Entering optional text between the quotes creates a header beneath the horizontal text.
Example
section=" "
or
section="Optional Text"
-
meta
Description
The <meta> node is a child of the properties tag and can include the attribute nodes:
name and content. Also, the properties tag maybe included in a <metadata> element.
See example from a TMPL. In the example for a TMPL, the echo var contstruct is used
to pass the value into the newly created content.
|
Works With
namecontentcharsethttp-equiv
Values
The value of the name attribute can take any HTML metadata (non-displayed data within the <head> of an HTML document) that can be used for a web page. For example:
name="keywords"
name="description"
name="author"
name="generator"
name="application-name"
Example
TMPL Example
<metadata>
<!-- com.omniupdate.properties -->
<meta name="Description" content="<!--%echo var="description" -->" />
<meta name="Author" content="<!--%echo var="author" -->" />
<meta name="Keywords" content="" />
<!-- /com.omniupdate.properties -->
</metadata>
-
filter
Description
Applies only to type="filechooser".
The use of this parameter on a variable node with a type of "filechooser" allows for
the restriction of a user within a specified folder.
|
Works With
type="filechooser" and type="image"
Values
file extension without a period (string)
Example
type="filechooser" filter="html"
-
format
Description
Optional helper attribute for the date-time picker, the date picker, and the time
picker. the default value of this attribute is format="iso", which produces the following variation:
2017-07-16T19:20+01:00
|
Works With
type="datetime", type="date", and type="time"
Values
Example
<variable name="datetime" type="datetime" format="iso" group="Everyone" prompt="Date & Time" alt="Please add a date and time." section="Date Time Example"></variable>C
-
parameter
Description
The parameter node allows for the storing of parameters in the pcf to be accessed
through Properties > Parameters in the interface. Might also be a child of the <config>
node.
A grouping of parameters are defined by surrounding them with the <-- com.omniupdate.properties
--><-- /com.omniupdate.properties --> tag.
|
Works With
With variables defined in the TCF and predefined variables, the XSLs can utilize the
variables and values to provide customization and options for content, page layout,
styling, and just about anything.
Values
- type —
This is the type of parameter. This is used to determine how the parameter is displayed to the end-user. If the type is checkbox, select, or radio then there is more than one <option> element as a child of the parameter.
- name — Required.
The name of the parameter is used by the system as an identifier, and therefore is not seen by the end-user. This parameter is, by nature, required to be defined for each parameter. It needs to be unique and is generally the attribute used to refer to the specific parameter from the XSL.
- prompt — This is the question posed to the user. It's displayed on the left side of the user's input text field. This parameter is not required, and defaults to null/not displayed.
- group — Required.
A group name as configured within OU Campus access group setup.
Editing group that can edit this area (Optional): The group identifies which group has access to edit the specific parameter. If a group is not included there is no parameter shown, even for administrators. Level 9 and 10 users only see the parameters that have a valid group defined. All other editors only see the parameters that have a valid group defined, assuming they are also a member of the specified group.
It is often helpful to use the default group "Everyone" for the main parameters of the page, then unique groups for such parameters that not everyone should be changing. The group "Everyone" contains all users. This can be used to quickly assign page access to any specific sub-group without changing the group attribute in the code. Remember that only people assigned access to a page can access and edit the properties for that page, regardless of the "Group" assigned to selective parameters.
- alt — Similar to the prompt parameter, alt gives more information about the input required in a text field. It is displayed to the right of the text box, and usually offers an example or more information. This field is not required, and defaults to null/not displayed.
- dependency — This value is only available when type="filechooser". Determines whether a dependency tag is inserted when the file is chosen. There are three options: no, yes, or sm-tag. The default value for the value is no.
Example
<parameter type="text" name="description" prompt="Description" alt="A short description for this page." group="Everyone">Here is an example of text.</parameter>
Page Layout Choice Example
<parameter name="pagetype" type="select" group="Everyone" prompt="Page Type" alt="Please choose a appropriate page type">
<option value="article" selected="false">Article</option>
<option value="content" selected="false">Content</option>
<option value="onecolumn" selected="true">One Column</option>
</parameter>
Image Teaser Option w/ Chooser
<parameter name="image_teaser" type="select" group="Everyone" prompt="Article Image" alt="Do you want to display the article with a image teaser ">
<!--%echo var="image_teaser" encoding="none" -->
</parameter>
<parameter name="article_image" type="filechooser" group="Everyone" dependency="yes" prompt="Article Image" alt="Please choose a suitable image for the article" path="/_resources/images/news/"><!--%echo var="article_image" --></parameter>
-
path
Description
Used in conjunction with type="filechooser". This attribute allows the user to add
a default location for the filechooser when it is opened. The path must be root-relative.
|
Works With
Specifically works with type="filechooser"
Values
Root-relative path to a directory on the server which the user is browsing. Must begin and end with a slash.
Example
path="/_resources/images/banner/"
-
source
Description
The source attribute is used in conjunction with type="filechooser." Selects the default
server when users enter the filechooser to browse for a file. If omitted from a variable,
the default value is source="production".
|
Works With
Specifically works with type="filechooser"
Values
Text string that matches the name of the server in OU Campus (e.g., "staging" or "production"). Text is case-sensitive.
Notes
Will not select alternative production targets or auxiliary sites.
Example
source="staging"
-
tags
Description
The tags attribute is used in conjunction with type="asset." Predefined tags filter
the assets displayed in the asset chooser. When defining filter tags, both type and
site are used to create key-value pairs.
|
Works With
Specifically works with type="asset"
Values
Values can be a text string, or for type and site, key-value pairs are used. Tag definitions are separated by commas, no spaces.
To filter by site, syntax is:
site:NAME_OF_SITE.
To filter by type of asset, the syntax is:
type:generic (Web Content Assets)
type:text (Plain Text Assets)
type:code (Source Code Assets)
type:gallery (Image Gallery Assets)
type:form (Form Assets)
Example
tags="tag name"
or
tags="type:text"
or
tags="site:Gallena_Sandbox,example"
-
type
Description
This is the type of parameter. This is used to determine how the parameter is displayed
to the end-user. If the type is checkbox, select, or radio then there is more than
one <option> element as a child of the parameter. Required.
|
Values
- text — Parameter is text.
- asset — Parameter is defined by the user selecting an asset from an asset chooser.
- select — Parameter is defined by user by choosing from a drop-down list. Parameter will be the value of the user-selected option.
- filechooser — Parameter is defined by user by navigating to and selecting a file. Parameter is an absolute path from the root of the staging or production server.
- checkbox — Parameter is defined by user by toggling the value of a checkbox. Parameter will be the value of the user-selected options.
- radio — Parameter is defined by user by choosing from a set of radio buttons. Parameter will be the value of the user-selected option.
- datetime — Parameter is defined by the date-time the user picks. The variable gets passed in the following format: 12/14/2016 10:45:29 AM. The formatting of this variable can be controlled using the optional format attribute.
- date — Parameter is defined by the date chosen in the date picker. The variable gets passed in the following format: 12/14/2016. The formatting of this variable can be controlled using the optional format attribute.
- time — Parameter is defined by the date chosen in the time picker. The variable gets passed in the following format: 10:45:29 AM. The formatting of this variable can be controlled using the optional format attribute.
Example
type="text"
-
option
Description
This produces a drop-down menu; the value of the choice will be marked as selected
in the PCF.
This only applies to the parameter node where the type is select, checkbox, or radio.
|
Values
value — (Required) Defines the value of the option. This is the same format and functionality as the option element defined in the XHTML specification and defines an options value for user-selection in a select field.
selected — true/false: This determines whether or not the option has been marked or selected. This attribute can be used by the XSL to find only options that have been selected.
Example
<parameter name="color" type="select" group="Everyone" prompt="Color" alt="Pick a color.">
<option value="red" selected="false">Red</option>
<option value="green" selected="false">Green</option>
<option value="blue" selected="true">Blue</option>
</parameter>
-
title
Description
The <title> node can be encapsulated by the properties tag.
|
Values
Takes a string that defines title of the document that is shown in the title bar for a document.
Example
<title>Overview</title>