| Preparing Cogent Documentation : | ||
|---|---|---|
 | Chapter 3. Creating Output from doc/o/ |  |
| Preparing Cogent Documentation : | ||
|---|---|---|
| | Chapter 3. Creating Output from doc/o/ | |
Table of Contents
The beauty of single-sourcing with SGML is that we can create different kinds of output from one source. The challenge is to organize the input and output files to meet our needs. We have done this by creating a separate directory for all output files, the doc/o/ directory, and then having one subdirectory for each book we produce. At present, we create one big book set (called Cogent Documentation) in HTML and QNX Helpviewer formats, and individual books in PDF format.
Here is how the doc/o/ subdirectories are organized.
![[Note]](images/note.gif) | The "Set" distribution format means that book is included in the HTML online Cogent Documentation book set. "Q4" means the book is included in the QNX 4 Helpviewer version of the Cogent Documentation book set, and "Q6" means the same for QNX 6. "W" stands for Windows HTML Help format. |
| File name | Book name | Distribution formats |
|---|---|---|
| api-book/ | Cogent API | Set, PDF, Q4, Q6 |
| cc-book/ | Cascade Connect | Set, PDF, Q4, Q6, W |
| cs-book/ | Cascade Connect Client/Serve Protocol | none |
| cogent-set/ | Cogent Documentation | HMTL, Q4, Q6 |
| dh-book/ | Cascade DataHub | Set, PDF, Q4, Q6 |
| drcf-book/ | Cogent Driver for Hilscher Fieldbus CIF Cards | Set, PDF, Q4, Q6 |
| drdn-book/ | Cogent Driver for SST 5136-DNP (DeviceNet) Cards | Set, PDF, Q4, Q6 |
| drgn-book/ | Cogent Driver (generic content) | none |
| drsd-book/ | Cogent Driver for SST 5136-SD (Data Highway Plus) Cards | Set, PDF, Q4 |
| drmb-book/ | Cogent Driver for Modicon SA85 and PC85 (Modbus Plus) Cards | Set, PDF, Q4 |
| gamma-book/ | Gamma (complete) | Set, Q4, Q6 |
| gamguide-book/ | Gamma Programmers Manual | |
| gamref1-book/ | Gamma Reference Vol. 1 | |
| gamref2-book/ | Gamma Reference Vol. 2 | |
| gl-book/ | Glossary and FAQ | Set, PDF, Q4, Q6 |
| gtkgamma-book/ | Gamma/GTK | Set, Q6 |
| sqlgamma-book/ | Gamma/MySQL | Set, PDF, Q4, Q6 |
| hi-book/ | Cascade Historian | Set, PDF, Q4, Q6 |
| p1-art/ | Cadbury Chocolate Project Review | |
| p2-art/ | Connecting QNX and MS-Windows | |
| p3-art/ | Hot Standby for InTouch | |
| p4-art/ | Gamma Discussion - Interpreted Languages | |
| p5-art/ | Synchronous & Asynchronous Messages | |
| p6-art/ | Shared Memory vs. Real-Time Database | |
| p7-art/ | Cascade DataHub and Cascade Connect Benchmarks | |
| phgamma-book/ | Gamma/Photon (complete) | Set, Q4, Q6 |
| phgamguide-book/ | Gamma/Photon Programmers Manual | |
| phgamref1-book/ | Gamma/Photon Reference Vol. 1 | |
| phgamref2-book/ | Gamma/Photon Reference Vol. 2 | |
| prepdoc-book/ | Preparing Cogent Documentation (This book) | HTML |
| sr-book/ | SRR Module | Set, PDF |
| testfile/ | (A set of test books) | none |
| testfile2/ | (A test book) | none |
| testfile3/ | (A book that illustrates SGML elements and tags) | none |
| tl-book/ | Cascade TextLogger | Set, PDF, Q4, Q6 |
| tu-book/ | Linux and QNX Tools Demo and Tutorials | Set, PDF, Q4, Q6 |
| wp-book/ | Cogent White Papers (all above articles) | Set, Q4, Q6 |
| |  | |
| 2.10. Publication Dates |  | 3.2. A typical output subdirectory |
Copyright © 1995-2004 by Cogent Real-Time Systems, Inc. All rights reserved.