HOWTO-HOWTO

Mark Komarinski

List the tools, procedures, and hints to get HOWTO authors up to speed and writing.


Table of Contents
Introduction
History
New versions
Comments
Version History
Copyrights and Trademarks
Acknowledgements and Thanks
Background on the LDP and SGML
The LDP
SGML
Why SGML instead of HTML or other formats?
The tools
Getting Started with DocBook
For New Authors
Mailing Lists
Downloading and installing the tools
Writing SGML by hand
Writing SGML using LyX
Writing SGML using PSGML
Getting Started with LinuxDoc
For New Authors
Mailing Lists
Downloading and installing the tools
Writing SGML by hand
CVS
Getting a CVS account
Other CVS repository notes
Updating files and CVS
Distributing your documentation
Before you distribute
Copyright and Licensing issues
Submission to LDP
Style guides
FAQs about the LDP
I want to help the LDP. How can I do this?
I want to publish a collection of LDP documents in a book. How is the LDP content licensed?
I found an error in an LDP document. Can I fix it?

Introduction

History

This document was started on Aug 26, 1999 by Mark F. Komarinski after two day's worth of frustration getting tools to work. If even one LDP author is helped by this, then I did my job.

New versions

The newest version of this can be found on my homepage http://www.cgipc.com/˜markk/in its SGML source. Other versions may be found in different formats at the LDP homepage http://www.linuxdoc.org/.

Comments

Comments on this HOWTO may be directed to the author (markk@linuxdoc.org).

Version History

v1.8 (May 17, 2000)

  • Corrected errors in LinuxDoc section that didn't render properly.

  • Added content about Cygnus tools - thanks to Dan Scott

  • Added OpenJade information and link

  • More DocBook rendering information - thanks to Greg Ferguson

Copyrights and Trademarks

(c) 1999-2000 Mark F. Komarinski

This manual may be reproduced in whole or in part, without fee, subject to the following restrictions:

  • The copyright notice above and this permission notice must be preserved complete on all complete or partial copies

  • Any translation or derived work must be approved by the author in writing before distribution.

  • If you distribute this work in part, instructions for obtaining the complete version of this manual must be included, and a means for obtaining a complete version provided.

  • Small portions may be reproduced as illustrations for reviews or quotes in other works without this permission notice if proper citation is given. Exceptions to these rules may be granted for academic purposes: Write to the author and ask. These restrictions are here to protect us as authors, not to restrict you as learners and educators. Any source code (aside from the SGML this document was written in) in this document is placed under the GNU General Public License, available via anonymous FTP from the GNU archive.

Acknowledgements and Thanks

Thanks to everyone that gave comments as I was writing this. This includes Deb Richardson and Daniel Barlow and other members of the ldp-discuss list. Some sections I got from the HOWTO Index (available at many LDP locations) and the sgmltools documentation. There are pointers to sgmltools and the LDP elsewhere in this document. The sections on network access to CVS was partially written by Serek (ser@serek.arch.pwr.wroc.pl). Sections on DocBook were written by Jorge Godoy (godoy@conectiva.com.br). A great deal of thanks to both of them for their help.