Repository navigation
Add abbreviated terms, symbols and mnemonics to Clause 3 (#435) - #438
Merged
Merged
Conversation
Add optional dl#terms-abbr, dl#terms-symbols and dl#terms-mnemonics lists. When any is present, Clause 3 is split into subclauses under an ISO composite title and terms are numbered 3.1.n. Validation checks element and entry order (ISO 17.5 order for symbols) and that entries are used in the text. An <abbr> without a title now gets its expansion from the list. Closes #435 Closes #8
An <a> without an href now resolves in this order: 1. a dfn, either in terms-int-defs or inline via data-lt (as before) 2. the matching entry in terms-abbr, terms-symbols or terms-mnemonics Each list entry gets a generated id (abbr-, symbol-, mnemonic-). Matching ignores case and accepts a trailing "s". When the link text is a known abbreviation, the link also shows its expansion on hover. Documents the resolution order in doc/main.html and adds the terms-lists-links-valid fixture. Refs #8
expansion must then match a synonym of the term, and the entry links back to the term.
References now match common English plurals of the last word of a term and of each data-lt form: +s, +es (s, x, z, ch, sh), y -> ies, ex/ix -> ices, is -> es, um/on -> a. Generated forms never cause duplicate definitions and yield to explicit terms. Irregular plurals use data-lt. The same rules apply to abbreviated terms, symbols and mnemonics, and the abbreviation usage check accepts plurals. Closes #415
Most end tags are optional in HTML, so a broken end tag such as "Identifier/dd>" parses as text and passes HTML validation, ending up in the definition or abbreviation expansion. Report such fragments anywhere in the body text, except inside pre, code, samp and kbd. Adds the malformed-end-tag-abbr-invalid and malformed-end-tag-intdefs-invalid fixtures.
raymondyyeungDBL
approved these changes
Sep 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clause 3 can now also list abbreviated terms, symbols and mnemonics, per
ISO Directives Part 2 Clause 17. Authors add up to three new optional
lists after terms-int-defs, in this order:
dl#terms-abbr abbreviated terms
dl#terms-symbols symbols
dl#terms-mnemonics mnemonics
The source stays flat. When any of these lists is present, rendering:
subclause per list present (Abbreviated terms, Symbols, Mnemonics)
e.g. "Terms, definitions and abbreviated terms"
change
"The following data types are used for data specifications:" and the
data-intro attribute replaces it
Documents without the new lists render exactly as before.
Validation:
case
letter indices, then numeric indices; Latin, then Greek, then other);
data-order="technical" skips this check for the symbols list only
Also resolves #8: an without a title gets its expansion from
terms-abbr, or from another with the same text written
inline in the document.
Includes 21 new validation fixtures and updates to doc/main.html.
Closes #435
Closes #8