NAME

VERSION

SYNOPSIS

hypertoc [--bak string ] [ --debug ] [ --entrysep string ] [ --footer file ] [ --header file ] [ --ignore_only_one ] [ --ignore_sole_first ] [ --inline ] [ --make_anchors ] [ --make_toc ] [ --notoc_match string ] [ --ol | --nool ] [ --ol_num_levels ] [ --outfile file ] [ --overwrite ] [ --quiet ] [ --textonly ] [ --title string ] { --toc_after tag=suffix } { --toc_before tag=prefix } { --toc_end tag=endtag } { --toc_entry tag=level } [ --toc_label string ] [ --toc_only | --notoc_only ] [ --toc_tag string ] [ --toc_tag_replace ] [ --use_id ] [ --useorg ] file ...

DESCRIPTION

Basically, the ToC generated is a multi-level level list containing links to the significant elements. hypertoc inserts the links into the ToC to significant elements at a level specified by the user.

Example:

If H1s are specified as level 1, than they appear in the first level list of the ToC. If H2s are specified as a level 2, than they appear in a second level list in the ToC.

There are two aspects to the ToC generation: (1) putting suitable anchors into the HTML documents (--make_anchors), and (2) generating the ToC from HTML documents which have anchors in them for the ToC to link to (--make_toc). One can choose to do one or both of these.

hypertoc also supports the ability to incorporate the ToC into the HTML document itself via the --inline option.

In order for hypertoc to support linking to significant elements, hypertoc inserts anchors into the significant elements. One can use hypertoc as a filter, outputing the result to another file, or one can overwrite the original file, with the original backed up with a suffix (default: "org") appended to the filename.

One can also define options in a config file as well as on the command-line.

OPTIONS

See Getopt::Long for more information.

--argfile filename

The name of a file to read more options from. This can be used more than once. For example:

--argfile your.args --argfile my.args

See "Options Files" for more information.

--bak

--bak string

If the input file/files is/are being overwritten (--overwrite is on), copy the original file to "filename.string". If the value is empty, there is no backup file written. (default:org)

--debug

Enable verbose debugging output. Used for debugging this module; in other words, don't bother. (default:off)

--entrysep

--entrysep string

Separator string for non-<li> item entries (default: ", ")

--footer

--footer file

File containing footer text for table of contents.

--header

--header file

File containing header text for table of contents.

--help

Print a short help message and exit.

--ignore_only_one

If there would be only one item in the ToC, don't make a ToC.

--ignore_sole_first

If the first item in the ToC is of the highest level, AND it is the only one of that level, ignore it. This is useful in web-pages where there is only one H1 header but one doesn't know beforehand whether there will be only one.

--inline

Put ToC in document at a given point. See "Inlining the ToC" for more information.

--make_anchors | --gen_anchors

Create anchors for the table-of-contents to link to.

--make_toc | --gen_toc

Make a Table-of-Contents which links to anchored significant elements.

--man_help | --manpage | --man

Print all documentation and exit.

--notoc_match

--notoc_match string

If there are certain individual tags you don't wish to include in the table of contents, even though they match the "significant elements", then if this pattern matches contents inside the tag (not the body), then that tag will not be included, either in generating anchors nor in generating the ToC. (default: class="notoc")

--ol | --nool

Use an ordered list for Table-of-Contents entries (to a given depth). If --ol is false (i.e. --nool is set) then don't use an ordered list for ToC entries.

(default:false)

(See --ol_num_levels to determine how deep the ordered-list listing goes)

--ol_num_levels

The number of levels deep the OL listing will go if --ol is true. If set to zero, will use an ordered list for all levels. (default:1)

--outfile

--outfile file

File to write the output to. This is where the modified HTML output and the Table-of-Contents goes to. If you give '-' as the filename, then output will go to STDOUT. (default: STDOUT)

--overwrite

Overwrite the input file with the output. If this is in effect, --outfile is ignored. Used in generate_anchors for creating the anchors "in place" and in generate_toc if the --inline option is in effect. (default:off)

--quiet

Suppress informative messages. (default: off)

--textonly

Use only text content in significant elements.

--title

--title string

Title for ToC page (if not using --header or --inline or --toc_only) (default: "Table of Contents")

--toc_after

--toc_after tag=suffix

--toc_after "H2=</em>"

For defining layout of significant elements in the ToC. The tag is the HTML tag which marks the start of the element. The suffix is what is required to be appended to the Table of Contents entry generated for that tag. This is a cumulative hash argument. (default: undefined)

--toc_before

--toc_before tag=prefix

--toc_before "H2=<em>"

