OmniUpdate Support & Documentation

Include

Include additional TCF files. Included TCF file must be in same directory as the TCF performing the inclusion.

Syntax:
<include> </include>

Example:

<include>includes/yellow.tcf</include>

Parameters

This tag has no parameters.

Child tag of navigation-list which contains structure of new navigation item to be rendered and appended to the file specified via the path parameter

Syntax:
<navigation> </navigation>

Example:

<navigation name="leftnav" path="subnav.inc" group="everyone" publish="yes">
<li>
<a href="{ox_autonav:shorturl}">
{navtitle}
</a>
</li>
</navigation>

Parameters ( toggle all )

group
Determines the editing group that is assigned to new navigation files. The "*inherit*" option assigns the new navigation file to the same group as that of the folder where the new navigation file is located.
Syntax:
group="*inherit* | everyone | string group name"
- *inherit* - Inherits group from directory access privileges.
- everyone - The "everyone" group. This means anyone can edit the file.
- string group name - Group name as defined within the OmniUpdate system.
Example:
group="*inherit*"
name

Navigation identifier used in correspondence with the template tag's autonav parameter
Syntax:
name="string name"

Example:
name="leftnav"
path

Path to navigation file into which new navigation item should be rendered.
Syntax:
path="string path"

Example:
path="subnav.inc"
publish

If yes, pushes a file to the production server for publishing prior to editing.
Syntax:
publish="yes | no"

Example:
publish="yes"

Contains child nodes which define navigation to be used throughout the new page creation process.

Syntax:
<navigation-list> </navigation-list>

Example:

<navigation-list>
<navigation name="leftnav" path="subnav.inc" group="everyone" publish="yes">
<li>
<a href="{ox_autonav:shorturl}">
{navtitle}
</a>
</li>
</navigation>
</navigation-list>

Parameters

This tag has no parameters.

Template

Defines a template file (TMPL) and relevant parameters to be used during new page creation process.

Syntax:
<template> </template>

Example:

<template
  prompt-prefix="New Document"
  group="everyone"
  filename="untitled"
  display-group="yes"
  rss-feed="*inherit*"
  preferred-redirect="yes"
  publish="no"
  extension="pcf"
  destination="{directory/}{dirname}"
  >{selected_template}</template>

Parameters ( toggle all )

approver
Allows certain pages to have assigned approvers. This is helpful for different sections of a site which require that different people approve content.
Syntax:
approver="*inherit* | string group name"
- *inherit* - Inherits publishers from directory access.
- string group name - Group name as defined within the OmniUpdate system.
Example:
approver="*inherit*"
autonav

Used in conjunction with the Navigation tag.
Syntax:
autonav="string navigation name"

Example:
autonav="leftnav"
destination
Will set a location for new files created other than the current folder when Create New Page was clicked.
Syntax:
destination="string absolute path"
- string absolute path -
Example:
destination="{dirname}"
display-filename

Determines whether a user can fill in a filename for a new file that is being created. This is desirable except when creating a resource file for a new folder; for example, a navigation file.
Syntax:
display-filename="yes | no"

Example:
display-filename="yes"
display-group

Displays a drop down list of groups that the user belongs to in the new page screen and allows the user to assign new pages to one of those groups. If the display group is set to "no", the user has no control over which group the new page is assigned.
Syntax:
display group="yes | no"

Example:
display-group="no"
display-overwrite

Determines whether users can overwrite existing files. By setting the value to "no", users cannot overwrite any existing pages.
Syntax:
display-overwrite="yes | no"

Example:
display-overwrite="yes"
extension

The default file extension of the resulting file. Use in conjunction with filename parameter to specify file filename of resulting file.

The following example produces a file named index.pcf
Syntax:
extension="string file extension"

Example:
filename="index" extension="pcf"
filename

The default name of the resulting file without file extension. Use in conjunction with extension parameter to specify file extension of resulting file.

The following example produces a file named index.pcf
Syntax:
filename="string filename"

