Preparing Cogent documentation is easy and fun if you have a good SGML editor and are comfortable using the DocBook DTD. Here are the basic steps:
These steps are explained in more detail in the following chapters of this guide. For best results, we strongly recommend reading this material carefully before editing or generating documents, and refer to it as necessary while doing so.
One way to understand the Cogent documentation system is by looking at the directories and files that make it up. The main directory is the doc/ directory, which contains the following subdirectories and files:
|i/||SGML source code.|
|o/||Output files and makefiles.|
|export/||Preparation area for distribution.|
|config/||Stylesheet customization files, etc.|
|docbook.ced||The Emacs PSGML mode DocBook DTD cache file.|
|sgml.mak||The fundamental, book-level, output-specific makefile.|
|Makefile||A top-level makefile, for system-wide makes.|
Here is a way to visualize how these files and directories are used to create the documentation:
Copyright © 1995-2004 by Cogent Real-Time Systems, Inc. All rights reserved.