Banyan Books Online Readme

Banyan Books in HTML Format

Banyan is offering all user documentation in HTML format. This provides the following advantages:

Standards-based documentation format used throughout the industry
Closer ties with our web site based documentation
Customer has a choice of what viewer and search tool to use
Documentation set is in smaller components, allowing selective updating

Documentation Architecture and Navigation

In the previous releases of Banyan documentation, referred to as Banyan IQ, the documentation was delivered as a single file, usually with many manuals, or books, within it. In this HTML version, each book is a directory, and each chapter is a file. Figure 1 shows all the manual directories. The file BookDirs.htm in the Readme directory contains a list of the mnemonics for the book directories and the corresponding book titles with a link from the title to the book.

Figure 1. Banyan Books Online Directories

The following aids make navigating through the manuals easier:

Banyan documentation home page
Book tables of contents
Navigation buttons
Links

In addition, this Readme describes several search methods.

Banyan Documentation Home Page

At the root of the CD, you will find the file Banyan.htm, which contains links to each manual, as shown in Figure 2. If your CD-ROM drive is set to autoplay, when you insert the Banyan Books Online CD, the Banyan.htm file automatically opens.

To determine if your Windows 95/98 CD-ROM drive is set to autoplay, click Start, Settings, Control Panel, double-click on System, click the Device Manager tab, click the plus sign next to the CD-ROM drive, select the drive, click Properties, and click the Settings tab. If there is a checkmark in the Auto insert notification checkbox, your system is set to autoplay. On Windows NT 4.0, AutoRun is set in the registry by default.

 

Figure 2. Banyan Books Online Home Page

Book Tables of Contents

You can view each book chapter with the Table of Contents for the entire book displayed in the left pane, as shown in the Figure 3.

Figure 3. Main Page for a Book

You do this by opening the book from the Banyan documentation home page (Banyan.htm) or by opening the HTML file in the book directory that has Main in the file name, for example, in the Banyan Server Operations Guide (BanSvrOpGD), open SvrOpGdMain.htm.

Nothing prevents you from opening any HTM file in a book directory but navigation will be easier if you open the Main.htm file or, preferably, open the book from the Banyan.htm file.

If you wish to change the width of the Contents frame, place the cursor on the bar separating the Contents frame from the text frame and, when the cursor changes to a double-ended arrow, move the bar in the appropriate direction.

Navigation Buttons

Figure 4 shows the buttons that are available at the top and bottom of each file to assist in navigating between chapters. The Page button takes you to the previous or next chapter and the Top button takes you to the top of the current chapter (Page).

Figure 4. Navigation Buttons

Links

Within the books there are links to references within the particular book and to references in other books. Links are underlined and in a different color than the surrounding text. Simply click on the link to go to the reference, and click Back on the Browser toolbar to return to the referring link.

What Browser to Use?

Any viewer/browser designed to view HTML files works with the documentation. The two most popular browsers are Microsoft® Internet Explorer and Netscape® Communicator.

When you open the files in the browser, you can set certain characteristics to make the text easier for you to read. For example, you can set the font size in the View menu of the browser. Or you can configure your browser's display.

How to Modify the Files

Although web browsers allow you to view and navigate through HTML files, they do not support editing. You can use any text editor to modify the source code, or use a WYSIWYG HTML editor, like Home Site, Adobe PageMill, or Microsoft FrontPage to modify the files. Before you do this, however, you should be familiar with HTML format and the editor you wish to use.

How to Perform Searches

The web browsers all have a search capability built into them. Unfortunately, they can search only in the file that is currently displayed. When you need to search across all the chapters in a book, or even all the books in a documentation set, you need a more powerful tool.

This Readme discusses three tools:

Windows Explorer
AltaVista Discovery
Windows NT Index Server

You may find other suitable search engines for your purposes.

Searching with Windows Explorer

Windows Explorer has a powerful Find utility that supports searching for a specified string in all the files in a directory tree. Figure 5 illustrates how to start the utility.

