component
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. An implementation may (but need
not) use this identification to check cross-component dependencies
when some components are installed, but not others. An implementation
may also (but need not) use the identification to make
sure that topics are hidden, removed, or flagged in some way when
the component they describe isn't installed.
Contains
Note
These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
| Doctype | Content model |
|---|---|
| topic (base), map (base), classifyMap, subjectScheme, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | ( text data or data or data-about or foreign or unknown or keyword or term) (any number) |
| topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap | ( text data or data or data-about or foreign or unknown or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or term or abbreviated-form) (any number) |
| machineryTask | ( text data or data or data-about or foreign or unknown or keyword or wintitle or term) (any number) |
Contained by
| Doctype | Content model |
|---|---|
| topic (base), map (base), topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | prodinfo |
Inheritance
- topic/component
Example
<prodinfo> <prodname>BatCom</prodname> <vrmlist> <vrm version="v5r2"/> </vrmlist> <component>TCP/IP</component> </prodinfo>
Attributes
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class | A common attribute described in Other common DITA attributes |