5 Headings

5.1 Use AsciiDoc syntax for headings (ASM-85)

Exceptions

There are no exceptions.

Example

Table 32. Use of AsciiDoc syntax for headings
No Yes

*1 Heading*

= Heading (level 1)

*1.1 Heading*

== Heading (level 2)

*1.1.1 Heading*

== Heading (level 3)

*1.1.1.1 Heading*

=== Heading (level 4)

Source

docs.asciidoctor.org/asciidoc/latest/sections/titles-and-levels/

5.2 Use a maximum of five levels for headings (ASM-86)

  • Headings up to the fourth level shall be numbered.

  • Headings of the fifth level shall not be numbered and highlighted by bold markup.

Exceptions

There are no exceptions.

Example

Code

= General architecture

== General rules and assumptions

=== Traffic direction

==== Left direction

*Rules*

*Examples*

Result

6 General architecture

6.1 General rules and assumptions

6.5.1 Traffic direction

6.5.1.1 Left direction

Rules

Examples

Source

ASAM specific rule.

5.3 Start headings with a capital letter (ASM-2)

  • In headings and captions the first word begins with an uppercase letter (sentence-style capitalization).

Exceptions

Acronyms and proper names are spelled as is.

Example

Table 33. Use of uppercase in headings and captions
No Yes

Wrong Formatting of a Heading

Correct formatting of a heading

Asam rules to follow

ASAM rules to follow

Scope of OpenScenario

Scope of ASAM OpenSCENARIO

Source

ASAM specific rule.

5.4 End headings without punctuation (ASM-3)

  • Do not use any punctuation at the end of a heading.

Exceptions

There are no exceptions.

Example

Table 34. Use of punctuation in headings
No Yes

Wrong punctuation in a heading.

Correct heading without punctuation

Is punctuation allowed in a heading?

Headings shall not use punctuation

Source

ASAM specific rule.

5.5 Use the automatic numbering (ASM-4)

  • Do not use any manual numbering in combination with a heading.

  • Headings are numbered automatically.

Exceptions

There are no exceptions.

Example

Table 35. Use of numbering in headings
No Yes

== 13. Wrong numbering in a heading

== Correct heading without numbering

== 14.3 Wrong numbering in a heading

== Correct heading without numbering

=== 14.3.a) Wrong numbering in a heading

=== Correct heading without numbering

Source

ASAM specific rule.