..
/
download
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "s1kd-index" "1" "2021-04-16" "" "s1kd-tools"
.hy
.SH NAME
.PP
s1kd-index - Flag index keywords in a data module
.SH SYNOPSIS
.IP
.nf
\f[C]
s1kd-index -h?
s1kd-index [-I <index>] [-filqv] [<module>...]
s1kd-index -D [-filqv] [<module>...]
\f[R]
.fi
.SH DESCRIPTION
.PP
The \f[I]s1kd-index\f[R] tool adds index flags to a data module based on
a user-defined set of keywords.
.SH OPTIONS
.TP
-D, --delete
Remove the current index flags from a data module.
.TP
-f, --overwrite
Overwrite input module(s).
.TP
-h, -?, --help
Show help/usage message.
.TP
-I, --indexflags <index>
Flag the terms in the specified <index> XML file instead of the default
\f[C].indexflags\f[R] file.
.TP
-i, --ignore-case
Ignore case when flagging terms.
.TP
-l, --list
Treat input (stdin or arguments) as lists of filenames of data modules
to add index flags to, rather than data modules themselves.
.TP
-q, --quiet
Quiet mode.
Errors are not printed.
.TP
-v, --verbose
Verbose output.
.TP
--version
Show version information.
.PP
In addition, the following options allow configuration of the XML
parser:
.TP
--dtdload
Load the external DTD.
.TP
--huge
Remove any internal arbitrary parser limits.
.TP
--net
Allow network access to load external DTD and entities.
.TP
--noent
Resolve entities.
.TP
--parser-errors
Emit errors from parser.
.TP
--parser-warnings
Emit warnings from parser.
.TP
--xinclude
Do XInclude processing.
.TP
--xml-catalog <file>
Use an XML catalog when resolving entities.
Multiple catalogs may be loaded by specifying this option multiple
times.
.SS \f[C].indexflags\f[R] file
.PP
This file specifies the list of indexable keywords for the project and
their level.
By default, the program will search for a file named
\f[C].indexflags\f[R] in the current directory or parent directories,
but any file can be specified using the -I option.
.PP
Exmaple of \f[C].indexflags\f[R] file format:
.IP
.nf
\f[C]
<indexFlags>
<indexFlag indexLevelOne=\[dq]bicycle\[dq]/>
<indexFlag indexLevelOne=\[dq]bicycle\[dq] indexLevelTwo=\[dq]brake system\[dq]/>
</indexFlags>
\f[R]
.fi
.SH EXAMPLE
.PP
Given the following in a data module:
.IP
.nf
\f[C]
<levelledPara>
<title>General</title>
<para>
The s1kd-tools are a set of small tools for manipulating S1000D XML
data.
</para>
</levelledPara>
\f[R]
.fi
.PP
And the following \f[C].indexflags\f[R] file:
.IP
.nf
\f[C]
<indexFlags>
<indexFlag indexLevelOne=\[dq]S1000D\[dq]/>
<indexFlag indexLevelTwo=\[dq]S10000D\[dq] indexLevelTwo=\[dq]s1kd-tools\[dq]/>
<indexFlag indexLevelOne=\[dq]data\[dq]/>
<indexFlag indexLevelOne=\[dq]data\[dq] indexLevelTwo=\[dq]XML\[dq]/>
</indexFlags>
\f[R]
.fi
.PP
Then the s1kd-index command:
.IP
.nf
\f[C]
$ s1kd-index <DM>.XML
\f[R]
.fi
.PP
Would result in the following:
.IP
.nf
\f[C]
<levelledPara>
<title>General</title>
<para>
The s1kd-tools<indexFlag indexLevelOne=\[dq]S1000D\[dq]
indexLevelTwo=\[dq]s1kd-tools\[dq]/> are a set of small tools for
manipulating S1000D<indexFlag indexLevelOne=\[dq]S1000D\[dq]/>
XML<indexFlag indexLevelOne=\[dq]data\[dq] indexLevelTwo=\[dq]XML\[dq]/>
data<indexFlag indexLevelOne=\[dq]data\[dq]/>.
</para>
</levelledPara>
\f[R]
.fi
.SH AUTHORS
khzae.net.
gopher://khzae.net/0/s1kd/s1kd-tools/src/tools/s1kd-index/doc/s1kd-index.1