DITA Syntax Diagram Domain ============================================================= HEADER ============================================================= MODULE: DITA Syntax Diagram Domain VERSION: 2.0 DATE: [[[Release date]]] PURPOSE: Declaring the elements and specialization attributes for the Syntax Diagram Domain ============================================================= ============================================================= PUBLIC DOCUMENT TYPE DEFINITION TYPICAL INVOCATION Refer to this file by the following public identifier or an appropriate system identifier PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Syntax Diagram Domain//EN" Delivered as file "syntaxdiagramDomain.mod" ============================================================= (C) Copyright OASIS Open 2005, 2009. (C) Copyright IBM Corporation 2001, 2004. All Rights Reserved. UPDATES: ============================================================= elementdomain syntaxdiagram-d -//OASIS//ELEMENTS DITA Syntax Diagram Domain//EN -//OASIS//ENTITIES DITA Syntax Diagram Domain//EN urn:oasis:names:tc:dita:rng:syntaxdiagramDomain.rng
DOMAIN EXTENSION PATTERNS
ELEMENT TYPE NAME PATTERNS
COMMON ATTRIBUTE SETS
LONG NAME: Universal Attributes Local Importance Provide an alternative set of univ-atts that allows importance to be redefined locally new changed deleted unchanged -dita-use-conref-target
ELEMENT TYPE DECLARATIONS
LONG NAME: Variable default optional required -dita-use-conref-target element defines a variable for which the user must supply content, such as their user name or password. It is represented in output in an italic font. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Syntax Phrase ) element is a container for syntax definition elements. It is used when a complete syntax diagram is not needed, but some of the syntax elements, such as kwd, oper, delim, are used within the text flow of the topic content. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Operator default optional required -dita-use-conref-target ) element defines an operator within a syntax definition. Typical operators are equals (=), plus (+) or multiply (*). This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Delimiter optional required -dita-use-conref-target ) element defines a character marking the beginning or end of a section or part of the complete syntax. Typical delimiter characters are the parenthesis, comma, tab, vertical bar or other special characters. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Separator optional required -dita-use-conref-target ) element defines a separator character that is inline with the content of a syntax diagram. The separator occurs between keywords, operators or groups in a syntax definition. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Syntax Diagram ) element is the main container for all the syntax elements that make up a syntax definition. The syntax diagram represents the syntax of a statement from a computer language, or a command, function call or programming language statement. Traditionally, the syntax diagram is formatted with railroad tracks that connect the units of the syntax together, but this presentation may differ depending on the output media. The syntax diagram element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Syntax Block ) element organizes small pieces of a syntax definition into a larger piece. The syntax block element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Sequence Group default required optional -dita-use-conref-target element is part of the subset of elements that define syntax diagrams in DITA. A group is a logical set of pieces of syntax that go together. Within the syntax definition, groups of keywords, delimiters and other syntax units act as a combined unit, and they occur in a specific sequence, as delimited by the element. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Choice Group default required optional -dita-use-conref-target element is part of the subset of elements that define syntax diagrams in DITA. A group is a logical set of pieces of syntax that go together. A group choice specifies that the user must make a choice about which part of the syntax to use. Groups are often nested. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Composite group default required optional -dita-use-conref-target element is part of the subset of elements that define syntax diagrams in DITA. A group is a logical set of pieces of syntax that go together. The group composite means that the items that make up the syntax diagram will be formatted close together rather than being separated by a horizontal or vertical line, which is the usual formatting method. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Fragment is a labeled subpart of the syntax. The element allows breaking out logical chunks of a large syntax diagram into named fragments. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Fragment Reference optional required -dita-use-conref-target ) element provides a logical reference to a syntax definition fragment so that you can reference a syntax fragment multiple times, or pull a large section of syntax out of line for easier reading. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Syntax Diagram Note ) element contains a note (similar to a footnote) within a syntax definition group or fragment. The syntax note explains aspects of the syntax that cannot be expressed in the markup itself. The note will appear at the bottom of the syntax diagram instead of at the bottom of the page. The syntax block element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Syntax Note Reference ) reference element references a syntax note element () that has already been defined elsewhere in the syntax diagram. The same notation can be used in more than one syntax definition. The syntax note reference element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Repeat Separator optional required -dita-use-conref-target ) element in a syntax diagram defines a group of syntax elements that can (or should) be repeated. If the element contains a separator character, such as a plus (+), this indicates that the character must be used between repetitions of the syntax elements. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
LONG NAME: Syntax Keyword default required optional -dita-use-conref-target element defines a keyword within a syntax diagram. A keyword must be typed or output, either by the user or application, exactly as specified in the syntax definition. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information. Category: Programming elements ]]>
SPECIALIZATION ATTRIBUTE DECLARATIONS