Common entities

The following are DTD entities that are referenced in other entities or in more than one element:

Entity name Entity name Entity name

%cellbackground.repeats;

%launch.all.whenopened;

%pixels;

%color;

%launch.common.attrs;

%pixels.1to4;

%color.names;

%launch.common.whenopened;

%pixpct;

%design.flags;

%launch.notes.whenopenend;

%pixpctrel;

%design.note.attrs;

%launch.webonly.whenopened;

%reading.orders;

%design.note.hide.tokens;

%length;

%reading.order.attrs;

%design.note.prolog;

%lenpct;

%richtext.block;

%design.webflags;

%link.attrs;

%richtext.hot.inline;

%direction.attrs;

%link.color.attrs;

%richtext.inline;

%embedded.fit.types;

%link.computed.content;

%richtext.links;

%field.kinds;

%link.content;

%richtext.nonhot.inline;

%form.focus.attrs;

%list.separators;

%root.attrs;

%formula.types;

%lr.aligns;

%root.fixed.attrs;

%html.core.attrs;

%named.design.note.attrs;

%send.value.types;

%image.formats;

%named.design.note.prolog;

%simple.aligns;

%image.original.formats;

%note.epilog;

%simple.types;

%item.complex.types;

%note.prolog;

%space.attrs;

%language.attrs;

%onopengoto.options;

%view.and.folder.attrs;

%onrefresh.options;

%view.headers;

%pardef.id;

%view.rowspacings

%view.unreadmarks;

%acl.levels;

The %acl.levels; entity lists the access levels allowed in a Domino database. This entity can be used in the <acl> and <aclentry> elements.

For more information on access levels, see Access levels in the ACL.

Syntax:

<!ENTITY % acl.levels "noaccess | depositor | reader | author | editor | designer | manager ">

%cellbackground.repeats;

The %cellbackground.repeats; entity defines the style options for displaying the background image of a cell or view. This entity is used in the <cellbackground> and <viewbackground> elements.

Syntax:

<!ENTITY % cellbackground.repeats "once | vrepeat | hrepeat | tile | center | resize">

center

Centers the image.

hrepeat

Repeats the image horizontally.

once

Displays the image once, without repeating it.

resize

Allows resizing of the image.

tile

Tiles the image, filling the background with multiple copies of it.

vrepeat

Repeats the image vertically.

%color;

The %color; entity defines colors, as in the CSS2 Cascading Style Sheet. See the %color.names; entity for a list of the color names that can be used as color values. The %color; entity is used in attributes of the <actionbar>, <actionbuttonstyle>, <border>, <bordercaption>, <button>, <embeddeddatepicker>, <eoutlinebackground>, <font>, <form>, <frameset>, <helpaboutdocument>, <helpusingdocument>, <horizrule>, <page>, <sectiontitle>, <sublevel>, <table>, <tablecell>, <title>, and <toplevel> elements, as well as the %link.color.attrs; and %view.and.folder.attrs; entities.

Syntax:

<!ENTITY % color "CDATA">

%color.names;

The %color.names; entity lists the color names that can be used for values of the %color; entity.

Syntax:

<!ENTITY % color.names " aqua | black | blue | fuchsia | gray | green | lime | maroon | navy | olive | purple | red | silver | teal | white | yellow | none | system " >

system

A preset color. For instance, the font color of a hotspot link is 'system' because it is determined by the %link.color.attrs; property settings for a form.

%design.flags;

The %design.flags; entity lists the flags that are common to many design elements. This entity is used in the %design.note.attrs; entity.

Syntax:

<!ENTITY % design.flags "
Entity name Entity name Entity name

hide

%tokens;

#IMPLIED

nocompose

%boolean;

#IMPLIED

noquery

%boolean;

#IMPLIED

norenderv3

%boolean;

#IMPLIED

insertdialog

%boolean;

#IMPLIED

newinsertdialog

%boolean;

#IMPLIED

otherdialog

%boolean;

#IMPLIED

noreplace

%boolean;

"false"

readonly

%boolean;

#IMPLIED

propagatenoreplace

%boolean;

#IMPLIED

">

hide

List of keyword tokens from %design.note.hide.tokens; entity.

insertdialog

For a subform, true displays the subform as an option in the Insert Subform dialog box.

newinsertdialog

For a subform, true includes the subform as an option in the Insert New Form dialog box. For more details on subforms, see "Subforms" in the Application Development with Domino Designer book.

nocompose

If true, does not include the design element in any menu bar drop-down options.

noquery

If true, does not return the design element when a database is searched.

norenderv3

If true, does not render the subform for Notes release 3 or earlier clients. A designer might prohibit a design element from displaying in an earlier release if it contains features that were introduced in a later release of Notes and thus would not display properly in release 3.

