OTHER PAGE LAYOUT TEMPLATE COMMAND ATTRIBUTES

This document defines the possible values for all of the attributes that can be used with different Page Layout and Edit Layout template commands, the functionality of which are determined by each command's type= attribute. The attributes are listed in alphabetical order.

absolute

When present, WSD will return a fully qualified path to the selected image instead of a path relative to the location where the document using the selected image will be published.
This attribute is used with [type=IMAGE and [type=HYPERLINK Page Layout Template commands. WSD, by default, returns a location reference relative to where the document will be published. When you use the "absolute" attribute, WSD returns a location relative to the document root, specifying a full path to the selected content. The following two examples show returned values for images selected from within a directory structure where multiple sub-directories each have a child "images" directory.

For our examples, we are publishing a document "/company/news/press/release_0223.html" where associated images are located in the "/company/news/press/images" directory:

      <!--[type=IMAGE name="Picture" dir="images" prompt="Select a picture"]-->
      <img src="" border=0>
      <!--END]-->

    In the above example, for a selected image named "this_picture.jpg" WSD would create the following image tag in the control:

        <img src="images/this_picture.jpg" border= 0>< /FONT>

  1.   <!--[type=IMAGE name="Picture" dir="images" absolute prompt="Select a picture"]-->
      <img src="" border=0>
      <!--END]-->

    In the above example, for a selected image named "this_picture.jpg" WSD would create the following image tag in the control:

        <img src="/company/news/press/images/this_picture.jpg" border= 0>< /FONT>

dbkey 

Optional for all commands. This attribute is used with templates that perform database updating to identify those fields that are used as "database keys" during publishing. When present, WSD uses this attribute to protect data values associated with this field, depending on the type of WSD update request is being edited during "Create Online" and "Edit Online" sessions. This feature prevents your contributor from changing database key values in those situations where an existing database record is being updated and the key should not be modified. The following table shows the type of Data Access to the declared dbkey(s)  WSD will allow for all types of WSD "request-types."

WSD Request-Type dbkey Data Access Allowed
Add/Upload Request Update
Modify Request Read-Only
Copy Request Update
Move Request Read-Only
Rename Request Update
Delete Request Read-Only

dir="<directory-list>"  --OR-- imagedir="<directory-list>" (optional syntax for IMAGE commands)

This attribute is optional for IMAGE, HTMLEDIT, and HYPERLINK fields, and specifies one or more directories (comma-separated) within the document root on the server, that contain published content.

All of the files found in <directory-list> are included in the contributor's selection list unless WSD encounters an associated mime= attribute within this page layout statement. When a mime= attribute is present, WSD's selection list is limited to content of the mime types selected.< /FONT>

The following special references can be used within <directory-list>:

$dirprop -- refers to the image locations assigned to the sub-directory where the page using this Page Layout Template will be published

$sysdir -- refers to the image locations assigned on the System Configuration screen by the System Administrator as the system default image location

$workingdir -- useful when users have been constrained to individual working directories or when WSD has been installed for only one segment of a site, instead of the entire document root. When present, provides the document root prefix required for content references.

The "dir= "value can refer to any directory within the Document Root. Example: < /FONT>
dir="$dirprop"
(content in the "Edit Online Image Directory" assigned to CURRENT directory)

dir="."
(Content in the CURRENT directory)

dir=".."
(Content in the PARENT directory)

dir="$sysdir"
(content in the "Edit Online Image Directory" assigned on the System Configuration screen)

dir=".,/products/new,accessories"
(content in multiple directories)

editliveflags=

This template statement attribute is optional for HTMLEDIT controls when using the EditLive! WYSIWYG Editor. The integer value specified immediately following "editliveflags=" is a calculated sum of one or more of the values identifying which toolbar buttons are available to the content contributor (see table below). If the "editliveflags= " attribute is not present, all of the toolbar buttons are enabled.< /FONT>


1

 Enable Font Color Button

2

 Enable Font Size Menu

4

 Enable Page Properties Menu Item

8

 Enable Tables Button

16

 Enable Underline Button

32

 Enable Horizontal Rule Button

64

 Enable Anchor Button

128

Enable Bold Button

256

 Enable Hyperlink Button

512

 Enable Indent Button
1024 Enable Italic Button
2048 Enable Center Justify Button
4096 Enable Left Justify Button
8192 Enable Right Justify Button
16384 Enable Ordered List Button
32768 Enable Unordered List Button
65536 Enable Outdent Button
131072 Enable Paragraph Marks Button
262144 Enable Special Characters Button
524288 Enable Table Column Add Button
1048576 Enable Table Column Delete Button
2097152 Enable Table Insert Button
4194304 Enable Table Row Add Button
8388608 Enable Table Row Delete Button
To enable just the Font Color Button and the Font Size Menu, the template designer would specify a template attribute of "editliveflags=3". The following example prevents the content contributor from using the underline tool in the WYSIWYG editor.< /FONT>