Figure 5. Windows Explorer Find Utility

You then see the Find dialog box (Figure 6).

Figure 6. Windows Explorer Find Utility Dialog Box

You should specify *.htm for the file name, and the location of the Banyan documentation in the Look in: pane. You also specify the string you are searching for in the Containing text pane. To start the search, click Find Now.

When the search is complete, Find displays a list of files as shown in Figure 7. You can double-click on a file name to open it in your default browser.

Figure 7. Windows Explorer Find Utility Results

Once you are in the file, you will have to repeat the search with the browser utility.

Searching with AltaVista Discovery

AltaVista™ Discovery (AVD) is an indexed search utility from Compaq® that supports very fast searches across multiple file types and multiple locations.

Downloading the Software

Go to http://discovery.altavista.digital.com/ to download the software.

Configuration for Banyan Documentation

Start AltaVista, open the pop-up menu from the AltaVista icon as shown in Figure 8, and select Options from the list.

Figure 8. AltaVista Pop-up Menu

The Configure tab of the AltaVista Discovery Options dialog box appears. You should set the values for the Configure tab as shown in the Figure 9.

Figure 9. AltaVista Discovery Options Window

Click on the Documents and Mail tab (Figure 10), and select all the drives and folders that you want to have indexed. When you select a directory, all subdirectories are also selected.

Figure 10. AltaVista Discovery Documents and Mail Configuration Tab

If you want to limit your searches to HTML files, click on "File Types," then select "Internet Document (HTML) " as shown in the Figure 11, or select "Netscape Hypertext Documents" depending on your default browser.

Figure 11. AltaVista Discovery Documents and Mail Configuration Tab File Types Window

You can schedule the indexing of the files (Figure 12). If you are going to use AltaVista Discovery to search across Banyan Documentation files only, you need index only when the files are updated.

Figure 12. AltaVista Discovery Options Index Schedule Tab

You can schedule the index update to occur at Discovery Startup, which will prompt you for permission to start the process. If there are no new files, you can cancel out of the update.

You can also start the Index manually. To do so, right-click the AltaVista Discovery icon in the Windows task bar and select Index Management. Click the Advanced button and then click Update. In this case, you may want to set Update the Index in the Schedule tab to Never and manually start the index whenever files change.

Note: You cannot use AltaVista Discovery to perform searches until it has indexed the target files. After you have configured the software, start the indexing. It may be easiest to configure AVD to index at start time, then restart AVD, or manually start the indexing.

Searching with AltaVista Discovery

Specify a string in the "Search:" "for" panes (Figure 13) and click Search.

Figure 13. AltaVista Discovery Tool Bar

The browser window displays the results of the search (Figure 14). Each file name is an active link, so you can double-click the link to go to that file.

Figure 14. AltaVista Discovery Search Results

One particularly helpful feature of AVD is that it highlights each hit in the target file (Figure 15). This allows you to scroll through the file and see where hits have occurred. You can still perform another search from within the browser.

Figure 15. AltaVista Discovery Highlighting

To make your searches more focused, use quotes around the search phrase. For example, if you search for time synchronization, you will find every document that has time and synchronization in it. But if you search for "time synchronization" in quotes, you will find only those instances where the words are adjacent in a document, that is, an exact match. Boolean searches are also available; see the AltaVista help in the pop-up menu.

Searching with Windows NT Index Server

If you copy the documentation from the Banyan Books Online CD to a web server running Windows NT Internet Information Server (IIS) and associate the copy with a virtual directory using Internet Service Manager, you can then use Microsoft Index Server to index all of the Books Online documentation. After you index the documentation, you use Active Server Pages (ASP) to query the index and display the results of the query. You click on a result and go to the page containing the query result. You can then search the page using your browser's Find command to get to the specific location of the query.

Index Server has sample ASPs that you can use as templates to design your results page.

Figure 16 shows an example search with this method. You then click on a URL to see the search result.

Figure 16. Searching with Windows NT Index Server


Return to Books Online Home Page

Top Of Page