hxtoc(1) [debian man page]
HXTOC(1) HTML-XML-utils HXTOC(1) NAME
hxtoc - insert a table of contents in an HTML file SYNOPSIS
hxtoc [ -x ] [ -l low ] [ -h high ] [ file ] [ -t ] [ -d ] [ -c class ] DESCRIPTION
The hxtoc command reads an HTML file, inserts missing ID attributes in all H1 to H6 elements between the levels -l and -h (unless the option -d is in effect, see below) and also inserts A elements with NAME attributes, so old browsers will recognize the H1 to H6 headers as target anchors as well (unless the option -t is in effect). The output is written to stdout. If there is a comment of the form <!--toc--> or a pair of comments <!--begin-toc--> ... <!--end-toc--> then the comment, or the pair with everything in between, will be replaced by a table of contents, consisting of a list (UL) of links to all headers in the document. The text of headers is copied to this table of contents, including any inline markup, except that DFN tags and SPAN tags with a CLASS of "index" are omitted (but the elements content is copied). If a header has a CLASS attribute with as value (or one of its values) the keyword "no-toc", then that header will not appear in the table of contents. OPTIONS
The following options are supported: -x Use XML conventions: empty elements are written with a slash at the end: <IMG /> -l low Sets the lowest numbered header to appear in the table of content. Default is 1 (i.e., H1). -h high Sets the highest numbered header to appear in the table of content. Default is 6 (i.e., H6). -t Normally, hxtoc adds both ID attributes and empty A elements with a NAME attribute and CLASS="bctarget", so that older browsers that do no understand ID will still find the target. With this option, the A elements will not be generated. -c class The generated UL elements in the table of contents will have a CLASS attribute with the value class. The default is "toc". -d Tries to use DIV elements as targets instead of H1 to H6: If a header element H1 to H6 within the range -l to -h is found and it is the first child of a DIV element, then the table of contents will link to the DIV instead of to the header element. The DIV will be given an ID if it doesn't have one yet. ID OPERANDS
The following operand is supported: file The name of an HTML file. If absent, standard input is read instead. DIAGNOSTICS
The following exit values are returned: 0 Successful completion. > 0 An error occurred in the parsing of the HTML file. hxtoc will try to correct the error and produce output anyway. SEE ALSO
asc2xml(1), hxnormalize(1), hxnum(1), xml2asc(1) BUGS
The error recovery for incorrect HTML is primitive. 6.x 10 Jul 2011 HXTOC(1)
Check Out this Related Man Page
HXREF(1) HTML-XML-utils HXREF(1) NAME
hxref - generate cross-references inside and between HTML files SYNOPSIS
hxref [ -x ] [ -l ] [ -b base ] [ -i index ] [ -- ] [ input [ output ] ] DESCRIPTION
The hxref command links inline elements to DFN elements with the same content. It adds ID attributes where necessary. If the content of a DFN or other element isn't suitable, the TITLE attribute may be used to provide the term to use for comparisons. Here is an example: <p>A <dfn>b-box</dfn> is defined to be... <p>For every b there is a <em>b-box</em>... The output of hxref will be similar to this: <p>A <dfn id="b-box">b-box</dfn> is defined to be... <p>For every b there is a <a href="#b-box"><em>b-box</em></a>... OPTIONS
The following options are supported: -x Use XML conventions: empty elements are written with a slash at the end: <IMG /> -b base Sets the prefix for the generated URLs. By default base is empty, which generates URLs like "#b-box" above. If base is set to, e.g., "http://xyz/", the URLs will look like "http://xyz/#b-box". -i index Directs hxref to read terms from a database file before looking for them in the document and afterwards store the terms that were found in the same file. DFN element in the document override terms found in index. This allows hxref to be run multiple times on different files, to make the files refer to each other. It may be necessary to run the commands twice, to resolve all cross-ref- erences. -l Try to use language-specific information to match instances to their definitions. Currently, only English is supported and the only rules applied are to search without a final "s" ("trees" matches "tree"), without a final "es" ("bosses" matches "boss") and with a "y" replacing a final "ies" ("bounties" matches "bounty"). hxref determines the language from "lang" and "xml:lang" attributes in the document. OPERANDS
The following operands are supported: input The name of an HTML file. If absent, standard input is read instead. The special name "-" also indicates standard input. The input may be an URL. output The file to write to. If absent, standard output is used. This may not be a URL. DIAGNOSTICS
The following exit values are returned: 0 Successful completion. > 0 An error occurred in the parsing of the HTML file. hxref will try to correct the error and produce output anyway. SEE ALSO
asc2xml(1), hxindex(1), hxnormalize(1), hxnum(1), hxtoc(1), xml2asc(1) BUGS
The error recovery for incorrect HTML is primitive. The program generates ID attributes, but doesn't generate <a name=...> tags, so the links only work in browsers that recognize ID attributes. The rules for matching English plurals are primitif. No dictionary is used. E.g., "bees" will be considered a plural of "be". There is currently no way to set the default language for a document for when the root element has no "lang" or "xml:lang" attribute. 6.x 10 Jul 2011 HXREF(1)