noreplace

If true, prohibits design refresh or replace from modifying an inherited design element. Default is false.

propagatenoreplace

If true, propagates the no design refresh or replace prohibition. Default is false.

otherdialog

For forms, true displays the form as an option in the Other dialog box accessed by choosing Create - Document - Other from the menu bar, instead of displaying it in the default Create - Document menu drop-down list.

readonly

If true, prohibits you from editing certain design elements, such as the imageresource design element. Default is false.

%design.note.attrs;

The %design.note.attrs; entity defines the attributes common to all design elements. This entity does not apply to the acl, profiledocument, database, and viewentries elements, because these are treated as root elements instead of design elements in DXL. This entity is used in the <databasescript>, <sharedactions>, <helpaboutdocument>, and <helpusingdocument> elements and the %named.design.note.attrs; entity.

Syntax:

<!ENTITY % design.note.attrs "
Entity name Entity name Entity name

%note.attrs;

%design.flags;

%design.webflags;

publicaccess

%boolean;

#IMPLIED

default

%boolean;

"false"

private

%boolean;

"false"

designerversion

%integer;

#IMPLIED

fromtemplate

%string;

#IMPLIED

%language.attrs;

">

default

If true, indicates that the current design element is set as the default form or default design view for the database. Default is false.

designerversion

Specifies the major release number of Domino Designer needed to successfully edit the design element.

fromtemplate

Name of the design template that this design element is inherited from. An example of a Notes template file is: mail6ex.ntf.

private

For views, true indicates that the current view is private. You can only designate a view as private at the time that you create it; it is not a setting that you can adjust in the View Properties box after its creation. Default is false.

publicaccess

If true, the design element is available to Public Access users.

For more on Public Access, see Creating pages, forms, outlines, view, and agents for public access.

%design.note.hide.tokens;

The %design.note.hide.tokens; entity defines keyword tokens that appear in the hide attribute for design notes. A designer may choose to hide design elements from an earlier release of Notes if the elements will not function properly in that earlier version. A designer may also want to hide a design element created specifically for the Notes client from a Web browser and vice versa. The hide attribute appears in the %design.flags; entity.

Syntax:

<!ENTITY % design.note.hide.tokens "v3 | v4 | v5 | notes | web | mobile ">

notes

Hides design elements from all Notes clients.

v3

Hides design elements from Notes release 3 clients.

v4

Hides design elements from Notes release 4 clients.

v5

Hides design elements from Notes release 5 clients.

web

Hides design elements from all Web browsers.

mobile

Hides design elements from all mobile users.

%design.note.prolog;

The %design.note.prolog; entity defines a note's identity data and update history, which is stored at the beginning of a design element. It is used in the <agentdata>, <sharedactions>, <helpaboutdocument>, and <helpusingdocument> elements and the %named.design.note.prolog; entity.

Syntax:

<!ENTITY % design.note.prolog " %note.prolog;">  

%design.webflags;

The %design.webflags; entity lists the flags that determine how design elements behave on the Web. This entity is used in the %design.note.attrs; entity.

Syntax:

<!ENTITY % design.webflags "
Entity name Entity name Entity name

useapplet

%boolean;

"false"

treatashtml

%boolean;

"false"

htmlallfields

%boolean;

#IMPLIED

">

htmlallfields

If true, generates HTML for all fields. If you want to ensure that hidden fields that perform calculations on a form function as expected on the Web, select this option instead of the treatashtml option. This choice makes the field available to Domino to perform the calculation and then render the result in HTML. Default is false.

treatashtml

If true, treats the contents of the element as HTML. This option corresponds to selecting HTML as the Content type for the On Web Access option in the design element's property box in Domino Designer. Default is false.

useapplet

If true, uses the Java applet to display the element in a browser. The following design elements can be displayed using Java applets: outlines, views, action bars, and rich text. Default is false.

%direction.attrs;

The %direction.attrs; entity specifies whether elements within a "container" read left-to-right or right-to-left. For example, a column is an element in a table element "container" that can display in either direction. This element is used in the <table> and <embeddedoutline> elements and %view.and.folder.attrs; entity.

<!ENTITY % direction.attrs "
Entity name Entity name Entity name

direction

(%reading.orders;)

'lefttoright'

">

%embedded.fit.types;

The %embedded.fit.types; entity defines the ways in which to size a view or date picker that is embedded in a page, form, or subform. This entity is used in the <embeddeddatepicker> and <embeddedview> elements.

Syntax:

<!ENTITY % embedded.fit.types "fixed | fittowindow ">

fittowindow

Automatically adjusts the size of the view or datepicker to fit into the design element it is embedded in.

