s1kd-newdm: Clarify template format

kibook · Dec 22, 2020 · 862b01c · 862b01c
1 parent 0f68242
commit 862b01c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 16 deletions.
diff --git a/tools/s1kd-newdm/README.md b/tools/s1kd-newdm/README.md
@@ -428,8 +428,9 @@ the schema, matching one of the schema names in the `.dmtypes` file or
 the schema specified with the -T option.
 
 The templates must be written to conform to the default S1000D issue of
-this tool (currently 5.0). They will be automatically transformed when
-another issue is specified with the -$ option.
+this tool (currently 5.0), regardless of what issue of S1000D the
+project is using. The final output will be automatically transformed
+when another issue is specified with the -$ option.
 
 The `templates` default can also be specified in the `.defaults` file to
 use these custom templates by default.

diff --git a/tools/s1kd-newdm/doc/DMC-S1KDTOOLS-A-07-00-00-00A-040A-D_EN-CA.XML b/tools/s1kd-newdm/doc/DMC-S1KDTOOLS-A-07-00-00-00A-040A-D_EN-CA.XML
@@ -6,10 +6,10 @@
       <dmIdent>
         <dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="07" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/>
         <language languageIsoCode="en" countryIsoCode="CA"/>
-        <issueInfo issueNumber="051" inWork="00"/>
+        <issueInfo issueNumber="051" inWork="01"/>
       </dmIdent>
       <dmAddressItems>
-        <issueDate year="2020" month="09" day="01"/>
+        <issueDate year="2020" month="12" day="22"/>
         <dmTitle>
           <techName>s1kd-newdm(1) | s1kd-tools</techName>
         </dmTitle>
@@ -38,11 +38,8 @@
       <qualityAssurance>
         <unverified/>
       </qualityAssurance>
-      <reasonForUpdate id="rfu-xml-catalog" updateHighlight="1" updateReasonType="urt02">
-        <simplePara>Add --xml-catalog parser option.</simplePara>
-      </reasonForUpdate>
-      <reasonForUpdate id="rfu-0001" updateHighlight="1" updateReasonType="urt02">
-        <simplePara>Replace -P (--two-sns-levels) with -P (--sns-levels).</simplePara>
+      <reasonForUpdate id="rfu-0001" updateHighlight="1" updateReasonType="urt01">
+        <simplePara>Clarify that the format of the templates is always the default S1000D issue, regardless of what issue the project is using.</simplePara>
       </reasonForUpdate>
     </dmStatus>
   </identAndStatusSection>
@@ -295,7 +292,7 @@
                 <para>The originator enterprise name of the new data module.</para>
               </listItemDefinition>
             </definitionListItem>
-            <definitionListItem changeMark="1" changeType="modify" reasonForUpdateRefIds="rfu-0001">
+            <definitionListItem>
               <listItemTerm>-P, --sns-levels &lt;levels&gt;</listItemTerm>
               <listItemDefinition>
                 <para>When determining tech name from an SNS (-S or -M), include the specified number of levels of SNS in the tech name, from 1 (default) to 4. Each level is separated by " - ".</para>
@@ -511,7 +508,7 @@
                 <para>Do XInclude processing.</para>
               </listItemDefinition>
             </definitionListItem>
-            <definitionListItem changeMark="1" changeType="add" reasonForUpdateRefIds="rfu-xml-catalog">
+            <definitionListItem>
               <listItemTerm>--xml-catalog &lt;file&gt;</listItemTerm>
               <listItemDefinition>
                 <para>Use an XML catalog when resolving entities. Multiple catalogs may be loaded by specifying this option multiple times.</para>
@@ -615,7 +612,7 @@ infoNameVariant="Clean with water"/>
         <levelledPara>
           <title>Custom XML templates (-%)</title>
           <para>A minimal set of S1000D templates are built-in to this tool, but customized templates may be used with the -% option. This option takes a path to a directory where the custom templates are located. Each template should be named <verbatimText verbatimStyle="vs02">&lt;schema&gt;.xml</verbatimText>, where <verbatimText verbatimStyle="vs02">&lt;schema&gt;</verbatimText> is the name of the schema, matching one of the schema names in the <verbatimText verbatimStyle="vs02">.dmtypes</verbatimText> file or the schema specified with the -T option.</para>
-          <para>The templates must be written to conform to the default S1000D issue of this tool (currently 5.0). They will be automatically transformed when another issue is specified with the -$ option.</para>
+          <para changeMark="1" changeType="modify" reasonForUpdateRefIds="rfu-0001">The templates must be written to conform to the default S1000D issue of this tool (currently 5.0), regardless of what issue of S1000D the project is using. The final output will be automatically transformed when another issue is specified with the -$ option.</para>
           <para>The <verbatimText>templates</verbatimText> default can also be specified in the <verbatimText verbatimStyle="vs02">.defaults</verbatimText> file to use these custom templates by default.</para>
         </levelledPara>
       </levelledPara>

diff --git a/tools/s1kd-newdm/doc/s1kd-newdm.1 b/tools/s1kd-newdm/doc/s1kd-newdm.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.3.1
 .\"
-.TH "s1kd\-newdm" "1" "2020\-09\-01" "" "s1kd\-tools"
+.TH "s1kd\-newdm" "1" "2020\-12\-22" "" "s1kd\-tools"
 .hy
 .SH NAME
 .PP
@@ -572,9 +572,10 @@ names in the \f[C]\&.dmtypes\f[] file or the schema specified with the
 \-T option.
 .PP
 The templates must be written to conform to the default S1000D issue of
-this tool (currently 5.0).
-They will be automatically transformed when another issue is specified
-with the \-$ option.
+this tool (currently 5.0), regardless of what issue of S1000D the
+project is using.
+The final output will be automatically transformed when another issue is
+specified with the \-$ option.
 .PP
 The \f[C]templates\f[] default can also be specified in the
 \f[C]\&.defaults\f[] file to use these custom templates by default.