1. Inline targets (if ``-W index-inline-targets``) 2. Targets created using a target role (either the target role or some other role based upon target) specified with ``-W index-role-target``). The index entry is either the visible text, or if there is none, the target name. 3. Indirect targets pointing to indexed targets (if ``-W index-indirect-targets``)
The index writer sorts indices from all input files and put them into a table. Each row of the table contains an index entry and the location of the entry in the html version of the source file. An entry is also a reference to the definition in the corresponding html file.
This writer uses the following output defines:
-W doc-titles=<0|1> Put the document title in the index (default is 1). -W file-suffix=<suffix> Specify a file suffix to be used for the html version of the source files (default is "html"). -W filename-ext=<ext> Specify an extension to the filename, (e.g. "_main") so the location of targets becomes <file><ext>.<suffix> (default is ""). -W index-inline-targets=<0|1> Specifies whether inline targets should be indexed (default is 1). -W index-indirect-targets=<0|1> Specifies whether indirect targets pointing to indexed targets should be indexed (default is 0). -W index-role-target[=<0|name>] Specifies whether targets originating from an interpreted text role should be indexed, and if so, what role name should be used (default is 0, or if specified with no name, 'target'). -W output-header=<0|1> Output a title and contents header (default is 1). -W short-titles=<0|1> Use short titles (no section titles) in the index (default is 1). -W title-underline=<char> Specify the underline character to use for the title in the header (default is '*'). =end Description =end reST
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 7:
=pod directives shouldn't be over one line long! Ignoring all 5 lines of content