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

Custom manifest location for specifying documents to include in a CR vocabulary document ("ISO 10303-2 subset") #177

Open
ronaldtse opened this issue Aug 31, 2023 · 1 comment

Comments

@ronaldtse
Copy link
Contributor

Goal is for developers to generate a subset of the ISO 10303-2 vocabulary so they can verify their text and descriptions for Clauses 4 and 5.

The manifest file will be located under {repo}/publication/part1000/CR_{name} with filename vocabulary.xml.

A sample vocabulary.xml for the Change Request (CR) CR_PMI4 looks like:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE docs
  SYSTEM "../../dtd/part1000/docs.dtd">
<docs part.version.number="10">

  <doc name="draughting" series="IAR" part="101" pub_type="IS" edition="6" pub_year_mo="2022" format="html-stepmod"/>
  <doc name="draughting_element" series="AM" part="1310" pub_type="TS" edition="5" pub_year_mo="2022" format="html-stepmod"/>
  <doc name="mechanical_design_features_and_requirements" series="AM" part="1846" pub_type="TS" edition="3" pub_year_mo="2022" format="html-stepmod"/>

</docs>

In our code we work with docs.xml, which has a similar structure, here:

docs_xml = Nokogiri::XML(File.read(@stepmod_path.join('library/docs.xml')))

The output of this command would be a valid ISO 10303-2 document, with:

  • complete Clauses 1, 2, 3 from ISO 10303-2
  • content of Clauses 4 and 5 will be specified in the vocabulary.xml file
@ronaldtse
Copy link
Contributor Author

The output of the command will be a Metanorma document that represents the vocabulary of the CR specified files.

The document identifier "could be":

  • ISO 10303-2:20XX/CR YYY
  • where 20XX is the publication date of the base ISO 10303-2 document
  • where YYY is the name of the CR (e.g. PMI4)
  • e.g. "ISO 10303-2:2023/CR PMI4" or in dated form "ISO 10303-2:2023/CR PMI4:2023"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant