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

Additional Elements Format #213

Open
ERyan71258 opened this issue Jan 11, 2024 · 4 comments · Fixed by #231
Open

Additional Elements Format #213

ERyan71258 opened this issue Jan 11, 2024 · 4 comments · Fixed by #231
Assignees
Labels
bug Something isn't working
Milestone

Comments

@ERyan71258
Copy link
Collaborator

Should Additional Elements be listed in a table format?

Clause 6.6 in the AG-16 specifies the following as an example:

"This annex lists non-prose elements of this document."

image

When I use a table to list the elements, I slightly rewrite the introductory sentence; otherwise, the table is not referenced, and per ISO, it should be:
"Table .1 lists non-prose elements of this document."
or
"This annex lists non-prose elements of this document, as shown in Table .1."

@palemieux palemieux transferred this issue from SMPTE/st429-10 Jan 31, 2024
@palemieux palemieux changed the title Annex B: Additional Elements Format Additional Elements Format Jan 31, 2024
@palemieux palemieux added this to the v2 milestone Feb 9, 2024
@palemieux palemieux self-assigned this Feb 9, 2024
@palemieux palemieux added the bug Something isn't working label Feb 9, 2024
@palemieux
Copy link
Member

The Additional Elements element of the document should be unnumbered.

palemieux added a commit that referenced this issue Feb 20, 2024
* Add informative/normative label to additional elements
* Make the additional element section unnumbered
* Make elements link cold in print media

#213
#212
#220
@ERyan71258
Copy link
Collaborator Author

If the Additional elements clause is unnumbered, then the AG-16 language introducing the elements must be changed, as the clause is no longer an annex:

"6.6 Non-prose elements of the Engineering Document_
All non-prose elements of the Engineering Document, as defined in AG-02, shall be explicitly referred to within the prose element.

All non-prose elements of the Engineering Document shall be listed in an informative annex titled Additional elements, which shall be the final annex of the document.

This annex shall be introduced by the following sentence:
This annex lists non-prose elements of this document.

The list shall include the letter designator, a brief description of the non-prose element, and an indication of whether the non-prose element is normative or informative."

"This annex lists non-prose elements of this document." would require rewording.

Even though the "Additional elements" clause is informative, each item listed must also be specified as either "normative" or "informative", as there may be a mix (e.g., ST 2021-4)

If restoring an annex letter to the "Additional Elements" heading, then the annex must be referenced from the body text. It should be referenced in any case.

@ERyan71258 ERyan71258 reopened this Jun 20, 2024
@palemieux
Copy link
Member

@ERyan71258 Please open the issue in AG-16: https://github.com/smpte/ag-16

@ERyan71258
Copy link
Collaborator Author

ERyan71258 commented Jun 20, 2024

Reopening to address language inconsistency and conflict with the AG-16.

Also referenced this issue in SMPTE/ag-16#35

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

Successfully merging a pull request may close this issue.

2 participants