..
/
download
<?xml version="1.0"?>
<dmodule xmlns:dc="http://www.purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.s1000d.org/S1000D_5-0/xml_schema_flat/descript.xsd">
<identAndStatusSection>
<dmAddress>
<dmIdent>
<dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="21" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/>
<language languageIsoCode="en" countryIsoCode="CA"/>
<issueInfo issueNumber="033" inWork="00"/>
</dmIdent>
<dmAddressItems>
<issueDate year="2020" month="09" day="01"/>
<dmTitle>
<techName>s1kd-newdml</techName>
<infoName>Description</infoName>
</dmTitle>
</dmAddressItems>
</dmAddress>
<dmStatus issueType="changed">
<security securityClassification="01"/>
<responsiblePartnerCompany>
<enterpriseName>khzae.net</enterpriseName>
</responsiblePartnerCompany>
<originator>
<enterpriseName>khzae.net</enterpriseName>
</originator>
<applic>
<displayText>
<simplePara>All</simplePara>
</displayText>
</applic>
<brexDmRef>
<dmRef>
<dmRefIdent>
<dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="00" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="022" infoCodeVariant="A" itemLocationCode="D"/>
</dmRefIdent>
</dmRef>
</brexDmRef>
<qualityAssurance>
<unverified/>
</qualityAssurance>
<reasonForUpdate id="rfu-xml-catalog" updateHighlight="1" updateReasonType="urt02">
<simplePara>Add --xml-catalog parser option.</simplePara>
</reasonForUpdate>
</dmStatus>
</identAndStatusSection>
<content>
<refs>
<dmRef>
<dmRefIdent>
<dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="07" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/>
</dmRefIdent>
<dmRefAddressItems>
<dmTitle>
<techName>s1kd-newdm</techName>
<infoName>Description</infoName>
</dmTitle>
</dmRefAddressItems>
</dmRef>
</refs>
<description>
<levelledPara>
<title>General</title>
<para>The <emphasis>s1kd-newdml</emphasis> tool creates a new S1000D data management list with the code and other metadata specified.</para>
</levelledPara>
<levelledPara>
<title>Usage</title>
<para>
<verbatimText verbatimStyle="vs24">s1kd-newdml [options] [<object>...]</verbatimText>
</para>
</levelledPara>
<levelledPara>
<title>Options</title>
<para>
<definitionList>
<definitionListItem>
<listItemTerm>-#, --code <code></listItemTerm>
<listItemDefinition>
<para>The data management list code of the new DML.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-$, --issue <issue></listItemTerm>
<listItemDefinition>
<para>Specify which issue of S1000D to use. Currently supported issues are:</para>
<para>
<randomList>
<listItem>
<para>5.0 (default)</para>
</listItem>
<listItem>
<para>4.2</para>
</listItem>
<listItem>
<para>4.1</para>
</listItem>
<listItem>
<para>4.0</para>
</listItem>
<listItem>
<para>3.0</para>
</listItem>
<listItem>
<para>2.3</para>
</listItem>
<listItem>
<para>2.2</para>
</listItem>
<listItem>
<para>2.1</para>
</listItem>
<listItem>
<para>2.0</para>
</listItem>
</randomList>
</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-@, --out <path></listItemTerm>
<listItemDefinition>
<para>Save the new DML to <path>. If <path> is an existing directory, the DML will be created in it instead of the current directory. Otherwise, the DML will be saved as the filename <path> instead of being automatically named.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-%, --templates <dir></listItemTerm>
<listItemDefinition>
<para>Use the XML template in the specified directory instead of the built-in template. The template must be named <verbatimText verbatimStyle="vs02">dml.xml</verbatimText> inside <dir> and must conform to the default S1000D issue (5.0).</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-~, --dump-templates <dir></listItemTerm>
<listItemDefinition>
<para>Dump the built-in XML template to the specified directory.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-b, --brex <BREX></listItemTerm>
<listItemDefinition>
<para>BREX data module code.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-c, --security <sec></listItemTerm>
<listItemDefinition>
<para>The security classification of the new DML.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-d, --defaults <file></listItemTerm>
<listItemDefinition>
<para>Specify the <verbatimText verbatimStyle="vs02">.defaults</verbatimText> file name.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-f, --overwrite</listItemTerm>
<listItemDefinition>
<para>Overwrite existing file.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-h, -?, --help</listItemTerm>
<listItemDefinition>
<para>Show usage message.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-I, --date <date></listItemTerm>
<listItemDefinition>
<para>The issue date of the new DML in the form of YYYY-MM-DD.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-i, --info-code <info code></listItemTerm>
<listItemDefinition>
<para>When creating a DMRL from SNS rules (-S), use the specified info code for each entry. Specify this option multiple times to create multiple data modules for each part of the SNS. <info code> can specify:</para>
<para>
<randomList>
<listItem>
<para>the base info code (e.g., 520)</para>
</listItem>
<listItem>
<para>the info code variant (e.g., 520B)</para>
</listItem>
<listItem>
<para>the item location code (e.g., 520B-C)</para>
</listItem>
</randomList>
</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-l, --list</listItemTerm>
<listItemDefinition>
<para>Treat input (stdin or arguments) as lists of CSDB objects to add to the new list.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-m, --remarks <remarks></listItemTerm>
<listItemDefinition>
<para>Set the remarks for the new data management list.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-N, --omit-issue</listItemTerm>
<listItemDefinition>
<para>Omit the issue/inwork numbers from filename.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-n, --issno <issue></listItemTerm>
<listItemDefinition>
<para>The issue number of the new DML.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-p, --prompt</listItemTerm>
<listItemDefinition>
<para>Prompts the user for any values left unspecified.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-q, --quiet</listItemTerm>
<listItemDefinition>
<para>Do not report an error when the file already exists.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-R, --rpccode <NCAGE></listItemTerm>
<listItemDefinition>
<para>Specifies a default responsible partner company enterprise code for entries which do not carry this in their ID STATUS section (ICN, COM, DML).</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-r, --rpcname <name></listItemTerm>
<listItemDefinition>
<para>Specifies a default responsible partner company enterprise name for entries which do not carry this in their IDSTATUS section (ICN, COM, DML).</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-S, --sns <SNS></listItemTerm>
<listItemDefinition>
<para>Create a DMRL using the specified SNS rules.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-v, --verbose</listItemTerm>
<listItemDefinition>
<para>Print the file name of the newly created DML.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-w, --inwork <inwork></listItemTerm>
<listItemDefinition>
<para>The inwork number of the new DML.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>-z, --issue-type <type></listItemTerm>
<listItemDefinition>
<para>The issue type of the new DML.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm>--version</listItemTerm>
<listItemDefinition>
<para>Show version information.</para>
</listItemDefinition>
</definitionListItem>
<definitionListItem>
<listItemTerm><object>...</listItemTerm>
<listItemDefinition>
<para>Any number of CSDB object file names to automatically add to the list.</para>
</listItemDefinition>
</definitionListItem>
</definitionList>
</para>
<para>
In addition, the following options allow configuration of the XML parser:
<definitionList><definitionListItem><listItemTerm>--dtdload</listItemTerm><listItemDefinition><para>Load the external DTD.</para></listItemDefinition></definitionListItem><definitionListItem><listItemTerm>--huge</listItemTerm><listItemDefinition><para>Remove any internal arbitrary parser limits.</para></listItemDefinition></definitionListItem><definitionListItem><listItemTerm>--net</listItemTerm><listItemDefinition><para>Allow network access to load external DTD and entities.</para></listItemDefinition></definitionListItem><definitionListItem><listItemTerm>--noent</listItemTerm><listItemDefinition><para>Resolve entities.</para></listItemDefinition></definitionListItem><definitionListItem><listItemTerm>--parser-errors</listItemTerm><listItemDefinition><para>Emit errors from parser.</para></listItemDefinition></definitionListItem><definitionListItem><listItemTerm>--parser-warnings</listItemTerm><listItemDefinition><para>Emit warnings from parser.</para></listItemDefinition></definitionListItem><definitionListItem><listItemTerm>--xinclude</listItemTerm><listItemDefinition><para>Do XInclude processing.</para></listItemDefinition></definitionListItem><definitionListItem changeMark="1" changeType="add" reasonForUpdateRefIds="rfu-xml-catalog"><listItemTerm>--xml-catalog <file></listItemTerm><listItemDefinition><para>Use an XML catalog when resolving entities. Multiple catalogs may be loaded by specifying this option multiple times.</para></listItemDefinition></definitionListItem></definitionList>
</para>
<levelledPara>
<title><verbatimText verbatimStyle="vs02">.defaults</verbatimText> file</title>
<para>Refer to <dmRef><dmRefIdent><dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="07" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/></dmRefIdent><dmRefAddressItems><dmTitle><techName>s1kd-newdm</techName><infoName>Description</infoName></dmTitle></dmRefAddressItems></dmRef> for information on the <verbatimText verbatimStyle="vs02">.defaults</verbatimText> file which is used by all the s1kd-new* commands.</para>
</levelledPara>
</levelledPara>
<levelledPara>
<title>Example</title>
<para>
<verbatimText verbatimStyle="vs24">$ s1kd-newdml -# EX-12345-C-2018-00001</verbatimText>
</para>
</levelledPara>
</description>
</content>
</dmodule>
gopher://khzae.net/0/s1kd/s1kd-tools/sample/csdb/DMC-S1KDTOOLS-A-21-00-00-00A-040A-D_EN-CA.XML