fixed

Fixed width and height, in inches.

%field.kinds;

The %field.kinds; entity lists the options for defining whether a field is editable or computed. This entity is used in the <field> and <section> elements.

Syntax:

<!ENTITY % field.kinds "editable | computed | computedfordisplay | computedwhencomposed ">

These options define a field as follows:

computed

A formula calculates its value each time a user creates, saves, or refreshes a document.

computedfordisplay

A formula recalculates its value each time a user opens or saves a document.

computedwhencomposed

A formula calculates its value only once: when a user first creates the document.

editable

A user can enter or change its value.

%form.focus.attrs;

The %form.focus.attrs; entity defines when a form should receive focus. This entity is used in the <form> and <page> elements.

Syntax:

<!ENTITY % form.focus.attrs "noinitialfocus | nofocusonf6 ">

noinitialfocus

Boolean. If true, specifies to not give a form initial focus.

nofocusonf6

Boolean. If true, disables the F6 and SHIFT - F6 key functions that give focus to a form in a frame.

Note: Domino Designer users should use CTRL-F7 to navigate in any direction.

%formula.types;

The %formula.types; entity defines the options for the formulatype attributes in the <simpleaction> and <agent> elements.

Syntax:

<!ENTITY % formula.types " modifydocs | selectdocs | createdocs ">

When the specified formula is run:

createdocs

Creates new documents.

modifydocs

Updates existing documents.

selectdocs

Selects existing documents.

%grid.styles;

The %grid.styles; entity defines the types of grids you can use in a view or folder background to display the rows. This entity is used in the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % grid.styles " none | solid | dash | dot | dashdot ">

This option differentiates each row by outlining it with

dash

A dashed line.

dashdot

A series of consecutive dashes and dots.

dot

Dotted line.

none

No lines. This option does not display an outline around each row.

solid

A solid line.

%html.core.attrs;

The %html.core.attrs; entity lists the attributes for core html elements. This entity is used in the <actionhotspot>, <area>, <button>, <computedtext>, <embeddedfileuploadcontrol>, <field>, <frame>, <frameset>, <horizrule>, <javaapplet>, <table>, <tablecell>, and elements.

Syntax:

<!ENTITY % html.core.attrs "
Entity name Entity name Entity name

htmlid

%string;

#IMPLIED

htmlclass

%string;

#IMPLIED

htmlstyle

%string;

#IMPLIED

htmltitle

%tstring;

#IMPLIED

extrahtmlattrs

%string;

#IMPLIED

">

You set these values on the HTML tab of an object's property box:

extrahtmlattrs

'Other' or additional HTML tag attributes written as pure HTML.

htmlclass

Applies a Cascading Style Sheet (CSS) class to a defined object.

htmlid

ID of an object, used to reference it in JavaScript or CSS.

htmlstyle

Applies a specific CSS style to an object using in-line CSS.

htmltitle

Translatable text that displays as a tip in the browser. It displays differently in different browsers.

%image.formats;

The %image.formats; entity defines the options for image formats. This entity is used in the <imageresource>, <background>, <cellbackground>, and <picture> elements.

Syntax:

<!ENTITY % image.formats "gif | jpeg | notesbitmap | cgm">

%image.original.formats;

The %image.original.formats; entity defines the native format in which an image is stored in a Notes database. This entity is used in the <gif> and <jpeg> elements.

Syntax:

<!ENTITY % image.original.formats "notesbitmap">

%item.complex.types;

The %item.complex.types; entity defines the types of items allowed in a Domino database. This entity is used in the <item> and <fieldchoice> elements and contains the <formula> and <richtext> elements.

Syntax:

<!ENTITY % item.complex.types "formula | object | richtext ">

This entity represents items comprised of:

formula

A compiled formula language @function or @command in parsed character data.

object

A data object, such as a file attachment, which is stored separately from a note item in a Notes database.

richtext

Rich text data.

%language.attrs;

The %language.attrs; entity defines the attributes for language settings. This entity is used in the <actionbar> and <textproperty> elements and the %design.note.attrs; entity.

Syntax:

<!ENTITY % language.attrs "
Entity name Entity name Entity name

language

%string;

#IMPLIED

">

language

Language associated with an element or attribute in ISO format.

%launch.all.whenopened;

The %launch.all.whenopened; entity lists the types of launch settings that can be applied to a Notes database. This entity is used in the %launch.common.attrs; entity. Options of the %launch.notes.whenopened; entity can only be used in the <noteslaunch> element and options of the launch.webonly.whenopened; entity can only be used in the <weblaunch> element.

Syntax:

<!ENTITY % launch.all.whenopened " %launch.common.whenopened;| %launch.notes.whenopened;| %launch.webonly.whenopened;">