For defining the layout of significant elements in the ToC. The tag is the HTML tag which marks the start of the element. The prefix is what is required to be prepended to the Table of Contents entry generated for that tag. This is a cumulative hash argument. (default: undefined)

--toc_end

--toc_end tag=endtag

--toc_end "H1=/H1"

For defining significant elements. The tag is the HTML tag which marks the start of the element. The endtag the HTML tag which marks the end of the element. When matching in the input file, case is ignored (but make sure that all your tag options referring to the same tag are exactly the same!). This is a cumulative hash argument. (default: H1=/H1 H2=/H2)

--toc_entry

--toc_entry tag=level

--toc_entry "TITLE=1" --toc_entry "H1=2"

For defining significant elements. The tag is the HTML tag which marks the start of the element. The level is what level the tag is considered to be. The value of level must be numeric, and non-zero. If the value is negative, consective entries represented by the significant_element will be separated by the value set by --entrysep option. This is a cumulative hash argument. (default: H1=1 H2=2)

--toc_label | --toclabel

--toc_label string

HTML text that labels the ToC. Always used. (default: "<h1>Table of Contents</h1>")

--toc_only | --notoc_only

Output only the Table of Contents, that is, the Table of Contents plus the toc_label. If there is a --header or a --footer, these will also be output.

If --toc_only is false (i.e. --notoc_only is set) then if there is no --header, and --inline is not true, then a suitable HTML page header will be output, and if there is no --footer and --inline is not true, then a HTML page footer will be output. (default:--notoc_only)

--toc_tag

--toc_tag string

If a ToC is to be included inline, this is the pattern which is used to match the tag where the ToC should be put. This can be a start-tag, an end-tag or a comment, but the < should be left out; that is, if you want the ToC to be placed after the BODY tag, then give "BODY". If you want a special comment tag to make where the ToC should go, then include the comment marks, for example: "!--toc--" (default:BODY)

--toc_tag_replace

In conjunction with --toc_tag, this is a flag to say whether the given tag should be replaced, or if the ToC should be put after the tag. This can be useful if your toc_tag is a comment and you don't need it after you have the ToC in place. (default:false)

--use_id

Use id="name" for anchors rather than <a name="name"> anchors. However if an anchor already exists for a Significant Element, this won't make an ID for that particular element.

--useorg

Use pre-existing backup files as the input source; that is, files of the form filename.bak (see --bak).

FILE FORMATS

    # set the ToC to be three-level
    --toc_entry H1=1
    --toc_entry H2=2
    --toc_entry H3=3

    --toc_end H1=/H1
    --toc_end H2=/H2
    --toc_end H3=/H3

DETAILS

    --toc_entry "H1=1" --toc_end "H1=/H1" --toc_entry "H2=2" --toc_end "H2=/H2"

    # default settings
    --toc_entry H1=1
    --toc_end H1=/H1
    --toc_entry H2=2
    --toc_end H2=/H2

    # An options file that adds some formatting
    # make level 1 ToC entries <strong>
    --toc_entry H1=1
    --toc_end H1=/H1
    --toc_before H1=<strong>
    --toc_after H1=</strong>

    # make level 2 ToC entries <em>
    --toc_entry H2=2
    --toc_end H2=/H2
    --toc_before H2=<em>
    --toc_after H2=</em>
   
    # Make level 3 entries as is
    --toc_entry H3=3
    --toc_end H3=/H3

    # An options file that can work for Glossary type documents
    --toc_entry H1=1
    --toc_end H1=/H1
    --toc_entry H2=2
    --toc_end H2=/H2

    # Assumes document has a DD for each DT, otherwise ToC
    # will get entries with alot of text.
    --toc_entry DT=3
    --toc_end DT=DD
    --toc_before DT=<em>
    --toc_after DT=</em>

    # this is the default
    --toc_tag BODY --notoc_tag_replace

    --toc_tag '!--toc--' --toc_tag_replace

