📄 htmlbook.html
字号:
<html><head><!-- /vobs/wpwr/docs/tornado/hutils/htmlBook.html - generated by refgen from ../../resource/doctools/htmlBook.tcl --> <title> htmlBook </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>Tornado Reference : Tornado Utilities</i></a></p></blockquote><h1>htmlBook</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>htmlBook</strong> - html Book Index generator</p></blockquote><h4>SYNOPSIS</h4><blockquote><p>htmlBook [-h] [-nonav] [-noupdate] [-skip <i>dirName</i>] [<i>dirList</i>]<p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This tool generates the hierarchy of HTML indexes for the HTML manualswithin a directory tree. The top-level index is called <b>books.html</b>.<p><b><a href="./htmlBook.html#top">htmlBook</a></b> reads all linkage files generated by <b><a href="./refgen.html#top">refgen</a></b>, by<b><a href="./htmlLink.html#top">htmlLink</a></b>, or inserted manually, extracts all the book and chapter/sectionnames, then creates the proper indexes.<p>Each book has a single entry in the top-level index, which points to abook-level index. If the book was not created by refgen, then it is possibleto have this link point directly to the book's table of contents. If thebook was created by refgen, then there will be a book index, which will havechapter/section entries pointing to chapter/section indexes. Thesechapter/section indexes then point to the specific entries in the referencemanual.<p><p></blockquote><h4>OPTIONS</h4><blockquote><p><dl><dt><b>-h</b><dd>Display a simple description of htmlBook.<p><dt><b>-nonav</b><dd>Do not create the alphabetic navigation bar at the top of thechapter/section index.<p><dt><b>-noupdate</b><dd>Do not generate new LIB.SUB and RTN.SUB files, just uses any existing ones.<p><dt><b>-skip <i>dirName</i></b><dd>Do not process the subdirectory <i>dirName</i>. Create no links to or from it.If several directories are to be skipped, then the<b>-skip</b> option must be repeated for each of the directories to be skiped. </dl><p></blockquote><h4>NON-REFERENCE DOCUMENTS</h4><blockquote><p>In order to generate index links to HTML documents not generated by refgen,a LIB (linkage) file must be associated with the new document (in the samedirectory as the html index for the document). This file allows<b><a href="./htmlBook.html#top">htmlBook</a></b> to generate the appropriate index entries.<p>This LIB file should contain a single linkage entry. A linkage entryconsists of a Tcl list with eight elements ( enclosed in curly braces)defined as follows:<p><dl><dt>Entry<dd>This field normally represents the name of library. If you are creatinga LIB file for an externally generated HTML document,this entry should be the name of the document.This field would normally appear in the chapter/section index, and if the<i>Category</i> field (see below) were not empty, thecategory name (between square brackets) would be appended to the entry name.For an externally generated HTML document, however, the <i>Chapter Name</i>field (see below) should be empty, and then thisname will only be used internally. The <i>Link</i> field (see below) willthen be used for the top-level book index.<p><dt>Short Description<dd>This is a short description of the entry that will appear in thechapter/section index, if present.<p><dt>Pattern<dd>This field is used only by <b><a href="./htmlLink.html#top">htmlLink</a></b> to specify what patternshould be replaced with the text in the <i>Link</i> field (next field)in all HTML files.<p><dt>Link<dd>This specifies the HTML text to be inserted, after the path is corrected,as the link for the entry.For an external document, this is usually a link to the table of contentsof the book. The path in this link should be relative to the LIB file, andshould begin with a ./ so that it canbe corrected for the actual location of the indexes.<p><dt>Book Name<dd>For a reference entry, this field specifies the book the library entry belongs to (for example, Tornado Reference or BSP Reference).This field would appear in the top-level index. For an external document,this field is only used internally.<p><dt>Chapter/Section Name<dd>This field specifies the chapter or section that the entry belongs in.In combination with the<i>Book Name</i> field, this allows two levels of indexes (for example, VxWorks Reference Manual->ANSI Libraries).If there is no chaptername, the <i>Link</i> field will be used (after the path is corrected)in the top-level index.<p><dt>Category<dd>This field makes it possible to distinguish help entries that have thesame name, butbelong to different libraries (for example, wtxToolAttach for C,Java or Tcl APIs).<p><dt>File<dd>This is used by <b><a href="./htmlLink.html#top">htmlLink</a></b> to generate the RTN.SUB and LIB.SUB files.The relative path of the LIB file containing this entry is stored inthis field.If this field is empty, the LIB file is in the local directory. </dl><p></blockquote><h4>EXAMPLE</h4><blockquote><p>If the LIB file contains the following line (all on one line) :<pre>{HTMLWorks} {HTMLWorks user's guide} {<b>HTMLWorks</b>} {<b><a href="./guide.html">HTMLWorks</a></b>} {Tornado Optional Products}{HTMLWorks} {} {}</pre>Then the top-level HTML index (<b>book.html</b>) will contain a link named<i>Tornado Optional Products</i> to a book HTML index, and this book indexwill contain a link to a section named <i>HTMLWorks</i>. If other LIB fileshave entries with <i>Tornado Optional Products</i> as their book name, thecorresponding section names will be listed along with <i>HTMLWorks</i>.<p>The <i>HTMLWorks</i> section index will then have links for all the LIB fileentries that give <i>Tornado Optional Products</i> as their book name, and<i>HTMLWorks</i> as their section name.<p>To make a direct link from the top-level index and the table of contents ofan externally generated HTML document, just provide a LIB file withan ampty <i>chapter name</i> field. The following examplewill create a <i>Tornado user's guide</i> entry in the top-level(<b>book.html</b>) index,and the link will go directly to <i>path</i><b>/tug/TUG.html</b>, where :<p><dl><dt><i>path</i><dd>is the directory the LIB file is in,<p><dt><b>tug</b><dd>comes from the <i>Path</i> field, and<p><dt><b>TUG.html</b><dd>is extracted from the <i>Link</i> field </dl><p><pre>{Tornado user's guide} {The Tornado user's guide}{<b>Tornado User's Guide</b>}{<b><a href="./TUG.html">Tornado User's Guide</a></b>}{Tornado user's guide} {} {} {tug}</pre>Note that the above entry must be on a single line.<p></blockquote><h4>FILES</h4><blockquote><p><dl><dt><b>updateDocTime</b><dd>This is an empty file that fixes the last doc update time. Such a file isgenerated in each directory in <i>dirList</i>.<p><dt><b>books.html</b><dd>The top-level HTML index, containing all books that <b><a href="./htmlBook.html#top">htmlBook</a></b> found.All other index file names are drived from the book or chapter/sectionnames by replacing any non-alphanumeric characters with an underscore. </dl><p></blockquote><h4>RETURNS </h4><blockquote><p>N/A<p></blockquote><h4>ERRORS</h4><blockquote><p>N/A<p></blockquote><h4>FILES</h4><blockquote><p><b>WIND_BASE</b>/docs/book.html<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./htmlBook.html#top">htmlBook</a></b>, <b><a href="./refgen.html#top">refgen</a></b>, <b><a href="../../tornado-api/guitcl-unix/windHelpLib.html#top" >windHelpLib</a></b>, <b><a href="./htmlLink.html#top">htmlLink</a></b><p><p></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -