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

Sponsors and committees #150

Closed
opoudjis opened this issue Oct 11, 2022 · 9 comments
Closed

Sponsors and committees #150

opoudjis opened this issue Oct 11, 2022 · 9 comments
Assignees
Labels
enhancement New feature or request

Comments

@opoudjis
Copy link
Contributor

From #95

Can you help investigate ieee-stl to see their XML schema to determine what additional fields we need?

From ieee-stl:

<std-sponsor> Standard Sponsor

The groups such as the society, the association, or the Working Committee responsible for a standard. This is a text field, containing words such as “sponsored by” and the names of organizations, with the possibility that the names of a committee, society, secretariat, or institution may be tagged within the text

Remarks

There can be a hierarchy of sponsors, ranging from: the IEEE-SA Standards board at the top; the next level usually the society, committee of the society, or SCC (Standards Coordinating Committee) that is the parent of the Working Group; and finally the Working Group or Task Force (typically a subset of the Committee) that wrote the standard. More than one Committee may sponsor a standard.

The name of a Committee, for example, the “Petroleum and Chemical Committee”, should also be thought of as a topic for searching and added to the keywords or subject categories.

The element contains sub-elements:

    <committee> Standards Committee
    <institution> Institution Name
    <institution-id> Institution Identifier
    <secretariat> Secretariat For a Standard
    <society> Society For a Standard

The xml source for master-1-standard document:

<std-sponsor>Sponsor <committee>Substations Committee of the IEEE Power and Energy Society</committee>
</std-sponsor>