%launch.common.attrs;

The %launch.common.attrs; entity lists the attributes for the launch settings of a database. This entity is used in the <noteslaunch> and <weblaunch> elements.

Syntax:

<!ENTITY % launch.common.attrs "
Entity name Entity name Entity name

whenopened

(%launch.all.whenopened;)

#IMPLIED

frameset

%string;

#IMPLIED

navigator

%string;

#IMPLIED

">

frameset

Name of the frameset to open if the whenopened attribute is set to openframeset.

navigator

Name of the navigator to open if the whenopened attribute is set to opennavigator or opennavigatorinwindow.

whenopened

Defines the first item to display or open when a database is first accessed. See the %launch.all.whenopened; entity for the available options.

%launch.common.whenopened;

The %launch.common.whenopened; entity lists the launch settings that are common to a Notes database that is being launched either in Notes or on the Web. These correspond to the setting options available on the launch tab of the Database Properties box in Domino Designer. This entity is used in the %launch.all.whenopened; entity.

Syntax:

<!ENTITY % launch.common.whenopened "openaboutdocument | openframeset | opennavigatorinwindow | openfirstdoclink ">

These options specify what to display or open when the database is first accessed:

openaboutdocument

Display the About this database document.

openframeset

Display the designated frameset.

openfirstdoclink

Open to the first document link in the About this database document.

opennavigatorinwindow

Open the specified navigator in its own window.

%launch.notes.whenopened;

The %launch.notes.whenopened; entity lists the launch settings that are specific to launching Notes databases in Notes. These correspond to the setting options available on the launch tab of the Database Properties box in Domino Designer. This entity is used in the %launch.all.whenopened; entity. You can reference these options when using the <noteslaunch> element or when launching from the Web, if the %launch.webonly.whenopened; entity is set to usenotesoptions.

Syntax:

<!ENTITY % launch.notes.whenopened "restorelastview | opennavigator | openfirstaboutattachment ">

These options specify the following when the database is first accessed:

openfirstaboutattachment

Opens to the first attachment in the About this database document.

opennavigator

Displays the specified Notes navigator.

restorelastview

Restores the view most recently accessed by that user. This option is the implied default.

%launch.webonly.whenopened;

The %launch.webonly.whenopened; entity lists launch settings that are specific to launching Notes databases on the Web. These correspond to the setting options available on the launch tab of the Database Properties box in the Notes UI. This entity is used in the %launch.all.whenopened; entity. You can only reference these options when using the <weblaunch> element.

Syntax:

<!ENTITY % launch.webonly.whenopened "usenotesoptions | openpage | openspecifieddoclink | openfirstdocumentinview ">

These options specify the following when the database is first accessed:

openfirstdocumentinview

Displays the first document in the view.

openpage

Opens the designated page.

openspecifieddoclink

Displays the specified document link.

usenotesoptions

Uses the same options that were specified for use when launching to the Notes client in the %launch.notes.whenopened; entity. This option is the implied default.

%length;

The %length; entity defines horizontal and vertical measurements in units of inches, centimeters, millimeters, points, percentages, or pixels as defined by CSS2. This entity is used in the <border>, <button>, <embeddeddatepicker>, <embeddedview>, <field>, <font>, <horizrule>, <layout>, <picture>, <table>, and <tablecolumn> elements.

Syntax:

<!ENTITY % length "CDATA">

%lenpct;

The %lenpct; entity defines an explicit length specified as a specific length, using the same units of measure as the %length; entity, or as a percentage. This entity is used in the <embeddedoutline>, <embeddedview>, <field>, <horizrule>, <pardef>, and <table> elements.

Syntax:

<!ENTITY % lenpct "CDATA">

%link.attrs;

The %link.attrs; entity defines the common attributes for all link elements. This entity is used in the <doclink>, <viewlink>, <databaselink>, <urllink>, and <namedelementlink> elements.

Syntax:

<!ENTITY % link.attrs "
Entity name Entity name Entity name

showborder

%boolean;

"false"

targetframe

%string;

#IMPLIED

regionid

%integer;

#IMPLIED

(%html.core.attrs;)

">

regionid

Unique ID of the <region> elements associated with the link construct.

showborder

If true, displays a border around the link content. Applies to hotspot links only.

targetframe

Name of the frame in which to display the linked document, Universal Resource Identifier (URI), or named design element.

%link.color.attrs;

The %link.color.attrs; entity defines the text colors of a link when viewed on the Web. This entity is used in the <form>, <page>, <view>, and <folder> elements.

Syntax:

<!ENTITY % link.color.attrs "
Entity name Entity name Entity name

activelinkcolor

