|
|
|
|
|
The TechPubTools described in this document create an online HTML system with appropriate links to the associated PDF files. The features of the online HTML system include:
HTML suitable for a website or CD-ROM.
A modular design with multiple mini-HTML systems coming from various sources.
(Mif2Go/WWP) FrameMaker books each can be in their own directory with their own mini-HTML system.
(Doxygen/JavaDoc) Code reference components each can be in their own directory with their own mini-HTML system.
Flexible bi-pane design that can be easily customized; the two panes are the navigation frame and the data frame.
The navigation frame controls the information that is displayed in the data frame. The navigation frame supports:
a comprehensive table of contents with collapsing/expanding levels using an award-winning Java applet. Input to the applet are multiple, generated-from-these-tools script files that are nested and very flexible. The Java applet is available at www.better-homepage.com/java/java-applets-toc.html.
a comprehensive index covering all HTML files in the system as well as word-chunking.
(DevaSearch) a comprehensive full-text search. This is available at www.devahelp.com.
navigation in the index implemented using multiple, generated HTML files and no Javascript.
The data frame displays the individual HTML topic. The two supported types of HTML topics are descriptive topics (books) and reference topics (code). Each HTML topic has:
a common navigation bar at the top.
a second navigation bar that changes depending on whether it is a descriptive topic or a code reference topic.
links to the table of contents, index, and its associated PDF file.
The individual HTML topics as well as the index each have their own template documents. As such, changes to the look-and-feel or navigation can be made in one place and propagated quickly throughout the whole system.
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02