All Element Summary |
|
The <apiname> element provides the name of an application programming interface (API) such as a Java class name or method name.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The <codeblock> element represents lines of program code.
Type: |
|
Content: |
mixed (allows character data), 22 attributes, 38 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The code phrase (<codeph>) element represents a snippet of code within the main flow of text.
Type: |
|
Content: |
mixed (allows character data), 17 attributes, 33 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Within a syntax definition, the delimiter (<delim>) element defines a character marking the beginning or end of a section or part of the complete syntax.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Within a syntax definition, a <fragment> is a labeled subpart of the syntax.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The fragment reference (<fragref>) element provides a logical reference to a syntax definition fragment so that you can reference a syntax fragment multiple times.
Type: |
|
Content: |
mixed (allows character data), 19 attributes, 32 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The <groupchoice> element is part of the subset of elements that define syntax diagrams in DITA.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The <groupcomp> element is part of the subset of elements that define syntax diagrams in DITA.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The <groupseq> element is part of the subset of elements that define syntax diagrams in DITA.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The <kwd> element defines a keyword in a syntax definition.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The operator (<oper>) element defines an operator within a syntax definition.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The <option> element describes an option that can be used to modify a command (or something else, like a configuration).
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The parameter list (<parml>) element contains a list of terms and definitions that describes the parameters in an application programming interface.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
When referencing the name of an application programming interface parameter within the text flow of your topic, use the parameter name (<parmname>) element to markup the parameter.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
A parameter definition, within a parameter list entry, is enclosed by the <pd> element.
Type: |
|
Content: |
mixed (allows character data), 17 attributes, 60 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The parameter list entry element (<plentry>) contains one or more parameter terms and definitions (pd and pt).
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
A parameter term, within a parameter list entry, is enclosed by the <pt> element.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 35 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The repeat separator (<repsep>) element defines a group of syntax elements that can (or should) be repeated.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The separator (<sep>) element defines a separator character that is inline with the content of a syntax definition.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The syntax block (<synblk>) element organizes small pieces of a syntax definition into a larger piece.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The syntax note (<synnote>) element contains a note (similar to a footnote) within a syntax definition group or fragment.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 30 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The syntax note (<synnoteref>) reference element references a syntax note element (<synnote>) that has already been defined elsewhere in the topic.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
The syntax phrase (<synph>) element is a container for syntax definition elements.
Type: |
|
Content: |
mixed (allows character data), 17 attributes, 9 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
The syntax diagram (<syntaxdiagram>) element is the main container for all the syntax elements that make up a syntax definition.
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Within a syntax definition, the <var> element defines a variable for which the user must supply content, such as their user name or password.
Type: |
|
Content: |
mixed (allows character data), 18 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
Complex Type Summary |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 21 attributes, 38 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 16 attributes, 33 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 18 attributes, 32 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 16 attributes, 60 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 35 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 30 elements |
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
|
|
Content: |
mixed (allows character data), 17 attributes, 13 elements |
Defined: |
|
Includes: |
|
Used: |
|
|