%color;

#IMPLIED

visitedlinkcolor

%color;

#IMPLIED

unvisitedlinkcolor

%color;

#IMPLIED

">

%link.computed.content;

The %link.computed.content; entity defines the content of any links with URIs or named elements as link targets. This entity is used in the <urllink> and <namedelementlink> elements.

Syntax:

<!ENTITY % link.computed.content "( #PCDATA | code | %richtext.inline;)*">

%link.content;

The %link.content; entity defines the content of all links except those with URIs or named elements as link targets. This entity is used in the <databaselink>, <doclink>, and <viewlink> elements.

Syntax:

<!ENTITY % link.content "( #PCDATA | %richtext.inline;)*">

%list.separators;

The %list.separators; entity defines the choices of separators for rich text. This entity is used in the <field> and <column> elements. The "none" option is not applicable in a <field> element and the "blankline" option is not applicable in a <column> element.

Syntax:

<!ENTITY % list.separators "space | comma | semicolon | newline | blankline | none">

%lr.aligns

The %lr.aligns; entity lists the two options for the alignment of objects, such as an icon on an action button, or the action button on the action bar. This entity is used in the <action> and <actionbar> elements.

Syntax:

<!ENTITY % lr.aligns " left | right ">

%named.design.note.attrs;

The %named.design.note.attrs; entity defines the attributes that can be used with a named design element, such as an <agent>, <appletresource>, <dataconnection>, <folder>, <form>, <imageresource>, <page>, <scriptlibrary>, <sharedfield>, <subform>, or <view> element.

Syntax:

<!ENTITY % named.design.note.attrs "
Entity name Entity name Entity name

%design.note.attrs;

name

%tstring;

#IMPLIED

alias

%tstring;

#IMPLIED

comment

%tstring;

#IMPLIED

">

alias

Alias or aliases for a named design element. An alias is an optional name you can assign to an element for programmatic use. If you use the alias name whenever you reference the element in database scripts, you will not need to update your code if the primary name of the element must be changed. Multiple aliases are separated by ' | '.

comment

Comment for the design element. The comments display in the list of elements in the Design pane of the Designer UI. Providing a comment that identifies the function of the element is useful to others who access your databases and can also be useful to you when you return to a database you have not worked with for a while.

name

Primary name for the design element.

%named.design.note.prolog;

The %named.design.note.prolog; entity defines the identification data and update history information, which is located at the beginning of a named design element. This entity is used in the <agent>, <appletresource>, <dataconnection>, <databasescript>, <folder>, <form>, <frameset>, <imageresource>, <page>, <scriptlibrary>,<sharedfield>, <subform>, and <view> elements.

Syntax:

<!ENTITY % named.design.note.prolog "%design.note.prolog;" >

%note.attrs;

The %note.attrs; entity represents the attributes that are common to all notes, including design elements. This entity is used in the <note> and <document> elements as well as the %design.note.attrs; entity, which defines the attributes common to all Domino design notes (except the ACL, database, profiledocument, and viewentries elements, which are treated as root elements instead of notes in DXL). This entity contains the root attribute of a note because the version information of a note is required when you export it independently, by its ID or name, instead of exporting it as part of the database that contains it.

Syntax:

<!ENTITY % note.attrs "
Entity name Entity name Entity name

%root.attrs;

key

ID

#IMPLIED

key

User-specified ID that identifies a note and enables the user to reference it.

%note.epilog;

The %note.epilog; entity represents the content at the end of a note, which consists of any uninterpreted data represented by item elements. Most notes that are design elements, such as forms or views, are highly interpreted when manipulated by DXL and therefore the note epilog for these elements consists of only a few uninterpreted <item> elements. Elements like <document> and <note> contain more data that is not interpreted in DXL, so a lot of their content is expressed as <item> elements in the note epilog. This entity is used in the <agentdata>, <appletresource>, <dataconnection>, <note>, <document>, <form>, <scriptlibrary>, <subform>, <view>, <folder>, <agent>, <imageresource>, <page>, <helpaboutdocument>, <helpusingdocument>, <sharedfield>, <profiledocument>, <frameset>, and <sharedactions> elements.

Syntax:

<!ENTITY % note.epilog "( item* )">

%note.prolog;

The %note.prolog; entity represents the identification data that resides at the beginning of all notes. This entity is used in the <note>, <profiledocument>, and <document> elements and the %design.note.prolog; entity.

Syntax:

<!ENTITY % note.prolog "( noteinfo?, updatedby?, revisions?, textproperties?, wassignedby? )">

%onopengoto.options;

The %onopengoto.options; entity lists the options for setting the focus when a view or folder opens. This entity is used in the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % onopengoto.options "top | bottom | lastopened ">

