Domain specializations
Domains in this section include those generally associated with technical content, such as the programming and software domains.
Abbreviated-form domain elements
The abbreviated-form domain contains an element that can be used, in conjunction with a glossary entry topic, for rendering different versions of a term on first and later occurrences in a publication.
<abbreviated-form>
The <abbreviated-form> element represents
a reference to a term that might appear in an abbreviated form. The
abbreviated form often is an acronym.
Usage information
The <abbreviated-form> element typically is used in conjunction with
a glossary entry topic that defines a term and an acronym. The
glossary entry topic might also provide a surface form that specifies both the term and the
acronym. The surface form is intended to be rendered on first
use or in introductory contexts where the term might be unfamiliar to a reader. In other
contexts, processors typically render the abbreviated form of the term. Note that the
definition of an introductory context will differ for every deliverable format and is highly
processor-specific.
For instance, a process composing a book deliverable might render
the surface form of a term on the first reference to the
<glossentry> topic within the book or for
every reference within a copyright or a warranty-related warning. A
process generating an online page might render the surface form as
a hover tooltip on every instance of the term.
Rendering expectations
Specialization hierarchy
The <abbreviated-form> element is specialized from
<term>. It is defined in the abbreviated-form domain module.
Content model
EMPTY
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<xref>
Empty
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<xref>
Inheritance
+ topic/term abbrev-d/abbreviated-form
The <abbreviated-form> element is specialized from
<term>
. It is defined in the abbrev-domain module.
Attributes
The following attributes are available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
This section contains examples of how the
<abbreviated-form> element works in
conjunction with a glossary entry topic that defines a term and its
variations.
The following code sample shows the markup for a simple glossary entry topic:
<glossentry id="id-attribute-value">
<glossterm>Anti-lock Braking System</glossterm>
<glossBody>
<glossSurfaceForm>Anti-lock Braking System (ABS)</glossSurfaceForm>
<glossAlt>
<glossAcronym>ABS</glossAcronym>
</glossAlt>
</glossBody>
</glossentry>For the purposes of rendering, the code sample contains three important elements:
<glossSurfaceform>- Defines the term as it should be rendered on first use. Typically this is the long form of a term, followed by an abbreviation or acronym. Note that other languages often do not follow the same conventions as English.
<glossAcronym>- Defines the terms as it should be rendered on second or later us. Typically this is the acronym or abbreviation that is associated with the term.
<glossterm>- Provides a fallback version of the term, which will be displayed in situations where the preferred representation is unavailable.
In order for the <abbreviated-form>
element to reference the glossary entry topic, the glossary entry
topic must be associated with a key. This can happen using
standard key definition, or a map architect can use the
specialized <glossref> element"
<glossref keys="abs" href="antilock.dita"/><abbreviated-form> element
references the keyThe <abbreviated-form> element references
the key defined for the glossary entry topic, for example:
<section>An <abbreviated-form keyref="abs"/> helps a driver to stop. For this reason
many find an <abbreviated-form keyref="abs"/> useful.
<!-- ... -->
</section>The typical rendering is that the first use of the
<abbreviated-form keyref="ab"> will result
in the surface form of the term, while subsequent usages will
result in the acronym, as shown in the following screen
capture:
Do note, however, that processors implement varying levels of
support for the <abbreviated-form>
element.
Equation domain
The equation domain includes elements that authors can use to identify, number, and format equations within a document. This domain can be used independently of the MathML domain.
Example
This section is non-normative.
<equation-block>
The <equation-block> element represents
an equation that is presented as a separate block within a text flow or
an <equation-figure>.
Usage information
When an <equation-block> element has multiple direct child elements,
each child represents an alternative form of the equation.
Rendering expectations
Block equations can be numbered.
Processing expectations
When there are multiple forms of an
equation, processors can choose the form or forms that they render.
For example, if there is both an image and MathML markup, an
HTML-generating processor could generate both the image reference
and the MathML with appropriate HTML @class or
@id values to enable dynamic rendering that is based on browser capability.
Specialization hierarchy
The <equation-block> element is specialized from
<div>. It is defined in the equation domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how an
<equation-block> element can include two
alternative forms of the same equation:
<equation-block>
<!-- Imaged-based equation -->
<image keyref="equation-image-01">
<alt>a squared plus b squared.</alt>
</image>
<!-- MathML-based equation -->
<mathml>
<m:math>
<m:semantics>
<m:mrow>
<m:msqrt>
<m:mrow>
<m:msup><m:mi>a</m:mi><m:mn>2</m:mn></m:msup>
<m:mo>+</m:mo>
<m:msup><m:mi>b</m:mi><m:mn>2</m:mn></m:msup>
</m:mrow>
</m:msqrt>
</m:mrow>
</m:semantics>
</m:math>
</mathml>
</equation-block><equation-figure>
The <equation-figure> element is a container for equations and their supporting
information.
Usage information
Equation figures can have titles,
descriptions, figure groups, and all other figure components. The
direct children of <equation-figure> can be
the equation content itself (for example,
<mathml> or an image reference), or it can
be one or more <equation-block> elements,
along with other elements allowed within figures.
When an <equation-figure> element has multiple direct child
<mathml>, <equation-block>,
<image>, or <pre> elements, each child
represents an alternative form of the equation.
When the intent is to combine equations
and commentary within an
<equation-figure>, use child
<equation-block> elements to contain the
equations and so clearly distinguish them
from the commentary.
Rendering expectations
Equation figures can be numbered. Either
standard figure numbering can be used, or
<equation-number>
elements can be placed within
<equation-block> elements.
Processing expectations
When there are multiple forms of an
equation, processors can choose the form or forms that they render.
For example, if there is both an image and MathML markup, an
HTML-generating processor could generate both the image reference
and the MathML with appropriate HTML @class or
@id values to enable dynamic rendering that is based on browser capability.
Specialization hierarchy
The <equation-figure> element is specialized from
<fig>. It is defined in the equation domain module.
Attributes
The following attributes are available on this element: display attributes and universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@expanse(display attributes)- Specifies the horizontal placement of the element. The
following values are valid:
- column
- Indicates that the element is aligned with the current column margin.
- page
- Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
- spread
- Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
- textline
- Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
For
<table>, in place of the@expanseattribute that is used by other DITA elements, the@pgwideattribute is used in order to conform to the OASIS Exchange Table Model.Some processors or output formats might not support all values.
@frame(display attributes)- Specifies which portion of a border surrounds the element.
The following values are valid:
- all
- Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
- bottom
- Indicates that a line is rendered at the bottom of the containing element.
- none
- Indicates that no lines are rendered.
- sides
- Indicates that a line is rendered at the left and right of the containing element.
- top
- Indicates that a line is rendered at the top of the containing element.
- topbot
- Indicates that a line is rendered at the top and bottom of the containing element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Some processors or output formats might not support all values.
@scale(display attributes)- Specifies the percentage by which fonts are resized in
relation to the normal text size. The value of this attribute
is a positive integer. When used on
<table>or<simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.This attribute is primarily useful for print-oriented display. Some processors might not support all values.
If the
@scaleattribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the<image>element.
Example
This section is non-normative.
The following code sample shows how an
<equation-figure> element can contain both
MathML content and commentary. The MathML content is contained with
a nested <equation-block> element, and it is
followed by commentary that is contained
in a nested <p> element.
<equation-figure>
<title>An equation with commentary</title>
<equation-block>
<mathml>
<m:math display='block'>
<m:semantics>
<m:mrow>
<m:mfrac>
<m:mrow><m:mi>n</m:mi><m:mo>!</m:mo></m:mrow>
<m:mrow><m:mi>r</m:mi><m:mo>!</m:mo>
<m:mrow>
<m:mo>(</m:mo>
<m:mrow><m:mi>n</m:mi><m:mo>−</m:mo><m:mi>r</m:mi></m:mrow>
<m:mo>)</m:mo>
</m:mrow>
<m:mo>!</m:mo>
</m:mrow>
</m:mfrac>
</m:mrow>
</m:semantics>
</m:math>
</mathml>
</equation-block>
<p>Where
<equation-inline><mathml><m:math><m:mi>r</m:mi></m:math></mathml></equation-inline>
is greater than 1.</p>
</equation-figure><equation-inline>
The <equation-inline> element represents an equation that is
presented inline within a paragraph or similar context.
Usage information
Inline equations are not intended to be numbered.
When an <equation-inline> element has multiple direct child
elements, each child represents an alternative form of the equation.
Processing expectations
When there are multiple forms of an
equation, processors can choose the form or forms that they render.
For example, if there is both an image and MathML markup, an
HTML-generating processor could generate both the image reference
and the MathML with appropriate HTML @class or
@id values to enable dynamic rendering that is based on browser capability.
Specialization hierarchy
The <equation-inline> element is specialized from
<ph>. It is defined in the equation domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Examples
This section is non-normative.
This section contains examples of how the
<equation-inline> element can be used.
The following code sample shows how a paragraph can contain an
<equation-inline> element that holds
MathML markup:
<p>Consider the following equation:
<equation-inline>
<mathml>
<m:math display='inline'>
<m:semantics>
<m:mrow>
<m:msqrt>
<m:mrow>
<m:msup><m:mi>a</m:mi><m:mn>2</m:mn></m:msup>
<m:mo>+</m:mo>
<m:msup><m:mi>b</m:mi><m:mn>2</m:mn></m:msup>
</m:mrow>
</m:msqrt>
</m:mrow>
</m:semantics>
</m:math>
</mathml>
</equation-inline>
It is simple arithmetic that school children understand.</p>The following code sample shows how the
<equation-inline> element can contain an
image:
<p>The Pythagorean Theorem describes the relationship among the three sides of a
right triangle. In any right triangle, the sum of the areas of the squares formed on the
legs of the triangle equals the area of the square formed on the hypotenuse:
<equation-inline>
<image keyref="equation-image-01">
<alt>a squared plus b squared.</alt>
</image>
</equation-inline>
</p><equation-number>
The <equation-number> element indicates
that a block equation should be numbered. It
optionally specifies the number to use for the block
equation.
Usage information
In normal usage, a block equation has a single number. However,
the <equation-number> element can occur
multiple times within the <equation-block>
element. This enables the use of numbers with different (and
exclusive) conditional properties.
When the <equation-figure> element contains
content, the content of the element should be the number value
without any rendering-specific punctuation,
for example, 3.2a rather than
(3.2a).
Rendering expectations
In this context, white-space content is considered equivalent to
empty content. When the <equation-number>
element has empty content, the equation number SHOULD be generated. When the
<equation-number> element is not empty,
the content SHOULD be used as
the equation number. Processors MAY add punctuation or decoration to the number.
The details of equation numbering and number presentation are processor-specific. A common practice is to present the equation number to the right of the equation, centered vertically within the vertical extent of the block equation.
Specialization hierarchy
The <equation-number> element is specialized from
<ph>. It is defined in the equation domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Examples
This section is non-normative.
This section contains examples of how the
<equation-number> element can be used:
The following code sample shows how an
<equation-number> element can be used to
indicate to a processor that an equation number should be
auto-generated:
<equation-block id="eq-001">
<equation-number/>
<image keyref="equation-image-01">
<alt>a squared plus b squared.</alt>
</image>
</equation-block>The following code sample shows how an
<equation-number> element can specify the
value for an equation number:
<equation-block id="eq-3.2a">
<equation-number>3.2a</equation-number>
<image keyref="equation-image-01">
<alt>a squared plus b squared.</alt>
</image>
</equation-block>Glossary-reference domain elements
<glossref>
Glossary reference topic references are a convenience element for creating references to
glossary topics. It has a required @keys attribute, which forces the author to
create a key by which inline terms can reflect the glossary terms and become navigable links to
the glossary definition. For example, when <glossentry> topics are used
to define acronyms, this reminds authors to create a key that
<abbreviated-form> elements can use to refer to the short and expanded
versions of the acronyms.
Usage information
Note that the key names defined in the@keys attribute do not need to match the target term or acronym. Using
more qualified values or distinct key scopes for the keys will reduce conflicts in situations
where the same key name might be associated with different terms. For example, an information
set could use cars.absas the key for the term Anti-lock Braking System, and
ship.absto refer to the term American Bureau of Shipping.
Specialization hierarchy
The <glossref> element is specialized from
<topicref>. It is defined in the glossary reference domain
module.
Attributes
The following attributes are available on this element: link-relationship attributes, universal
attributes, @chunk, @collection-type,
@keyref, @linking, @processing-role,
@search, and @toc.
- The
@hrefattribute is a reference to a glossary definition, typically a<glossentry>topic. - The
@keysattribute is required. - The
@linkingattribute has a default value of none. - The
@tocattribute has a default value of no. - The
@searchattribute has a default value of no.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@chunk(common map attributes)- Specifies how a processor should render a map or branch of a
map. For example, it can be used to
specify that individual topic documents should be rendered as
a single document, or that a single document with multiple
topics should be rendered as multiple documents.The following values are valid:
- combine
- Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
- split
- Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.
Processors can also define custom, implementation-specific tokens for this attribute.
For a detailed description of the
@chunkattribute and its usage, see Chunking. @collection-type(common map attributes)- Specifies how topics or links relate to each other. The
processing default is unordered, although no
default is specified in the OASIS-provided grammar files. The
following values are valid:
- unordered
- Indicates that the order of the child topics is not significant.
- sequence
- Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
- choice
- Indicates that one of the children should be selected.
- family
- Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.
@format(link-relationship attributes)- Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.
@href(link-relationship attributes)- Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref @keys- The
@keysattribute is required. @linking(common map attributes)- Specifies linking characteristics of a topic specific to the
location of this reference in a map. If the value is not specified
locally, the value might cascade from another element in the map
(for cascade rules, see Cascading of metadata attributes in a DITA map).
The
following values are valid:
- targetonly
- A topic can only be linked to and cannot link to other topics.
- sourceonly
- A topic cannot be linked to but can link to other topics.
- normal
- A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
- none
- A topic cannot be linked to or link to other topics.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
@processing-role(common map attributes)- Specifies whether the referenced
resource is processed normally or treated as a resource that is
only included in order to resolve references, such as key or
content references. The following values are valid:
- normal
- Indicates that the resource is a readable part of the
information set. It is included in navigation and search
results. This is the default value for the
<topicref>element. - resource-only
- Indicates that the resource should be used only for
processing purposes. It is not included in navigation or
search results, nor is it rendered as a topic. This is
the default value for the
<keydef>element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.
@scope(link-relationship attributes)- Specifies the closeness of the relationship between the
current document and the referenced resource. The following values are valid:
local, peer,
external, and
-dita-use-conref-target.
See STUB CONTENT for detailed information on supported values and processing implications.
@search(common map attributes)- Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.
@toc(common map attributes)- Specifies whether a topic appears in the table of contents
(TOC) based on the current map context. If the value is not specified
locally, the value might cascade from another element in the map
(for cascade rules, see Cascading of metadata attributes in a DITA map). The following
values are valid:
- yes
- The topic appears in a generated TOC.
- no
- The topic does not appear in a generated TOC.
- -dita-use-conref-target
- See STUB CONTENT for more information.
@type(link-relationship attributes)- Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.
Example
This section is non-normative.
The following code sample demonstrates using a <glossref> element to
include a car-specific glossary entry in the map. The glossary reference has the key "abs".
The <glossref> element is within the key scope "cars", so references
to this glossary entry from outside the "cars" key scope will be of the form
<keyword keyref="cars.abs"/>.
<map>
<!-- ... -->
<topicref href="car-maintenance.dita"/>
<!-- ... -->
<topichead keyscope="cars">
<topicmeta><navtitle>Car Terminalogy</navtitle></topicmeta>
<glossref keys="abs" href="glossary/a/antiLockBrake.dita"/>
<!-- ... key declarations for other referenced acronyms ... -->
</topichead>
</map>When this is map is rendered using typical output processing, the table of contents will
have an entry for the topic head "Car Terminology" but will not have entries for the
glossary entries because <glossref> sets the value of
@toc to no by default.
Hardware domain
The hardware domain elements are used to document physical devices.
<hwcontrol>
A hardware control is a key, button, switch, indicator, or other physical device that controls a piece of hardware.
Specialization hierarchy
The <hwcontrol> element is specialized from
<ph>. It is defined in the hardware domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<draft-comment>
|
<image>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<text>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<apiname> -
<b> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<hwcontrol> -
<i> -
<image> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<text> -
<textentity> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph hw-d/hwcontrol
The <hwcontrol> element is specialized from
<ph>
. It is defined in the hw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<hwcontrol> element can be used to
identify a hardware controls:
<step>
<cmd>After entering the amount you received, press <hwcontrol>Amt Tend</hwcontrol>.</cmd>
<stepresult>This opens the cash drawer. The display shows the amount of change to give the
customer.</stepresult>
</step><partno>
A part number is a unique identifier that is assigned to a hardware component.
Specialization hierarchy
The <partno> element is specialized from
<ph>. It is defined in the hardware domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<draft-comment>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<text>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<apiname> -
<cmdname> -
<data> -
<draft-comment> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph hw-d/partno
The <partno> element is specialized from
<ph>
. It is defined in the hw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how
<partno> can be used to identify a part
number:
<p>The basic model, <partno>DB-123-456</partno>, is an entry model. Most users
can take advantage of all features with little to no set up. The <partno>DB-123-456</partno>
is available with all systems.</p>Markup domain
The markup domain contains an element that can be used for the mention of named components in markup languages.
<markupname>
The <markupname> element identifies
named markup components, for example, elements or attributes in HTML and SGML, named groups in XSD schemas, and
named patterns in RELAX NG schemas.
Usage information
The <markupname> element serves as the
specialization basis for the elements in the XML mention domain.
When the XML mention domain is present, use its more specific
elements instead of <markupname> if
appropriate.
Specialization hierarchy
The <markupname> element is specialized from
<keyword>. It is defined in the markup domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname
The <markupname> element is specialized from
<keyword>
. It is defined in the markup-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<markupname> element can be used to tag an
attribute group:
The <markupname>p.attributes</markupname> attribute group defines
the allowed attributes for the <xmlelement>p</xmlelement> element.MathML domain
The MathML domain elements enable the use of embedded or referenced MathML markup. Referenced MathML markup must be stored in separate, non-DITA XML documents. MathML is a W3C standard.
When MathMLelements are embedded in DITA
documents that are validated using DTDs, the MathML elements
must use a namespace prefix in order to avoid conflict with the
DITA-defined elements of the same name. Documents validated using
RELAX NG can default the MathML namespace on the MathML
<math> element. MathML elements that are
referenced using the <mathmlref> element do
not need to have a namespace prefix, because they are parsed
separately from the DITA documents that refer to them.
By default, the MathML domain is configured to use the namespace prefix "m" for the MathML elements.
<mathml>
The <mathml> element contains MathML
markup or other content that contributes to a semantic
equation.
Usage information
The <mathml> element can contain MathML
elements, references to MathML elements stored in separate, non-DITA documents, or
<data> elements.
The <mathml> element is not intended to represent a semantic
equation, only content that contributes to a semantic equation. Use the equation domain
elements or their equivalent to represent equations semantically, for example, to enable
numbering of equations.
The MathML markup must have a root element of
<math> within the MathML namespace:
http://www.w3.org/1998/Math/MathML.
Specialization hierarchy
The <mathml> element is specialized from
<foreign>. It is defined in the MathML domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how to use a <mathml> element to
include MathML content:
<equation-block>
<mathml>
<m:math>
<m:semantics>
<m:mrow>
<m:msqrt>
<m:mrow>
<m:msup>
<m:mi>a</m:mi>
<m:mn>2</m:mn></m:msup>
<m:mo>+</m:mo>
<m:msup>
<m:mi>b</m:mi>
<m:mn>2</m:mn>
</m:msup>
</m:mrow>
</m:msqrt>
</m:mrow>
</m:semantics>
</m:math>
</mathml>
</equation-block><mathmlref>
The <mathmlref> element references a
non-DITA XML document that contains MathML markup.
Usage information
The <mathmlref> element enables the use
MathML markup by reference. The reference must be to a MathML
<math> element. The reference can be one
of the following:
- A URI that addresses an XML document. The XML document has a
MathML
<math>element as the root element. - A URI that addresses an XML document and contains a fragment
identifier that is the XML ID of a
<math>element within the document.
The reference can be direct, using the @href
attribute, or indirect, using the @keyref
attribute. For indirect referencing, only the key name should be
specified. The ID of the <math> element must
be specified as part of the value for the @href
attribute on the key definition.
For example, to refer to the <math>
element with the @id of
math-fragment-02 within a larger document
using a key reference, you would define the key in the following
way:
<keydef keys="math-fragment-0002" href="mathml/mathml-library.xml#math-fragment-02"/>You reference this key by using just the key name:
<mathref keyref="math-fragment-0002"/>Processing expectations
Processors SHOULD process the
MathML as though the <m:math> element occurs
directly in the content of the containing
<mathml> element.
Specialization hierarchy
The <mathmlref> element is specialized from
<include>. It is defined in the MathML domain module.
Attributes
The following attributes are available on this element: inclusion attributes, universal
attributes, @format, @href, @keyref, and @scope.
- The
@formatattribute has a default value of mml. - The
@hrefattribute is a reference to a MathML document or<mathml>element. If the<mathml>element is the root element of the referenced resource, then no fragment identifier is required. Otherwise, a fragment identifier must be specified, where the fragment identifier is the XML ID of the<mathml>element. - The
@parseattribute has a default value of xml.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@encoding(inclusion attributes)- Specifies the character encoding to use when translating the character
data from the referenced content. The value should be a valid encoding name. If not
specified, processors may make attempts to automatically determine the correct encoding,
for example using HTTP headers, through analysis of the binary structure of the
referenced data, or the
<?xml?>processing instruction when including XML as text. The resource should be treated as UTF-8 if no other encoding information can be determined.When
parse="xml", standard XML parsing rules apply for the detection of character encoding. The necessity and uses of@encodingfor non-standard values of@parseare implementation-dependent. @format(link-relationship attributes)- Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.
@href(link-relationship attributes)- Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref @parse(inclusion attributes)- Specifies the processing expectations for the referenced resource. Processors must
support the following values:
- text
-
The contents should be treated as plain text. Reserved XML characters should be displayed, and not interpreted as XML markup.
- xml
-
The contents of the referenced resource should be treated as an XML document, and the referenced element should be inserted at the location of the
<include>element. If a fragment identifier is included in the address of the content, processors must select the element with the specified ID. If no fragment identifier is included, the root element of the referenced XML document is selected. Any grammar processing should be performed during resolution, such that default attribute values are explicitly populated. Prolog content must be discarded.It is an error to use
parse="xml"anywhere other than within<foreign>or a specialization thereof.
Processors may support other values for the
@parseattribute with proprietary processing semantics. Processors should issue warnings and use<fallback>when they encounter unsupported@parsevalues. Non-standard@parseinstructions should be expressed as URIs.Note (non-normative):Proprietary@parsevalues will likely limit the portability and interoperability of DITA content, so should be used with care. @scope(link-relationship attributes)- Specifies the closeness of the relationship between the
current document and the referenced resource. The following values are valid:
local, peer,
external, and
-dita-use-conref-target.
See STUB CONTENT for detailed information on supported values and processing implications.
Examples
This section is non-normative.
This section contains examples of how the
<mathmlref> element can be used.
<math> root
elementThe following code sample shows how a
<mathmlref> element can be used to
reference a MathML <math> element that is
the root element of its containing document:
<equation-block>
<mathml>
<mathmlref href="../mathml-source/mathml-root-mathml.mml"/>
</mathml>
</equation-block>The mathml-root-mathml.mml file contains
the following content. Note that the
<math> element sets the MathML namespace
as the default namespace, so there are no namespace prefixes on
the MathML markup.
<?xml version="1.0" encoding="UTF-8"?>
<math xmlns="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink">
<mstyle displaystyle="false" scriptlevel="0">
<mrow>
<mfrac>
<mrow>
<mi mathcolor="gray">sin</mi>
<mo rspace="verythinmathspace"/>
<mi>ฮธ</mi>
</mrow>
<mi>ฯ</mi>
</mfrac>
</mrow>
</mstyle>
</math><math> element
within a documentThe following code sample shows how a
<mathmlref> element can reference a
specific <math> element in a containing
XML file:
<equation-block>
<mathml>
<mathmlref href="../mathml-source/mathml-equation-library.xml#mathfrag-02"/>
</mathml>
</equation-block>The mathml-equation-library.xml file contains the following content:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<part>
<math id="timeinday" xmlns="http://www.w3.org/1998/Math/MathML">
<mi>x</mi>
</math>
<math id="mathfrag-02" xmlns="http://www.w3.org/1998/Math/MathML">
<math>
<mrow>
<mi>y</mi>
<mo>=</mo>
<mn>5</mn>
<mi>x</mi>
<mo>+</mo>
<mn>2</mn>
</mrow>
</math>
</math>
</part>
<!-- ... -->
</root>Programming domain
The programming domain elements are used to describe the syntax for programming languages.
<apiname>
An API name is the name of an application programming interface (API), such as a Java class name or method name.
Specialization hierarchy
The <apiname>
element is specialized from <keyword>. It
is defined in the programming domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword pr-d/apiname
The <apiname> element is specialized from
<keyword>
. It is defined in the pr-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<apiname> element can be used to identify
the document.write method:
<p>Use the <apiname>document.write</apiname> method to create text
output in the dynamically constructed view.</p><codeblock>
A code block is a set of lines from a program.
Rendering expectations
Processors SHOULD preserve line the breaks and spaces
that are present in the content of a <codeblock> element.
The content of the <codeblock> element is typically
rendered in a monospaced font.
Specialization hierarchy
The <codeblock>
element is specialized from <pre>. It is
defined in the programming domain module.
Content model
(Text |
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<xref>
|
<coderef>
|
<data>
|
<sort-as>
|
<foreign>
|
<draft-comment>
|
<fn>
|
<indexterm>
|
<required-cleanup>
)*
Contained by
<dd>
,
<desc>
,
<div>
,
<draft-comment>
,
<entry>
,
<example>
,
<fallback>
,
<fig>
,
<figgroup>
,
<fn>
,
<li>
,
<lq>
,
<note>
,
<p>
,
<pd>
,
<stentry>
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<coderef> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<fn> -
<foreign> -
<hwcontrol> -
<i> -
<include> -
<indexterm> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
-
<dd> -
<desc> -
<div> -
<draft-comment> -
<entry> -
<example> -
<fallback> -
<fig> -
<figgroup> -
<fn> -
<li> -
<lq> -
<note> -
<p> -
<pd> -
<stentry>
Inheritance
+ topic/pre pr-d/codeblock
The <codeblock> element is specialized from
<pre>
. It is defined in the pr-domain module.
Attributes
The following attributes are available on this element: display
attributes, universal
attributes, and @xml:space.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@expanse(display attributes)- Specifies the horizontal placement of the element. The
following values are valid:
- column
- Indicates that the element is aligned with the current column margin.
- page
- Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
- spread
- Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
- textline
- Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
For
<table>, in place of the@expanseattribute that is used by other DITA elements, the@pgwideattribute is used in order to conform to the OASIS Exchange Table Model.Some processors or output formats might not support all values.
@frame(display attributes)- Specifies which portion of a border surrounds the element.
The following values are valid:
- all
- Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
- bottom
- Indicates that a line is rendered at the bottom of the containing element.
- none
- Indicates that no lines are rendered.
- sides
- Indicates that a line is rendered at the left and right of the containing element.
- top
- Indicates that a line is rendered at the top of the containing element.
- topbot
- Indicates that a line is rendered at the top and bottom of the containing element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Some processors or output formats might not support all values.
@scale(display attributes)- Specifies the percentage by which fonts are resized in
relation to the normal text size. The value of this attribute
is a positive integer. When used on
<table>or<simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.This attribute is primarily useful for print-oriented display. Some processors might not support all values.
If the
@scaleattribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the<image>element. @xml:space- Specifies how to handle white space in the
current element. This attribute is provided
on
<pre>,<lines>, and on elements specialized from those. It ensures that parsers respect white space that is part of the data in those elements, including line-end characters. When defined, it has a fixed value of preserve, making it a default property of the element that cannot be changed or deleted by authors.
Example
This section is non-normative.
The following code sample shows how the <codeblock> element can be
used to tag an excerpt from an XSLT stylesheet:
<codeblock>
<xsl:template match="*[contains(@outputclass,'green')]">
<xsl:attribute name="color">#006400;</xsl:attribute>
</xsl:template>
</codeblock>For a sample of how this element can be combined with
<coderef> to embed external code samples, see coderef.
<codeph>
A code phrase is a small portion of source code, machine code, or text that is displayed in-line.
Rendering expectations
The content of the <codeph> element is typically rendered in a
monospaced font.
Specialization hierarchy
The <codeph>
element is specialized from <ph>. It is
defined in the programming domain module.
Content model
(Text |
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<xref>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<required-cleanup>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<synph>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<synph> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph pr-d/codeph
The <codeph> element is specialized from
<ph>
. It is defined in the pr-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
In the following code sample, the <codeph> element identifies a code
snippet. The code snippet will be rendered in-line in the paragraph.
<p>The second line of the sample program code, <codeph>Do forever</codeph>,
represents the start of a loop construct.</p><coderef>
A code reference is the mechanism for referencing an external text file that contains program code.
Rendering expectations
When evaluated, the <coderef> element causes the target code to be
displayed inline. If the target code contains non-XML characters such as '<' or '&',
those characters need to be handled so that they can be displayed correctly by the final
rendering engine.
Specialization hierarchy
The <coderef>
element is specialized from <include>. It is
defined in the programming domain module.
Content model
<fallback>
?
Contained by
Optional
<fallback>
Contained by
Inheritance
+ topic/include pr-d/coderef
The <coderef> element is specialized from
<include>
. It is defined in the pr-domain module.
Attributes
The following attributes are available on this element: inclusion attributes, link-relationship attributes, universal
attributes, and @keyref.
For this element, the @parse attribute has a default
value of text.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@encoding(inclusion attributes)- Specifies the character encoding to use when translating the character
data from the referenced content. The value should be a valid encoding name. If not
specified, processors may make attempts to automatically determine the correct encoding,
for example using HTTP headers, through analysis of the binary structure of the
referenced data, or the
<?xml?>processing instruction when including XML as text. The resource should be treated as UTF-8 if no other encoding information can be determined.When
parse="xml", standard XML parsing rules apply for the detection of character encoding. The necessity and uses of@encodingfor non-standard values of@parseare implementation-dependent. @format(link-relationship attributes)- Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.
@href(link-relationship attributes)- Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref @parse(inclusion attributes)- Specifies the processing expectations for the referenced resource. Processors must
support the following values:
- text
-
The contents should be treated as plain text. Reserved XML characters should be displayed, and not interpreted as XML markup.
- xml
-
The contents of the referenced resource should be treated as an XML document, and the referenced element should be inserted at the location of the
<include>element. If a fragment identifier is included in the address of the content, processors must select the element with the specified ID. If no fragment identifier is included, the root element of the referenced XML document is selected. Any grammar processing should be performed during resolution, such that default attribute values are explicitly populated. Prolog content must be discarded.It is an error to use
parse="xml"anywhere other than within<foreign>or a specialization thereof.
Processors may support other values for the
@parseattribute with proprietary processing semantics. Processors should issue warnings and use<fallback>when they encounter unsupported@parsevalues. Non-standard@parseinstructions should be expressed as URIs.Note (non-normative):Proprietary@parsevalues will likely limit the portability and interoperability of DITA content, so should be used with care. @scope(link-relationship attributes)- Specifies the closeness of the relationship between the
current document and the referenced resource. The following values are valid:
local, peer,
external, and
-dita-use-conref-target.
See STUB CONTENT for detailed information on supported values and processing implications.
@type(link-relationship attributes)- Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.
Example
This section is non-normative.
In the following code sample, the <coderef>
element references the content of the
process-dita.xsl file. In the rendered
output, the XSL code will be presented in a code block.
<example>
<title>Processing DITA</title>
<p>This code is an example of how to process DITA.</p>
<codeblock>
<coderef href="process-dita.xsl"/>
</codeblock>
</example><option>
The <option> element specifies a permitted value for a parameter or
configuration.
Specialization hierarchy
The <option>
element is specialized from <keyword>. It is
defined in the programming domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<synph>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<synph> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword pr-d/option
The <option> element is specialized from
<keyword>
. It is defined in the pr-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
This section contains examples of how the
<option> element can be used.
In the following code sample, the
<option> element is used to specify
permitted values for a parameter:
<p> You can use the <parmname>map-order</parmname> parameter to specify
if the order of the frontmatter and backmatter content is retained. The allowed
values are <option>keep</option> and <option>trash</option>; the default value is
<option>trash</option>.</p>In the following code sample, the
<option> element is used to specify an
option that modifies a configuration:
<p>You can purchase the <option>Sports Model</option> package in order
to configure your automobile with the latest sports suspension, bonnet stripes,
a roof spoiler and an aero body kit.</p><parmname>
A parameter name is the name of a parameter that is passed to an API or a command-line interface (CLI).
Specialization hierarchy
The <parmname>
element is specialized from <keyword>. It is
defined in the programming domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<synph>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<synph> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword pr-d/parmname
The <parmname> element is specialized from
<keyword>
. It is defined in the pr-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<parmname> element can be used to identify
a parameter that is used with the config
command:
<p>You can use the <parmname>-env</parmname> parameter of the <cmdname>config</cmdname>
command to update the field value.</p><parml>
A parameter list is a specialized definition list that is designed for documenting parameters.
Specialization hierarchy
The <parml>
element is specialized from <dl>. It is
defined in the programming domain module.
Content model
(
<data>
|
<sort-as>
)*,
<plentry>
+
Contained by
<dd>
,
<desc>
,
<div>
,
<draft-comment>
,
<entry>
,
<example>
,
<fallback>
,
<fig>
,
<figgroup>
,
<fn>
,
<li>
,
<lq>
,
<note>
,
<p>
,
<pd>
,
<stentry>
- Zero or more of the following
-
<data> -
<sort-as>
-
- One or more
<plentry>
Contained by
-
<dd> -
<desc> -
<div> -
<draft-comment> -
<entry> -
<example> -
<fallback> -
<fig> -
<figgroup> -
<fn> -
<li> -
<lq> -
<note> -
<p> -
<pd> -
<stentry>
Inheritance
+ topic/dl pr-d/parml
The <parml> element is specialized from
<dl>
. It is defined in the pr-domain module.
Attributes
The following attributes are available on this element:
universal
attributes and
@compact.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@compact- Specifies whether the vertical spacing between list items is
tightened. The following values are valid:
yes, no, and
-dita-use-conref-target. Some DITA
processors or output formats might not support the
@compactattribute.
Example
This section is non-normative.
The following code sample shows how a set of sample code is followed by a parameter list that defines those parameters:
<p>This code example is a basic method signature:</p>
<codeblock>returnType methodName(pList1, pList2)</codeblock>
<p>The method requires the following parameters:</p>
<parml>
<plentry>
<pt>pList1</pt>
<pd>The first variable declaration that is passed to methodName</pd>
</plentry>
<plentry>
<pt>pList2</pt>
<pd>The second variable declaration that is passed to methodName</pd>
</plentry>
</parml><plentry>
A parameter-list entry contains one or more parameter terms and definitions.
Specialization hierarchy
The <plentry>
element is specialized from <dlentry>. It is
defined in the programming domain module.
Content model
Contained by
Contained by
Inheritance
+ topic/dlentry pr-d/plentry
The <plentry> element is specialized from
<dlentry>
. It is defined in the pr-domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
<pt>
A parameter term is a term that is defined in a parameter-list entry.
Specialization hierarchy
The <pt>
element is specialized from <dt>. It is
defined in the programming domain module.
Content model
(Text |
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<required-cleanup>
|
<image>
)*
Contained by
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<image> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/dt pr-d/pt
The <pt> element is specialized from
<dt>
. It is defined in the pr-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
<pd>
A parameter definition is a definition of a term that is defined in a parameter-list entry.
Specialization hierarchy
The <pd>
element is specialized from <dd>. It is
defined in the programming domain module.
Content model
(Text |
<audio>
|
<dl>
|
<parml>
|
<div>
|
<imagemap>
|
<example>
|
<fig>
|
<syntaxdiagram>
|
<image>
|
<lines>
|
<lq>
|
<note>
|
<hazardstatement>
|
<object>
|
<ol>
|
<p>
|
<pre>
|
<codeblock>
|
<msgblock>
|
<screen>
|
<simpletable>
|
<sl>
|
<table>
|
<ul>
|
<video>
|
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<foreign>
|
<draft-comment>
|
<fn>
|
<indexterm>
|
<required-cleanup>
)*
Contained by
- Text
-
<abbreviated-form> -
<apiname> -
<audio> -
<b> -
<cite> -
<cmdname> -
<codeblock> -
<codeph> -
<data> -
<div> -
<dl> -
<draft-comment> -
<em> -
<example> -
<fig> -
<filepath> -
<fn> -
<foreign> -
<hazardstatement> -
<hwcontrol> -
<i> -
<image> -
<imagemap> -
<include> -
<indexterm> -
<keyword> -
<line-through> -
<lines> -
<lq> -
<markupname> -
<menucascade> -
<msgblock> -
<msgnum> -
<msgph> -
<note> -
<numcharref> -
<object> -
<ol> -
<option> -
<overline> -
<p> -
<parameterentity> -
<parml> -
<parmname> -
<partno> -
<ph> -
<pre> -
<q> -
<required-cleanup> -
<screen> -
<simpletable> -
<sl> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<syntaxdiagram> -
<systemoutput> -
<table> -
<term> -
<text> -
<textentity> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<ul> -
<userinput> -
<varname> -
<video> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/dd pr-d/pd
The <pd> element is specialized from
<dd>
. It is defined in the pr-domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Release management domain
The release-management domain elements contain information about the changes that have been made to a DITA topic or map. This information can be retrieved and used to assemble a list of changes.
<change-completed>
The <change-completed> element
specifies the date on which the change was
completed.
Usage information
The recommended best practice
is to use date strings that conform to the ISO 8601 standard,
unless an epoch timestamp is used. The
string might contain a date and time (for example,
2017-04-05T12:30-02:00) or just a date (for
example, 2019-03-04).
Specialization hierarchy
The <change-completed> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<text>
)*
Contained by
- Text
-
<text>
Contained by
Inheritance
+ topic/data relmgmt-d/change-completed
The <change-completed> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-completed> element
can be used to note when the change was completed:
<change-historylist>
<change-item product="productA productB"><change-person>Tom Cihak</change-person>
<change-organization>JEDEC</change-organization>
<change-started>2019-01-15</change-started>
<change-completed>2019-03-23</change-completed>
<change-summary>Made change 1 to both products</change-summary>
<data>Details of change 1</data>
</change-item>
<change-historylist><change-historylist>
The <change-historylist> element
contains one or more changes that are applicable to the DITA topic or map.
Specialization hierarchy
The <change-historylist> element is specialized from
<metadata>. It is defined in the release-management domain
module.
Content model
Contained by
<bookmeta>
,
<topicmeta>
Zero or more
<change-item>
Contained by
-
<bookmeta> -
<topicmeta>
Inheritance
+ topic/metadata relmgmt-d/change-historylist
The <change-historylist> element is specialized from
<metadata>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-historylist> element
can be used to document one or more changes in a DITA topic or map. This example includes
three changes. This topic is used in documentation for two products, A and B.
<change-historylist>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-organization>JEDEC</change-organization>
<change-started>2019-01-15</change-started>
<change-completed>2019-03-23</change-completed>
<change-summary>Made change 1 to both products</change-summary>
<data>Details of change 1</data>
</change-item>
<change-item product="productA">
<change-person>Tom Cihak</change-person>
<change-completed>2019-06-07</change-completed>
<change-summary>Made change 2 to product A</change-summary>
<data>Details of change 2</data>
</change-item>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-revisionid>r23.4</change-revisionid>
<change-request-reference>
<change-request-system>example.com/my/queue/</change-request-system>
<change-request-id>TCKT-1313</change-request-id>
</change-request-reference>
<change-completed>2019-07-20</change-completed>
<change-summary>Made change 3 to both products</change-summary>
<data>Details of change 3</data>
</change-item>
</change-historylist><change-item>
The <change-item> element represents a
record of a change to a DITA topic or
map.
Specialization hierarchy
The <change-item> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(
<change-person>
|
<change-organization>
)*,
<change-revisionid>
?,
<change-request-reference>
?,
<change-started>
?,
<change-completed>
,
<change-summary>
*, (
<data>
|
<sort-as>
)*
Contained by
- Zero or more of the following
- Optional
<change-revisionid> - Optional
<change-request-reference> - Optional
<change-started> -
<change-completed> - Zero or more
<change-summary> - Zero or more of the following
-
<data> -
<sort-as>
-
Contained by
Inheritance
+ topic/data relmgmt-d/change-item
The <change-item> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-item> element can be
used to detail a change. This example includes two changes, one that is applicable to
products A and B and one that is applicable to only product A.
<change-historylist>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-organization>JEDEC</change-organization>
<change-started>2019-01-15</change-started>
<change-completed>2019-03-23</change-completed>
<change-summary>Made change 1 to both products</change-summary>
<data>Details of change 1</data>
</change-item>
<change-item product="productA">
<change-person>Tom Cihak</change-person>
<change-completed>2019-06-07</change-completed>
<change-summary>Made change 2 to product A</change-summary>
<data>Details of change 2</data>
</change-item>
</change-historylist><change-organization>
The <change-organization> element
specifies the name of the business unit that
required the change.
Specialization hierarchy
The <change-organization> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<text>
)*
Contained by
- Text
-
<text>
Contained by
Inheritance
+ topic/data relmgmt-d/change-organization
The <change-organization> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the
<change-organization> element can be used
to specify the business unit that required
the change:
<change-historylist>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-organization>JEDEC</change-organization>
<change-started>2019-01-15</change-started>
<change-completed>2019-03-23</change-completed>
<change-summary>Made change 1 to both products</change-summary>
<data>Details of change 1</data>
</change-item>
</change-historylist><change-person>
The <change-person> element specifies the name of the person who
made the change.
Specialization hierarchy
The <change-person> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<text>
)*
Contained by
- Text
-
<text>
Contained by
Inheritance
+ topic/data relmgmt-d/change-person
The <change-person> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-person> element can
be used to specify who made the change:
<change-historylist>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-organization>JEDEC</change-organization>
<change-started>2019-01-15</change-started>
<change-completed>2019-03-23</change-completed>
<change-summary>Made change 1 to both products</change-summary>
<data>Details of change 1</data>
</change-item>
</change-historylist><change-request-id>
The <change-request-id> element specifies an identifier
associated with the change request, such as an issue ID or ticket number.
Specialization hierarchy
The <change-request-id> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<audio>
|
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<image>
|
<object>
|
<required-cleanup>
|
<title>
|
<video>
)*
Contained by
- Text
-
<abbreviated-form> -
<apiname> -
<audio> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<image> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<object> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<title> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<video> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/data relmgmt-d/change-request-id
The <change-request-id> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-request-id> element
can be used to specify a ticket ID that is applicable to the change request:
<change-historylist>
<change-item product="productA productB">
<change-request-reference>
<change-request-system>example.com/my/queue/</change-request-system>
<change-request-id>TCKT-1313</change-request-id>
</change-request-reference>
</change-item>
</change-historylist><change-request-reference>
The <change-request-reference> element contains details about
the change request, such as an ID or a reference to the system used to track the
request.
Specialization hierarchy
The <change-request-reference> element is specialized from
<metadata>. It is defined in the release-management domain
module.
Content model
<change-request-system>
?,
<change-request-id>
?
Contained by
- Optional
<change-request-system> - Optional
<change-request-id>
Contained by
Inheritance
+ topic/data relmgmt-d/change-request-reference
The <change-request-reference> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-request-reference>
element can be used to specify the ticketing system used to manage the change request as
well as the applicable ticket ID:
<change-historylist>
<change-item product="productA productB">
<change-request-reference>
<change-request-system>example.com/my/queue/</change-request-system>
<change-request-id>TCKT-1313</change-request-id>
</change-request-reference>
</change-item>
</change-historylist><change-request-system>
The <change-request-system> element specifies the name of an
information system that manages or serves the referenced change request, for example, an issue
tracking system.
Specialization hierarchy
The <change-request-system> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<audio>
|
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<image>
|
<object>
|
<required-cleanup>
|
<title>
|
<video>
)*
Contained by
- Text
-
<abbreviated-form> -
<apiname> -
<audio> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<image> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<object> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<title> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<video> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/data relmgmt-d/change-request-system
The <change-request-system> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-request-system>
element can be used to specify the the ticketing system that manages the change request:
<change-historylist>
<change-item product="productA productB">
<change-request-reference>
<change-request-system>example.com/my/queue/</change-request-system>
<change-request-id>TCKT-1313</change-request-id>
</change-request-reference>
</change-item>
</change-historylist><change-revisionid>
The <change-revisionid> element specifies a string to identify
the change.
Specialization hierarchy
The <change-revisionid> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<audio>
|
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<image>
|
<object>
|
<required-cleanup>
|
<title>
|
<video>
)*
Contained by
- Text
-
<abbreviated-form> -
<apiname> -
<audio> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<image> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<object> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<title> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<video> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/data relmgmt-d/change-revisionid
The <change-revisionid> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the
<change-revisionid> element can be used to
identify a particular change. In this example, change revision ID
is used to note the release number for which the change is
applicable.
<change-historylist>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-revisionid>r23.4</change-revisionid>
<change-completed>2019-07-20</change-completed>
<change-summary>Made change 3 to both products</change-summary>
<data>Details of change 3</data>
</change-item>
</change-historylist><change-started>
The <change-started> element specifies
the date on which a change began.
Usage information
The recommended best practice
is to use date strings that conform to the ISO 8601 standard,
unless an epoch timestamp is used. The
string might contain a date and time (for example,
2017-04-05T12:30-02:00) or just a date (for
example, 2019-03-04).
Specialization hierarchy
The <change-started> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<text>
)*
Contained by
- Text
-
<text>
Contained by
Inheritance
+ topic/data relmgmt-d/change-started
The <change-started> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-started> element can
be used to specify the first day a particular change began:
<change-historylist>
<change-item product="productA productB">
<change-person>Tom Cihak</change-person>
<change-organization>JEDEC</change-organization>
<change-started>2019-01-15</change-started>
<change-completed>2019-03-23</change-completed>
<change-summary>Made change 1 to both products</change-summary>
<data>Details of change 1</data>
</change-item>
</change-historylist><change-summary>
The <change-summary> element includes a brief description of the
change.
Usage information
The <change-summary> element contains the portion of the release
note that might appear in a document.
Specialization hierarchy
The <change-summary> element is specialized from
<data>. It is defined in the release-management domain module.
Content model
(Text |
<audio>
|
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<image>
|
<object>
|
<required-cleanup>
|
<title>
|
<video>
)*
Contained by
- Text
-
<abbreviated-form> -
<apiname> -
<audio> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<image> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<object> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<title> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<video> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/data relmgmt-d/change-summary
The <change-summary> element is specialized from
<data>
. It is defined in the relmgmt-domain module.
Attributes
The following attributes
are available on this element: universal
attributes and @name.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <change-summary> element can
be used to provide a brief description of a change:
<change-historylist>
<change-item product="productA">
<change-person>Tom Cihak</change-person>
<change-completed>2019-06-07</change-completed>
<change-summary>Made change 2 to product A</change-summary>
<data>Details of change 2</data>
</change-item>
<change-historylist>Software domain
The software domain elements are used to describe the presentation and operation of a software program.
<cmdname>
A command name is the name of a software command.
Specialization hierarchy
The <cmdname> element is specialized from
<keyword>. It is defined in the software domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword sw-d/cmdname
The <cmdname> element is specialized from
<keyword>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows a <cmdname>
element that identifies the name of the rm
command.
<p>You can use the <cmdname>rm</cmdname> command to permanently delete an object.</p><filepath>
A file path is the location of a resource, such as the system path and file name of a file on a storage device.
Rendering expectations
The content of the <filepath> element is typically rendered in a
monospaced font.
Specialization hierarchy
The <filepath> element is specialized from
<ph>. It is defined in the software domain module.
Content model
, (Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Zero or more of the following
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph sw-d/filepath
The <filepath> element is specialized from
<ph>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
In the following code sample, the <filepath> element is used to tag
both file names and system paths:
<p>Uncompress the <filepath>gbbrsh.gz</filepath> file to the
<filepath>/usr</filepath> directory. Ensure that the
<filepath>/usr/tools/data.cfg</filepath> path is listed in
the execution path system variable.</p><msgblock>
A message block is a multi-line message or set of messages that is produced by an application or device.
Usage information
The <msgblock> element can contain multiple
message numbers and message descriptions, each enclosed in
<msgnum> and
<msgph> elements. It can also contain the
message content directly.
Rendering expectations
Processors SHOULD preserve the
line breaks and spaces that are present in the content of a
<msgblock> element.
The content of the <msgblock> element is typically
rendered in a monospaced font.
Specialization hierarchy
The <msgblock> element is specialized from
<pre>. It is defined in the software domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
|
<msgph>
)*
Contained by
<dd>
,
<desc>
,
<div>
,
<draft-comment>
,
<entry>
,
<example>
,
<fallback>
,
<fig>
,
<figgroup>
,
<fn>
,
<li>
,
<lq>
,
<note>
,
<p>
,
<pd>
,
<stentry>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<dd> -
<desc> -
<div> -
<draft-comment> -
<entry> -
<example> -
<fallback> -
<fig> -
<figgroup> -
<fn> -
<li> -
<lq> -
<note> -
<p> -
<pd> -
<stentry>
Inheritance
+ topic/pre sw-d/msgblock
The <msgblock> element is specialized from
<pre>
. It is defined in the sw-domain module.
Attributes
The following attributes are available on this element: display
attributes, universal
attributes, and @xml:space.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@expanse(display attributes)- Specifies the horizontal placement of the element. The
following values are valid:
- column
- Indicates that the element is aligned with the current column margin.
- page
- Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
- spread
- Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
- textline
- Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
For
<table>, in place of the@expanseattribute that is used by other DITA elements, the@pgwideattribute is used in order to conform to the OASIS Exchange Table Model.Some processors or output formats might not support all values.
@frame(display attributes)- Specifies which portion of a border surrounds the element.
The following values are valid:
- all
- Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
- bottom
- Indicates that a line is rendered at the bottom of the containing element.
- none
- Indicates that no lines are rendered.
- sides
- Indicates that a line is rendered at the left and right of the containing element.
- top
- Indicates that a line is rendered at the top of the containing element.
- topbot
- Indicates that a line is rendered at the top and bottom of the containing element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Some processors or output formats might not support all values.
@scale(display attributes)- Specifies the percentage by which fonts are resized in
relation to the normal text size. The value of this attribute
is a positive integer. When used on
<table>or<simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.This attribute is primarily useful for print-oriented display. Some processors might not support all values.
If the
@scaleattribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the<image>element. @xml:space- Specifies how to handle white space in the
current element. This attribute is provided
on
<pre>,<lines>, and on elements specialized from those. It ensures that parsers respect white space that is part of the data in those elements, including line-end characters. When defined, it has a fixed value of preserve, making it a default property of the element that cannot be changed or deleted by authors.
Example
This section is non-normative.
The following code sample shows a
<msgblock> element that contains a
multi-line message that is returned by an application:
<p>A sequence of failed password attempts generates the following message stream:</p>
<msgblock>
I:0
S:3
I:1
S:3
I:1
S:4
S:99 (lockup)
</msgblock><msgnum>
A message number is the identifier of a message that is produced by an application or program.
Specialization hierarchy
The <msgnum> element is specialized from
<keyword>. It is defined in the software domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword sw-d/msgnum
The <msgnum> element is specialized from
<keyword>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows a <msgnum>
element that identifies the number of the message that is returned
by an application:
<p>A server log entry of <msgnum>I:0</msgnum> is equivalent to the
text message <msgph>informational: successful</msgph>.</p><msgph>
A message phrase is the text of a message that is produced by an application or program.
Specialization hierarchy
The <msgph> element is specialized from <ph>.
It is defined in the software domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<msgblock>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<msgblock> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph sw-d/msgph
The <msgph> element is specialized from
<ph>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<msgph> element can be used to tag a
message that is returned by the server:
<p>A server log entry of <msgnum>I:0</msgnum> is equivalent to the
text message, <msgph>informational: successful</msgph>.</p><systemoutput>
System output is content that a computer or device generates in response to a command or situation.
Specialization hierarchy
The <systemoutput> element is specialized from
<ph>. It is defined in the software domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph sw-d/systemoutput
The <systemoutput> element is specialized from
<ph>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
In the following code sample, the <systemoutput> element identifies
an application response to user input:
<p>After you type <userinput>mealplan dinner</userinput>, the meal planning program
will print <systemoutput>For what day?</systemoutput>.
Reply by typing the day of the week for which you want a meal plan,
for example, <userinput>Thursday</userinput>.</p><userinput>
User input is text that a user enters, such as a response to an application or system prompt.
Specialization hierarchy
The <userinput> element is specialized from
<ph>. It is defined in the software domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph sw-d/userinput
The <userinput> element is specialized from
<ph>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
In the following code sample, the <userinput> element identifies
text that a user should type at the command prompt:
<p>From a DOS command prompt, type <userinput>dir</userimput> to view a list
of files in the current directory.</p><varname>
A variable name is a placeholder for content that might change based on how something is used, such as a variable supplied to a software application or a user-defined path in a command.
Rendering expectations
The content of the <varname> element is typically rendered in an
italic font.
Specialization hierarchy
The <varname> element is specialized from
<keyword>. It is defined in the software domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword sw-d/varname
The <varname> element is specialized from
<keyword>
. It is defined in the sw-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<varname> element is used to identify
variables that represent the "installation directory," "project
directory," and "file name":
<filepath>
<varname>install-dir</varname>/projects/working/<varname>project-dir</varname>
/source/<varname>filename</varname>.java
</filepath>SVG domain
The SVG domain elements enable the use of embedded or referenced SVG markup. Referenced SVG markup must be stored in separate, non-DITA XML documents. SVG is a W3C standard.
For SVG markup that is stored directly in DITA documents that are validated using DTDs, the
SVG elements must use a namespace prefix in order to avoid conflict with DITA-defined
elements of the same name. Documents validated using RELAX NG can default the SVG namespace
on the SVG <svg> element. SVG elements that are referenced using the
<svgref> element do not need to have a namespace prefix, because
they are parsed separately from the DITA documents that refer to them. By default, the SVG
domain is configured to use the namespace prefix svg for the SVG
elements.
<svg-container>
The <svg-container> element stores content that contributes to a
scalable vector graphic (SVG).
Usage information
The <svg-container> element can contain SVG
elements, references to SVG elements that are stored in separate,
non-DITA documents, or <data> elements.
The SVG markup must have a root element of <svg> with the SVG
namespace: "http://www.w3.org/2000/svg".
Specialization hierarchy
The <svg-container> is specialized from
<foreign>. It is defined in the SVG domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
<svg-container> elements can be used in a
DITA topic. It is used to generate both inline SVG markup and a
titled figure that contains SVG
markup:<topic id="svg-test-topic-01">
<title>SVG Domain Test: Namespace Prefixed SVG Elements</title>
<body>
<!-- SVG inline -->
<svg-container>
<svg:svg width="100" height="100">
<svg:defs>
<svg:filter id="f1" x="0" y="0">
<svg:feGaussianBlur in="SourceGraphic" stdDeviation="15"/>
</svg:filter>
</svg:defs>
<svg:rect width="90" height="90" stroke="green" stroke-width="3" fill="yellow"
filter="url(#f1)"/>
</svg:svg>
</svg-container>
<!-- ... -->
<fig>
<title>Figure with SVG container</title>
<svg-container>
<svg:svg width="4in" height="6in" version="1.1">
<svg:circle cx="150" cy="200" r="100" fill="url(#grad_blue)"/>
<svg:rect x="70" y="320" height="40" width="80" fill="aqua"/>
<svg:text x="90" y="350" font-size="30" fill="green">Go</svg:text>
</svg:svg>
</svg-container>
</fig>
</body>
</topic><svgref>
The <svgref> element references a non-DITA XML document that
contains scalable vector graphic (SVG) markup.
Usage information
The <svgref> element enables the use of SVG
markup by reference. The reference must be to a SVG
<svg> element that is
stored in a separate, non-DITA XML document. The reference
can be one of the following:
- A URI that addresses an XML document which has a SVG
<svg>element as the root element - A URI that addresses an XML document and contains a fragment
identifier that is the XML ID of a
<svg>element within the document
The reference can be direct, using the @href attribute, or indirect, using
the @keyref attribute. For indirect referencing, only the key name should be
specified. The ID of the <svg> element must be specified as part of
the value for the @href attribute on the key definition.
For example, to refer to the <svg>
element with the @id of
svg-fragment-02 within a larger document
using a key reference, you would define the key in the following
way:
<keydef keys="svg-fragment-0002" href="svg/svg-library.xml#svg-fragment-02"/>You reference this key by using just the key name:
<svg-container>
<svgref keyref="svg-fragment-0002"/>
</svg-container>Processing information
Processors SHOULD process the
SVG as though the <svg> element occurs
directly in the content of the containing
<svg-container> element.
Specialization hierarchy
The <svgref> is specialized from <include>.
It is defined in the SVG domain module.
Attributes
The following attributes are available on this element: inclusion attributes, link-relationship attributes, universal
attributes, and @keyref.
- The
@formatattribute has a default value of svg. - The
@hrefattribute is a reference to an SVG document or SVG element. If the<svg>element is the root element of the referenced resource, then no fragment identifier is required. Otherwise, a fragment identifier must be specified, where the fragment identifier is the XML ID of the<svg>element. - The
@parseattribute has a default value of xml.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@encoding(inclusion attributes)- Specifies the character encoding to use when translating the character
data from the referenced content. The value should be a valid encoding name. If not
specified, processors may make attempts to automatically determine the correct encoding,
for example using HTTP headers, through analysis of the binary structure of the
referenced data, or the
<?xml?>processing instruction when including XML as text. The resource should be treated as UTF-8 if no other encoding information can be determined.When
parse="xml", standard XML parsing rules apply for the detection of character encoding. The necessity and uses of@encodingfor non-standard values of@parseare implementation-dependent. @format(link-relationship attributes)- Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.
@href(link-relationship attributes)- Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref @parse(inclusion attributes)- Specifies the processing expectations for the referenced resource. Processors must
support the following values:
- text
-
The contents should be treated as plain text. Reserved XML characters should be displayed, and not interpreted as XML markup.
- xml
-
The contents of the referenced resource should be treated as an XML document, and the referenced element should be inserted at the location of the
<include>element. If a fragment identifier is included in the address of the content, processors must select the element with the specified ID. If no fragment identifier is included, the root element of the referenced XML document is selected. Any grammar processing should be performed during resolution, such that default attribute values are explicitly populated. Prolog content must be discarded.It is an error to use
parse="xml"anywhere other than within<foreign>or a specialization thereof.
Processors may support other values for the
@parseattribute with proprietary processing semantics. Processors should issue warnings and use<fallback>when they encounter unsupported@parsevalues. Non-standard@parseinstructions should be expressed as URIs.Note (non-normative):Proprietary@parsevalues will likely limit the portability and interoperability of DITA content, so should be used with care. @scope(link-relationship attributes)- Specifies the closeness of the relationship between the
current document and the referenced resource. The following values are valid:
local, peer,
external, and
-dita-use-conref-target.
See STUB CONTENT for detailed information on supported values and processing implications.
@type(link-relationship attributes)- Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.
Examples
This section is non-normative.
This section contains examples of how the
<svgref> element can be used.
The following code sample shows how an
<svgref> element can be used to
reference an <svg> element that is the
root element of its containing document:
<fig>
<title>Figure with an SVG container</title>
<svg-container>
<svgref href="media/svg/svg-graphic-01.xml"/>
</svg-container>
</fig><svg>
element sets the SVG namespace as the default namespace, so there
are no namespace prefixes on the SVG
markup.<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100">
<defs>
<filter id="f1" x="0" y="0">
<feGaussianBlur in="SourceGraphic" stdDeviation="15"/>
</filter>
</defs>
<rect width="90" height="90" stroke="green" stroke-width="3" fill="yellow"
filter="url(#f1)"/>
</svg>The following code sample shows an
<svgref> element can be used to
reference a specific <svg> element in a
containing XML file:
<fig>
<title>Figure with SVG container</title>
<svg-container>
<svgref href="media/svg/svg-library.xml#frag-0001" />
</svg-container>
</fig><?xml version="1.0" encoding="UTF-8"?>
<root>
<part>
<svg id="frag-0001" xmlns="http://www.w3.org/2000/svg" width="100" height="100">
<defs>
<filter id="f1" x="0" y="0">
<feGaussianBlur in="SourceGraphic" stdDeviation="15"/>
</filter>
</defs>
<rect width="90" height="90" stroke="green" stroke-width="3" fill="yellow"
filter="url(#f1)"/>
</svg>
<!-- ... -->
</part>
</root>Syntax diagram domain
The syntax-diagram domain elements are used to diagram expressions or syntax phrases for programming languages or command line processors.
The syntax diagram domain is specialized from the programming domain, and uses elements from that domain within the content model of syntax phrases.
<delim>
A delimiter is a character that marks the beginning or end of a section within a syntax diagram.
Usage information
Typical delimiter characters are parentheses, commas, tabs, vertical bars, or other special characters.
Specialization hierarchy
The <delim> element is specialized from <ph>.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synph>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
Inheritance
+ topic/ph pr-d/ph syntaxdiagram-d/delim
The <delim> element is specialized from
<ph>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional or
required. The attribute value is limited to
optional,
required, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the
<delim> element can be used to specify
that the equal sign (=) is used to mark the end of the group
sequence:
<syntaxdiagram>
<title>Integer addition</title>
<groupseq>
<var>integer</var>
<oper>+</oper>
<var>integer</var>
<delim>=</delim>
<var>total</var>
</groupseq>
</syntaxdiagram><fragment>
The <fragment> element contains a labeled subpart of the syntax
within a syntax diagram.
Usage information
The <fragment> element enables breaking out
logical chunks of a large syntax diagram into named fragments.
Specialization hierarchy
The <fragment> element is specialized from
<figgroup>. It is defined in the syntax-diagram domain module,
which is a specialization of the programming domain module.
Content model
<title>
?, (
<fragref>
|
<groupchoice>
|
<groupcomp>
|
<groupseq>
|
<synnote>
|
<synnoteref>
)*
Contained by
- Optional
<title> - Zero or more of the following
Contained by
Inheritance
+ topic/figgroup pr-d/figgroup syntaxdiagram-d/fragment
The <fragment> element is specialized from
<figgroup>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the <fragment> element can be
used to break out a set of related logging options from the larger set of syntax. This
allows the logging options to be displayed separately in a titled group, out of the flow of
the primary diagram.
<syntaxdiagram>
<title>Syntax for runprogram command</title>
<groupseq>
<kwd>runprogram</kwd>
<groupchoice>
<groupcomp><oper>-</oper><kwd>i</kwd><sep>:</sep><var>program-name.py</var></groupcomp>
<groupcomp><oper>--</oper><kwd>input</kwd><sep>=</sep><var>program-name.py</var></groupcomp>
</groupchoice>
</groupseq>
<fragment>
<title>Logging options</title>
<groupseq importance="optional"><oper>--</oper><kwd>debug</kwd></groupseq>
<groupseq importance="optional"><oper>--</oper><kwd>verbose</kwd></groupseq>
</fragment>
</syntaxdiagram><fragref>
A fragment reference is the mechanism for referencing a syntax fragment within the same syntax diagram.
Usage information
The <fragref> element is used to reference a syntax fragment
multiple times or pull a large section of syntax out of line for easier reading.
Specialization hierarchy
The <fragref> element is specialized from <xref>.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<data>
|
<sort-as>
|
<draft-comment>
|
<foreign>
|
<required-cleanup>
)*
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<foreign> -
<hwcontrol> -
<i> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
Inheritance
+ topic/xref pr-d/xref syntaxdiagram-d/fragref
The <fragref> element is specialized from
<xref>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal
attributes and @href.
- The
@hrefattribute is a reference to a syntax diagram<fragment>. The referenced<fragment>must be in the same diagram as the<fragref>element. - The
@importanceattribute is limited to the values optional, required, or -dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@href(link-relationship attributes)- Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.
@importance- The
@importanceattribute is limited to the values optional, required, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<fragref> element can be used to break out
a set of related logging options from the larger set of syntax. The
<fragref> element is part of the program
sequence after an input file, but the syntax for logging is defined
outside of the main diagram.
<syntaxdiagram frame="none">
<title>CopyFile</title>
<groupseq><kwd>COPYF</kwd></groupseq>
<groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp>
<groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq>
<fragref href="#./overlay"/>
<groupchoice><var>input-filename</var><kwd>*INFILE</kwd></groupchoice>
<groupchoice><var>output-filename</var><kwd>*OUTFILE</kwd></groupchoice>
<fragment id="overlay">
<title>Overlay</title>
<groupchoice><kwd>*OVERLAP</kwd><kwd>*Prompt</kwd></groupchoice>
</fragment>
</syntaxdiagram><groupchoice>
The <groupchoice> element provides a set of choices between
groups of pieces of syntax.
Usage information
Each syntax 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.
Specialization hierarchy
The <groupchoice> element is specialized from
<figgroup>. It is defined in the syntax-diagram domain module,
which is a specialization of the programming domain module.
Content model
<title>
?,
<repsep>
?, (
<delim>
|
<fragref>
|
<groupchoice>
|
<groupcomp>
|
<groupseq>
|
<kwd>
|
<oper>
|
<sep>
|
<synnote>
|
<synnoteref>
|
<var>
)*
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
- Optional
<title> - Optional
<repsep> - Zero or more of the following
Contained by
Inheritance
+ topic/figgroup pr-d/figgroup syntaxdiagram-d/groupchoice
The <groupchoice> element is specialized from
<figgroup>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<groupchoice> element can be used to
specify that there are two ways to specify an input file name to a
command line program:
<syntaxdiagram>
<title>Syntax for runprogram command</title>
<groupseq>
<kwd>runprogram</kwd>
<groupchoice>
<groupcomp><oper>-</oper><kwd>i</kwd><sep>:</sep><var>program-name.py</var></groupcomp>
<groupcomp><oper>--</oper><kwd>input</kwd><sep>=</sep><var>program-name.py</var></groupcomp>
</groupchoice>
</groupseq>
</syntaxdiagram><groupcomp>
The <groupcomp> element groups a set of pieces of syntax as a
single unit.
Usage information
Each syntax 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 rendered close together rather than being separated by a horizontal or vertical line, which is the usual formatting method.
Specialization hierarchy
The <groupcomp> element is specialized from
<figgroup>. It is defined in the syntax-diagram domain module,
which is a specialization of the programming domain module.
Content model
<title>
?,
<repsep>
?, (
<delim>
|
<fragref>
|
<groupchoice>
|
<groupcomp>
|
<groupseq>
|
<kwd>
|
<oper>
|
<sep>
|
<synnote>
|
<synnoteref>
|
<var>
)*
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
- Optional
<title> - Optional
<repsep> - Zero or more of the following
Contained by
Inheritance
+ topic/figgroup pr-d/figgroup syntaxdiagram-d/groupcomp
The <groupcomp> element is specialized from
<figgroup>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<groupcomp> element can be used to
indicate how pieces of syntax are grouped together. Two composite
groups represent two alternate ways to specify an input file to a
command line program, using either
-i:program-name.py or
--input=program-name.ph.
<syntaxdiagram>
<title>Syntax for runprogram command</title>
<groupseq>
<kwd>runprogram</kwd>
<groupchoice>
<groupcomp><oper>-</oper><kwd>i</kwd><sep>:</sep><var>program-name.py</var></groupcomp>
<groupcomp><oper>--</oper><kwd>input</kwd><sep>=</sep><var>program-name.py</var></groupcomp>
</groupchoice>
</groupseq>
</syntaxdiagram><groupseq>
The <groupseq> element specifies the sequence of groups with
pieces of syntax.
Usage information
Each syntax 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 <groupseq>
element.
Specialization hierarchy
The <groupseq> element is specialized from
<figgroup>. It is defined in the syntax-diagram domain module,
which is a specialization of the programming domain module.
Content model
<title>
?,
<repsep>
?, (
<delim>
|
<fragref>
|
<groupchoice>
|
<groupcomp>
|
<groupseq>
|
<kwd>
|
<oper>
|
<sep>
|
<synnote>
|
<synnoteref>
|
<var>
)*
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
- Optional
<title> - Optional
<repsep> - Zero or more of the following
Contained by
Inheritance
+ topic/figgroup pr-d/figgroup syntaxdiagram-d/groupseq
The <groupseq> element is specialized from
<figgroup>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<groupseq> element can be used to indicate
that a short set of command line syntax is specified in a
sequential order. The runprogram tool name is
followed by a choice of how to specify an input file.
<syntaxdiagram>
<title>Syntax for runprogram command</title>
<groupseq>
<kwd>runprogram</kwd>
<groupchoice>
<groupcomp><oper>-</oper><kwd>i</kwd><sep>:</sep><var>program-name.py</var></groupcomp>
<groupcomp><oper>--</oper><kwd>input</kwd><sep>=</sep><var>program-name.py</var></groupcomp>
</groupchoice>
</groupseq>
</syntaxdiagram><kwd>
The <kwd> element identifies a keyword within a syntax diagram
or phrase.
Usage information
A <kwd> might be entered by a user typing in the syntax, or rendered
by an application as part of a syntax prompt. The keyword value is typed or rendered exactly
as specified in the syntax diagram or phrase.
Specialization hierarchy
The <kwd> element is specialized from
<keyword>. It is defined in the syntax-diagram domain module, which
is a specialization of the programming domain module.
Content model
(Text |
<text>
)*
Contained by
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synph>
- Text
-
<text>
Contained by
Inheritance
+ topic/keyword pr-d/keyword syntaxdiagram-d/kwd
The <kwd> element is specialized from
<keyword>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on
this element: universal
attributes and
@keyref.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target. @keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<kwd> element can be used to identify text
that must be provided to the application exactly as specified:
<syntaxdiagram id="validate">
<title>Validate account setup</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp>
<oper>--</oper><kwd>user</kwd><sep>=</sep><var>userid</var>
</groupcomp>
<groupcomp>
<oper>--</oper><kwd>validate</kwd>
</groupcomp>
</groupseq>
</syntaxdiagram><oper>
The <oper> element identifies an operator within a syntax
definition.
Usage information
Typical operators are equals (=), plus (+), or multiply (*).
Specialization hierarchy
The <oper> element is specialized from <ph>.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synph>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
Inheritance
+ topic/ph pr-d/ph syntaxdiagram-d/oper
The <oper> element is specialized from
<ph>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<oper> element can be used to specify that
the operator in an operation is plus (+):
<syntaxdiagram>
<title>Integer addition</title>
<groupseq>
<var>integer</var>
<oper>+</oper>
<var>integer</var>
<delim>=</delim>
<var>total</var>
</groupseq>
</syntaxdiagram><repsep>
The <repsep> element identifies a
character that indicates that a group of syntax elements can (or
should) be repeated in a syntax diagram.
Usage information
If the <repsep> element contains a separator character such as a
plus (+), this indicates that the character must be used between repetitions of the syntax
elements.
Specialization hierarchy
The <repsep> element is specialized from
<ph>. It is defined in the syntax-diagram domain module, which is a
specialization of the programming domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<groupchoice>
,
<groupcomp>
,
<groupseq>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
Inheritance
+ topic/ph pr-d/ph syntaxdiagram-d/repsep
The <repsep> element is specialized from
<ph>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional or
required. The attribute value is limited to
optional,
required, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
In the following code sample, a file listing can be requested for
multiple volumes. The <repsep> element
identifies that each requested volume can be separated with a comma
(,):
<syntaxdiagram>
<title>Request file listing</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp><oper>--</oper><kwd>user</kwd><sep>=</sep><var>userid</var></groupcomp>
<groupcomp>
<repsep>,</repsep>
<oper>--</oper><kwd>filelist</kwd><sep>=</sep><var>volumeid</var>
</groupcomp>
</groupseq>
</syntaxdiagram><sep>
The <sep> element defines a character
that separates pieces of syntax in a syntax diagram.
Usage information
The separator occurs between keywords, operators, or groups in a syntax definition.
Specialization hierarchy
The <sep> element is specialized from <ph>.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synph>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
Inheritance
+ topic/ph pr-d/ph syntaxdiagram-d/sep
The <sep> element is specialized from
<ph>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<sep> element can be used to separate a
parameter name from a parameter value:
<syntaxdiagram id="validate">
<title>Validate account setup</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp>
<oper>--</oper>
<kwd>user</kwd>
<sep>=</sep>
<var>userid</var>
</groupcomp>
<groupcomp>
<oper>--</oper>
<kwd>validate</kwd>
</groupcomp>
</groupseq>
</syntaxdiagram><synblk>
A syntax block organizes small pieces of a syntax definition into a larger piece.
Specialization hierarchy
The <synblk> element is specialized from
<figgroup>. It is defined in the syntax-diagram domain module, which
is a specialization of the programming domain module.
Content model
<title>
?, (
<fragment>
|
<fragref>
|
<groupchoice>
|
<groupcomp>
|
<groupseq>
|
<synnote>
|
<synnoteref>
)*
Contained by
- Optional
<title> - Zero or more of the following
Contained by
Inheritance
+ topic/figgroup pr-d/figgroup syntaxdiagram-d/synblk
The <synblk> element is specialized from
<figgroup>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how
<synblk> elements can be used to group
sets of related options for user profile parameters. These syntax
blocks might be used in many different sets of syntax.
<synblk id="profileopts">
<title>Required profile options</title>
<groupcomp><oper>--</oper><kwd>user</kwd><sep>=</sep><var>userid</var></groupcomp>
<groupcomp><oper>--</oper><kwd>acctkey</kwd><sep>=</sep><var>keyfile</var></groupcomp>
<groupcomp><oper>--</oper><kwd>region</kwd><sep>=</sep><var>homeregion</var></groupcomp>
</synblk><syntaxdiagram>
<title>Request file listing</title>
<groupseq>
<kwd>clicmd</kwd>
<synblk conkeyref="syntax-library/profileopts"/>
<groupcomp><oper>--</oper><kwd>filelist</kwd><sep>=</sep><var>volumeid</var></groupcomp>
</groupseq>
</syntaxdiagram><synnote>
The syntax note provides additional information within a syntax diagram.
Usage information
The syntax note explains aspects of the syntax that cannot be expressed in the markup itself.
Rendering expectations
The note typically appears at the bottom of the syntax diagram instead of at the bottom of the page.
Specialization hierarchy
The <synnote> element is specialized from <fn>. It
is defined in the syntax-diagram domain module, which is a specialization of the programming
domain module.
Content model
(Text |
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
)*
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<em> -
<filepath> -
<hwcontrol> -
<i> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/fn pr-d/fn syntaxdiagram-d/synnote
The <synnote> element is specialized from
<fn>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes and the attribute defined below.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample show how the
<synnote> element can be used to remind
the reader where to find information for a required parameter:
<syntaxdiagram id="validate">
<title>Validate account setup</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp>
<oper>--</oper><kwd>user</kwd><sep>=</sep><var>userid</var>
<synnote>Your user ID can be found in your account activation email.</synnote>
</groupcomp>
<groupcomp>
<oper>--</oper><kwd>validate</kwd>
</groupcomp>
</groupseq>
</syntaxdiagram><synnoteref>
A syntax note reference is the mechanism for referencing a syntax note within the same syntax diagram.
Usage information
The same notation can be used in more than one syntax definition.
Specialization hierarchy
The <synnoteref> element is specialized from
<xref>. It is defined in the syntax-diagram domain module, which is a
specialization of the programming domain module.
Content model
EMPTY
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
Empty
Contained by
Inheritance
+ topic/xref pr-d/xref syntaxdiagram-d/synnoteref
The <synnoteref> element is specialized from
<xref>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal
attributes and @href.
For this element, the
@href attribute is a reference to a syntax note within the same syntax
diagram.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@href(link-relationship attributes)- Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.
Example
This section is non-normative.
In the following code sample, a syntax note is reused twice in the sample diagram, instructing the reader how to request a modified user name or password:
<syntaxdiagram id="validate">
<title>Validate account setup</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp>
<oper>--</oper><kwd>user</kwd><sep>=</sep><var>account_id</var><synnoteref href="#./reset"/>
</groupcomp>
<groupcomp>
<oper>--</oper><kwd>pwd</kwd><sep>=</sep><var>password_key</var><synnoteref href="#./reset"/>
</groupcomp>
<groupcomp>
<oper>--</oper><kwd>validate</kwd>
</groupcomp>
</groupseq>
<synnote id="reset">If you have forgotten your account ID or password key,
please contact customer support.</synnote>
</syntaxdiagram><synph>
A syntax phrase is a small group of pieces of syntax.
Usage information
The <synph> element is used when a complete syntax diagram is not
needed, but some of the syntax elements, such as <kwd>,
<oper>, or <delim> are used within the text
flow of the topic content.
Specialization hierarchy
The <synph> element is specialized from <ph>.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<codeph>
|
<delim>
|
<kwd>
|
<oper>
|
<option>
|
<parmname>
|
<sep>
|
<synph>
|
<text>
|
<var>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<synph>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<synph> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph pr-d/ph syntaxdiagram-d/synph
The <synph> element is specialized from
<ph>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample shows how the
<synph> element can be used to identify a
syntax phrase that must be run before a task:
<task id="setup-volume">
<title>Setting up a new volume</title>
<shortdesc>This task will help you set up a new volume for your account.</shortdesc>
<taskbody>
<prereq>Before starting this procedure, ensure that you have requested
the volume using the <synph><kwd>request</kwd> <var>volumename</var></synph>
command.</prereq>
<!-- ... -->
</taskbody>
</task><syntaxdiagram>
A syntax diagram represents the syntax of a command, function call, or programming language statement.
Rendering expectations
Traditionally, the syntax diagram is formatted with "railroad tracks" that connect the units of the syntax together, but the presentation might vary depending on the output media.
Specialization hierarchy
The <syntaxdiagram> element is specialized from
<fig>. It is defined in the syntax-diagram domain module, which is
a specialization of the programming domain module.
Content model
<title>
?, (
<fragment>
|
<fragref>
|
<groupchoice>
|
<groupcomp>
|
<groupseq>
|
<synblk>
|
<synnote>
|
<synnoteref>
)*
Contained by
<dd>
,
<div>
,
<draft-comment>
,
<entry>
,
<example>
,
<fn>
,
<li>
,
<lq>
,
<note>
,
<p>
,
<pd>
,
<stentry>
- Optional
<title> - Zero or more of the following
Contained by
-
<dd> -
<div> -
<draft-comment> -
<entry> -
<example> -
<fn> -
<li> -
<lq> -
<note> -
<p> -
<pd> -
<stentry>
Inheritance
+ topic/fig pr-d/fig syntaxdiagram-d/syntaxdiagram
The <syntaxdiagram> element is specialized from
<fig>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: display attributes and universal attributes.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@expanse(display attributes)- Specifies the horizontal placement of the element. The
following values are valid:
- column
- Indicates that the element is aligned with the current column margin.
- page
- Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
- spread
- Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
- textline
- Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
For
<table>, in place of the@expanseattribute that is used by other DITA elements, the@pgwideattribute is used in order to conform to the OASIS Exchange Table Model.Some processors or output formats might not support all values.
@frame(display attributes)- Specifies which portion of a border surrounds the element.
The following values are valid:
- all
- Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
- bottom
- Indicates that a line is rendered at the bottom of the containing element.
- none
- Indicates that no lines are rendered.
- sides
- Indicates that a line is rendered at the left and right of the containing element.
- top
- Indicates that a line is rendered at the top of the containing element.
- topbot
- Indicates that a line is rendered at the top and bottom of the containing element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Some processors or output formats might not support all values.
@scale(display attributes)- Specifies the percentage by which fonts are resized in
relation to the normal text size. The value of this attribute
is a positive integer. When used on
<table>or<simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.This attribute is primarily useful for print-oriented display. Some processors might not support all values.
If the
@scaleattribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the<image>element.
Example
This section is non-normative.
The following code sample shows how a
<syntaxdiagram>can be used to illustrate
the syntax of a basic file-copy command. The initial
COPYF command is followed by the input directory
and file name. The input is followed by a choice of either an
output directory (and optional file name) or a file name.
<syntaxdiagram>
<title>CopyFile</title>
<groupseq><kwd>COPYF</kwd></groupseq>
<groupcomp><var>input-directory</var><kwd>*INFILE</kwd></groupcomp>
<groupchoice>
<groupcomp><var>output-directory</var><kwd importance="optional">*OUTFILE</kwd></groupcomp>
<groupcomp><kwd>*OUTFILE</kwd></groupcomp>
</groupchoice>
</syntaxdiagram><var>
The <var> element identifies a variable within a syntax diagram
or phrase.
Specialization hierarchy
The <var> element is specialized from <ph>.
It is defined in the syntax-diagram domain module, which is a specialization of the
programming domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
)*
Contained by
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synph>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
Inheritance
+ topic/ph pr-d/ph syntaxdiagram-d/var
The <var> element is specialized from
<ph>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes.
For this element, the
@importance attribute indicates
whether this item in a syntax diagram is optional, required,
or used by default. The attribute value is limited to
optional,
required,
default, or
-dita-use-conref-target.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@importance- For this element, the
@importanceattribute indicates whether this item in a syntax diagram is optional, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.
Example
This section is non-normative.
The following code sample shows how the
<var> element can be used to identify
variables for which the user will substitute the names of the input
and output files:
<syntaxdiagram frame="bottom">
<title>CopyFile</title>
<groupseq><kwd>COPYF</kwd></groupseq>
<groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp>
<groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq>
</syntaxdiagram>User interface domain
The user-interface domain elements are used to describe the graphical user interface of a software program.
<menucascade>
A menu cascade is a sequence of menu choices in a nested menu, such as .
<screen>
The <screen> element contains a textual representation of a
terminal console or other text-based computer interface.
Rendering expectations
Processors SHOULD preserve the
line breaks and spaces that are present in the content of a
<screen> element.
The contents of the <screen>
element is typically enclosed within a box to suggest a computer
display screen. It also is typically rendered in a monospaced
font.
Specialization hierarchy
The <screen> element is specialized from
<pre>. It is defined in the user-interface domain module.
Content model
(Text |
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<xref>
|
<data>
|
<sort-as>
|
<foreign>
|
<draft-comment>
|
<fn>
|
<indexterm>
|
<required-cleanup>
)*
Contained by
<dd>
,
<desc>
,
<div>
,
<draft-comment>
,
<entry>
,
<example>
,
<fallback>
,
<fig>
,
<figgroup>
,
<fn>
,
<li>
,
<lq>
,
<note>
,
<p>
,
<pd>
,
<stentry>
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<data> -
<draft-comment> -
<em> -
<filepath> -
<fn> -
<foreign> -
<hwcontrol> -
<i> -
<include> -
<indexterm> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<required-cleanup> -
<sort-as> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
-
<dd> -
<desc> -
<div> -
<draft-comment> -
<entry> -
<example> -
<fallback> -
<fig> -
<figgroup> -
<fn> -
<li> -
<lq> -
<note> -
<p> -
<pd> -
<stentry>
Inheritance
+ topic/pre ui-d/screen
The <screen> element is specialized from
<pre>
. It is defined in the ui-domain module.
Attributes
The following attributes are available on this element: display
attributes, universal
attributes, and @xml:space.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@expanse(display attributes)- Specifies the horizontal placement of the element. The
following values are valid:
- column
- Indicates that the element is aligned with the current column margin.
- page
- Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
- spread
- Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
- textline
- Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
For
<table>, in place of the@expanseattribute that is used by other DITA elements, the@pgwideattribute is used in order to conform to the OASIS Exchange Table Model.Some processors or output formats might not support all values.
@frame(display attributes)- Specifies which portion of a border surrounds the element.
The following values are valid:
- all
- Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
- bottom
- Indicates that a line is rendered at the bottom of the containing element.
- none
- Indicates that no lines are rendered.
- sides
- Indicates that a line is rendered at the left and right of the containing element.
- top
- Indicates that a line is rendered at the top of the containing element.
- topbot
- Indicates that a line is rendered at the top and bottom of the containing element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Some processors or output formats might not support all values.
@scale(display attributes)- Specifies the percentage by which fonts are resized in
relation to the normal text size. The value of this attribute
is a positive integer. When used on
<table>or<simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.This attribute is primarily useful for print-oriented display. Some processors might not support all values.
If the
@scaleattribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the<image>element. @xml:space- Specifies how to handle white space in the
current element. This attribute is provided
on
<pre>,<lines>, and on elements specialized from those. It ensures that parsers respect white space that is part of the data in those elements, including line-end characters. When defined, it has a fixed value of preserve, making it a default property of the element that cannot be changed or deleted by authors.
Example
This section is non-normative.
In the following code sample, the <screen> element is used to illustrate the steps needed to clone a git repository and check
status:
<screen>
workspace $ git clone git@example.com:oasis-tcs/dita-techcomm.git
Cloning into 'dita-techcomm'...
remote: Enumerating objects: 1023, done.
remote: Counting objects: 100% (31/31), done.
remote: Compressing objects: 100% (23/23), done.
remote: Total 1023 (delta 6), reused 21 (delta 4), pack-reused 992
Receiving objects: 100% (1023/1023), 9.87 MiB | 729.00 KiB/s, done.
Resolving deltas: 100% (367/367), done.
workspace $ cd dita-techcomm
dita-techcomm $ git status
On branch main
Your branch is up to date with 'origin/main'.
nothing to commit, working tree clean
dita-techcomm $
</screen><shortcut>
A shortcut is a keyboard shortcut that can perform a menu or window action.
Rendering expectations
The contents of the <shortcut> element is
typically underlined.
Specialization hierarchy
The <shortcut> element is specialized from
<keyword>. It is defined in the user-interface domain module.
Content model
(Text |
<text>
)*
Contained by
- Text
-
<text>
Contained by
Inheritance
+ topic/keyword ui-d/shortcut
The <shortcut> element is specialized from
<keyword>
. It is defined in the ui-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
In the following code sample, the <shortcut> element identifies the
keyboard shortcuts for navigating a menu to save a file:
<menucascade>
<uicontrol><shortcut>F</shortcut>ile</uicontrol>
<uicontrol><shortcut>S</shortcut>ave</uicontrol>
</menucascade><uicontrol>
A user interface control is a label for an item that allows a person or tool to control an interface, such as a button, field, menu item, or other object.
Usage information
The <uicontrol> element is also used inside
a <menucascade> element to identify a
sequence of menu choices in a nested menu, such as .
Specialization hierarchy
The <uicontrol> element is specialized from
<ph>. It is defined in the user-interface domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<term>
|
<abbreviated-form>
|
<text>
|
<image>
|
<shortcut>
)*
Contained by
<alt>
,
<b>
,
<booklibrary>
,
<booktitlealt>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<consequence>
,
<data>
,
<dd>
,
<ddhd>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<figgroup>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<keytext>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<menucascade>
,
<navtitle>
,
<note>
,
<overline>
,
<p>
,
<pd>
,
<ph>
,
<pre>
,
<pt>
,
<q>
,
<screen>
,
<searchtitle>
,
<shortdesc>
,
<sli>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<sup>
,
<synnote>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<xref>
- Text
-
<abbreviated-form> -
<apiname> -
<cmdname> -
<data> -
<foreign> -
<image> -
<keyword> -
<markupname> -
<msgnum> -
<numcharref> -
<option> -
<parameterentity> -
<parmname> -
<shortcut> -
<sort-as> -
<term> -
<text> -
<textentity> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi>
Contained by
-
<alt> -
<b> -
<booklibrary> -
<booktitlealt> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<consequence> -
<data> -
<dd> -
<ddhd> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<em> -
<entry> -
<example> -
<fallback> -
<figgroup> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<keytext> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<menucascade> -
<navtitle> -
<note> -
<overline> -
<p> -
<pd> -
<ph> -
<pre> -
<pt> -
<q> -
<screen> -
<searchtitle> -
<shortdesc> -
<sli> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<sup> -
<synnote> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<xref>
Inheritance
+ topic/ph ui-d/uicontrol
The <uicontrol> element is specialized from
<ph>
. It is defined in the ui-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<uicontrol> element can be used to
identify a button that a user is directed to press:
<p>Press <uicontrol>OK</uicontrol> to continue.</p><wintitle>
A window title is the name of a window or dialog.
Specialization hierarchy
The <wintitle> element is specialized from
<keyword>. It is defined in the user-interface domain module.
Content model
(Text |
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword ui-d/wintitle
The <wintitle> element is specialized from
<keyword>
. It is defined in the ui-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<wintitle> element can be used to tag the
name of the "Configuration Options" window:
<step>
<cmd>Click <uicontrol>Configure</uicontrol>.</cmd>
<stepresult>The <wintitle>Configuration Options</wintitle> window
opens with your last set of selections highlighted.</stepresult>
</step>XML mention domain
The XML-mention domain elements are used to describe and document XML document types and applications. They also can enable typographic styling, search and retrieval, and automatic indexing for XML constructs.
<numcharref>
A numeric character reference is a common markup construction that is used in markup languages such as HTML, SGML, and XML. It consists of a short sequence of characters that represents a single character.
Usage information
The content of the <numcharref> element should be the numeric value
without any leading or trailing characters, for example, 10 or
x0a.
Rendering expectations
The contents of the <numcharref> element is
typically rendered with a leading ampersand (&) and a trailing
semi-colon (;).
Specialization hierarchy
The <numcharref> element is specialized
from <markupname>; the
<numcharref> element is defined in the
XML-mention domain module. The <markupname>
element is specialized from <keyword>, and
the <markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/numcharref
The <numcharref> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how a
<numcharref> element can be used to tag
the numeric character reference for the a-acute Unicode
character:
<p>Numeric character references represent characters from the Universal
Character Set (UCS) of Unicode. They are used to reference characters that
cannot easily be directly encoded in a document, such as a copyright
symbol. When a markup-aware processor encounters a numeric character
reference, for example, <numcharref>225</numcharref>, it renders the
reference as the Unicode character that it represents: lower-case a with acute.</p><parameterentity>
A parameter entity is a syntactic construction that names a collection of elements, attributes, and attribute values. This enables reuse of the collection in grammar files.
Usage information
The content of the <parameterentity> element should be the entity
name without a leading percentage sign or trailing semi-colon, for example,
keyword.content.
Rendering expectations
The contents of the <parameterentity>
element is typically rendered with a leading percentage sign (%)
and a trailing semi-colon (;).
Specialization hierarchy
The <parameterentity> element is
specialized from <markupname>; the
<parameterentity> element is defined in
the XML-mention domain module. The
<markupname> element is specialized from
<keyword>, and the
<markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/parameterentity
The <parameterentity> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Examples
This section is non-normative.
The following code sample shows how the
<parameterentity> element can be used to
tag the name of the %xml-d-dec;
parameter entity:
<p>To include the XML-mention domain in a DTD document-type shell, declare and
reference the <parameterentity>xml-d-dec</parameterentity> parameter entity.</p><textentity>
A text entity is an XML construction that resolves to another value when the document is parsed.
Usage information
The content of the <textentity> element should be the entity name
without the ampersand and semi-colon delimiters, for example,
hi-d-att.
Rendering expectations
The contents of the <textentity> element is typically rendered with a
leading ampersand (&) and a trailing semi-colon (;).
Specialization hierarchy
The <textentity> element is specialized
from <markupname>; the
<textentity> element is defined in the
XML-mention domain module. The <markupname>
element is specialized from <keyword>, and
the <markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/textentity
The <textentity> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<textentity> element is used to tag the
token that the @deliveryTarget attribute domain
contributes to the @specializations attribute:
<p>The <textentity>deliveryTargetAtt-d-att</textentity> entity holds the contribution for the
<xmlatt>specializations</xmlatt> attribute.</p><xmlatt>
An XML attribute is a name and value pair that is associated with an XML element. It defines properties of the XML element.
Usage information
The content of the <xmlatt> element should
be the attribute name without the at symbol
(@), for example, processing-role.
Rendering expectations
The contents of the <xmlatt> element is
typically rendered with a preceding at symbol (@).
Specialization hierarchy
The <xmlatt> element is specialized from
<markupname>; the
<xmlatt> element is defined in the
XML-mention domain module. The <markupname>
element is specialized from <keyword>, and
the <markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/xmlatt
The <xmlatt> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<xmlatt> element can be used to tag
mentions of the @collection-type and
@linking attributes:
<p>The <xmlatt>collection-type</xmlatt> and <xmlatt>linking</xmlatt>
attributes affect how related links are generated for topics that are
referenced in the DITA map.</p><xmlelement>
An XML element is the basic building block of an XML document. It can contain text, other elements, processing instructions, and more.
Usage information
The content of the <xmlelement> element should be the element type
name without leading or trailing angle brackets.
Rendering expectations
The contents of the <xmlelement> element is
typically rendered with leading (<) and trailing (>) angle
brackets.
Specialization hierarchy
The <xmlelement> element is specialized
from <markupname>; the
<xmlelement> element is defined in the
XML-mention domain module. The <markupname>
element is specialized from <keyword>, and
the <markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/xmlelement
The <xmlelement> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<xmlelement> element can be used to tag
the <uicontrol> element from the
user-interface domain.
<p>Use the <xmlelement>uicontrol</xmlelement> element
to indicate the names of buttons, entry fields, menu items, or
other objects that enable a user to interact with a graphical user
interface.</p><xmlnsname>
The <xmlnsname> element identifies mentions of namespace
names.
Specialization hierarchy
The <xmlnsname> element is specialized from
<markupname>; the
<xmlnsname> element is defined in the
XML-mention domain module. The <markupname>
element is specialized from <keyword>, and
the <markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/xmlnsname
The <xmlnsname> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how an
<xmlnsname> element can be used to tag the
namespace for SVG:
<p>SVG markup is specified in an <xmlelement>svg</xmlelement> element with
the namespace <xmlnamespace>http://www.w3.org/2000/svg</xmlnamespace>.</p><xmlpi>
The <xmlpi> element identifies mentions of processing
instruction names.
Specialization hierarchy
The <xmlpi> element is specialized from
<markupname>; the
<xmlpi> element is defined in the
XML-mention domain module. The <markupname>
element is specialized from <keyword>, and
the <markupname> element is defined in the
markup-name domain module.
Content model
(Text |
<draft-comment>
|
<required-cleanup>
|
<text>
)*
Contained by
<alt>
,
<author>
,
<b>
,
<booklibrary>
,
<booknumber>
,
<bookpartno>
,
<booktitlealt>
,
<brand>
,
<category>
,
<change-request-id>
,
<change-request-system>
,
<change-revisionid>
,
<change-summary>
,
<cite>
,
<codeblock>
,
<codeph>
,
<component>
,
<consequence>
,
<coords>
,
<copyrholder>
,
<data>
,
<day>
,
<dd>
,
<ddhd>
,
<delim>
,
<desc>
,
<div>
,
<draft-comment>
,
<dt>
,
<dthd>
,
<edition>
,
<em>
,
<entry>
,
<example>
,
<fallback>
,
<featnum>
,
<figgroup>
,
<filepath>
,
<fn>
,
<fragref>
,
<howtoavoid>
,
<hwcontrol>
,
<i>
,
<index-see>
,
<index-see-also>
,
<indexterm>
,
<isbn>
,
<keytext>
,
<keywords>
,
<li>
,
<line-through>
,
<lines>
,
<linktitle>
,
<lq>
,
<mainbooktitle>
,
<month>
,
<msgblock>
,
<msgph>
,
<navtitle>
,
<note>
,
<oper>
,
<organization>
,
<overline>
,
<p>
,
<partno>
,
<pd>
,
<person>
,
<ph>
,
<platform>
,
<pre>
,
<printlocation>
,
<prodname>
,
<prognum>
,
<pt>
,
<publisher>
,
<q>
,
<repsep>
,
<revisionid>
,
<screen>
,
<searchtitle>
,
<sep>
,
<series>
,
<shortdesc>
,
<sli>
,
<sort-as>
,
<source>
,
<stentry>
,
<strong>
,
<sub>
,
<subtitle>
,
<summary>
,
<sup>
,
<synnote>
,
<systemoutput>
,
<title>
,
<titlealt>
,
<titlehint>
,
<tt>
,
<typeofhazard>
,
<u>
,
<uicontrol>
,
<userinput>
,
<var>
,
<volume>
,
<xref>
,
<year>
- Text
-
<draft-comment> -
<required-cleanup> -
<text>
Contained by
-
<alt> -
<author> -
<b> -
<booklibrary> -
<booknumber> -
<bookpartno> -
<booktitlealt> -
<brand> -
<category> -
<change-request-id> -
<change-request-system> -
<change-revisionid> -
<change-summary> -
<cite> -
<codeblock> -
<codeph> -
<component> -
<consequence> -
<coords> -
<copyrholder> -
<data> -
<day> -
<dd> -
<ddhd> -
<delim> -
<desc> -
<div> -
<draft-comment> -
<dt> -
<dthd> -
<edition> -
<em> -
<entry> -
<example> -
<fallback> -
<featnum> -
<figgroup> -
<filepath> -
<fn> -
<fragref> -
<howtoavoid> -
<hwcontrol> -
<i> -
<index-see> -
<index-see-also> -
<indexterm> -
<isbn> -
<keytext> -
<keywords> -
<li> -
<line-through> -
<lines> -
<linktitle> -
<lq> -
<mainbooktitle> -
<month> -
<msgblock> -
<msgph> -
<navtitle> -
<note> -
<oper> -
<organization> -
<overline> -
<p> -
<partno> -
<pd> -
<person> -
<ph> -
<platform> -
<pre> -
<printlocation> -
<prodname> -
<prognum> -
<pt> -
<publisher> -
<q> -
<repsep> -
<revisionid> -
<screen> -
<searchtitle> -
<sep> -
<series> -
<shortdesc> -
<sli> -
<sort-as> -
<source> -
<stentry> -
<strong> -
<sub> -
<subtitle> -
<summary> -
<sup> -
<synnote> -
<systemoutput> -
<title> -
<titlealt> -
<titlehint> -
<tt> -
<typeofhazard> -
<u> -
<uicontrol> -
<userinput> -
<var> -
<volume> -
<xref> -
<year>
Inheritance
+ topic/keyword markup-d/markupname xml-d/xmlpi
The <xmlpi> element is specialized from
<markupname>
. It is defined in the xml-domain module.
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@callout- Specifies the character or character string that is used for the footnote link.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how an
<xmlpi> element can be used to tag the
name of a processing instruction:
<p>While DITA does not define any processing instructions, applications might
use some DocBook processing instructions, such as <xmlpi>dbhtml_bgcolor</xmlpi>.</p>