Tagging Reference

1. style

   Style of the datetime stamp. short by default.

   Syntax:
   style="full | long | medium | short"

   • full - Tuesday, April 12, 1952 AD or 3:30:42pm PST
   • long - January 12, 1952 or 3:30:32pm
   • medium - Jan 12, 1952
   • short - 12.13.52 or 3:30pm

2. type

   Specify the type of datetime stamp. datetime by default.

   Syntax:
   type="datetime | date | time"

   • datetime -
   • date -
   • time -

This tag has no parameters.

1. bgcolor

   Background color of editing area (Optional): Value of color can be a hex number (such as: "#FFFFFF") or the color name (such as: "white"). 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.

   Syntax:
   bgcolor="color name | color Hex"

   • color name - Color name like green or red.
   • color Hex - Hexadecimal value for a color (#FF00CC).

2. border

   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.

   Syntax:
   border="color name | color Hex"

   • color name - Color name like green or red.
   • color Hex - Hexadecimal value for a color (#FF00CC).

3. break

   Break after button (Optional): The break simply 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.

   Syntax:
   break="break"

4. button

   Editing Graphic or Button type (Optional): Numeric value (list of buttons currently available can be found here). If the Button is not used, the default button graphic is displayed:

   New button graphics can also be added -- feel free to make a request.

   Syntax:
   button="button id | hide"

   • button id - The id or name of a button. A list of buttons currently available can be found here.
   • hide - Hide the button. This is used in conjunction with the multiedit tag, found here.

5. group (Required)

   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), simply 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.

   Syntax:
   group="Everyone | group name"

   • Everyone - All users
   • group name - A group name as configured within OmniUpdate's group setup.

6. hide

   When used in conjunction with the path parameter, this parameter allows for omission of included text. Omit parameter for default behavior.

   Syntax:
   hide="yes | true | hide"

7. label (Required)

   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.

   Syntax:
   label="unique name or id"

   • unique name or id - A unique-per-page identifier for a editable region.

8. padding

   Padding in pixels (Optional): Values in pixels, the padding adds space around the tagged editable area. This padding is only visible within OmniUpdate during page editing. When a "border" is used, the padding value will create a colored border surrounding the tagged area.

   Syntax:
   padding="pixel number"

   • pixel number - Padding in number of pixels

9. path

   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.

   Syntax:
   path="staging absolute path"

   • staging absolute path - An absolute path relative to the root of the staging server.

10. position

    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.

    Syntax:
    position="bottom | top"

This tag has no parameters.

1. cssmenu

   The cssmenu (optional) refers to a shortcut of CSS classes that are available to your users within the WYSIWYG editor (Please update the copy on the staging server for this.) This file will contain a short list of css classes that the user can select from.

   .special special
   .special2 special2
   

   The .txt menu file is nothing more than the actual css style followed by the friendly name. In this example the style is ".special" (always with a period in front) and the friendly name "special" separated only by a tab. With a list of styles separate them with carriage returns. The file must be free of anything but carriage returns and tabs. It is much easier to keep track of things if the friendly name and the actual css style are the same.

   Syntax:
   cssmenu="production absolute path"

   • production absolute path - An absolute path relative to the root of the production server. Do not include a protocol or domain. (http://omniupdate.com)

2. csspath

   The csspath (optional) refers to a css file (absolute from the base of the web site) that is used within the editing area. It can include a body background image with margins.

   Syntax:
   csspath="production absolute path"

   • production absolute path - An absolute path relative to the root of the production server. Do not include a protocol or domain. (http://omniupdate.com)

3. div (Deprecated)

   Name DIV (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. Syntax:
   div="css class"

4. editor

   Provides the ability to specifically select a certain editor to be used to edit a region where it is defined.

   Syntax:
   editor="0 | 1 | 2 | 3 | 4 | 5 | 6"

   • 0 - ActiveX + EOPro
   • 1 - ActiveX
   • 2 - EOPro
   • 3 - OmniDev + EOPro
   • 4 - EditLive
   • 5 - OmniDev + EditLive
   • 6 - Universal Editor v2 (IE,Fx) + v1 (Safari)

5. parag

   The paragraph (optional) - will force the editor to use <br> tags instead of using paragraph tags. This is useful for some heavily CSS driven areas like navigation files.

   NOTE: By default, paragraphs are turned "on".

   Syntax:
   parag="no | on"

   • no - The editor will use <br> instead of <p>
   • on - The editor will use <p> instead of <br>. (Note: Shift-Enter will insert <br> in editor.)

6. reflow

   The reflow (optional) - will force the editor to structure your 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.

   NOTE: By default, reflow is turned "on".

   Syntax:
   reflow="no | yes"

   • no - Where the editor will leave the structure of the page alone.
   • yes - Where the editor will add structure to the page as described above.

7. toolbar

   The toolbar (optional) - this will force a particular toolbar for an editing area.

   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.

   Syntax:
   toolbar="toolbar name"

8. width

   The width (optional) 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.

   Syntax:
   width="pixel number"

   • pixel number - A numeric value representing the pixel width of the editor when loaded.

9. wysiwyg

   The wysywig (optional) - this will force 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 (outside of the OmniUpdate system) to load particular editor types.

   Syntax:
   wysiwyg="noie | yes | no"

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

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

2. prompt (Required)

   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.

   Syntax:
   prompt="string"

3. type (Required)

   Specify the type of the contents

   Syntax:
   type="text | textarea | radio | checkbox | select | image"

   • text - Variable is simple text
     

     Additional parameter: maxlength(optional)- Specifies the maximum length of the variable.
     Example: maxlength="50"

   • textarea - Text area is defined by user
     

     Additional Parameter: rows(optional) , editor="yes|no"
     rows="No.of Rows" - user can have any number of rows
     editor="yes|no" - provides the ability to use a editor to edit a region where it is defined
     Example: rows="50" editor="yes"

   • radio - Variable is defined by user by choosing from a set of radio buttons. Variable will be the value of the user-selected option.
     

     Additional Parameter:options(required)-Specifies the options for the variable defined by user. Keys must have no spaces.Keys are shown in list. Values are what is submitted.
     options="key1:value1;key2:value2;"
     Example: options="Morning:Morning; Noon:Noon; Evening:Evening;"

   • checkbox - Variable is defined by user by toggling the value of a checkbox. Variable will be the value of the user-selected option.
     

     Additional Parameter: options(required)-Specifies the options for the variable defined by user. Keys must have no spaces.Keys are shown in list. Values are what is submitted.
     options="key1:value1;key2:value2;"
     Example: options="Morning:Morning; Noon:Noon; Evening:Evening;"

   • select - Variable is defined by user by choosing from a select-pull down. Variable will be the value of the user-selected option.
     

     Additional Parameter: options(required)-Specifies the options for the variable defined by user. Keys must have no spaces.Keys are shown in list. Values are what is submitted.
     options="key1:value1;key2:value2;"
     Example: options="Morning:Morning; Noon:Noon; Evening:Evening;"

   • image - Variable is defined by the user by defining the path where the image exists
     

     Additional Parameter: path(required),lockout(optional)
     path="Path to a directory"
     lockout="yes|no" - lockout="yes" will prevent the user from traversing outside the directory that has been set
     Example: path="/navigation/images" lockout="yes"

This tag has no parameters.