Next: 2  Package document Up: RichDoc Framework XML Format Specification Previous: RichDoc Framework XML Format Specification


1 Package core

Class styleElement

A class of elements that may contain custom style definition. This includes contentElements, i.e. elements that correspond to visible material, or for example paragraphFragments, that only group visible material together.

Attributes: class id userId language

Content: style? indexEntryRef?

Class contentElement

Elements that represent visible parts of the document, such as words, paragraphs or sections.

Attributes: class id userId language

Content: style? indexEntryRef?

Class numbered

Elements that are automatically numbered, such as sections, floatings or displayedMath equations. The numbering may be supressed by the hasNumber element.

Attributes: hasNumber class id userId language

Content: style? indexEntryRef?

Class titled

Element that may have title, in the form of the title child element. Any element may have at most one title, and the title must be the first block element of the enclosing element.

Attributes: class id userId language

Content: style? indexEntryRef? title? block*

Class other

Attribute id

This attribute is used throughout the RichDoc framework format to provide globally-unique identifiers for particular elements of the framework. This identification is usually synthesized automatically, and is not intended to be displayed to the user. There is no requirement on possible values of the ID, but it is sometimes used as a file name, so it should not contain any values that prevents such usage. Also note that although it is intended to be interpreted case-sensitive, using it in case-insensitive contexts, such as MS Windows-based file systems, may cause problems. Currently, the framework synthesize the id as twelve-byte random number, encoded using modified BASE-64 encoding. The modification replaces the slash character ‘/’ with the hyphen character ‘-’.

Attribute userId

Identification of element that is intended to be provided and referenced by end users. There is, however, no guarantee that this identifier is unique.

Attribute class

Specifies a variant of the element. The usage is similar to HTML class mechanism.

Attribute language

Specifies the language of this element and its children, unless the children override the value. The value should be Java-compatible locale specification, such as cs, en, or en_US.

Attribute hasNumber

Supresses numbering of the enclosed numbered element.

Attribute title

Attribute width(bitmap)

Attribute height(bitmap)


Next: 2  Package document Up: RichDoc Framework XML Format Specification Previous: RichDoc Framework XML Format Specification