..
/
download
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "s1kd-tools" "1" "2020-05-01" "" "s1kd-tools"
.hy
.SH NAME
.PP
s1kd-tools - Tools for S1000D data
.SH DESCRIPTION
.SS S1000D
.PP
\f[B]S1000D\f[R] is \[dq]an international specification for the
procurement and production of technical publications\[dq], part of the
S-Series of ILS specifications.
The main focus of S1000D is the breakdown and classification of
documents in to individual components, called \[dq]data modules\[dq],
which can be re-used in multiple publications.
These data modules are typically authored using a set of provided XML
schemas, allowing them to be automatically managed in a Common Source
Database (CSDB) and validated against a defined set of project
\[dq]business rules\[dq].
.SS s1kd-tools
.PP
The \f[B]s1kd-tools\f[R] are a set of small tools for creating and
manipulating S1000D data.
They are designed to be used as a standalone method of maintaining a
simple S1000D CSDB, in conjunction with a more typical version control
system such as Git or SVN, as a backend to implement a more complex
S1000D CSDB, or to support an existing S1000D CSDB already in use by a
project.
.SS CSDB
.PP
Common Source Databases can be implemented in any number of ways.
For the purposes of the s1kd-tools, the CSDB is simply a directory
within a filesystem.
Use of the \[dq]File-based transfer\[dq] file naming conventions in Chap
7 of the S1000D specification are recommended, and most of the tools
will use these conventions when creating or listing CSDB objects
represented by files.
In order to use these tools in conjuction with other implementations of
CSDBs, a project can make use of \[dq]transfer packages\[dq] also
described in Chap 7 to facilitate interchange between the two kinds of
CSDB.
.SS Relationship to the S1000D process
.PP
The s1kd-tools can support multiple parts of the basic S1000D process:
.IP "1." 3
\f[B]Generation:\f[R] The generation of new CSDB objects is supported by
the \f[B]s1kd-dmrl\f[R] tool and the \f[B]s1kd-new*\f[R] set of tools.
These provide two methods of creating objects, either using a data
management requirements list (DMRL) or a more on-the-fly approach using
the s1kd-new* tools directly.
.RS 4
.PP
The \f[B]s1kd-defaults\f[R] tool is used to manage the files which
contain default metadata for new CSDB objects.
.RE
.IP "2." 3
\f[B]Authoring:\f[R] These tools support the authoring process.
.RS 4
.PP
The \f[B]s1kd-addicn\f[R] tool creates the notation and entity elements
to reference an ICN in a data module.
.PP
The \f[B]s1kd-ls\f[R] tool lists data modules within a directory.
.PP
The \f[B]s1kd-metadata\f[R] tool lists and edits S1000D metadata on CSDB
objects.
.PP
The \f[B]s1kd-mvref\f[R] tool changes references to one object into
references to another.
.PP
The \f[B]s1kd-ref\f[R] tool can be used to quickly insert references to
other CSDB objects.
.PP
The \f[B]s1kd-sns\f[R] tool can be used to organize the CSDB using a
given SNS structure.
.PP
The \f[B]s1kd-upissue\f[R] tool moves CSDB objects through the standard
S1000D workflow, between \[dq]inwork\[dq] (draft) and \[dq]official\[dq]
states.
.RE
.IP "3." 3
\f[B]Validation:\f[R] These tools all validate different aspects of CSDB
objects.
.RS 4
.PP
The \f[B]s1kd-appcheck\f[R] tool validates the applicability of CSDB
objects.
.PP
The \f[B]s1kd-brexcheck\f[R] tool validates CSDB objects against a
business rules exchange (BREX) data module, which contains the
project-defined computable business rules.
.PP
The \f[B]s1kd-refs\f[R] tool lists references in a CSDB object to
generate a list of dependencies on other CSDB objects.
.PP
The \f[B]s1kd-repcheck\f[R] tool validates CIR references in CSDB
objects.
.PP
The \f[B]s1kd-validate\f[R] tool validates CSDB objects according to
their S1000D schema and general correctness as XML documents.
.RE
.IP "4." 3
\f[B]Publication:\f[R] These tools support the production of
publications from a CSDB.
.RS 4
.PP
The \f[B]s1kd-acronyms\f[R] tool can automatically mark up acronyms
within data modules, and can also generate lists of acronyms marked up
within data modules.
.PP
The \f[B]s1kd-aspp\f[R] tool preprocesses applicability statements in a
data module, generating display text and \[dq]presentation\[dq]
applicability statements.
.PP
The \f[B]s1kd-flatten\f[R] tool flattens a publication module and
referenced data modules in to a single \[dq]deliverable\[dq] file for a
publishing system.
.PP
The \f[B]s1kd-fmgen\f[R] tool generates front matter data module content
from a publication module.
.PP
The \f[B]s1kd-icncatalog\f[R] tool resolves ICN references in objects.
.PP
The \f[B]s1kd-index\f[R] tool flags index keywords in a data module
based on a user-defined list.
.PP
The \f[B]s1kd-instance\f[R] tool produces \[dq]instances\[dq] of CSDB
objects using applicability filtering and/or common information
repositories (CIRs).
.PP
The \f[B]s1kd-neutralize\f[R] tool generates IETP neutral metadata for
CSDB objects.
.PP
The \f[B]s1kd-syncrefs\f[R] tool generates the References table within
data modules.
.PP
The \f[B]s1kd-uom\f[R] tool converts units of measure used in data
modules.
.RE
.SH SEE ALSO
.PP
S1000D website: http://www.s1000d.org
.PP
Manpages for each tool:
.IP \[bu] 2
s1kd-acronyms(1)
.IP \[bu] 2
s1kd-addicn(1)
.IP \[bu] 2
s1kd-appcheck(1)
.IP \[bu] 2
s1kd-aspp(1)
.IP \[bu] 2
s1kd-brexcheck(1)
.IP \[bu] 2
s1kd-defaults(1)
.IP \[bu] 2
s1kd-dmrl(1)
.IP \[bu] 2
s1kd-flatten(1)
.IP \[bu] 2
s1kd-fmgen(1)
.IP \[bu] 2
s1kd-icncatalog(1)
.IP \[bu] 2
s1kd-index(1)
.IP \[bu] 2
s1kd-instance(1)
.IP \[bu] 2
s1kd-ls(1)
.IP \[bu] 2
s1kd-metadata(1)
.IP \[bu] 2
s1kd-mvref(1)
.IP \[bu] 2
s1kd-neutralize(1)
.IP \[bu] 2
s1kd-newcom(1)
.IP \[bu] 2
s1kd-newddn(1)
.IP \[bu] 2
s1kd-newdm(1)
.IP \[bu] 2
s1kd-newdml(1)
.IP \[bu] 2
s1kd-newimf(1)
.IP \[bu] 2
s1kd-newpm(1)
.IP \[bu] 2
s1kd-newsmc(1)
.IP \[bu] 2
s1kd-newupf(1)
.IP \[bu] 2
s1kd-ref(1)
.IP \[bu] 2
s1kd-refs(1)
.IP \[bu] 2
s1kd-repcheck(1)
.IP \[bu] 2
s1kd-sns(1)
.IP \[bu] 2
s1kd-syncrefs(1)
.IP \[bu] 2
s1kd-uom(1)
.IP \[bu] 2
s1kd-upissue(1)
.IP \[bu] 2
s1kd-validate(1)
.PP
Configuration files:
.IP \[bu] 2
s1kd-defaults(5)
.SH AUTHORS
khzae.net.
gopher://khzae.net/0/s1kd/s1kd-tools/src/doc/s1kd-tools.1