EXAMPLES

    hypertoc --inline --make_anchors --overwrite --make_toc index.html

    hypertoc --make_anchors --overwrite index.html fred.html george.html

    hypertoc --make_toc --outfile table.html index.html fred.html george.html

    hypertoc --make_anchors --inline --overwrite --make_toc --toc_tag /H1 \
    --notoc_tag_replace --toc_label "" index.html fred.html george.html

        hypertoc --quiet --make_anchors --bak "" --overwrite \
        --make_toc --inline --toc_label "" --toc_tag '!--toc--' \
        --toc_tag_replace \
        --toc_entry H2=1 --toc_entry H3=2 \
        --toc_end H2=/H2 --toc_end H3=/H3 myfile.html

    hypertoc --quiet --make_anchors --bak "" --overwrite \
    --toc_entry TITLE=1 --toc_end TITLE=/TITLE
    --toc_entry H2=2 --toc_entry H3=3 \
    --toc_end H2=/H2 --toc_end H3=/H3 \
    --make_toc --outfile index.html \
    mary.html fred.html george.html

    # Title, H2 and H3
    --toc_entry TITLE=1
    --toc_end TITLE=/TITLE
    --toc_entry H2=2
    --toc_end H2=/H2
    --toc_entry H3=3
    --toc_end H3=/H3

    hypertoc --quiet --make_anchors --bak "" --overwrite \
    --argfile custom.opt --make_toc --outfile index.html mary.html fred.html george.html

NOTES

• hypertoc is smart enough to detect anchors inside significant elements. If the anchor defines the NAME attribute, hypertoc uses the value. Else, it adds its own NAME attribute to the anchor. If --use_id is true, then it likewise checks for and uses IDs.
• The TITLE element is treated specially if specified as a significant element. It is illegal to insert anchors (A) into TITLE elements. Therefore, hypertoc will actually link to the filename itself instead of the TITLE element of the document.
• hypertoc will ignore a significant element if it does not contain any non-whitespace characters. A warning message is generated if such a condition exists.
• If you have a sequence of significant elements that change in a slightly disordered fashion, such as H1 -> H3 -> H2 or even H2 -> H1, though hypertoc deals with this to create a list which is still good HTML, if you are using an ordered list to that depth, then you will get strange numbering, as an extra list element will have been inserted to nest the elements at the correct level.

  For example (H2 -> H1 with --ol_num_levels=1):

      1. 
          * My H2 Header
      2. My H1 Header
      

  For example (H1 -> H3 -> H2 with --ol_num_levels=0 and H3 also being significant):

      1. My H1 Header
          1. 
              1. My H3 Header
          2. My H2 Header
      2. My Second H1 Header
      

  In cases such as this it may be better not to use the --ol option.

• If one is not using --overwrite when generating anchors, then the command needs to be done in two passes, in order to give the correct filenames (the ones with the actual anchors in them) to the ToC generation part. Otherwise the ToC will have anchors pointing to files that don't have them.
• When using --inline, care needs to be taken if overwriting -- if one sets the ToC to be included after a given tag (such as the default BODY) then if one runs the command repeatedly one could get multiple ToCs in the same file, one after the other.

CAVEATS

• Version 3.10 (and above) generates more verbose (SEO-friendly) anchors than prior versions. Thus anchors generated with earlier versions will not match version 3.10 anchors.
• Version 3.00 (and above) of hypertoc behaves somewhat differently than Version 2.x of hypertoc. It is now designed to do everything in one pass, and has dropped certain options: the --infile option is no longer used (all filenames are put at the end of the command); the --toc_file option no longer exists; use the --outfile option instead; the --tocmap option is no longer supported.

  It now generates lower-case tags rather than upper-case ones.

• hypertoc is not very efficient (memory and speed), and can be slow for large documents.
• Now that generation of anchors and of the ToC are done in one pass, even more memory is used than was the case before. This is more notable when processing multiple files, since all files are read into memory before processing them.
• Invalid markup will be generated if a significant element is contained inside of an anchor. For example:

      <a name="foo"><h1>The FOO command</h1></a>
      

  will be converted to (if h1 is a significant element),

      <a name="foo"><h1><a name="The">The</a> FOO command</h1></a>
      

  which is illegal since anchors cannot be nested.

  It is better style to put anchor statements within the element to be anchored. For example, the following is preferred:

      <h1><a name="foo">The FOO command</a></h1>
      

  hypertoc will detect the "foo" NAME and use it.

  Even better is to use IDs:

      <h1 id="foo">The FOO command</h1>
      

• NAME attributes without quotes are not recognized.

BUGS

REQUIRES

    Getopt::Long
    Getopt::ArgvFile
    File::Basename
    Pod::Usage
    HTML::LinkList
    HTML::Entities
    HTML::GenToc

SCRIPT CATEGORIES

ENVIRONMENT

HOME

hypertoc looks in the HOME directory for config files.

FILES

"~/.hypertocrc"

User configuration file.

".hypertocrc"

Configuration file in the current working directory; overrides options in "~/.hypertocrc" and is overridden by command-line options.

SEE ALSO

AUTHOR

Based on htmltoc by Earl Hood ehood AT medusa.acs.uci.edu

Contributions from Dan Dascalescu, <http://dandascalescu.com>

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.