Page Tagging Reference

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 --> 

Attributes 

  • style

  • type


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 />&nbsp;<a href="http://themeforest.net/item/rising-fully-responsive-html5-css3-theme/703187?ref=der">Rising</a>. &nbsp; An <abbr title="HyperText Markup Language">HTML5</abbr> &amp; <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. 


Editable Regions

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! 

 

 

Attributes 

  • bgcolor

  • border

  • break

  • button

  • button-class

  • button-color

  • button-text

  • group

  • hide

  • label (Required)

  • padding

  • path

  • position

  • wysiwyg-class


 

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"
-->

 

Attributes 

  • cssmenu (optional)

  • csspath (optional)

  • div (Deprecated)

  • editor (Deprecated)

  • parag (optional)

  • reflow (optional)

  • tags

  • toolbar

  • width

  • wysiwyg

  • wysiwyg-class


 

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 

Attributes 

  • alt

  • dependency

  • editor

  • filter

  • label

  • lockout

  • maxlength

  • options (required for radio, checkbox, or select)

  • path

  • prompt (Required)

  • rows

  • section

  • source

  • tags

  • type (Required)


 

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>

 

Attributes 

  • section

  • meta

  • filter

  • format

  • parameter

  • source 

  • tags

  • type

  • option

  • title