Enumerated References Extension

Vladimir Schneider edited this page Mar 12, 2018 · 1 revision

Enumerated references extension, in conjunction with the Attributes extension allows easy references with text and ordinal number to be created and automatically updated as the documentation evolves.

To create an element anchor or bookmark use the id attribute syntax of {#type:reference} after the element to be referenced. Where type is a category used to keep separate numbering within the category and reference is used to uniquely identify an element in the category. The anchor id of the element will be type:reference and this must be used by the enumerated reference label or link.

To refer to the element in the document use the enumerated reference elements:

  1. A reference link syntax [@type:reference] converts to a link based on type pattern defined in enumerated reference format definition. The target of the link will be an element with a {#type:reference} attribute assigned to it. The text of the link will be that which is defined by the enumerated reference definition for type.

  2. A reference text syntax [#type:reference] converts to text which is defined by the enumerated reference definition for type. This is to be used where the identifying text of the element within the document is needed.

  3. One reference definition for each type must be included in the document. Syntax [@type]: Label Text [#] is used to define how to create a label for all elements of the given type. This usually includes the ordinal position of the element in the document.

    Text following the [@type]: is used as the label with the [@] or [#] replaced by the ordinal number of the element in the document relative to other elements of the same type. The first element will have ordinal of 1, second 2, etc.

    If a type has no enumerated definition then type [#] will be used where type is the category type and [#] is the ordinal of the element in its category. It is equivalent to specifying [@type]: type [#] in the document.

For example:



| table |
| data  |
[[#tbl:test] caption]

See [@fig:test2]

See [@fig:test]

See [@tbl:test]

[@fig]: Figure [#].

[@tbl]: Table [#].

is equivalent to the following without having to manually keep track of numbering of individual elements:

Figure 1.

Figure 2.

| table |
| data  |
[Table 1. caption]

See [Figure 2.](#fig:test2)

See [Figure 1.](#fig:test)

See [Table 1.](#tbl:test)

:exclamation: Note that attributes extension is needed in order for the references to be properly resolved for rendering.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.