This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.
The element describes an option that can be used to modify a command (or something else, like a configuration). If the target contains non-XML characters such as < and &, those will need to be handled in a way that they may be displayed correctly by the final rendering engine. When evaluated the coderef element should cause the target code to be displayed inline. The codref element allows a reference to an external file that contains literal code.
Like the element, content of this element has preserved line endings and is output in a monospaced font. The element represents lines of program code. The code phrase is displayed in a monospaced font for emphasis.
The code phrase ( ) element represents a snippet of code within the main flow of text. elements may use to reference the short and expanded versions of that Topics are used to define acronyms, this will remind authors to create a key which Key by which inline terms may reference their definition. It has a required keys attribute, which forces the author to create a
The element is a convenience element for creating a reference When rendering an element. Processors should display the referenced term
Generally defined in a topic. The element represents a reference to a term that mayĪppear in an abbreviated form (often an acronym). Formatting may vary depending on your output process.
Subscripted text is often a smaller font than Lower in relationship to the surrounding text.
This element is part of the DITA highlighting domain.Ī subscript ( ) indicates that text should be subscripted, or placed SuperscriptsĪre usually a smaller font than the surrounding text. Superscripted, or vertically raised in relationship to the surrounding text.
The superscript ( ) element indicates that text should be The teletype ( ) element is used to apply monospaced highlighting to The italic ( ) element is used to apply italic highlighting to the The underline ( ) element is used to apply underline highlighting to the ThisĮlement is part of the DITA highlighting domain.
ForĮxample, for specific items such as GUI controls, use the element. Use this element only when there is not some other more proper element.
The bold ( ) element is used to apply bold highlighting to the content