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

Implement IEC URN #52

Closed
ronaldtse opened this issue Jun 14, 2022 · 0 comments · Fixed by #79
Closed

Implement IEC URN #52

ronaldtse opened this issue Jun 14, 2022 · 0 comments · Fixed by #79
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link
Contributor

Rules

1. If any field is absent, leave empty

e.g. urn:iec:std:iec:60601-1-1:::: vs urn:iec:std:iec:60601-1-1:2005-10:tr:prv:fr

2. All URIs are extensible, to - define adjuncts (such as amendment, corrigendum or interpretation sheet). - name consolidations (such as base edition plus its amendment)The adjunct string is appended to the base URI (after || or _)

EXAMPLE: Naming an adjunct (e.g. corrigendum to an amendment):

  • urn:iec:std:iec:60601-1-1:2015-10:::||amd:1:2017-01||cor:1:2018-01

EXAMPLE: Consolidation of base edition and its amendments:

  • urn:iec:std:iec:60601-1-1:2015-04:csv:_amd:1:2016-07_amd:2:2017-02

3. All values in lower-case

Separation between a base document and its adjuncts

When a base edition is amended, corrected or otherwise added to, the URN is constructed using that of the base edition, to which we add information on the adjunct. Two types of reference exist: either to the adjunct itself or to the consolidation of the base edition with one or more of its adjuncts.

The base edition information is separated from the adjunct information by three fields. The middle field indicates whether the reference is to a consolidation or not. If left empty, the reference is to the adjunct itself. If it contains the word "plus", it is a consolidation.

EXAMPLE: Amendment 1:1993 to IEC 60068-2-2:1974

  • urn:iec:std:iec:60068-2-2:1974: : : : :amd:1:1993

EXAMPLE: Consolidation of amendment 1:1993 with IEC 60068-2-2:1974

  • urn:iec:std:iec:60068-2-2:1974: : : :plus:amd:1:1993

Note on adjuncts

In theory, there is no limit to the number of adjuncts that are possible. In practice, when there are many adjuncts, it is advisable to either make use of an undated reference to the base edition as a whole, or to deliver content by different means, such as database standards.

Separator Rule Example
: Between fields in the URN  urn:iec:std:iec:60601
- Within field urn:iec:std:iec-iso:60601-1-1:
# Between URI and IDs for document elements, such as clauses, figures, etc. urn:iec:std:iec:60601-1-1:2015-10:::#fig-1

Note on IDs

The IDs content elements used in this document and its examples are those that were used in IEC's conversion process. Outside the context of conversion excercises, the use of semantic ID naming schemes is not necessarily encouraged. This URN model can be used with other IDs.

Note on languages

Languages are listed in alphabetical order, to ensure that identical values are expressed in the same way (and at the same time, to avoid complex tables of language combinations to solve the problem)

Defining table

item description
sdo namespace Specific to each organisation.
content type namespace Right now limited to "std", which means standards-type documents. Could be extended to other deliverables?
date  blank, YYYY, YYYY-MM or YYYY-MM-DD
type  For IS: can be blank or use "is". Other currently existing values: ts, tr, pas, guide, is, srd, ser (for series/all parts)
deliverable product type
language  can be blank or use ISO language codes, can be one or many
adjunct type currently used values: amd, cor, ish…could be extended.

Examples

  • Prefix = urn + sdo namespace + content type namespace
  • Base document identifier: header + project number + date + type + deliverable + language
  • Relation = relation
  • adjunct document information: adjunct type + adjunct number + date
  • component or related asset information: # or =, component id or related asset
urn : sdo namespace : content type namespace : header : project number : date : type : deliverable : language       adjunct type : adjunct number : date # or = component id or related asset
: relation :
urn : iec : std : iec : 67654 : blank : blank : prv : blank : plus : amd : 1 : 2010-08 # fig-1
urn :   :   : iso : 60601-1 : 2010-03 : ts : csv : en :   : amd : 1 : 2010-12 # sec-1
urn :   :   : iec-iso : 61076-7-101 : 2010 : tr : exv : fr : plus : cor : etc… : 2010-11 # sec-3.4
urn :   :   : iec-ieee : 80004 : 2010-10-11 : pas : rlv : ru : plus : ish : 1 : etc. # sec-4.5.6
urn :   :   : iec-itu : etc. :   : guide : cmv : en-fr : plus : :   :   # tabl-7
urn :   :   : iec-astm :   :   : is :   : en-fr-ru : plus :   :   :   # anx-a
urn                       ser                         # not-4.6.7-2
                                                  # nte-3.2-1
                                                  # etc.
                                                     
                                                  = software supplement
                                                  = voting report
                                                  = webpage
                                                  = forum
@ronaldtse ronaldtse added the enhancement New feature or request label Jun 14, 2022
@mico mico mentioned this issue Jul 22, 2022
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
None yet
Development

Successfully merging a pull request may close this issue.

2 participants