Example:
filename="index" extension="pcf"
filename-alt

The default description for the filename prompt.

The following example replaces the default description that shows up to the right of the filename box.
Syntax:
description="string description"

Example:
filename-alt="Please enter a filename"
force-destination

If yes, creates folders or directories if they do not exist already and must be used with the destination parameter.
Syntax:
force-destination="yes | no"

Example:
force-destination="yes"
group
Determines the editing group that is assigned to new files. The "*inherit*" option assigns the new page to the same group as that of the folder where the new page is located.
Syntax:
group="*inherit* | everyone | string group name"
- *inherit* - Inherits group from directory access privileges.
- everyone - The "everyone" group. This means anyone can edit the file.
- string group name - Group name as defined within the OmniUpdate system.
Example:
group="*inherit*"
name

Uniquely identifies template. If prompt-prefix is omitted, the value of this parameter will be used.
Syntax:
name="unique string"

Example:
name="defaultpage"
overwrite

If yes, creates a new page of the chosen filename after erasing any existing file of the same name.
Syntax:
overwrite="yes | no"

Example:
overwrite="yes"
preferred-redirect

Determines the file that is opened by the editor after the Template Control File is finished. This is very helpful when creating multiple files at once. If you are using the TCF to create a new section you can open the home page for a new folder after creating a series of files in that new folder.
Syntax:
preferred-redirect="yes | no"

Example:
preferred-redirect="yes"
prompt-prefix

Because the tcf format allows for multiple files to be created and referenced, the prompt-prefix parameter helps to identify the file to which a question refers. OmniUpdate adds the prompt-prefix to each question being asked. As an example, if prompt-prefix was "New file," the user may be asked "New file overwrite if exists?"
Syntax:
prompt-prefix="string"

Example:
prompt-prefix="New file"
publish

If yes, pushes a file to the production server for publishing prior to editing. This is very helpful for navigation files when creating new sections.
Syntax:
publish="yes | no"

Example:
publish="yes"
publishers
Allows certain pages to have assigned publishers.
Syntax:
publishers="*inherit* | string group name"
- *inherit* - Inherits publishers from directory access.
- string group name - Group name as defined within the OmniUpdate system.
Example:
publishers="*inherit*"
rss-author

Allows the author of an RSS feed item to be attached to a different user.
Syntax:
rss-author="string"

Example:
rss-author="{some_variable}"
rss-description
Allows for the population of the RSS item's description node with content provided by a TCF variable.
Syntax:
rss-description="*inherit* | string description"
- *inherit* - Inherits feed from directory access.
- string description - Allows for a customized description to be added for each RSS item.
Example:
rss-description="*inherit*"
rss-extra
Allows for the population of the RSS item node with additional XML.
Syntax:
rss-extra="*inherit* | string xml nodes"
- *inherit* - Inherits feed from directory access.
- string xml nodes - A string of XML nodes to be added to each RSS item.
Example:
rss-extra="*inherit*"
rss-feed
Determines the feed to which the newly created page will belong. By default, new pages do not have an RSS feed assigned to them and this property allows the page to automatically be assigned to an RSS feed.
Syntax:
rss-feed="*inherit* | string feed path"
- *inherit* - Inherits feed from directory access.
- string feed path - Absolute path relative to production server root as defined within the OmniUpdate System.
Example:
rss-feed="*inherit*"
rss-link
Allows the RSS link to be provided by a TCF variable.
Syntax:
rss-link="string url"
- string url - Specifies the link associated with each RSS item.
Example:
rss-link="{var_name}"
rss-media
Allows for the population of the RSS item node with additional XML.
Syntax:
rss-media="Delimited List"
- Delimited List - A delimited string defining the number of Media RSS items and the value of each item parameter. The double-het (^^) delimiter separates each Media RSS parameter, and each double-bar (||) separates each Media RSS item.
Example:
rss-media="{mtitle1}^^{murl1}^^{mdesc1}^^{mthumbnail1}^^{mkeywords1}|| {mtitle2}^^{murl2}^^{mdesc2}^^{mthumbnail2}^^{mkeywords2}|| {mtitle3}^^{murl3}^^{mdesc3}^^{mthumbnail3}^^{mkeywords3}"
rss-pubdate
Allows for the population of the RSS item's pubdate node with content provided by a TCF variable.
Syntax:
rss-pubdate="*inherit* | string date"
- *inherit* - Inherits the date from directory access.
- string date - A customized date that can be added in manually.
Example:
rss-pubdate="*inherit*"
rss-title
Allows for the population of the RSS item's title node with content provided by a TCF variable.
Syntax:
rss-title="*inherit* | string title"
- *inherit* - Inherits feed from directory access.
- string title - Specifies the title of each RSS item.
Example:
rss-title="*inherit*"
template-group
Makes new folders created by a TCF inherit the template groups from the parent folder. This is desirable when creating new folders in a section of the site which has specific templates.
Syntax:
template-group="*inherit* | string template group name"
- *inherit* - Inherits template-group from directory access.
- string template group name - Template Group name as defined within OmniUpdate system.
Example:
template-group="*inherit*"
toolbar
Determines the toolbar used for a particular page. This overrides the user's own toolbar assignment and is helpful when creating navigation files and never want the full toolbar to be used on a page, regardless of the user editing the file. The toolbar group can also be found in the editor tag. The hierarchy is users, page and then editor tag for the toolbar that will be available to an editing area.

