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

Terms and definitions: Format, Abbreviations #194

Closed
ERyan71258 opened this issue Dec 15, 2023 · 4 comments
Closed

Terms and definitions: Format, Abbreviations #194

ERyan71258 opened this issue Dec 15, 2023 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@ERyan71258
Copy link
Collaborator

ERyan71258 commented Dec 15, 2023

The terms are not numbered. Per ISO, each term must be numbered.

All of the terms are not really terms, but instead expansions of abbreviations that serve as the definitions. They should go instead into an "Abbreviated terms" clause, or be wrapped into the "Terms and definitions" clause, with the change to the clause title to "Terms, definitions, and abbreviated terms".

image

Note that it is not required to number symbols.

When listing an abbreviation, there is no guidance in ISO document as to whether the term is the expanded version and the definition is the abbreviation, or vice versa. If there is an actual definition, then the expanded version of the term is listed first, then underneath, the abbreviation, all as part of term heading. That is followed by the definition.

@ERyan71258 ERyan71258 changed the title 4 Terms and defintions 4 Terms and defintions: Format, Abbreviations Dec 18, 2023
@palemieux palemieux transferred this issue from SMPTE/st429-4 Dec 29, 2023
@palemieux palemieux self-assigned this Dec 29, 2023
@palemieux palemieux added the bug Something isn't working label Dec 29, 2023
@SteveLLamb
Copy link
Member

As per: SMPTE/st430-1#102 (comment):

We need to figure out a consistent way to format:

  • A term with only an abbreviation. This would usually be listed in a separate "Abbreviations" clause or subclause, but can be included in the Terms and Definitions, with the appropriate heading, e.g., "Terms, Definitions, and Abbreviated Terms"
    Perhaps list as follows, all bold:

    Key Delivery Message
    KDM

  • A term with only an abbreviation that cites a source.
    I would format as follows, with the term and its abbreviation in bold:

    Coordinated Universal Time
    UTC
    [SOURCE: ISO 8601-1]

@SteveLLamb SteveLLamb changed the title 4 Terms and defintions: Format, Abbreviations Terms and definitions: Format, Abbreviations May 23, 2024
@SteveLLamb
Copy link
Member

Can we combine this with #117?

@ERyan71258
Copy link
Collaborator Author

Yes.

@SteveLLamb
Copy link
Member

Great, closing as duplicate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants