Building a Map File

PreviousUpNext
Up: Contents Next: Map Files for man Pages Previous: doctext

One of the most useful features of tohtml is its ability to automatically replace citations and names with hot links into other documents. This is done by providing one or more -mapref files (for citations) and -mapman files (for names, currently defined as strings consisting only of letters). Currently, the format of this file is fairly ugly but easy to use:

cite:+ cite-name++ cite-text++++ kind+ URL
where the items are as follows.
cite-name
A citation key that is used in a LaTeX \cite command, such as \cite{tohtml-user-ref}.

cite-text
The name that should replace the citation use. For example, if the document contains a \cite{tohtml-user-ref}, and you wish this to turn into a hot link with text [Tohtml User Manual], you would use Tohtml User Manual for cite-text.

kind
The field is used to indicate the type of the reference. This is not yet implemented. Use the value manual for user manuals and cite for everything else for the time being.

URL
The URL (Universal or Uniform Resource Locator) that the item will link to. These are paths such as http://www.mcs.anl.gov/home/gropp/tohtml/tohtml.html.


All of these items must be on a single line; the exact number of + characters must be used.

You can comment out a line in a mapref or mapman file by placing a ``;'' in the first column.

Here is a sample map file for citations. Note that {}\citegropp will turn into gropp@mcs.anl.gov in the text, with a link to the Web home page for gropp.


 
cite:+sles-user-ref++SLES User Manual++++manual+http://www.mcs.anl.gov/petsc/solvers.html 
cite:+gropp++gropp@mcs.anl.gov++++person+http://www.mcs.anl.gov/home/gropp/index.html 
cite:+petsc-man-pages++PETSc Manual Pages++++manual+http://www.mcs.anl.gov/petsc/ref/index.html 


PreviousUpNext
Up: Contents Next: Map Files for man Pages Previous: doctext