Preparing Cogent Documentation :
	Chapter 4. Making the Distribution from doc/export/

Chapter 4. Making the Distribution from `doc/export/`

Table of Contents

4.1. Step by step
4.2. In one step, and copied to the server

Once an article, book or bookset has been produced, it still needs to be processed for distribution. We have set up a makefile in doc/export/ that searches through all the directories in doc/o/, takes any newly generated output, tars and zips it into a single file for distribution, and copies that file into the doc/distribution/ directory, giving it a Cogent-distribution filename.

In addition to this, we have a script (docs2andrewgate) that runs through these steps and copies the resulting distribution files to the Cogent web server. This is designed to be run immediately after doing make most in the doc/o/ directory (explained previously in Generating all distributed books).

4.1. Step by step

Here is the procedure for making distribution files.

Change directories to the doc/export/ directory:
```
[sh]$ cd doc/export/
```

To process for everything-- HTML, QNX Helpviewer,PDF, and Gamma/Photon examples output, do:

[doc/export]$ make all

   (makefile output is displayed)

For specific output, do any of the following:

[doc/export]$ make html
[doc/export]$ make help
[doc/export]$ make pdf
[doc/export]$ make examples

Once you have completed any or all of the above make commands, to add any newly created documentation or examples to the doc/distribution/ directory, do:
```
[doc/export]$ make version

   (makefile output is displayed)
```

If you do an ls on the doc/distribution/ directory, you should see something like this:

CogentAPI-4.1-030710-PDF.zip        GammaPhoton-4.0-030614-Examples.tgz
CogentDocs-1.0-030710-HTML.tgz      GammaPhoton-4.0-030710-PDF.zip
CogentDocs-1.0-030710-QNX4Help.tgz  Glossary-4.0-030710-PDF.zip
CogentDocs-1.0-030710-QNX6Help.tgz  Historian-4.1-030710-PDF.zip
Connect-4.1-030710-PDF.zip          Makefile
CVS/                                PaperBenchMarks-1.0-030710-PDF.zip
DataHub-4.0-030710-PDF.zip          PaperCadburyProject-2.0-030710-PDF.zip
DR_5136DNP-1.0-030710-PDF.zip       PaperConnectQNXWindows-2.0-030710-PDF.zip
DR_5136PFB-1.0-030710-PDF.zip       PaperGammaDiscussion-2.0-030710-PDF.zip
...

The format for the files is:

product_name-versionnumber-date-format.zipformat

The versionnumber is either the software version number or the bookset release date. PDF files' zipformat is zip for accessibility in Windows, while the HTML and QNX Helpviewer files' zipformat is tgz.


3.7. Generating all distributed books		4.2. In one step, and copied to the server

Chapter 4. Making the Distribution from doc/export/

4.1. Step by step

Chapter 4. Making the Distribution from `doc/export/`