Laserfiche WebLink
The on-line documentation within each ?box,? will be written by the appropriate task leaders and <br />developers (the figure was developed using minutes from System Integration Team meetings). The <br />CRDSS home page will make the proper cross-references to other home pages to provide the <br />framework for documentation. The cross-references within specific products will be up to the <br />discretion of the author for that documentation, based on extent of existing material and the <br />complexity of the documentation. <br />A general glossary will be available. Glossary terms for individual documentation ?boxes? can be <br />put in the global directory but may also reside in product-specific glossaries. The format for all <br />glossaries should be kept the same so that the glossaries can be combined with a simple utility <br />program. A ?hot key? graphic will be developed so that the glossary can be accessed by pressing an <br />icon. Such hot keys may also be appropriate for allowing the user to return to the home page for a <br />software product. <br />On-line documentation will not be limited to the areas shown in Figure 1. The consultant anticipates <br />that information related to data manipulation may warrant sections within the on-line documentation. <br />For example, the procedures used to calculate virgin flows can be made available in on-line form so <br />that all parties understand the procedure. <br />Implementation of UNIX Man Pages <br />UNIX man pages are implemented differently on different UNIX platforms. The differences apply <br />mainly to the high-level directory structure used to organize files, but the low-level directory <br />structure and file syntax are the same on most systems. Both the general implementation and SGI <br />implementation are discussed in this section. <br />Man pages can typically exist in two forms: <br />Source form nroff <br />1. . The source form for a man page consists of an ASCII file that contains <br />nroff <br />syntax. is a text-formatting language that has traditionally been supported on UNIX <br />nroff nroff <br />machines. A file containing syntax must be processed by the program (or other <br />groff <br />available programs such as the Free Software Foundation's ) in order to be useful for <br />viewing. The source form of a man pages is somewhat free-format in that whitespace <br />within the text is not interpreted literally. <br />Compiled form <br />2. . The processed, or ?compiled,? form of a man page has been formatted so <br />nroff <br />that syntax within the file is expanded appropriately. For example, the ?.IP? <br />command indicates that an indented paragraph should start. Extra whitespace in the source <br />file is compressed to produce visually-pleasing paragraphs. The format of the compiled <br />man page depends on the options given to the program used to compile the source file. <br />Two common formats are the ?cat? format (hereafter referred to as the compiled format) <br />and PostScript. PostScript can be printed to a PostScript printer but is generally not useful <br />cat <br />for screen viewing. Compiled man pages are usually viewable by using the UNIX or <br />more man <br /> commands. Compiled man pages are also displayed by the command. <br />Man pages are stored on UNIX systems in different ways, but a system typically allows both source <br />man <br />and compiled versions of the man pages to exist. The UNIX command is used to display man <br />6 <br />A275 06.29.94 1.05-12 Malers <br />