[everywhere] Rework how we mark up inline references. #1690
Conversation
This file contains 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
|
Do the ISO drafting directives allow the word "Annex" in a reference? I think I have a similar pull request open where this question needs to be resolved. |
Visual changes:
* The "Clause" and "Annex" in "Clause N" and "Annex N" are now part of
the hyperlink.
* Fewer words are hyphenated (we prefer to move an inline reference
across a line break rather than hyphenating a word)
* Some spurious "Clause"s and "Annex"es are gone and some missing ones
are now present.
LaTeX-level changes:
Instead of "some text~(\ref{blah})", we now use "some text\iref{blah}".
Instead of "Clause~\ref{blah}", we now use simply "\ref{blah}", and the
"Clause" prefix is automatically added (likewise for "Annex").
For multi-reference parentheticals, use "some text (\ref{a}, \ref{b})".
A longer orphaned parenthetical is not really a big deal.
~s should now generally not be used near \ref's.
|
"Annex" is expected prior to a reference to an annex, per Directives Part 2 (7th ed), 6.1, and examples throughout the directives. |
|
This has already been applied as beb8815. |
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.
Visual changes:
the hyperlink.
across a line break rather than hyphenating a word)
are now present.
LaTeX-level changes:
Instead of "some text~(\ref{blah})", we now use "some text\iref{blah}".
Instead of "Clause~\ref{blah}", we now use simply "\ref{blah}", and the
"Clause" prefix is automatically added (likewise for "Annex").
For multi-reference parentheticals, use "some text (\ref{a}, \ref{b})".
A longer orphaned parenthetical is not really a big deal.
~s should now generally not be used near \ref's.