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

ISO/IEC Coding Guidelines: reference to the term #308

Closed
Intelligent2013 opened this issue Jan 7, 2023 · 3 comments
Closed

ISO/IEC Coding Guidelines: reference to the term #308

Intelligent2013 opened this issue Jan 7, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@Intelligent2013
Copy link
Contributor

Intelligent2013 commented Jan 7, 2023

Source: #190, metanorma/metanorma-iso#868

Currently, mnconvert creates the element named-content for the reference to the term

<named-content xlink:href="#term_3.1.1.2" content-type="term">time</named-content>

in 'Terms and definitions` section and document's body. This behavior inherited from BSI documents.

From 'IEC/ISO Coding Guidelines':

  • '9.3.6 Cross-references between terms in the Terms and definitions clause':
    Cross-references between terminological entries or terms within the Terms and definitions clause can be tagged as <tbx:entailedTerm>. This element should only be used in child elements of <tbx:termEntry>.

Example:

<tbx:definition>action to eliminate a detected <tbx:entailedTerm target="term_3.21">nonconformity (3.21)</tbx:entailedTerm></tbx:definition>
  • '10.1.3 Cross-references to terms':
    Outside the terms and definitions section, references to terms contained within the document should be made using the id in the terminological entry.
    • ISO:
    <p>This term is defined in <xref ref-type="sec" rid="term_3.3">3.3</xref>.</p>
    • IEC:
    <p>This term is defined in <xref ref-type="other" rid="con-3.3">3.3</xref>.</p>
@Intelligent2013 Intelligent2013 added the enhancement New feature or request label Jan 7, 2023
@Intelligent2013 Intelligent2013 self-assigned this Jan 7, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Metanorma Jan 7, 2023
@ronaldtse
Copy link
Contributor

@Intelligent2013 could you also help document the STS XML practices of BSI in the same way so that we can keep track of the differences? Thanks!

@Intelligent2013 Intelligent2013 moved this from 🆕 New to 🏗 In progress in Metanorma Jan 7, 2023
Intelligent2013 added a commit that referenced this issue Jan 7, 2023
mn2xml.xsl updated for reference to term, #308
@Intelligent2013
Copy link
Contributor Author

@Intelligent2013 could you also help document the STS XML practices of BSI in the same way so that we can keep track of the differences? Thanks!

@ronaldtse I'll do it in #309.

@Intelligent2013
Copy link
Contributor Author

Done.

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Metanorma Jan 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

2 participants