Cover page contains some different text (there isn't this text in the xml):
image
But 2nd page contains exactly text from xml (some text is bold-faced):
image

The xml source for master-2-standards document doesn't contain 'Sponsor' word:

<std-sponsor>
<committee>IEEE Standards Coordinating Committee on Test and Diagnosis for Electronic Systems (SCC20)</committee>
</std-sponsor>

Cover page:
image

2nd page contains 'Sponsor' (it's missing in xml, but presents in the xml for 'master-1-standard'):
image

So:

  • the text on the cover page and 2nd page is different
  • in the xml there isn't text for cover page
  • the element 'std-sponsor' may contain text like 'Sponsor'
  • the element 'std-sponsor' is complex, and may contain 'committee', 'institution', 'institution-id', 'secretariat', 'society':
<std-sponsor>Sponsored by the<break/>
   <committee>Power System Communications Committee</committee><break/>
   of the<break/>
   <society>IEEE Power &amp; Energy Society</society><break/>
   and the<break/>
  <committee>Standards Committee</committee><break/>
  of the<break/>
 <society>IEEE Communications Society</society>
</std-sponsor>
  • there is case when the element 'society' isn't using, for instance: <std-sponsor>Sponsor <committee>Substations Committee of the IEEE Power and Energy Society</committee></std-sponsor>, i.e. 'IEEE Power and Energy Society' inserted as the committee's part.

Regarding 'Developed by ', IEEE uses the element 'std-sponsor' also for this purpose.
Xml example for 2830-2021:

<std-sponsor>Developed by the 
  <committee>Standards Activities Board</committee> of the 
  <society>IEEE Computer Society</society>
</std-sponsor>

Cover page (no 2nd page in the draft):
image

So, we need fields for specifying:

  • 'developed' or 'sponsored' (I can't find another kind of '... by')
  • hierarchy for committee/institution/secretariat/society and relationships between them - 'of the', 'and the'.
@opoudjis opoudjis self-assigned this Oct 11, 2022
@opoudjis
Copy link
Contributor Author

All I capture currently is:

<div><p>Developed by the</p>
  <p><b>{{ technical_committee }}</b></p>
<p>of the</p>
<p><b>IEEE {{ society }}</b></p>

where technical_committee is //bibdata/ext/editorialgroup/committee, and society is //bibdata/ext/editorialgroup/society. I have no representation of sponsor, and the difference between "developed" and "sponsor" is not one of wording, it is a difference between //bibdata/ext/editorialgroup/committee and //bibdata/ext/editorialgroup/sponsor (once I add it).

This will need to become a separate ticket for me to work through.

@opoudjis opoudjis added the enhancement New feature or request label Oct 11, 2022
@opoudjis opoudjis moved this to 🆕 New in Metanorma Oct 11, 2022
@opoudjis opoudjis moved this from 🆕 New to 🏔 High priority in Metanorma Oct 11, 2022
@opoudjis opoudjis moved this from 🏔 High priority to 🏗 In progress in Metanorma Feb 22, 2024
@opoudjis
Copy link
Contributor Author

There is no separate hierarchy to encode, this is merely conjunction of multiple sponsors.

We can do some of this thanks to updates motivated by JIS and NIST (https://github.com/metanorma/metanorma-nist/issues/103). But they don't capture the hierarchy to this degree of elaborateness: we would need to allow multiple levels of divisions, with division types.

We do need to start with the topmost level, which will be the society if available; and we will need the division types to be prefixed to the division name.

So a maximal instance with

    <committee> Standards Committee
    <institution> Institution Name
    <institution-id> Institution Identifier
    <secretariat> Secretariat For a Standard
    <society> Society For a Standard

will be: (not implemented yet)

sponsor: IEEE # Institution
sponsor-subdivision: society: IEEE Power & Energy Society, committee: Power System Communications Committee, secretariat: IEEE  Secretariat
sponsor-id: whatever
sponsor_2: IEEE # Institution
sponsor-subdivision_2: society: IEEE Communications Society, committee: Standards Committee
sponsor-id_2: whatever2

And we will know to suppress the institution from rendering if it is IEEE. The XML is going to be:

<contributor>
<role type="enabler"><description>sponsor</description></role>
<organization>
  <name>Institute of Electrical and Electronic Engineers</name>
  <abbreviation>IEEE</abbrevation>
  <subdivision type="society">IEEE Power &amp; Energy Society</subdivision>
  <subdivision type="committee">Power System Communications Committee</subdivision>
  <subdivision type="secretariat">IEEE Secretariat</subdivision>
  <identifier>whatever</identifier>
</organization>
</contributor>

<contributor>
<role type="enabler"><description>sponsor</description></role>
<organization>
  <name>Institute of Electrical and Electronic Engineers</name>
  <abbreviation>IEEE</abbrevation>
  <subdivision type="society">IEEE Communications Society</subdivision>
  <subdivision type="committee">Standards Committee</subdivision>
  <identifier>whatever</identifier>
</organization>
</contributor>

Will need to add optional type to subdivision, multiple subdivisions, and subdivision processing on organisations.

@opoudjis
Copy link
Contributor Author

opoudjis commented Feb 22, 2024

@andrew2net I'm about to do a breaking change to contributor/organization/subdivision in the relaton grammar, turning it from a string to a recursive instance of the organization object. Are you using it at all?

@opoudjis
Copy link
Contributor Author

Proceeding. @andrew2net you will need to update Relaton.

opoudjis added a commit to relaton/relaton-models that referenced this issue Feb 23, 2024
opoudjis added a commit to metanorma/metanorma.org that referenced this issue Feb 25, 2024
opoudjis added a commit to metanorma/metanorma.org that referenced this issue Feb 26, 2024
opoudjis added a commit to metanorma/metanorma-standoc that referenced this issue Feb 26, 2024
@opoudjis
Copy link
Contributor Author

opoudjis commented Feb 26, 2024

Now that we have means of entering multiple multi-level sponsors, we need to incorporate them into language for the IEEE front page. I will need to generate that language in Presentation XML.

@opoudjis
Copy link
Contributor Author

The parent ticket #95 has long since been put into the fridge, and this is one of the many tickets that I've ignored for years because nobody was actually asking for them, because we have not had any management of work. But if @anermina @Intelligent2013 want to revisit IEEE 1127-1998, they're about to be able to.

@opoudjis
Copy link
Contributor Author

I have no interest in perpetuating inconsistencies between documents, which reflect sloppiness rather than any genuine requirement.

There shall be an /bibdata/ext/developed-attribution and a /bibdata/ext/sponsored-attribution element, added to Presentation XML. They will have consistent wording: Developed/Sponsored by the **a3** of the **a2** of the **a1** and the **b3** of the **b2** of the **b1**. If a1 is IEEE (or Institute of Electrical and Electronic Engineers), it is dropped, and instead prefixed to a2.

opoudjis added a commit to metanorma/metanorma.org that referenced this issue Feb 26, 2024
opoudjis added a commit that referenced this issue Feb 26, 2024
opoudjis added a commit that referenced this issue Feb 26, 2024
@opoudjis
Copy link
Contributor Author

CSV processing of document attributes needs us to unescape the attribute values, to get rid of ; in XML escapes.

@opoudjis
Copy link
Contributor Author

:sponsor: IEEE
:sponsor_subdivision: Power & Energy Society, Power System Communications Committee; Communications Society, Standards Committee

gives the output required above; implemented in Word and HTML, with the relevant phrasing stored in /bibdata/ext/sponsored-attribution.

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Metanorma Feb 26, 2024
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

1 participant