Skip to content

Commit

Permalink
Merge pull request #184 from metanorma/updates
Browse files Browse the repository at this point in the history 
skip documents missing in repository index, metanorma/iso-10303#83
  • Loading branch information
@Intelligent2013
Intelligent2013 authored May 2, 2024
2 parents 5d82d55 + db84463 commit 5e7662b
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 29 deletions.
56 changes: 28 additions & 28 deletions README.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ You will need the `maven` build tool and `make`.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <XML-FileName>
java -Xss5m -jar target/stepmod2mn-1.55.jar <XML-FileName>
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar data/resource_docs/draughting_elements/resource.xml
java -Xss5m -jar target/stepmod2mn-1.55.jar data/resource_docs/draughting_elements/resource.xml
----

NOTE: resulted AsciiDoc found in data/resource_docs/draughting_elements/document.adoc
Expand All @@ -34,28 +34,28 @@ NOTE: resulted AsciiDoc found in data/resource_docs/draughting_elements/document

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <XML-FileName> [--output <AsciiDoc-FileName>]
java -Xss5m -jar target/stepmod2mn-1.55.jar <XML-FileName> [--output <AsciiDoc-FileName>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar data/resource_docs/draughting_elements/resource.xml --output result_dir/draughting_elements/document.adoc
java -Xss5m -jar target/stepmod2mn-1.55.jar data/resource_docs/draughting_elements/resource.xml --output result_dir/draughting_elements/document.adoc
----

=== Convert all resource.xml and module.xml in the specified folder and sub-folders into the Metanorma AsciiDoc format:

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Input-folder>
java -Xss5m -jar target/stepmod2mn-1.55.jar <Input-folder>
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar data/
java -Xss5m -jar target/stepmod2mn-1.55.jar data/
----

NOTE: the result AsciiDocs will be saved in the folder with the source resource.xml and module.xml files.
Expand All @@ -65,57 +65,57 @@ NOTE: the result AsciiDocs will be saved in the folder with the source resource.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Input-folder> [--output <Output-folder>]
java -Xss5m -jar target/stepmod2mn-1.55.jar <Input-folder> [--output <Output-folder>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar data/ --output documents/
java -Xss5m -jar target/stepmod2mn-1.55.jar data/ --output documents/
----


=== Convert all resource.xml and module.xml in the specified folder and sub-folders into the Metanorma AsciiDoc format, except specified documents:

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Input-folder> [--exclude <documents or part numbers list>]
java -Xss5m -jar target/stepmod2mn-1.55.jar <Input-folder> [--exclude <documents or part numbers list>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar data/ --exclude "machining_features 104"
java -Xss5m -jar target/stepmod2mn-1.55.jar data/ --exclude "machining_features 104"
----

=== Convert only specified documents resource.xml and module.xml in the specified folder and sub-folders into the Metanorma AsciiDoc format:

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Input-folder> [--include-only <documents list>]
java -Xss5m -jar target/stepmod2mn-1.55.jar <Input-folder> [--include-only <documents list>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar data/ --include-only "fundamentals_of_product_description_and_support kinematics"
java -Xss5m -jar target/stepmod2mn-1.55.jar data/ --include-only "fundamentals_of_product_description_and_support kinematics"
----

=== Generate Metanorma collection files (metanorma.yml and collection.yml) for the documents specified in the publication index xml file in the tags 'resource_docs' and 'modules':

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Publication-Index-XML-FileName>
java -Xss5m -jar target/stepmod2mn-1.55.jar <Publication-Index-XML-FileName>
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar publication/part1000/CR_PMI_5/publication_index.xml
java -Xss5m -jar target/stepmod2mn-1.55.jar publication/part1000/CR_PMI_5/publication_index.xml
----

NOTE: the Metanorma collection files .yml will be saved in the 3 level up folder (usually, source repository's root folder).
Expand All @@ -125,14 +125,14 @@ and save them into the output folder:

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Publication-Index-XML-FileName> [--output <Output-folder>]
java -Xss5m -jar target/stepmod2mn-1.55.jar <Publication-Index-XML-FileName> [--output <Output-folder>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar iso-10303-srl/iso-10303-stepmod-wg12/publication/part1000/CR_PMI_5/publication_index.xml --output iso-10303-srl/
java -Xss5m -jar target/stepmod2mn-1.55.jar iso-10303-srl/iso-10303-stepmod-wg12/publication/part1000/CR_PMI_5/publication_index.xml --output iso-10303-srl/
----

NOTE: the output folder should contains the folder with the generated .adoc (usually, 'documents'). You can specify this folder obviously by the parameter '--input-documents':
Expand All @@ -141,7 +141,7 @@ e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar iso-10303-srl/iso-10303-stepmod-wg12/publication/part1000/CR_PMI_5/publication_index.xml --output iso-10303-srl/CR_PMI_5 --input-documents iso-10303-srl/documents
java -Xss5m -jar target/stepmod2mn-1.55.jar iso-10303-srl/iso-10303-stepmod-wg12/publication/part1000/CR_PMI_5/publication_index.xml --output iso-10303-srl/CR_PMI_5 --input-documents iso-10303-srl/documents
----

NOTE: the Metanorma collection files (.yml) will be saved in the folder 'iso-10303-srl/CR_PMI_5' and the references point to the documents in the folder iso-10303-srl/documents.
Expand All @@ -151,14 +151,14 @@ NOTE: the Metanorma collection files (.yml) will be saved in the folder 'iso-103

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar <Publication-Index-XML-FileName> [--type <resource_docs or modules>]
java -Xss5m -jar target/stepmod2mn-1.55.jar <Publication-Index-XML-FileName> [--type <resource_docs or modules>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.54.jar publication/part1000/CR_PMI_5/publication_index.xml --type resource_docs
java -Xss5m -jar target/stepmod2mn-1.55.jar publication/part1000/CR_PMI_5/publication_index.xml --type resource_docs
----

NOTE: the Metanorma collection file 'metanorma.yml' will be saved in the 3 level up folder (usually, source repository's root folder).
Expand All @@ -168,42 +168,42 @@ NOTE: the Metanorma collection file 'metanorma.yml' will be saved in the 3 level

[source,sh]
----
java -jar target/stepmod2mn-1.54.jar <start folder to process xml maps files> --svg
java -jar target/stepmod2mn-1.55.jar <start folder to process xml maps files> --svg
----

e.g.

[source,sh]
----
java -jar target/stepmod2mn-1.54.jar data/resources --svg
java -jar target/stepmod2mn-1.55.jar data/resources --svg
----

=== Generate SVG images for the XML in the specified folder and sub-folders, and save them in the output folder:

[source,sh]
----
java -jar target/stepmod2mn-1.54.jar <start folder to process xml maps files> --svg [--output <Output-folder>]
java -jar target/stepmod2mn-1.55.jar <start folder to process xml maps files> --svg [--output <Output-folder>]
----

e.g.

[source,sh]
----
java -jar target/stepmod2mn-1.54.jar data/resources --svg --output schemas/
java -jar target/stepmod2mn-1.55.jar data/resources --svg --output schemas/
----

=== Generate SVG image for Express Imagemap XML and Image:

[source,sh]
----
java -jar stepmod2mn-1.54.jar --xml <Express Imagemap XML file path> --image <Image file name> [--svg <resulted SVG map file or folder>]
java -jar stepmod2mn-1.55.jar --xml <Express Imagemap XML file path> --image <Image file name> [--svg <resulted SVG map file or folder>]
----

e.g.

[source,sh]
----
java -jar stepmod2mn-1.54.jar --xml data\resource_docs\fundamentals_of_product_description_and_support\schema_diagexpg1.xml --image schema_diagexpg1.gif --svg schema_diagexpg1.svg
java -jar stepmod2mn-1.55.jar --xml data\resource_docs\fundamentals_of_product_description_and_support\schema_diagexpg1.xml --image schema_diagexpg1.gif --svg schema_diagexpg1.svg
----


Expand All @@ -223,7 +223,7 @@ Update version in `pom.xml`, e.g.:
----
<groupId>org.metanorma</groupId>
<artifactId>stepmod2mn</artifactId>
<version>1.54</version>
<version>1.55</version>
<name>STEPmod XML to Metanorma AsciiDoc converter</name>
----

Expand All @@ -234,8 +234,8 @@ Tag the same version in Git:

[source,xml]
----
git tag v1.54
git push origin v1.54
git tag v1.55
git push origin v1.55
----

Then the corresponding GitHub release will be automatically created at:
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.metanorma</groupId>
<artifactId>stepmod2mn</artifactId>
<version>1.54</version>
<version>1.55</version>
<name>STEPmod XML to Metanorma AsciiDoc converter</name>
<packaging>jar</packaging>
<url>https://www.metanorma.org</url>
Expand Down
14 changes: 14 additions & 0 deletions src/main/java/org/metanorma/stepmod2mn.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ public class stepmod2mn {
List<String> includeOnlyList = new ArrayList<>();

boolean isPublicationIndexMode = false;
boolean isDocumentsGenerationMode = false;

/**
* Main method.
Expand Down Expand Up @@ -440,6 +441,7 @@ private static void runoptions(String[] args) throws ParseException {
boolean isStandaloneXML = false;
RepositoryIndex repositoryIndex = null;
boolean isPublicationIndexMode = false;
boolean isDocumentsGenerationMode = false;
String namePublicationIndex = "";
// if remote file (http or https)
if (Util.isUrl(argXMLin)) {
Expand Down Expand Up @@ -492,6 +494,8 @@ private static void runoptions(String[] args) throws ParseException {

// if input path in the directory
if (fXMLin.isDirectory()) {
isDocumentsGenerationMode = true;

inputFolder = fXMLin.getAbsolutePath();

repositoryIndex = new RepositoryIndex(inputFolder);
Expand Down Expand Up @@ -585,6 +589,7 @@ private static void runoptions(String[] args) throws ParseException {
app.setResourcePath(resourcePath);
app.setRepositoryIndex(repositoryIndex);
app.setPublicationIndexMode(isPublicationIndexMode);
app.setDocumentsGenerationMode(isDocumentsGenerationMode);
app.setOutputPathSchemas(outputPathSchemas);
app.setExcludeList(excludeList);
app.setIncludeOnlyList(includeOnlyList);
Expand Down Expand Up @@ -679,6 +684,11 @@ private boolean convertstepmod2mn(String xmlFilePath, File fileOut) throws IOExc
result = false;
}

if (isDocumentsGenerationMode && !(repositoryIndex.contains(documentName, rootElement))) {
System.out.println("[WARNING] The document '" + documentName + "' skipped from the processing - it's missing in the repository index.");
return false;
}

if (isPublicationIndexMode && !(repositoryIndex.contains(documentName, rootElement))) {
System.out.println("[WARNING] The document '" + documentName + "' skipped in the metanorma collection - it's missing in the repository index.");
result = false;
Expand Down Expand Up @@ -830,6 +840,10 @@ public void setPublicationIndexMode(boolean isPublicationIndexMode) {
this.isPublicationIndexMode = isPublicationIndexMode;
}

public void setDocumentsGenerationMode(boolean isDocumentsGenerationMode) {
this.isDocumentsGenerationMode = isDocumentsGenerationMode;
}

public String generateSVG(String xmlFilesPath, String image, String outPath, boolean isSVGmap) throws IOException, TransformerException, SAXParseException {
List<String> xmlFiles = new ArrayList<>();
try (Stream<Path> walk = Files.walk(Paths.get(xmlFilesPath))) {
Expand Down

0 comments on commit 5e7662b

Please sign in to comment.