Skip to content
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.

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

[std] Multiple notes and examples within the same subclause shall be numbered #3522

Closed
JohelEGP opened this issue Dec 5, 2019 · 5 comments
Closed
Labels
decision-required A decision of the editorial group (or the Project Editor) is required.

Comments

@JohelEGP
Copy link
Contributor

JohelEGP commented Dec 5, 2019

So says the ISO Directives, Part 2:
https://www.iso.org/sites/directives/current/part2/index.xhtml#_idTextAnchor328
https://www.iso.org/sites/directives/current/part2/index.xhtml#_idTextAnchor342

@jwakely
Copy link
Member

jwakely commented Dec 5, 2019

The purpose of that is to be able to refer to a note unambiguously. In theory we achieve that by numbering our paragraphs, although that means the notes don't have consecutive numbers starting from one. In practice I think we have a few places where we put two notes in a single paragraph.

@jwakely
Copy link
Member

jwakely commented Dec 5, 2019

Also, ISO have never asked us to change this when we submit a new IS or TS.

@jensmaurer jensmaurer added big An issue causing a large set of changes, scattered across most of the text. decision-required A decision of the editorial group (or the Project Editor) is required. and removed big An issue causing a large set of changes, scattered across most of the text. labels Dec 5, 2019
@jensmaurer
Copy link
Member

Even with that change, we're still not satisfying the all-caps presentation of the note and example introducers that the ISO Directives desire.
It would probably be a relatively small change to add subclause-local sequential numbers to notes and examples, if we so desire.

@JohelEGP
Copy link
Contributor Author

JohelEGP commented Dec 5, 2019

Even with that change, we're still not satisfying the all-caps presentation of the note and example introducers that the ISO Directives desire.

I think it's fine, given https://www.iso.org/sites/directives/current/part2/index.xhtml#_idTextAnchor003:

The ISO/IEC Directives, Part 2 does not specify the typography and layout of documents, which are determined by the house style of the publishing organization. Presentation is outside of the scope of the ISO/IEC Directives, Part 2.

@jwakely Perhaps that means that it's fine as is. With wg21.link, you can reference specific notes within a paragraph. And in text, too (e.g. the second note in [xxx]p2).

@JohelEGP JohelEGP changed the title Multiple notes and examples within the same subclause shall be numbered [std] Multiple notes and examples within the same subclause shall be numbered Dec 6, 2019
@jensmaurer
Copy link
Member

Editorial meeting: We believe our notes and examples are well-numbered. ISO CS will advise if they disagree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
decision-required A decision of the editorial group (or the Project Editor) is required.
Projects
None yet
Development

No branches or pull requests

3 participants