Creating a documentation release

Any release of LCDproc is accompanied the the user guide and developer guide. Here is how to create these documentation packages.

Procedure 7.2. Steps to create the documentation package

  1. Get the release tarball and extract it (or change to the CVS directory exported in the section called “Creating a source code release” and change to docs/lcdproc-user.

  2. Create the documentation package by running: xmlto -o lcdproc-0-5-A-user-html xhtml lcdproc-user.docbook

  3. Create a tarfile of the documentation package: tar -czf lcdproc-0-5-A-user-html.tar.gz lcdproc-0-5-A-user-html

  4. Repeat the above steps for the developers guide, replacing -user with -dev where appropriate.

  5. Upload the files to the Sourceforge file release system.

The online documenation consists of the user and developer guide, each converted to a single file for viewing online.

Procedure 7.3. Steps to create the online documentation

  1. Get the release tarball and extract it (or change to the CVS directory exported exported in the section called “Creating a source code release” and change to docs/lcdproc-user.

  2. Create the documentation file by running: xmlto xhtml-nochunks lcdproc-user.docbook

  3. Rename the file: mv lcdproc-user.html lcdproc-0-5-A-user.html

  4. Repeat the above steps for the developers guide, replacing -user with -dev where appropriate.

  5. Upload the files to our Sourceforge web site (not the file release system!) and change htdocs/docs/index.html to point to the new files.