Understanding a document root
The content files for a top-level help topic reside in a corresponding document root. For example, the using-ip document root contains iPusing-intro.2.1.html, iPusing-intro.2.2.html, and so on. These files are the content files for the help. Each document root also contains an index.html file. Opening this file displays the topic and content files for the book.
Within each document root is a wwhdata\common directory that contains the JavaScript files that organize help content and that link the help files to the application.
Table 10‑3 lists and describes the customizable <document root>\wwhdata\common contents.
Table 10‑3 Help content management files
File | Purpose |
files.js | Lists the content files to be used and in what order |
title.js | Specifies the title for the browser window and the top-level table of contents text |
topics.js | Designates the targets for context-sensitive help keys the Information Console emits |
Within each document root, a wwhdata\js directory contains JavaScript files that organize the navigation frame. This frame includes the table of contents (TOC), index, and search frames.
Table 10‑4 lists and describes the customizable <document root>\wwhdata\js contents.
Table 10‑4 Help navigation files
File | Purpose |
index.js | Organizes the index links and hierarchy |
search.js | Designates specific search values and priority |
toc.js | Specifies the table of contents frame hierarchy, linking behavior, and text |