On opening a view or folder, the %onopengoto; entity options set the focus to the following:

bottom

Bottom row.

lastopened

Document that was last opened.

top

First row.

%onrefresh.options;

The %onrefresh.options; entity lists the options for refreshing a view or folder. This entity is used in the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % onrefresh.options "refreshtop | refreshbottom | refresh | displayindicator ">

These options refresh a view or folder as follows:

displayindicator

Only when a user clicks the refresh button. This option does not automatically update the view or folder, but displays a refresh button if the view or folder changes.

refresh

Automatically, before showing the view or folder to users.

refreshbottom

Beginning with the bottom row. This option displays the changes immediately, from the end to the beginning of the view or folder.

refreshtop

Beginning with the first row. This option displays the changes immediately, from the beginning to the end of the the view or folder. This increases the display speed to changes in a view or folder having documents in reverse chronological order.

%pardef.id;

The %pardef.id; entity defines the paragraph ID as a token. NMTOKENS are name tokens that enable a user to make multiple choices. This entity is used in the <pardef>, <sectiontitle> and <par> elements.

Syntax:

<!ENTITY % pardef.id "NMTOKEN">
 

%pixels;

The %pixels; entity defines an attribute whose value is a single length in pixels. A pixel is the smallest resolvable rectangular area of an image, either on a screen or stored in memory. For example, the height attribute of a picture element could be defined as follows: <picture height='142px'/>. The "px" stands for pixels. This entity is used in the <border>, <frame>, <frameset>, <picture> and <table> elements.

Syntax:

<!ENTITY % pixels "CDATA">

%pixels.1to4;

The %pixels.1to4; entity defines lengths in pixels for four-sided objects as follows:

  • If one length is supplied, then this length applies to all four edges.
  • If two lengths are supplied, then the first length applies to the leading and trailing edges, and the second length applies to the left and right edges.
  • If three lengths are supplied, then the first length applies to the leading edge, the second length applies to the left and right edges, and the third length applies to the trailing edge.
  • If four lengths are supplied, then they apply to the four edges, leading, right, trailing, and left, respectively.

This entity is used in the <border>, <tablecell> elements and the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % pixels.1to4 "CDATA">

%pixpct;

The %pixpct; entity defines the length for an attribute that must be measured as a single %pixels; unit or as a percentage. This entity is used in the <javaapplet> and <bordercaption> elements.

Syntax:

<!ENTITY % pixpct "CDATA">

%pixpctrel;

The %pixpctrel; entity defines the length for an attribute that must be measured one of three ways: in pixels ("1px"), as a percentage ("80%"), or as a relative value ("4").

Syntax:

<!ENTITY % pixpctrel "CDATA">

%reading.orders;

The %reading.orders; entity lists the orders in which rich text displays for reading. It is used in the %reading.order.attrs; and %direction.attrs; entities.

Syntax:

<!ENTITY % reading.orders "righttoleft | lefttoright">

%reading.order.attrs;

The %reading.order.attrs; entity defines the attributes of the %reading.orders; entity, where the default is "lefttoright." This entity is used in the <block>, <run>, <pardef>, <form>, <page>, <keywords>, <button>, <action>, <column>, and <columnheader> elements.

Syntax:

<!ENTITY % reading.order.attrs "
Entity name Entity name Entity name

readingorder

(%reading.orders;)

"lefttoright"

">

%richtext.block;

The %richtext.block; entity lists the elements that appear at the paragraph level, such as the <block>, <richtext>, <section>, and <tablecell> elements.

Syntax:

<!ENTITY % richtext.block "par | pardef | table | subformref | section | block ">

%richtext.hot.inline;

The %richtext.hot.inline; entity lists the inline elements that are clickable, which are included in the %richtext.inline; entity.

Syntax:

<!ENTITY % richtext.hot.inline " %richtext.links;| attachmentref | button | computedtext | popup | javaapplet | actionhotspot | objectref | region ">

%richtext.inline;

The %richtext.inline; entity lists the hot (clickable) and nonhot entities that can appear in running text. This entity is used in the <actionhotspot>, <run>, <par>, <popup>, <region>, and <span> elements and %link.content; and %link.computed.content; entities.

Syntax:

<!ENTITY % richtext.inline " %richtext.nonhot.inline;| %richtext.hot.inline;">

%richtext.links;

The %richtext.links; entity lists the types of links used in rich text elements and is used in the %richtext.hot.inline; and %area.link; entities.

Syntax:

<!ENTITY % richtext.links "urllink | doclink | viewlink | databaselink | namedelementlink ">

These hotspot link types determine the destination of the hypertext jump as follows:

databaselink

A Notes database.*

