Merge pull request #194 from metanorma/update

Update

README.adoc

@@ -17,14 +17,14 @@ You will need the `maven` build tool and `make`.
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar <XML-FileName>
+java -Xss5m -jar target/stepmod2mn-1.57.jar <XML-FileName>
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar data/resource_docs/draughting_elements/resource.xml 
+java -Xss5m -jar target/stepmod2mn-1.57.jar data/resource_docs/draughting_elements/resource.xml 
 ----
 
 NOTE: resulted AsciiDoc found in data/resource_docs/draughting_elements/document.adoc
@@ -34,28 +34,28 @@ NOTE: resulted AsciiDoc found in data/resource_docs/draughting_elements/document
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar <XML-FileName> [--output <AsciiDoc-FileName>]
+java -Xss5m -jar target/stepmod2mn-1.57.jar <XML-FileName> [--output <AsciiDoc-FileName>]
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar data/resource_docs/draughting_elements/resource.xml --output result_dir/draughting_elements/document.adoc
+java -Xss5m -jar target/stepmod2mn-1.57.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.56.jar <Input-folder>
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Input-folder>
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar data/
+java -Xss5m -jar target/stepmod2mn-1.57.jar data/
 ----
 
 NOTE: the result AsciiDocs will be saved in the folder with the source resource.xml and module.xml files.
@@ -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.56.jar <Input-folder> [--output <Output-folder>]
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Input-folder> [--output <Output-folder>]
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar data/ --output documents/
+java -Xss5m -jar target/stepmod2mn-1.57.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.56.jar <Input-folder> [--exclude <documents or part numbers list>]
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Input-folder> [--exclude <documents or part numbers list>]
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar data/ --exclude "machining_features 104"
+java -Xss5m -jar target/stepmod2mn-1.57.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.56.jar <Input-folder> [--include-only <documents list>]
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Input-folder> [--include-only <documents list>]
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar data/ --include-only "fundamentals_of_product_description_and_support kinematics"
+java -Xss5m -jar target/stepmod2mn-1.57.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.56.jar <Publication-Index-XML-FileName>
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Publication-Index-XML-FileName>
 ----
 
 e.g.
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar publication/part1000/CR_PMI_5/publication_index.xml
+java -Xss5m -jar target/stepmod2mn-1.57.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).
@@ -125,14 +125,14 @@ and save them into the output folder:
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar <Publication-Index-XML-FileName> [--output <Output-folder>]
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Publication-Index-XML-FileName> [--output <Output-folder>]
 ----
 
 e.g.
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.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.57.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':
@@ -141,7 +141,7 @@ e.g.
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.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.57.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.
@@ -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.56.jar <Publication-Index-XML-FileName> [--type <resource_docs or modules>]
+java -Xss5m -jar target/stepmod2mn-1.57.jar <Publication-Index-XML-FileName> [--type <resource_docs or modules>]
 ----
 
 e.g.
 
 [source,sh]
 ----
-java -Xss5m -jar target/stepmod2mn-1.56.jar publication/part1000/CR_PMI_5/publication_index.xml --type resource_docs
+java -Xss5m -jar target/stepmod2mn-1.57.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).
@@ -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.56.jar <start folder to process xml maps files> --svg
+java -jar target/stepmod2mn-1.57.jar <start folder to process xml maps files> --svg
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -jar target/stepmod2mn-1.56.jar data/resources --svg
+java -jar target/stepmod2mn-1.57.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.56.jar <start folder to process xml maps files> --svg [--output <Output-folder>]
+java -jar target/stepmod2mn-1.57.jar <start folder to process xml maps files> --svg [--output <Output-folder>]
 ----
 
 e.g. 
 
 [source,sh]
 ----
-java -jar target/stepmod2mn-1.56.jar data/resources --svg --output schemas/
+java -jar target/stepmod2mn-1.57.jar data/resources --svg --output schemas/
 ----
 
 === Generate SVG image for Express Imagemap XML and Image:
 
 [source,sh]
 ----
-java -jar stepmod2mn-1.56.jar --xml <Express Imagemap XML file path> --image <Image file name> [--svg <resulted SVG map file or folder>]
+java -jar stepmod2mn-1.57.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.56.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.57.jar --xml data\resource_docs\fundamentals_of_product_description_and_support\schema_diagexpg1.xml --image schema_diagexpg1.gif --svg schema_diagexpg1.svg
 ----
 
 
@@ -223,7 +223,7 @@ Update version in `pom.xml`, e.g.:
 ----
 <groupId>org.metanorma</groupId>
 <artifactId>stepmod2mn</artifactId>
-<version>1.56</version>
+<version>1.57</version>
 <name>STEPmod XML to Metanorma AsciiDoc converter</name>
 ----
 
@@ -234,8 +234,8 @@ Tag the same version in Git:
 
 [source,xml]
 ----
-git tag v1.56
-git push origin v1.56
+git tag v1.57
+git push origin v1.57
 ----
 
 Then the corresponding GitHub release will be automatically created at:

pom.xml

@@ -5,7 +5,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.metanorma</groupId>
 	<artifactId>stepmod2mn</artifactId>
-	<version>1.56</version>
+	<version>1.57</version>
 	<name>STEPmod XML to Metanorma AsciiDoc converter</name>
 	<packaging>jar</packaging>
 	<url>https://www.metanorma.org</url>