This parameter is only necessary to override toolbar groups for pages, irrespective of user assigned toolbars.
Syntax:
toolbar="*inherit* | string toolbar group name"
- *inherit* - Inherits toolbar from directory access.
- string toolbar group name - Toolbar Group name as defined within OmniUpdate system.
Example:
toolbar="*inherit*"

Template List

Contains child nodes which define templates to be used throughout the new page creation process.

Syntax:
<template-list> </template-list>

Example:

<template-list>
  <template
    prompt-prefix="New Document"
    group="everyone"
    filename="z-breadcrumb"
    destination="{directory/}{dirname}"
    display-group="yes"
    preferred-redirect="yes"
    publish="no"
    extension="pcf"
    >z-breadcrumb.tmpl</template>
  <template
    group="everyone"
    filename="index"
    display-group="no"
    display-destination="no"
    display-filename="no"
    display-overwrite="no"
    preferred-redirect="yes"
    publish="no"
    extension="pcf"
    destination="{directory/}{dirname}"
    force-destination="yes"
    >newpcf.tmpl</template>
</template-list>

Parameters

This tag has no parameters.

Variable

The variables node allows for the creation of variables to be used throughout the new page creation process.

variable is a child node of variable-list

Syntax:
<variable> </variable>

Example:

<variable name="pagetitle" prompt="Title" alt="New document title">Untitled</variable>

Parameters ( toggle all )

alt

Similar to the prompt parameter, alt gives more information about the input required in a text field. It's 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.
Syntax:
alt="string"
display

Determines whether or not this particular variable is presented to the user for modification. If a variable is not displayed, the initial value defined between the <variable> tags defines the variable's contents. However, if the variable is displayed, its contents are considered a suggestion to the user, as they can change it freely.
Syntax:
display="yes | no"
editor
Applies only to type="text"

The use of this parameter on a variable node whose type is "text" will result in an input field being turned into a WYSIWYG editor that can be used by the user to define the value of a variable.

Must be used in conjunction with the "rows" parameter.
Syntax:
editor="yes"
- yes - Enable WYSIWYG editor for input field
filter
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.
Syntax:
filter="string file extension"
- string file extension - The extension of a file type without a period.
Example:
<variable name="leftnav_include" prompt="Left Nav" alt="Choose your left nav" type="filechooser" filter="html" >/includes/navs/default.html</variable>
lockout
Applies only to type="filechooser" and path="/some/path"