doclink

A Notes document.*

namedelementlink

A named design element in the current database or another database on the server.

urllink

A URL, uniform resource locator.

viewlink

A Notes view.*

*Links that you copy and paste in Domino Designer using the Hotspot Link Properties box.

%richtext.nonhot.inline;

The %richtext.nonhot.inline; entity lists the inline elements that are not clickable. This entity is used in the <attachmentref> and <objectref> elements and is included the %richtext.inline; entity.

Syntax:

<!ENTITY % richtext.nonhot.inline "run | break | field | sharedfieldref | picture | horizrule | anchor | embeddedcontrol | embeddeddatepicker | embeddedfileuploadcontrol | embeddedfolderpane | embeddednavigator | embeddedoutline | embeddedview | imagemap | namedelementref | nonxmlchar | richtextdata | span ">

%root.attrs;

The %root.attrs; entity defines the attributes of root elements, such as <database>, <acl>, <profiledocument>, and <viewentries>. This entity is also contained in the %note.attrs; entity, since the version of a note is required when you export it, independently, by its ID or name instead of exporting it as part of the database that contains it.

Syntax:

<!ENTITY % root.attrs "
Entity name Entity name Entity name

version

%float;

#IMPLIED

maintenanceversion

%float;

#IMPLIED

milestonebuild

%number;

#IMPLIED

replicaid

%replicaid;

#IMPLIED

%root.fixed.attrs;

">

maintenanceversion

Represents the maintenance version of the DXL data. For example, the exporter on Domino maintenance release 6.0.1b outputs version 6.0, maintenance version 1.2. The 2 represents the b.

milestonebuild

Represents the milestone build version of the DXL data. For example, the exporter on Domino milestone build 7 outputs version 6.0, milestonebuild 7.

replicaid

Represents the replica ID of the database that contains the note.

version

Represents the version of the DXL data. For example, the exporter on Domino Release 6 outputs version 6.0.

%root.fixed.attrs;

The %root.fixed.attrs; entity defines the namespace for the root elements in the Domino DTD. this entity is not referenced elsewhere in the DTD because it is an XML-defined attribute.

Syntax:

<!ENTITY % root.fixed.attrs "
Entity name Entity name Entity name

xmlns

CDATA

#FIXED 'http://www.lotus.com/dxl'

">

xmlns

Represents the fixed namespace for the Domino DTD.

%send.value.types;

The %send.value.types; entity defines the data types that can make up the content of a mail message. This entity is used in the <sendbcc>, <sendcc>, <sendsubject>, and <sendto> elements.

Syntax:

<!ENTITY % send.value.types " text | textlist | formula ">

%simple.aligns;

The %simple.aligns; entity defines the choices of alignment for the contents of the <column> and <columnheader> elements.

Syntax:

<!ENTITY % simple.aligns "left | center | right">

%simple.types;

The %simple.types; entity defines common data type elements. This entity is used in the <item>, <fieldchoice> and <entrydata> elements.

Syntax:

<!ENTITY % simple.types "text | number | datetime | textlist | numberlist | datetimelist | itemdata ">
 

%space.attrs;

The %space.attrs; entity determines how white space is handled. This entity is used in the block, <run>, and <par> elements.

Syntax:

<!ENTITY % space.attrs "
Entity name Entity name Entity name

keepindentation

%boolean;

#IMPLIED

">

%view.and.folder.attrs;

The %view.and.folder.attrs; entity defines the attributes of views and folders. This entity is used in the <folder> and <view> elements.

Syntax:

<!ENTITY % view.and.folder.attrs "
Entity name Entity name Entity name

opencollapsed

%boolean;

"false"

showresponsehierarchy

%boolean;

"false"

unreadmarks

(%view.unreadmarks;)

#IMPLIED

onopengoto

(%onopengoto.options;)

#IMPLIED

onrefresh

%onrefresh.options;

#IMPLIED

headers

(%view.headers;)

#IMPLIED

showmargin

%boolean;

#IMPLIED

extendlastcolumn

%boolean;

"false"

bgcolor

%color;

#IMPLIED

altrowcolor

%color;

#IMPLIED

unreadcolor

%color;

#IMPLIED

totalscolor

%color;

#IMPLIED

shrinkrows

%boolean;

#IMPLIED

rowlinecount

%integer;

#IMPLIED

rowspacing

(%view.rowspacings;)

#IMPLIED

headerlinecount

%integer;

#IMPLIED

uniquekeys

%boolean;

"false"

defaultdesign

%boolean;

"false"

showinmenu

%boolean;

"false"

allowdocselection

%boolean;

"false"

headerbgcolor

%color;

#IMPLIED

hidemarginborder

%boolean;

