Skip to content

Specify punctuation handling for auto-generated heading IDs #393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
karlb wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −6
Open

Specify punctuation handling for auto-generated heading IDs #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,9 @@
* Use the JavaScript reference implementation, not the Lua one
to generate expected output in syntax.html.

* Specify punctuation handling for auto-generated heading IDs:
each maximal run of non-alphanumeric ASCII characters is
replaced with `-`, and leading/trailing `-` are trimmed. This
settles remove-vs-replace as replace and removes the previous
exceptions for individual punctuation characters (#391).

7 changes: 4 additions & 3 deletions doc/syntax.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1753,9 +1753,10 @@ <h3>Links to headings</h3>
do not have explicit identifiers attached to them.
The identifier is formed by taking the plain text content of
the heading, excluding non-textual elements such as footnote
references and symbols, removing punctuation (other than <code>_</code>
and <code>-</code>), replacing spaces with <code>-</code>, and if necessary for
uniqueness, adding a numerical suffix.</p>
references and symbols, replacing each maximal run of
non-alphanumeric ASCII characters with <code>-</code>, removing any
leading or trailing <code>-</code>, and if necessary for uniqueness,
adding a numerical suffix.</p>
<p>For example, <code># Introduction[^1]</code> generates the identifier
<code>Introduction</code>, not <code>Introduction1</code>.</p>
<div class="example">
Expand Down
7 changes: 4 additions & 3 deletions doc/syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,9 +765,10 @@ Identifiers are added automatically to any headings that
do not have explicit identifiers attached to them.
The identifier is formed by taking the plain text content of
the heading, excluding non-textual elements such as footnote
references and symbols, removing punctuation (other than `_`
and `-`), replacing spaces with `-`, and if necessary for
uniqueness, adding a numerical suffix.
references and symbols, replacing each maximal run of
non-alphanumeric ASCII characters with `-`, removing any
leading or trailing `-`, and if necessary for uniqueness,
adding a numerical suffix.

For example, `# Introduction[^1]` generates the identifier
`Introduction`, not `Introduction1`.
Expand Down