6.7 Element Properties

The following element properties can be assigned using the @props attribute in the <element> definition element. Processors and editors should use the properties, not the element name, to determine how to handle the element and its content.

The elements described in the uDoc documentation are all predefined in stdelems.mxl. If a specific <doc>, <map>, or <lib> also defines any, the definition in the <doc> overrides the standard one. The following set of properties should be understood by processors and editors:

Block element properties:

   Root    defines the start and end of a uDoc file
    Doc     uDoc document file, with text content
    Map     uDoc map file, organizes doc files into a project
    Lib     uDoc library file, contains resources referenced by doc or map
   Group   groups consecutive elements for any purpose
   NoLevel does not affect the hierarchical level for nested content or docs
    Start   is a starting element
   Num     is numbered; used for ol lists or other numbered elements
   Sub     is used to distingish list types, cites, and subtitles
   Seq     is used to identify inline text sequences like menu selections
   Sect    is a section of mainly text elements that increases level and nests
   Table   groups elements in rows and columns
    Col     contains column properties
    Row     contains row properties and cells
    Cell    contains block and text elements
   Fig     contains an image or other non-text object; can be a table or example
    Image   is a graphic element used as a block
    Object  is a non-graphic and non-text element such as audio
     Param   is a parameter for an object
   List    is a sequential group of items that may be numbered, bulleted, or plain
   PList   is a sequential group of pairs of items
    Item    is a member of a list
   Note    is an element with title, text paragraphs, and possibly icon
   Comment contains content not to be shown in the final doc
   Short   identifies a short tag used in tag minimization

Text contains inline elements and text, but not block or other text elements

   Text    is allowed to contain text
   Para    contains a text paragraph where spaces are normalized
   Pre     is text in which line endings and spaces are preserved
   Title   contains text to be used in references to the containing element
   Usage   describes the purpose of an element or attribute; not rendered
   Quote   contains a quoted paragraph, language-dependent
   Alt     is a text element for use if graphic cannot be shown
   Desc    is a description used for mouseover

Inline contains other inline elements and text, but not block or text elements

   Inline  is an inline element
   Gloss   is a term for which reference is made to the glossary
   Abbr    is an abbreviation which may have special processing
   Tmark   is a trademark, service mark, or the like
   Marker  is a data item associated with a particular text location
   Index   is an index term to be associated with the containing element
   Var     is a variable that provides text content
   Fnote   is a footnote or endnote
   Break   is a required break for a line, column, or page
   Tab     is a tab, left, center, right, or decimal at a fixed position
   Typo    is a typographic property applied to the contained text

Data is a block element that contains metadata not rendered as text

   Data    contains data as opposed to text
   Date    is a general-purpose date element, default yyyy-mm-dd
   CSH     is an alias used for Context-Sensitive Help
   Code    contains the code associated with an element, such as CSS for typographics

Ref is a block element that references content, data, or definitions elsewhere

   Ref     is a reference element
   File    is a reference to a file or URL
   Dir     is a reference to a directory to query
   DB      is a reference to a database to query
   Web     is a reference to a search engine to query
   Elem    is a reference to an element
   Rel     is a reference to a related document
   Ext     is a reference to an external preprocessed document

Def is a block element that contains a definition

   Def     is a definition element
   Cond    is a definition of a condition to be used in the project
   Output  is a definition used for a specific type of output, like HTML
   Attr    is a definition of an attribute
   Syn     is a definition of a synonym for the containing item
   Key     is a definition of a reference key, possibly in another project

The groupings above are for convenience, and are not restrictive. For example, the <codeph> element defined earlier uses text, inline, and code, which are in three different groups.

Previous Topic:  6.6 Content Models

Next Topic:  6.8 Element Attributes

Parent Topic:  Chapter 6. uDoc Elements

Sibling Topics:

6.1 Creating New Elements

6.2 Events and Ranges

6.3 Range Generation

6.4 Creating New Shorthand Symbols

6.5 Foreign Elements

6.6 Content Models

6.8 Element Attributes