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

Document the STS XML practices of BSI #309

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

Document the STS XML practices of BSI #309

Intelligent2013 opened this issue Jan 7, 2023 · 10 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Intelligent2013
Copy link
Contributor

Source issue: #308

document the STS XML practices of BSI in the same way so that we can keep track of the differences.

@Intelligent2013 Intelligent2013 added the documentation Improvements or additions to documentation 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
@Intelligent2013 Intelligent2013 moved this from 🆕 New to 🏗 In progress in Metanorma Jan 15, 2023
@Intelligent2013
Copy link
Contributor Author

Intelligent2013 commented Jan 15, 2023

DRAFT list of BSI XML practices:

  • root front element nat-meta, or iso-meta + reg-meta + nat-meta
  • front element contains Publishing and copyright information block in <sec id="sec_pub_info_nat" sec-type="publication_info">
  • Introduction section placed as the first item in the element body
  • Permissions: contains copyright-statement, copyright year and holder
<xsl:apply-templates select="../misc-container/semantic-metadata/copyright-statement"/>
<xsl:call-template name="put_copyright_year"/>
<xsl:call-template name="put_copyright_holder">
	<xsl:with-param name="from">name</xsl:with-param>
</xsl:call-template>
  • the value of pub-date/@pub-typeis PUBL
  • default value of app/@content-type is norm-annex
  • centered paragraph text enclosed in the element p/styled-content style="text-alignment: center">. Example: ...
  • element p doesn't contain the attribute id (similar to ISO practice).
  • reference to the bibliographic item represents as the element <std type=".." std-id="..."><std-ref>...</std-ref>, ... </std> (similar to ISO practice).
  • element for figure's group is fig, all sub-figures placed in the element graphic (similar to ISO practice).
  • figure label in the element fig/label (similar to ISO practice).
  • Index structure:
<sec sec-type="index">
	<title>Index</title>
	<list list-type="simple">
		<list-item>
			<p>abstentions, <xref ref-type="sec" rid="sec_7.7">7.7</xref>
			</p>
		</list-item>

Will be updated with examples.

@Intelligent2013
Copy link
Contributor Author

  • unit statements for figures encoded in fig/table-wrap/caption/p:
<fig id="fig_A.1" fig-type="figure">
  <label>Figure A.1</label>
  <caption><title>Island platform</title></caption>
  <table-wrap id="tab_k" position="float">
    <caption><p content-type="Dimension" specific-use="100">Dimensions in metres</p></caption>

(https://github.com/metanorma/mn-samples-bsi/issues/79)

@Intelligent2013
Copy link
Contributor Author

Intelligent2013 commented Jan 16, 2023

Just to progress.
DRAFT [NISO_STS_BSI_Guidelines_DRAFT.docx]

@Intelligent2013
Copy link
Contributor Author

Intelligent2013 commented Jan 17, 2023

Just to progress.
NISO_STS_BSI_Guidelines_DRAFT.docx

@Intelligent2013
Copy link
Contributor Author

BSI practice is mostly compliance with ISO, therefore

default value of app/@content-type is norm-annex

should be changed to normative-annex.

@Intelligent2013
Copy link
Contributor Author

centered paragraph text enclosed in the element p/styled-content style="text-alignment: center">

Actually, this case relates to the inline block in the table cell text:

<td style="border-bottom: 1px solid;">For the purposes of this International Standard,...<break/>
The following terms, ...<break/>
<styled-content style="text-alignment: center"><bold>supplier ----&gt; organization ----&gt; customer</bold></styled-content><break/>
The term “organization” replaces the term “supplier” ....<break/>
Throughout the text of this International Standard, ....</td>

converts into Metanorma adoc as the multi paragraph table cell:

a|For the purposes of this International Standard, ... +
The following terms, ...

[align=center]
*supplier ----> organization ----> customer*

The term “organization” replaces the term “supplier”... +
Throughout the text of this International Standard,

Instead, ISO practice should be used:

<p style-type="align-center"><bold>supplier ----&gt; organization ----&gt; customer</bold></p>

@Intelligent2013
Copy link
Contributor Author

Cross-references between terminological entries or terms within the Terms and definitions clause tagged as <xref> if reference contains clause number only:

<term-sec id="sec_3.7">
	<label>3.7</label>
	<tbx:termEntry id="term_3.7">
		<tbx:langSet xml:lang="en">
			<tbx:definition>information required to be controlled and maintained by an organization (see <xref ref-type="sec" rid="sec_3.19">
					<bold>3.19</bold>
				</xref>) and the medium on which it is contained</tbx:definition>
			...
			<tbx:tig id="term_3.7-1">
				<tbx:term>documented information</tbx:term>
				<tbx:partOfSpeech value="noun"/>
			</tbx:tig>
		</tbx:langSet>
	</tbx:termEntry>
</term-sec>

or <entailedTerm> if reference contains term and clause number:

<term-sec id="sec_3.3">
	<label>3.3</label>
	<tbx:termEntry id="term_3.3">
		<tbx:langSet xml:lang="en">
			<tbx:definition>process through which <tbx:entailedTerm target="term_3.16">organizations (3.16)</tbx:entailedTerm> proactively identify, assess, prevent, mitigate and account for how they address their actual and potential adverse impacts as an integral part of decision-making and <tbx:entailedTerm target="term_3.22">risk management (3.22)</tbx:entailedTerm>
			</tbx:definition>
			<tbx:tig id="term_3.3-1">
				<tbx:term>due diligence</tbx:term>
				<tbx:partOfSpeech value="noun"/>
			</tbx:tig>
		</tbx:langSet>
	</tbx:termEntry>
</term-sec>

@Intelligent2013
Copy link
Contributor Author

sec-type for front/sec depends on the title:

@sec-type="publication_info"	front sec with title ‘Publishing and copyright information’
@sec-type="foreword"	Foreword
@sec-type="foreword_publishing"	Foreword sub-clause ‘Publishing information’
@sec-type="foreword_supersession"	Foreword sub-clause ‘Supersession’
@sec-type="foreword_relationship"	Foreword sub-clause ‘Relationship with other publications’
@sec-type="foreword_doc_info"	Foreword sub-clause ‘Information about this document’
@sec-type="foreword_hazard"	Foreword sub-clause ‘Hazard warnings’
@sec-type="foreword_doc_use"	Foreword sub-clause ‘Use of this document’
@sec-type="foreword_presentational"	Foreword sub-clause ‘Presentational conventions’
@sec-type="foreword_legal"	Foreword sub-clause ‘Contractual and legal considerations ‘
@sec-type="endorsement"	front sec with title ‘Endorsement notice’

@Intelligent2013
Copy link
Contributor Author

Intelligent2013 commented Jan 19, 2023

Just to progress:
[NISO_STS_BSI_Guidelines_1.0_DRAFT.docx]

@Intelligent2013
Copy link
Contributor Author

Final version: NISO_STS_BSI_Guidelines_1.0.docx

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

No branches or pull requests

1 participant