The use of this parameter on a variable node whos type is "filechooser" allows for the restriction of a user within a specified folder defined by the path parameter.
Syntax:
lockout="yes | no"
- yes - Restrict user to directory specified in "path" parameter.
- no - Don't restrict user to directory specified in "path" parameter.
Example:
<variable name="leftnav_include" prompt="Left Nav" alt="Choose your left nav" type="filechooser" path="/includes/navs" lockout="yes" filter="html" >/includes/navs/default.html</variable>
maxlength

Defines a specific number of characters the variable may contain. Anything over and the user will be alerted that the field can contain no more than "number" characters once the create button is pressed.
Syntax:
maxlenth="number of characters including spaces"
name (Required)

The name of the variable to be used when echoing its contents into the newly-created pages. It's used by the system as an identifier for the variable, and therefore is not seen by the end-user. This parameter is, by nature, required to be defined for each variable.
Syntax:
name="string variable name"
output

Determines whether or not this variable will output xml-friendly <option> elements or a comma-seperated value. This is attribute is used only in conjunction with checkbox,select, and radio variable types. The XML type is mainly used for enhanced page properties.
Syntax:
output="csv | xml"
path
Applies only to type="filechooser"

The use of this parameter on a variable node whos type is "filechooser" allows for the selection of the starting browse folder.
Syntax:
path="staging absolute path"
- staging absolute path - An absolute path relative to the root of the staging server.
Example:
<variable name="leftnav_include" prompt="Left Nav" alt="Choose your left nav" type="filechooser" path="/includes/navs" >/includes/navs/default.html</variable>
prompt

The question posed to the user. It's displayed on the left side of the user's input text field. A colon (:) is automatically added to the end of this prompt. This parameter is not required, and defaults to null / not displayed.
Syntax:
prompt="string"
rows

Applies only to editor="yes"

The use of this parameter on a variable node with the editor parameter set to "yes" allows control over the resulting textarea html element rows.
Syntax:
rows="integer textarea rows"
type
Form field type. Checkbox, select, or radio variables can maintain their form field type in page properties if their <option> tagging is preserved in the PCF. To do this, specify the output method as xml (output="xml"). Variable output encoding must be turned off in the TMPL file to avoid changing the <option> nodes into plain text; to do this, use an encoding="none" attribute in the appropriate TMPL echo statement.
Syntax:
type="text | select | filechooser | checkbox | radio"
- text - Variable is simple text
- select - Variable is defined by user by choosing from a select-pulldown. Variable will be the value of the user-selected option.
- filechooser - Variable is defined by user by navigating to and selecting a file. Variable will be an absolute path relative to the root of the production server.
- checkbox - Variable is defined by user by toggling the value of a checkbox. Variable will be the value of the user-selected option.
- radio - Variable is defined by user by choosing from a set of radio buttons. Variable will be the value of the user-selected option.

Variable List

Contains child nodes which define variables to be used throughout the new page creation process.

Syntax:
<variable-list> </variable-list>

Example:

<variable-list>
<variable name="pagetitle" prompt="Title" alt="New document title">Untitled</variable>
<variable name="template_path" display="no">/resources/xsl</variable>
</variable-list>

Parameters

This tag has no parameters.

Variable Select Option

Will produce a drop-down menu; the value of the choice will be echoed onto the page.

Applies only to the variable node where type="select"

Syntax:
<option> </option>

Example:

Parameters

value

Same format and functionality as the option element defined in the XHTML specs

Defines an options value for user-selection in a select field.
Syntax:
value="string value"

Example:
<option value="blue">Blue Text</option>

TCF Reference

Contents

Include

Parameters

Navigation

Parameters ( toggle all )

Navigation List

Parameters

Template

Parameters ( toggle all )

Template List

Parameters

Variable

Parameters ( toggle all )

name (Required)

Variable List

Parameters

Variable Select Option

Parameters

Documents