| FlexDoc/XML XSDDoc Demo | XML Schemas for DITA 1.1

Overview All Components NS-Bindings | FRAMES NO FRAMES | SEARCH |

element <component>

Namespace: | {no namespace}
Type: | anonymous complexType (extension of component.class)
Content: | mixed, 16 attributes, 13 elements
Defined: | globally in metaDeclMod.xsd; see XML source
Includes: | declaration of 1 attribute
Referenced: | by 1 location

Component Diagram

XML Representation Summary
<component
id | = | xs:NMTOKEN
conref | = | xs:string
props | = | xs:string
platform | = | xs:string
product | = | xs:string
audience | = | xs:string
otherprops | = | xs:string
base | = | xs:string
rev | = | xs:string
importance | = | ("obsolete" | "deprecated" | "optional" | "default" | "low" | "normal" | "high" | "recommended" | "required" | "urgent" | "-dita-use-conref-target")
status | = | ("new" | "changed" | "deleted" | "unchanged" | "-dita-use-conref-target")
translate | = | ("yes" | "no" | "-dita-use-conref-target")
xml:lang | = | xs:language
xtrc | = | xs:string
xtrf | = | xs:string
class | = | xs:string : "- topic/component "
| >
Content: | {text} × (keyword | option | parmname | apiname | wintitle | msgnum | varname | cmdname | term | data | data-about | foreign | unknown)*
</component>

Attributes:

Attribute | Type / Value | Default | Required? | Declared In | Description
id | xs:NMTOKEN |  | no | id-atts |
conref | xs:string |  | no | id-atts |
props | xs:string |  | no | filter-atts |
platform | xs:string |  | no | filter-atts |
product | xs:string |  | no | filter-atts |
audience | xs:string |  | no | filter-atts |
otherprops | xs:string |  | no | filter-atts |
base | xs:string |  | no | select-atts |
rev | xs:string |  | no | select-atts |
importance | importance-atts.class : ("obsolete" | "deprecated" | "optional" | "default" | "low" | "normal" | "high" | "recommended" | "required" | "urgent" | "-dita-use-conref-target") |  | no | select-atts |
status | status-atts.class : ("new" | "changed" | "deleted" | "unchanged" | "-dita-use-conref-target") |  | no | select-atts |
translate | yesno-att.class : ("yes" | "no" | "-dita-use-conref-target") |  | no | univ-atts |
xml:lang | xs:language |  | no | univ-atts | In due course, we should install the relevant ISO 2- and 3-letter codes as the enumerated possible values . . .
xtrc | xs:string |  | no | global-atts |
xtrf | xs:string |  | no | global-atts |
class | xs:string | "- topic/component " | no | this | The class attribute supports specialization. »

Content Element Model:

Component | Type / Value | Occurs | Nillable? | Declared In | Description
{text} × | character data |  |  |  | may appear between child elements
CHOICE |  | 0..∞ |  | words.cnt |
keyword | anonymous | 1..1 | no | keyword (ver 1) | The <keyword> element identifies a keyword or token, such as a single value from an enumerated list, the name of a command or parameter, or a lookup key for a message (contrast with term).
option | anonymous | 1..1 | no | pr-d-keyword | The <option> element describes an option that can be used to modify a command (or something else, like a configuration). »
parmname | anonymous | 1..1 | no | pr-d-keyword | When referencing the name of an application programming interface parameter within the text flow of your topic, use the parameter name (<parmname>) element to markup the parameter. »
apiname | anonymous | 1..1 | no | pr-d-keyword | The <apiname> element provides the name of an application programming interface (API) such as a Java class name or method name. »
wintitle | anonymous | 1..1 | no | ui-d-keyword | The window title <wintitle> element represents the title text that appears at the top of a window or dialog, and applies to wizard titles, wizard page titles, and pane titles. »
msgnum | anonymous | 1..1 | no | sw-d-keyword | The message number (<msgnum>) element contains the number of a message produced by an application or program. »
varname | anonymous | 1..1 | no | sw-d-keyword | The variable name (<varname>) element defines a variable that must be supplied to a software application. »
cmdname | anonymous | 1..1 | no | sw-d-keyword | The command name (<cmdname>) element specifies the name of a command when it is part of a software discussion. »
term | anonymous | 1..1 | no | term | The <term> element identifies words that represent extended definitions or explanations. »
data | anonymous | 1..1 | no | data | The <data> element represents a property within a DITA topic or map. »
data-about | anonymous | 1..1 | no | data-about | The <data-about> element identifies the subject of a property when the subject isn't associated with the context in which the property is specified. »
foreign | anonymous | 1..1 | no | foreign | The <foreign> element is an open extension that allows information architects to incorporate existing standard vocabularies for non-textual content. like MathML and SVG, as inline objects. »
unknown | anonymous | 1..1 | no | unknown | The <unknown> element is an open extension that allows information architects to incorporate xml fragments that does not necessarily fit into an exisitng DITA use case. »

Description
The <component> element describes the component of the product that this topic is concerned with. For example, a product might be made up of many components, each of which is installable separately. Components might also be shared by several products so that the same component is available for installation with many products. This identification can be used to check cross-component dependencies when some components are installed, but not others. It could also be used to make sure that topics are hidden, removed, or flagged in some way when the component they describe isn't installed. Such process-control logic is not currently supported in DITA processing.
Related Components

- Included in content model of elements (1):
  prodinfo

Referenced By

- In model groups (1):
  component [ref]

Anonymous Type Detail

Type Derivation Tree component.class (extension) complexType

Overview All Components NS-Bindings | FRAMES NO FRAMES | SEARCH |

XML schema documentation generated with FlexDoc/XML 1.15 using FlexDoc/XML XSDDoc 3.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.