Enumerated References Extension

flexmark-java extension for enumerated reference processing

Overview

An enumerated reference is a based on an id specified by Attributes elmenet (see Attributes Extension) of the form category:elementId. Category is an arbitrary category identifier used to generate a numeric sequence for each element in the category. The elmentId part is used to uniquely identify the element within the category.

Syntax

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.

ℹ️ type must not start with a digit.

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:

![Flexmark Icon Logo](https://github.com/vsch/flexmark-java/raw/master/assets/images/flexmark-icon-logo%402x.png){#fig:test}
[#fig:test]

![Flexmark Icon Logo](https://github.com/vsch/flexmark-java/raw/master/assets/images/flexmark-icon-logo%402x.png){#fig:test2}
[#fig:test2]

| heading | heading | heading |
|---------|---------|---------|
| data    | data    |         |
[[#tbl:test] caption]
{#tbl:test}

See [@fig:test2]

See [@fig:test]

See [@tbl:test]

[@tbl]: Table [#].

[@fig]: Figure [#].

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

![Flexmark Icon Logo](https://github.com/vsch/flexmark-java/raw/master/assets/images/flexmark-icon-logo%402x.png){#fig:test}
Figure 1.

![Flexmark Icon Logo](https://github.com/vsch/flexmark-java/raw/master/assets/images/flexmark-icon-logo%402x.png){#fig:test2}
Figure 2.

| table |
|-------|
| data  |
[Table 1. caption]
{#tbl:test}

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

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

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

Will render as:

<p><img src="http://example.com/test.png" alt="Fig" id="fig:test" /><br />
<span>Figure 1.</span></p>
<p><img src="http://example.com/test.png" alt="Fig" id="fig:test2" /><br />
<span>Figure 2.</span></p>
<table id="tbl:test">
  <thead>
    <tr><th>table</th></tr>
  </thead>
  <tbody>
    <tr><td>data</td></tr>
  </tbody>
  <caption><span>Table 1.</span> caption</caption>
</table>
<p></p>
<p>See <a href="#fig:test2"><span>Figure 2.</span></a></p>
<p>See <a href="#fig:test"><span>Figure 1.</span></a></p>
<p>See <a href="#tbl:test"><span>Table 1.</span></a></p>

Enumerated Reference Text in Headings

Because headings contain their own anchor id an enumerated reference with only a type is allowed in headings and has the effect of adding an incremented counter to heading text.

# [#hd1] Heading 1

# [#hd1] Heading 2

# [#hd1] Heading 3

[@hd1]: [#].

Will render as:

<h1>1. Heading 1</h1>
<h1>2. Heading 2</h1>
<h1>3. Heading 3</h1>

Compound Types

Compound enumerated reference types are created by including more than one type reference with : separating each type.

The effect of compound reference is that all child reference counters are reset to 1 for change in parent type's ordinal allowing creation of legal numbering using enumerated references.

ℹ️ When combining enumerated type ordinal strings for compound enumerated reference if the last element of the enumerated format definition is an empty enumerated reference text [#] or empty enumerated reference link [@] then a . will be added after the parent enumerated ordinal text.

ℹ️ For compound type for headings without an element id, a trailing : is needed to prevent the last type from being interpreted as the element id.

# [#hd1] Heading 1

## [#hd1:hd2:] Heading 1.1

### [#hd1:hd2:hd3:] Heading 1.1.1

### [#hd1:hd2:hd3:] Heading 1.1.2

## [#hd1:hd2:] Heading 1.2

### [#hd1:hd2:hd3:] Heading 1.2.1

### [#hd1:hd2:hd3:] Heading 1.2.2

# [#hd1] Heading 2

## [#hd1:hd2:] Heading 2.1

### [#hd1:hd2:hd3:] Heading 2.1.1

### [#hd1:hd2:hd3:] Heading 2.1.2

[@hd1]: [#].
[@hd2]: [#].
[@hd2]: [#].

Will render as:

<h1>1. Heading 1</h1>
<h2>1.1. Heading 1.1</h2>
<h3>1.1.1. Heading 1.1.1</h3>
<h3>1.1.2. Heading 1.1.2</h3>
<h2>1.2. Heading 1.2</h2>
<h3>1.2.1. Heading 1.2.1</h3>
<h3>1.2.2. Heading 1.2.2</h3>
<h1>2. Heading 2</h1>
<h2>2.1. Heading 2.1</h2>
<h3>2.1.1. Heading 2.1.1</h3>
<h3>2.1.2. Heading 2.1.2</h3>

Similarly other enumerated references can be used:

# [#hd1] Heading 1

![image-base64.png](https://github.com/vsch/MarkdownTest/raw/master/image-base64.png) {#hd1:fig:img1} 
[#hd1:fig:img1]

# [#hd1] Heading 2

![image-base64.png](https://github.com/vsch/MarkdownTest/raw/master/image-base64.png) {#hd1:fig:img2} 
[#hd1:fig:img2]

[@hd1]: [#].
[@fig]: Figure [#].

Will render as:

<h1>1. Heading 1</h1>
<p><img src="https://github.com/vsch/MarkdownTest/raw/master/image-base64.png" alt="image-base64.png" /><span id="hd1:fig:img1"> </span>
Figure 1.1.</p>
<h1>2. Heading 2</h1>
<p><img src="https://github.com/vsch/MarkdownTest/raw/master/image-base64.png" alt="image-base64.png" /><span id="hd1:fig:img2"> </span>
Figure 2.1.</p>

Parsing Details

Use class EnumeratedReferenceExtension from artifact flexmark-ext-enumerated-reference.

❗ Note Attributes extension is needed in order for references to be properly resolved for rendering.