src/main/resources/stepmod.base_xsl/common.xsl

@@ -108,6 +108,8 @@ $Id: common.xsl,v 1.209 2020/02/22 00:08:47 tom Exp $
 						<xsl:with-param 
 							name="message" 
 							select="concat('Error FT: No French title (module/@name.french) provided for ',@name)"/>
+						<xsl:with-param name="comment">yes</xsl:with-param>
+						<xsl:with-param name="document_attributes">yes</xsl:with-param>
 					</xsl:call-template>
 				</xsl:when>
 				<xsl:otherwise>
@@ -1628,6 +1630,7 @@ or name()='screen' or name()='ul' or name()='example' or name()='note' or name()
 		<xsl:param name="inline" select="'yes'"/>
 		<xsl:param name="insert_newline" select="'yes'"/>
 		<xsl:param name="comment" select="'no'"/>
+		<xsl:param name="document_attributes" select="'no'"/>
 		<xsl:param name="linebreakchar" select="'#'"/>
 		<xsl:param name="warning_gif" select="'../../../../images/warning.gif'"/>
 
@@ -1645,7 +1648,7 @@ or name()='screen' or name()='ul' or name()='example' or name()='note' or name()
 
 		<xsl:if test="contains($INLINE_ERRORS,'yes')">
 			<xsl:if test="contains($inline,'yes')">
-				<xsl:if test="$insert_newline = 'yes'">
+				<xsl:if test="$insert_newline = 'yes' and $document_attributes = 'no'">
 					<xsl:text>&#xa;</xsl:text>
 				</xsl:if>
 				<!-- <br/>
@@ -1673,7 +1676,10 @@ width="20" height="20"/> -->
 						</xsl:call-template>
 					<xsl:text>_</xsl:text>
 
-				<xsl:text>&#xa;&#xa;</xsl:text>
+				<xsl:text>&#xa;</xsl:text>
+				<xsl:if test="$document_attributes = 'no'">
+					<xsl:text>&#xa;</xsl:text>
+				</xsl:if>
 			</xsl:if>
 		</xsl:if>
 	</xsl:template>
@@ -4713,6 +4719,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 1: No contact provided for project leader.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -4732,6 +4740,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 1: No contact provided for project leader.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -4751,6 +4761,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 1: No contact provided for project leader.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -4776,6 +4788,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 2: No contact provided for project editor.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -4796,6 +4810,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 2: No contact provided for project editor.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -4815,6 +4831,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 2: No contact provided for project editor.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -4835,6 +4853,8 @@ is case sensitive.')"/>
 				<xsl:with-param name="message">
 					Error 1: No contact provided for developer.
 				</xsl:with-param>
+				<xsl:with-param name="comment">yes</xsl:with-param>
+				<xsl:with-param name="document_attributes">yes</xsl:with-param>
 			</xsl:call-template>
 		</xsl:otherwise>
 	</xsl:choose>
@@ -5115,7 +5135,9 @@ is case sensitive.')"/>
 			<xsl:when test="$part &lt;  99">Integrated generic resource</xsl:when>
 			<xsl:otherwise>
 				<xsl:call-template name="error_message">
-				<xsl:with-param name="message" select="concat('Error : unknown type,  part number:', $part)"/>
+					<xsl:with-param name="message" select="concat('Error : unknown type,  part number:', $part)"/>
+					<xsl:with-param name="comment">yes</xsl:with-param>
+					<xsl:with-param name="document_attributes">yes</xsl:with-param>
 				</xsl:call-template>
 			</xsl:otherwise>
 		</xsl:choose>
@@ -5141,6 +5163,8 @@ is case sensitive.')"/>
 	<xsl:otherwise>
 		<xsl:call-template name="error_message">
 			<xsl:with-param name="message" select="concat('Error : unknown type: ', $doctype)"/>
+			<xsl:with-param name="comment">yes</xsl:with-param>
+			<xsl:with-param name="document_attributes">yes</xsl:with-param>
 		</xsl:call-template>
 	</xsl:otherwise>
 	</xsl:choose>
@@ -5159,9 +5183,11 @@ is case sensitive.')"/>
 		Integrated generic resource</xsl:when>
 	<xsl:otherwise>
 		<xsl:call-template name="error_message">
-		<xsl:with-param 
-			name="message" 
-			select="concat('Error : unknown type: ', $doctype)"/>
+			<xsl:with-param 
+				name="message" 
+				select="concat('Error : unknown type: ', $doctype)"/>
+			<xsl:with-param name="comment">yes</xsl:with-param>
+			<xsl:with-param name="document_attributes">yes</xsl:with-param>
 		</xsl:call-template>
 	</xsl:otherwise>
 	</xsl:choose>
@@ -5180,9 +5206,11 @@ is case sensitive.')"/>
 	<xsl:when test="name(.)='resource' and $part &lt;  99">igr</xsl:when>
 	<xsl:otherwise>
 		<xsl:call-template name="error_message">
-		<xsl:with-param 
-			name="message" 
-			select="concat('Error : unknown type,  part number:', $part)"/>
+			<xsl:with-param 
+				name="message" 
+				select="concat('Error : unknown type,  part number:', $part)"/>
+			<xsl:with-param name="comment">yes</xsl:with-param>
+			<xsl:with-param name="document_attributes">yes</xsl:with-param>
 		</xsl:call-template>
 	</xsl:otherwise>
 	</xsl:choose>