#IMPLIED

marginwidth

%pixels.1to4;

#IMPLIED

marginbgcolor

%color;

#IMPLIED

gridstyle

(%grid.styles;)

#IMPLIED

logviewupdates

%boolean;

#IMPLIED

initialbuildrestricted

%boolean;

#IMPLIED

noemptycategories

%boolean;

#IMPLIED

evaluateactions

%boolean;

#IMPLIED

allownewdocuments

%boolean;

#IMPLIED

allowcustomizations

%boolean;

#IMPLIED

boldunreadrows

%boolean;

#IMPLIED

%direction.attrs;

">

allowcustomizations

If true, enables users to make their own customizations to a view by selecting View - Customize this view from the menu.

allowdocselection

If true, when the view displays on the Web, check boxes appear with each document so users can select multiple documents.

allownewdocuments

If true, displays Ctrl-Click here to add a new document in the last row of the view.

altrowcolor

Color for alternate rows, which helps a user to follow one row across all the columns in a view or folder.

bgcolor

Background color of the view.

boldunreadrows

Emboldens the text in unread rows.

defaultdesign

If true, sets current view or folder design as the default design for new views and folders.

evaluateactions

If true, evaluates actions for every document change.

extendlastcolumn

Spreads out the last column to remove any empty space in the view.

gridcolor

Specifies the color of the grid lines when a grid is applied to a view.

gridstyle

Defines the style of the grid pattern for a view. The options are defined in the %grid.styles; entity.

headerbgcolor

Specifies the background color of the view header.

headerlinecount

Lines per heading; indicates how many lines a column title can wrap.

headers

Omits or displays a bar at the beginning of the view with a column heading that has a simple or beveled border. See the %view.headers; entity for a list of options.

hidemarginborder

If true, hides the selection margin border.

initialbuildrestricted

If true, restricts the initial index build to a user with designer or manager access to the view.

logviewupdates

If true, includes view updates to the transaction log.

marginbgcolor

Specifies the color of the selection margin.

marginwidth

Indicates the width of the selection margin (in pixels).

noemptycategories

If true, prevents categories that have no documents from displaying in the view or folder.

onopengoto

Sets focus on the first row, last row, or the last document a user opened in the view or folder. See the %onopengoto.options; entity for a list of options.

onrefresh

Automatically refreshes the view or folder from the first row, last row, or before a user opens it. Can also display a refresh indicator when something in the view or folder changes. See the %onrefresh.options; entity for a list of options.

opencollapsed

If true, displays only the category titles in a view by collapsing all the documents when the database is first opened.

showmargin

If true, shows a document selection margin. The leftmost column in the Inbox view of a mail database, where the unread marks and deletion marks display, is an example of a selection margin.

rowlinecount

Number of lines per row entry.

rowspacing

The amount of space between rows, as defined in the %view.rowspacings; entity.

showinmenu

If true, displays the name of the current view or folder at the end of the View drop-down menu.

showresponsehierarchy

If true, shows response documents in a hierarchy.

shrinkrows

If the number of lines per row (rowlinecount attribute) is greater than one, shrinks the rows to fit the line content. If the rowlinecount attribute is set to two, but the content of a row only requires one line, displays the row in one line, preventing blank lines from enlarging the view.

totalscolor

Color for a column total row. A total row is a row that displays at the end of a view and calculates totals, averages, or percents for a column's numeric values.

uniquekeys

If true, includes unique keys in the index to enable ODBC access.

unreadcolor

Color for unread rows.

unreadmarks

Displays or omits an asterisk next to unread documents. The unreadonly option displays an asterisk for unread main and response documents as well as categories that contain collapsed, unread documents. See the %view.unreadmarks; entity for a list of options. The anychild option displays an asterisk for unread main and response documents only.

%view.headers;

The %view.headers; entity lists the header options for the style properties of views or folders. This entity is used in the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % view.header "none | simple | beveled ">

beveled

The column header displays with a beveled border.

none

The show column headings option is deselected; no column header is visible.

simple

The column header displays with no visible border.

%view.rowspacings;

The %view.rowspacings; entity lists the options for the amount of space between rows in views and folders. This entity is used in the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % view.linespacings "1 | 1.25 | 1.5 | 1.75 | 2 ">

%view.unreadmarks;

The %view.unreadmarks; entity lists the options for the way in which unread documents are marked in views or folders. This entity is used in the %view.and.folder.attrs; entity.

Syntax:

<!ENTITY % view.unreadmarks "none | unreadonly | standard ">

none

Does not mark unread documents.

standard

Marks a document as unread if it or any of its descendants are unread; this includes collapsed categories that contain unread documents.

unreadonly

Marks unread main and response documents only.