embeddedoutline (Domino DTD)

For more details, see Selected embedded outline properties.

Containment Hierarchy

Contained by: %richtext.nonhot.inline;

Contains: <border>, <control>, <sublevel>, <title>, <toplevel>, <twistieimage>

Syntax

<!ELEMENT embeddedoutline ( control?, title?, toplevel?, sublevel?, twistieimage?, border? )>

Content

control?, title?, toplevel?, sublevel?, twistieimage?, border?

Contains an optional <control> element, followed by optional <title>, <toplevel>, <sublevel> <twistieimage>, and <border> elements.

Attributes

<!ATTLIST embeddedoutline

>

characters

Number of characters making up the width of the embedded outline. This attribute is required if the value of the widthtype attribute is the 'fixedcharacter' option of the %eoutline.sizetypes; entity.

columnwidth

Width of the embedded outline columns in inches.

database

Name of the database containing the outline being embedded. This string value can be a database's replica ID or one of the keywords defined in the %named.element.link.databases; entity which represent special databases that are commonly linked to.

display

When the embedded outline has a flat style, this attribute determines how the outline displays. Can be any of the options in the %outline.displaydirections; entity.

expand

When the embedded outline has a tree style, this attribute determines how the entries display when the form containing the outline first displays. Can be any of the options in the %outline.expandtypes; entity.

height

Height of the embedded outline.

heighttype

Specifies the types of height settings you can apply to an embedded outline. Can be any of the options in the %eoutline.sizetypes; entity.

imagelabel

Boolean value. If true, indicates that the entry or title label includes an image.

name

Name assigned to the outline embedded in the form.

outline

Name of the outline design.

rootname

Name of the toplevel entry you want to display by default. This enables you to restrict user access to other elements in your database.

samebackground

Boolean value. If true, applies one set of background properties to the Top-level, Sub-level, and Title entries, as well as the control.

samefont

Boolean value. If true, applies one set of font properties to the Top-level, Sub-level, and Title entries.

scrollbars

Boolean value. If true, indicates that the Show scroll bar checkbox on the Info tab of the Embedded Outline properties box is selected; displays a scrollbar in the embedded outline.

showfolderunread

Boolean value. If true, displays a folder's unread documents.

showtwistie

Boolean value. If true, displays a twistie that users can click to expand or collapse an entry.

showviewcontents

Boolean value. If true, displays the folder or view contents in the outline. This option is only available with subscription and bookmark database types.

targetframe

Name of the frame to display data in or to open any linked entries in.

tileimage

Boolean value. If true, tiles the background image, which means it repeats the same image several times across the background until it fills it.

type

Defines the outline type. Can be any of the options in the %outline.types; entity.

useappletinbrowser

Boolean value. If true, specifies to display the embedded outline as a Java applet on the Web. If false, uses HTML to display the outline.

width

Width of the embedded outline.

widthtype

Specifies the types of width settings you can apply to an embedded outline. Can be any of the options in the %eoutline.sizetypes; entity.

Defined entities for <embeddedoutline> element

The %eoutline.sizetypes; entity specifies the types of height and width settings you can set for an embedded outline.

Syntax:

<!ENTITY % eoutline.sizetypes "fixed | fitwindow | fitcontent | fixedcharacter ">

fitcontent

Automatically adjusts the size of the outline to fit its content, including any expanded entries.

fitwindow

Automatically adjusts the size of the outline to fit into the design element it is embedded in.

fixed

Fixed width and height, in inches.

fixedcharacter

Sets the width of the outline to a specific number of character spaces in length. The number of characters is specified in the characters attribute of the embeddedoutline element.

The %outline.displaydirections; entity defines the direction in which a flat style outline displays.

Syntax:

<!ENTITY % outline.displaydirections "vertical | horizontal">

The %outline.expandtypes; entity defines how a tree style outline displays its entries when the form containing that outline first displays.

Syntax:

<!ENTITY % outline.expandtypes "all | first | saved | none ">

all

Expands all the entries by default when the outline displays.

first

Expands the first entry by default when the outline displays.

none

Collapses all the entries by default when the outline displays.

saved

Expands only those entries that were expanded before the outline was last saved.

The %outline.types; entity defines the types of embedded outlines that can be included in a page.

Syntax:

<!ENTITY % outline.types "flat | tree ">

flat

Displays one level of entries at a time. Initially displays the top-level or outdented main entries, which expand to display any entries indented below them. Once the sub-level entries for one top-level entry are displayed, the user has no access back to the top-level outline display, unless you provide an action button to navigate to it.

tree

Displays the embedded outline with a visible hierarchical structure. Tree outlines display outdented, main entries that have other entries indented under them as expandable sections.