automatically generated HTML documentation of "macros-commented.dtd" 

 DTD for GMT Macros files 
 28.01.04: change names: group-ref to group-include, macro-ref(inside macro) to macro-include, link-simple to GMT-LINK, link-ext to GMT-LINK_EXT 
 17.03.04: add text-node and comment-node and description of new text-macros inside attribute-values 
 30.04.04: add macros-group-include and update description of text-macros inside attribute-values 
 May 04:   add constant-def to macro element

possible Root Element(s): gmt-macros

Elements (unsorted and grouped by DTD parts)

Element: gmt-macros
Description: 
 gmt-macros is the root element
 - it must have exactly 2 children: macros-def and structure-def (=the top level group)
Content:
original declaration of children: (macros-def,structure-def)
Attribute Type (Value) Type (Definition) Defaultvalue
lang-id CDATA optional -
description CDATA optional -
Description of attribute lang-id: 
 This attribute is not used in the current release. It is intended to specify the XML-Language.
Description of attribute description: 
 This attribute is not used in the current release. It can be used to specify a description of this macros file.
gmt-macros is never used (root element?). .

top

Macros definition part:

Element: macros-def
Description: 
 the macros-def element contains all macro definitions: at least one macro-group or one macro
Content:
original declaration of children: ((macros-group|macro)+)
No Attributes.
macros-def is used in: gmt-macros.

top

Element: macros-group
Description: 
 with the macros-group element macros - which belongs togehter - can be combined;
 macros-group's are currently not shown in the macros view of the GMT - they are only useful 
 when editing a macros file in a XML editor
Content:
original declaration of children: ((macros-group|macro)+)
Attribute Type (Value) Type (Definition) Defaultvalue
name CDATA optional -
description CDATA optional -
Description of attribute name: 
 name of the macros-group
Description of attribute description: 
 description of the macros-group
macros-group is used in: macros-def, macros-group.

top

Element: macro
Description: 
 the macro element defines a macro (i.e. a structure of XML elements 
 which belongs togehter); a macro may contain one or more references 
 to elements, other macros or to the special link-def "macro"
Content:
original declaration of children: (constant-def*,(element-ref|text-node|comment-node|macro-include|GMT-LINK|GMT-LINK_EXT)+)
Attribute Type (Value) Type (Definition) Defaultvalue
name ID required -
description CDATA optional -
standalone (true|false) optional true
Description of attribute name: 
 the name of this macro
Description of attribute description: 
 an optional description for this macro - it will appear in the GMT as 
 a tooltip when the mouse is over the list element in the structure view
Description of attribute standalone: 
 indicates if the XML document stays valid after this macro is inserted (true)
 or if further macros/elements have to be inserted to this macro (false)
macro is used in: macros-def, macros-group.

top

Element: element-ref
Description: 
 with the element-ref element you can define an element which 
 may have attributes and can contains other elments; in the current version 
 the GMT will not check if this is an valid element
Content:
original declaration of children: (attribute-ref|element-ref|text-node|comment-node|macro-include|GMT-LINK|GMT-LINK_EXT)*
Attribute Type (Value) Type (Definition) Defaultvalue
name NMTOKEN required -
Description of attribute name: 
 the name of the referenced element
element-ref is used in: element-ref, macro.

top

Element: attribute-ref
Description: 
 with the attribute-ref element you can define an attribute for the element
 which is defined with the surrounding element-ref element;
  the GMT will not check if the name and the value of this attribute is valid for the element
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name NMTOKEN required -
value CDATA required -
default-value CDATA optional -
Description of attribute name: 
 the name of this attribute
Description of attribute value: 
 the value of this attribute - 
 currently there are special "text-macros" for attributes (and text-/comment-nodes) interpreted by the GMT:
       %INPUT% - the user is asked for a value - if the user cancels the input,
           the attribute won't be inserted;
       %TEXT% - if text in the other side is selected the selected text will be 
           used as the value, otherwise the attribute won't be inserted,
       %DATE% - will be replaced with the current date,	
       %TIME% - will be replaced with the current time,
       %USER% - will be replaced with the current user (is not fully supported yet),
       %LINK-ID% - will be replaced with the (next) link id, which will also be 
           used in the HTML link in the HTML view - is used in link-def
       $CONST_NAME$ - will be replaced with the text-value of string constant CONST_NAME; the first time a constant is accessed user input 
           is required; if its is in upper case characters it is a global constant, otherwise it is local (only valid in current macro)
       #COUNTERNAME# - will be replaced with "#COUNTERNAME{successive number}", e.g. #A-000# = #A-001, #A-002, #A-003;  ## = #1, #2, #3 
       {XPath-Expression} - will be replaced by the result of the XPath expression applied to the selected element in the current file
       [XPath-Expression] - will be replaced by the result of the XPath expression applied to the selected element in the other file
Description of attribute default-value: 
 defines a default value - makes only sense if used together with '%INPUT%' as value
attribute-ref is used in: element-ref.

top

Element: text-node
Description: 
 creates a text-node (PCDATA)
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
value CDATA required -
default-value CDATA optional -
Description of attribute value: 
 the value of this text-node
Description of attribute default-value: 
 defines a default value - makes only sense if used together with '%INPUT%' as value
text-node is used in: element-ref, macro.

