Home
Metadata, conditional processing, and indexing
Filtering and flagging
Content marked with metadata attributes can be conditionally processed so that the content is filtered (excluded) or flagged (highlighted) in the published output.
Conditional processing dangers
Any filtering conditions that apply must still result in valid DITA mark-up.

Introduction
Information types and topics
Topics are the building blocks of modular documents, and organising topics by semantic information types is one of the architectural features of DITA.
DITA map files
Syntax and mark-up
Language and punctuation
Graphics and figures
Cross-referencing
Cross-references are a means of binding individual topics into a coherent and navigable document.
Content re-use
Metadata, conditional processing, and indexing
- Conditional processing concepts
  When DITA content is processed to a reading format, rules to exclude or highlight some of the content can be defined in a ditaval file. This conditional processing requires metadata attributes to be set on DITA elements that may possibly be excluded or highlighted.
- Condition (or select) attributes
  The audience, platform, product, otherprops and rev attributes can be applied to most DITA elements. They are used for conditional processing, and are known as the condition (or select) attributes.
- Filtering and flagging
  Content marked with metadata attributes can be conditionally processed so that the content is filtered (excluded) or flagged (highlighted) in the published output.
  - Excluding topics: conditional processing at topic level
    If a whole topic is to be excluded from the output in a conditional processing scenario (that is, the condition applies to a whole topic), the metadata attribute must be defined in the topic reference in the ditamap.
  - Conditional processing dangers
    Any filtering conditions that apply must still result in valid DITA mark-up.
  - Conditions versus transclusion
    Transclusion, or content referencing, can sometimes achieve the same publishing aim as conditional processing. There are pros and cons for either method.
  - Include and exclude filtering actions
    In typical publishing tools, filtering and flagging actions to be taken during processing are defined in a ditaval file.
  - Limiting the use of conditions
    You should take care to limit the complexity of conditions that you apply to content. Context-agnostic writing is often a better approach.
  - Filtering ditamaps
    When filtering a nested ditamap, you should apply the condition attribute to the reference (topicref or mapref element) to the nested ditamap, rather than to the map element.
  - Filtering composite (ditabase) topics
    Care must be taken when applying conditions to composite topics, as filtering a nested topic through the topicref element will not necessarily result in the topic being excluded.
  - Print versus non-print metadata
    You can use condition attributes in topic elements, the print attribute in the topicref element, separate ditamaps, or a combination of these approaches when you need to produce different print and non-print versions of the same document.
- Other metadata
  In addition to the select attributes, DITA content includes many forms of metadata. These metadata elements and attributes are used to manage and organise topics, ditamaps and publications.
- Indexing
  DITA incorporates powerful features for indexing, including multi-level indexing, and see and see-also redirection. Index entries can be applied in the ditamap, in the topic prolog, and inline within the topic content.
The DITA documentation process
DITA authoring concepts
Moving from style-based authoring to a structured authoring methodology such as DITA requires a radically different approach to writing.

Conditional processing dangers

Any filtering conditions that apply must still result in valid DITA mark-up.

When using filtering in single-sourcing, you must be careful to ensure that a conditional processing rule doesn't result in invalid DITA. Filtering must not result in a required element being removed during processing.

For example, in the following snippet, if a condition of exclude web_only and exclude print_only was set, there would be no steps in the task, and the topic would be invalid. (The steps element requires at least one child step element.)

 
      <task id="myTopic"> 
      <title>Making a Warranty Claim</title> 
      <taskbody> 
      <context>...</context> 
	     <steps>
        <step otherprops="web_only">...</step> 
        <step otherprops="print_only">...</step>
      </steps> 
      <result>...</result> 
      </taskbody> 
      </task>