<!--[type=HTMLEDIT
name="Summary"
prompt="Summary:<br>"
width=PREFWIDTH
height=5
pixelwidth=100%
pixelheight=250
editliveflags=16777199]-->

ewebeditproflags=

    This template statement attribute is optional for HTMLEDIT controls when using the eWebEditPro WYSIWYG Editor. The integer value specified immediately following "ewebeditproflags=" is a calculated sum of one or more of the values identifying which toolbar buttons are available to the content contributor (see table below). If the "ewebeditproflags=" attribute is not present, all of the toolbar buttons are enabled. 
      
    1
    2
    4
    8
    16
    32
    64
    128    		 Toolbar Customization Allowed
    Enable About Button
    Enable Alignment Buttons
    Enable Bullets Buttons
    Enable Edit Buttons
    Enable Find Buttons
    Enable Font Color Buttons
    Enable Font Name Button    		 256
    512
    1024
    2048
    4096
    8192
    16384    		 Enable Font Size Button
    Enable Font Style Button
    Enable Hyperlink Button
    Enable Indent Buttons
    Enable Picture Button
    Enable Spell Check Button
    Enable Table Button

fonts="<list>"

A <list> of available font names for use by the HTMLEDIT control. Each font name must be enclosed in single quote characters. When defining multiple fonts, each one must be separated by a comma. If no fonts= attribute is specified, the default is: fonts= "'TimesNew Roman','Arial,Helvetica','Courier'". < /FONT>

Example: fonts="'Times New Roman','Arial,Helvetica','Garamond'"< /FONT>

group="<groupid>"
When present, specifies the Group ID of the group of users authorized to edit the content in this layout template field.  If the user editing a document using this layout template does not belong to the specified group, this field will be displayed as read only and the user will not be able to edit the field content.
 
Note: The <groupid> associated with each group is displayed on the WSD "Maintain Groups" screen. If you do not have "Workflow Administration" permission you must ask your Workflow Administrator to provide you with this information.

height="<lines>"    ---OR---   height=PREFHEIGHT

Required for TEXTAREA fields. Defines the vertical height in number of <lines> of a TEXTAREA field. This attribute should also be defined for HTMLEDIT fields, in case a content contributor does not have JavaScript enabled. When you specify PREFHEIGHT, WSD will use the value from the "User Preference" that is assigned to "Edit Online Number of Rows" as the <lines> value.

Note: We strongly recommend specifying "height=" with HTMLEDIT for those situations when a WYSIWYG editor is not available and the "Allow Text/HTML editing if no WYSIWYG editor is available" System Policy is set to "yes".

hidden

Optional for all commands. This attribute causes WSD to surround the data entered by your contributor for a field with HTML "Comment Tags" during preview and when the content is published. This attribute is useful for declaring properties and other forms of "breadcrumbs" associated with content that is required for use by server applications, dynamic content delivery systems, etc., but should be hidden from site visitors.

iepixelheight  See pixelheight

iepixelwidth   See pixelwidth

maxwidth="<characters>"

Optional for EDIT commands and those IMAGE and HYPERLINK commands without a dir= or imagedir= attribute.< /FONT>

mime="<mime-type-list>"

This attribute is used in conjunction with the dir= and imagedir= attributes to restrict the list of content references presented to a content contributor. Multiple mime-types can be specified, separated by commas. Example: mime= "text/html,text/asp"< /FONT>

Note: The wildcard character "*" (asterisk) is allowed in your <mime-type-list> declaration

Examples:

mime="*"   ALL mime types)
mime="text/*" (all mime types of family "text/")< /FONT>

name="<word>"

A descriptive <word>, without any embedded spaces, used to uniquely identify this Page Layout Template command; referencing its purpose, content, or the identity of the content contained between this command's Beginning-Tag and End-Tag.

nspixelheight  See pixelheight

nspixelwidth  See pixelwidth

pixelheight="<pixels> or <percent>"
 iepixelheight="<pixels> or <percent>"
nspixelheight="<pixels> or <percent>"

The desired display height of the currently available WYSIWYG control in <pixels> (e.g. pixelheight="300") or as a <percent> of the open browser window (e.g. pixelheight= "85%").< /FONT>

  • The attribute "nspixelheight" supports setting size information specific to Netscape browsers. 
  • The attribute "iepixelheight" supports setting size information specific to the Internet Explorer browser. 

If height is not specified for a specific browser, the size information will default to the regular "pixelheight" declaration</FONT>. 

Warning: If you specify a <percent> value that is too small, it may prevent the WYSIWYG control from loading properly when your content contributor resizes his browser window!

pixelwidth="<pixels> or <percent>"
 iepixelwidth="<pixels> or <percent>"