top

Element: comment-node
Description: 
 creates a comment-node
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
value CDATA required -
default-value CDATA optional -
Description of attribute value: 
 the value of this comment-node
Description of attribute default-value: 
 defines a default value - makes only sense if used together with '%INPUT%' as value
comment-node is used in: element-ref, macro.

top

Element: constant-def
Description: 
 defines a string constant which can be used inside the value-attribute of 
     attribute-ref, text-node and comment-node elements using $CONST_NAME$ or $const_name$
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name CDATA required -
value CDATA required -
Description of attribute name: 
 name of the constant to be defined
Description of attribute value: 
 value of the constant; see attribute-ref for special values
constant-def is used in: macro.

top

Element: macro-include
Description: 
 copies the content of the referred macro into the current macro
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name IDREF required -
Description of attribute name: 
 name of the referred macro
macro-include is used in: element-ref, macro.

top

Element: GMT-LINK
Description: 
 will be replaced by <(*gmt-link link-id="%LINK-ID%"/*)
Content: No children.
original declaration of children: EMPTY
No Attributes.
GMT-LINK is used in: element-ref, macro.

top

Element: GMT-LINK_EXT
Description: 
 will be replaced by (*gmt-link link-id="%LINK-ID%" comment="%INPUT% %TEXT%" created-at="%DATE%, %TIME%" created-by="%USER%"/*)
Content: No children.
original declaration of children: EMPTY
No Attributes.
GMT-LINK_EXT is used in: element-ref, macro.

top

Structure definition part:

Element: structure-def
Description: 
 structure-def contains the root-group of the macros structure as shown in GMT's structure view
Content:
original declaration of children: (group|group-include|group-link|macro-ref|single-element-ref|separator|label)+
No Attributes.
structure-def is used in: gmt-macros.

top

Element: group
Description: 
 a group contains one or more sub-groups, group-refs, macro-refs or single-element-refs
Content:
original declaration of children: (group|group-include|group-link|macro-ref|single-element-ref|separator|label|macros-group-include)*
Attribute Type (Value) Type (Definition) Defaultvalue
name CDATA required -
description CDATA optional -
Description of attribute name: 
 the name of this group
Description of attribute description: 
 an optional description for this element - will appear in the GMT as a tooltip 
 when the mouse is over the list element in the structure view
group is used in: group, structure-def.

top

Element: macro-ref
Description: 
 with macro-ref you can refer to an existing macro;  
 if a macro-ref element is used in a macro definition
 (i.e. in a macro or element-ref element), the macro-ref element will be replaced 
 with the contents of the refered macro
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name IDREF required -
label CDATA optional -
Description of attribute name: 
 the name of an existing macro
Description of attribute label: 
 the optional label attribute can be used to define a different label 
 (instead of the name) for the list-element in the structure view of the GMT
macro-ref is used in: group, structure-def.

top

Element: group-include
Description: 
 with group-include you can include an existing group 
 (i.e. defined somewhere else in the structure definition part);
 in the GMT it looks the same as the refered group 
   (i.e. it seems that the refered group is defined twice)
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name CDATA required -
label CDATA optional -
Description of attribute name: 
 the name of an existing group
Description of attribute label: 
 the optional label attribute can be used to define a different label 
 (instead of name) for the list-element in the structure view of the GMT
group-include is used in: group, structure-def.

top

Element: macros-group-include
Description: 
 inserts a new group with containing the macros of referenced macros-group; convenient way to quick add new macros
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name CDATA required -
Description of attribute name: 
 name of macros-group to be included
macros-group-include is used in: group.

top

Element: group-link
Description: 
 represents a link to a group
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name CDATA required -
label CDATA optional -
description CDATA optional -
Description of attribute name: 
 the name of an existing group
Description of attribute label: 
 the optional label attribute can be used to define a different label 
 (instead of name) for the list-element in the structure view of the GMT
Description of attribute description: 
 description for this group-link - will be shown as tooltip
group-link is used in: group, structure-def.

top

Element: single-element-ref
Description: 
 unlike element-ref a single-element-ref is used to define only a single element  
 it's the same as a macro-ref refering to a macro with only a single element-ref;
 if you want to define attributes with to single element, you have to use macro-ref/macro
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
name NMTOKEN required -
description CDATA optional -
standalone (true|false) optional true
Description of attribute name: 
 the name of the element
Description of attribute description: 
 an optional description for this element - will appear in the GMT as a tooltip 
       when the mouse is over the list element in the structure view
Description of attribute standalone: 
 indicates if the XML document stays valid after this element is inserted (true)
 or if further macros/elements have to be appended to this element (false)
single-element-ref is used in: group, structure-def.

top

Element: separator
Description: 
 inserts a separator (line) - use this to group macros/elements which belong together
Content: No children.
original declaration of children: EMPTY
No Attributes.
separator is used in: group, structure-def.

top

Element: label
Description: 
 inserts a label - useful together with separator to describe a part of a group
Content: No children.
original declaration of children: EMPTY
Attribute Type (Value) Type (Definition) Defaultvalue
text CDATA required -
description CDATA optional -
Description of attribute text: 
 the text of the label
Description of attribute description: 
 description for this label - will be shown as tooltip
label is used in: group, structure-def.