6.5.8 Understanding default attribute-based prefixes and headings

Your DITA2Go distribution includes default attribute-based format-name prefixes for <note> elements, and default prefixes based on the importance attribute for all elements, in system configuration file d2g_config.ini. If you want run-in headings different from those determined by these attributes, or no run-in headings at all, you must override the default configuration settings with your own.

The default for a <note> element is to use a run-in format (in system format configuration file d2htm_subformats.ini), which has a <name/> component. The actual name comes from system language configuration file d2g_lang_en.ini. The name does not come from the attribute value.

Type attribute for <note> elements

For <note>, the value of the type attribute (if any) determines which run-in heading will be prefixed to the text. The name of the format of the run-in heading consists of the value of the type attribute prefixed to Head. The content of the run-in heading consists of the text assigned to the name of the run-in heading format, in the [RuninHeadText] section of whichever language configuration template is in force. If a particular <note> element has no type attribute, DITA2Go does not include a run-in heading for that instance, unless you specify a default value for @type.

To specify a default type for any <note> element that lacks a type attribute; for example, note:

[ElementOptions]
; DefaultNoteType = value to use for @type if it is omitted;
; default is nothing, per the DITA spec. 
DefaultNoteType = note

If you do not specify a value for DefaultNoteType, no run-in heading is included in the output for any instance of <note> that does not contain a type attribute.

Note:  The DITA Open Toolkit assumes the value note when @type is missing.

Importance attribute for all text elements

For all text elements, the value of the importance attribute (if any) determines a format-name prefix, and the content of the associated run-in heading is specified by the run-in heading format assigned to each importance value. For <step>, importance attribute values required and optional specify a special run-in heading for the Step format.

Previous Topic:  6.5.7 Understanding how prefixes modify output formats

Next Topic:  6.6 Specifying formats for cross references

Parent Topic:  6.5 Mapping element attributes to output formats

Sibling Topics:

6.5.1 Listing elements whose attributes can affect output formats

6.5.2 Listing attributes whose values can affect output formats

6.5.3 Assigning format-name prefixes to attribute values

6.5.4 Assigning run-in headings to format-name prefixes

6.5.5 Deciding which formats need a run-in heading property

6.5.6 Understanding the order of prefixes for multiple attributes

6.5.7 Understanding how prefixes modify output formats