nspixelwidth="<pixels> or <percent>"

The desired display width of the currently available WYSIWYG control in <pixels> (e.g. pixelwidth="400") or as a <percent> of the open browser window (e.g. pixelwidth="85%").Three template field "width" attributes are available to provide better control over the size of HTMLEDIT fields in different browsers.< /FONT>

  • The attribute "nspixelwidth" supports setting size information specific to Netscape browsers. 
  • The attribute "iepixelwidth" supports the setting of size information specific to the Internet Explorer browser. 

If width is not specified for a specific browser, the size information will default to the regular "pixelwidth" declaration.

Warning: Specifying too small a value in <percent> format, may prevent the WYSIWYG control from loading properly, when your content contributor resizes his browser window!

prefix="<value>"

This attribute is used in IMAGE and HYPERLINK statements to specify an alternative word-match for placement of the content reference selected by a content contributor from the dir= or imagedir= list of content specified in IMAGE and HYPERLINK statements. WSD will place the selected content location reference immediately following all instances of the <value> found within the Optional-Text area of the IMAGE or HYPERLINK statement.

prompt="<text>"

This is the (optional) <text> that WSD displays immediately preceding the associated Page Layout Template control during "Create Online" and "Edit Online" sessions. It is used to identify the content purpose and/or content format for the content the user is expected to contribute. This attribute may be provided in an Edit-Layout Template associated with a Page-Layout template. If it is, the attribute value provided on the Page-Layout Template will be ignored, and the attribute value from the Edit Layout Template will be used instead .

This field should contain information meaningful to the content contributor and may contain HTML formatting commands (e.g. a trailing <br> command at the end of the prompt will cause the control to begin on a new line immediately under the prompt during data entry mode).

property="property-name"

Makes up to 255 of the leading characters of information (provided by the content contributor during "Create Online" and "Edit Online" sessions) available for later reference from within the same document, or from other documents once this document is published . WSD will place the value associated with this "property-name" into all references to "<$property-name>" or "$prop:property-name$" when this document is previewed or published. This method of declaring and populating user-defined document properties eliminates errors caused by retyping a value, such as a product number, multiple times within the same document.

Example-1 (reference from within document):

This FIRST HTML code fragment allows the user to enter the product code as part of the product description:

<P>This new slicer (Order Code:
<!--[type=EDIT name="product" prompt="Please enter the Product Number: " property="prodnumber" width=10]-->
<!--[END]-->
) is the latest in our series of outstanding slicers!

Later in the document: the template designer can reuse this property with the following HTML source fragment....

<P>When ordering, be sure to use Order Code: <$prodnumber>.

Example-2 (reference from another document after first document is published):

This FIRST DOCUMENT HTML code fragment allows the user to enter the department from which the product originated as a user-defined property:

<P>Originating Department:
<!--[type=EDIT name="productdept" prompt="Please enter the Product Description: " hidden  property="proddept" width=50]-->
<!--[END]-->
</P>

From ANOTHER DOCUMENT (after the first document has been published): the template designer can reuse the first document's property with the following HTML source fragment....

<P>Be sure to check out our 
<!--[type=HYPERLINK name="featuredlink" prompt= "Selectfeaturedproduct " dir=/products width=30]-->
<a href="">Product of the Month!</a>
<!--[END]-->
</P>

<P>This month's product originated in our <$reference $field:featuredlink$:$prop:proddept$> department.

 width="<characters>"  --OR--     width=PREFWIDTH

Required for EDIT, HTMLEDIT and TEXTAREA commands. Defines the horizontal width in number of <characters> of an EDIT or TEXTAREA field. This attribute must also be defined for HTMLEDIT fields, in case a content contributor does not have JavaScript enabled and the "Allow Text/HTML editing if no WYSIWYG editor is available" System Policy is set to "yes".

Also required for IMAGE and HYPERLINK commands that do not have a declared dir= or imagedir= command attribute.

Note: When you specify "PREFWIDTH", WSD will use the value from the "User Preference" that is assigned to "Edit Online Number of Columns" as the <characters> value.

 wrap=
Specifies how line wrapping occurs within TEXTAREA fields. Valid choices are OFF, SOFT and HARD.
OFF - no line wrapping occurs; the user has to manually use the Enter key to start a new line.

SOFT - input will wrap visibly within the edit field, but only explicit line feeds added via the Enter key will end up in the stored content.

HARD - all lines will wrap at the visible edge of the edit field, and the stored content will contain line feeds at those locations.

Note: If no "wrap= " attribute is specified, the default is OFF.

Copyright 2000-2005 CyberTeams, Inc., http://www.cyberteams.com All rights reserved
CyberTeams and WebSite Director are registered trademarks of CyberTeams, Inc. All other marks are the property of their respective owners.