Skip to content

Commit

Permalink
Merge pull request #85 from metanorma/issue/84
Browse files Browse the repository at this point in the history 
fixed issue #84
  • Loading branch information
@Intelligent2013
Intelligent2013 authored Oct 22, 2023
2 parents d2df3f4 + 40f5a75 commit a94a32d
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 37 deletions.
50 changes: 25 additions & 25 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.19.jar <XML-FileName>
java -Xss5m -jar target/stepmod2mn-1.20.jar <XML-FileName>
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.19.jar data/resource_docs/draughting_elements/resource.xml
java -Xss5m -jar target/stepmod2mn-1.20.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.19.jar <XML-FileName> [--output <AsciiDoc-FileName>]
java -Xss5m -jar target/stepmod2mn-1.20.jar <XML-FileName> [--output <AsciiDoc-FileName>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.19.jar data/resource_docs/draughting_elements/resource.xml --output result_dir/draughting_elements/document.adoc
java -Xss5m -jar target/stepmod2mn-1.20.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.19.jar <Input-folder>
java -Xss5m -jar target/stepmod2mn-1.20.jar <Input-folder>
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.19.jar data/
java -Xss5m -jar target/stepmod2mn-1.20.jar data/
----

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

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

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.19.jar data/ --output documents/
java -Xss5m -jar target/stepmod2mn-1.20.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.19.jar <Input-folder> [--exclude <documents list>]
java -Xss5m -jar target/stepmod2mn-1.20.jar <Input-folder> [--exclude <documents list>]
----

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.19.jar data/ --exclude "machining_features"
java -Xss5m -jar target/stepmod2mn-1.20.jar data/ --exclude "machining_features"
----


=== Convert the documents specified in the publication index xml file in the tags 'resource_docs' and 'modules' into the Metanorma AsciiDoc format:

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

e.g.

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

NOTE: the resulted AsciiDocs will be saved in the folder with the source resource.xml and module.xml files.
Expand All @@ -114,29 +114,29 @@ and save them into the output folder:

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

e.g.

[source,sh]
----
java -Xss5m -jar target/stepmod2mn-1.19.jar publication/part1000/CR_PMI_5/publication_index.xml --output documents/
java -Xss5m -jar target/stepmod2mn-1.20.jar publication/part1000/CR_PMI_5/publication_index.xml --output documents/
----


=== Convert the specified type of the document (resource_docs or modules) in the publication index xml file into the Metanorma AsciiDoc format:

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

e.g.

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

NOTE: the resulted AsciiDocs will be saved in the folder with the source resource.xml (or module.xml) files.
Expand All @@ -148,42 +148,42 @@ NOTE: the Metanorma collection file 'metanorma.yml' will be saved in the 3 level

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

e.g.

[source,sh]
----
java -jar target/stepmod2mn-1.19.jar data/resources --svg
java -jar target/stepmod2mn-1.20.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.19.jar <start folder to process xml maps files> --svg [--output <Output-folder>]
java -jar target/stepmod2mn-1.20.jar <start folder to process xml maps files> --svg [--output <Output-folder>]
----

e.g.

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

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

[source,sh]
----
java -jar stepmod2mn-1.19.jar --xml <Express Imagemap XML file path> --image <Image file name> [--svg <resulted SVG map file or folder>]
java -jar stepmod2mn-1.20.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.19.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.20.jar --xml data\resource_docs\fundamentals_of_product_description_and_support\schema_diagexpg1.xml --image schema_diagexpg1.gif --svg schema_diagexpg1.svg
----


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

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

[source,xml]
----
git tag v1.19
git push origin v1.19
git tag v1.20
git push origin v1.20
----

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.19</version>
<version>1.20</version>
<name>STEPmod XML to Metanorma AsciiDoc converter</name>
<packaging>jar</packaging>
<url>https://www.metanorma.org</url>
Expand Down
23 changes: 12 additions & 11 deletions src/main/java/org/metanorma/MetanormaCollectionManifest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,20 @@ public void generate() throws IOException {
String resultAdoc = entry.getValue();
String documentFolder = new File(resultAdoc).getParent();
File fileResultCollectionYml = Paths.get(documentFolder, "collection.yml").toFile();
InputStream is = new FileInputStream(fileResultCollectionYml);
Yaml yaml = new Yaml();
Map<String, Object> yamlDocumentObj = yaml.load(is);
//System.out.println(yamlDocumentObj);
if (fileResultCollectionYml.exists()) {
InputStream is = new FileInputStream(fileResultCollectionYml);
Yaml yaml = new Yaml();
Map<String, Object> yamlDocumentObj = yaml.load(is);
//System.out.println(yamlDocumentObj);

// manifest:
// - level: document
update_docref(yamlDocumentObj,0, documentFolder);

// manifest:
// - level: attachments
update_docref(yamlDocumentObj,1, documentFolder);
// manifest:
// - level: document
update_docref(yamlDocumentObj, 0, documentFolder);

// manifest:
// - level: attachments
update_docref(yamlDocumentObj, 1, documentFolder);
}
counter++;
}

Expand Down
1 change: 1 addition & 0 deletions src/main/resources/stepmod2mn.module.adoc.xsl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
<xsl:param name="boilerplate_path"/>
<xsl:param name="repositoryIndex_path"/>
<xsl:param name="errors_fatal_log"/>
<xsl:param name="errors_fatal_log_filename" select="concat($outpath, '/', $errors_fatal_log)"/>

<!-- placeholders, global variables -->
<xsl:variable name="FILE_EXT" select="'.xml'"/>
Expand Down

0 comments on commit a94a32d

Please sign in to comment.