s1kd-index Description khzae.net khzae.net All Add --xml-catalog parser option. General The s1kd-index tool adds index flags to a data module based on a user-defined set of keywords. Usage s1kd-index -h? s1kd-index [-I <index>] [-filqv] [<module>...] s1kd-index -D [-filqv] [<module>...] Options -D, --delete Remove the current index flags from a data module. -f, --overwrite Overwrite input module(s). -h, -?, --help Show help/usage message. -I, --indexflags <index> Flag the terms in the specified <index> XML file instead of the default .indexflags file. -i, --ignore-case Ignore case when flagging terms. -l, --list Treat input (stdin or arguments) as lists of filenames of data modules to add index flags to, rather than data modules themselves. -q, --quiet Quiet mode. Errors are not printed. -v, --verbose Verbose output. --version Show version information. In addition, the following options allow configuration of the XML parser: --dtdloadLoad the external DTD.--hugeRemove any internal arbitrary parser limits.--netAllow network access to load external DTD and entities.--noentResolve entities.--parser-errorsEmit errors from parser.--parser-warningsEmit warnings from parser.--xincludeDo XInclude processing.--xml-catalog <file>Use an XML catalog when resolving entities. Multiple catalogs may be loaded by specifying this option multiple times. <verbatimText verbatimStyle="vs02">.indexflags</verbatimText> file This file specifies the list of indexable keywords for the project and their level. By default, the program will search for a file named .indexflags in the current directory or parent directories, but any file can be specified using the -I option. Exmaple of .indexflags file format: <indexFlags> <indexFlag indexLevelOne="bicycle"/> <indexFlag indexLevelOne="bicycle" indexLevelTwo="brake system"/> </indexFlags> Example Given the following in a data module: <levelledPara> <title>General</title> <para> The s1kd-tools are a set of small tools for manipulating S1000D XML data. </para> </levelledPara> And the following .indexflags file: <indexFlags> <indexFlag indexLevelOne="S1000D"/> <indexFlag indexLevelTwo="S10000D" indexLevelTwo="s1kd-tools"/> <indexFlag indexLevelOne="data"/> <indexFlag indexLevelOne="data" indexLevelTwo="XML"/> </indexFlags> Then the s1kd-index command: $ s1kd-index <DM>.XML Would result in the following: <levelledPara> <title>General</title> <para> The s1kd-tools<indexFlag indexLevelOne="S1000D" indexLevelTwo="s1kd-tools"/> are a set of small tools for manipulating S1000D<indexFlag indexLevelOne="S1000D"/> XML<indexFlag indexLevelOne="data" indexLevelTwo="XML"/> data<indexFlag indexLevelOne="data"/>. </para> </levelledPara>