v1.4 12 Jun, 2000
| Revision History | ||
|---|---|---|
| Revision 1.4 | Jun 12, 2000 | Revised by: mfk |
| Documented vim and sgedit. Spelling and other changes from ldp list. Also added LDP guidelines under style guide. | ||
List the tools, procedures, and hints to get HOWTO authors up to speed and writing.
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.
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.
There are many ways to contribute to the Linux movement without actually writing code. One of the most important is writing documentation, allowing each person to share their knowledge with thousands of others around the world. This HOWTO is designed to help you get familiar with how the LDP works, and what tools you'll need to write your own HOWTO.
The following is an excerpt from the LDP Manifesto (http://www.linuxdoc.org/manifesto.html)
The Linux Documentation Project (LDP) is working on developing free, high-quality documentation for the GNU/Linux operating system.The overall goal of the LDP is to collaborate in all of the issues of Linux documentation. This includes the creation of "HOWTOs" and "Guides". We hope to establish a system of documentation for Linux that will be easy to use and search. This includes the integration of the manual pages, info docs, HOWTOs,and other documents.
You can find out more about the Linux Documentation Project at http://www.linuxdoc.org
Comments on this HOWTO may be directed to the author (<markk@linuxdoc.org>).
(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.
Thanks to everyone that gave comments as I was writing this. This includes David Lawyer, Deb Richardson, Daniel Barlow, Greg Ferguson, Mark Craig and other members of the <ldp-discuss@lists.linuxdoc.org> list. Some sections I got from the HOWTO Index (available at many LDP locations) and the sgmltools documentation. 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.
Commands that are listed have the following format. Commands are prefaced with the name of the current shell running. This is followed by a $ for commands that should be run as a normal (non-root) user. Shells followed by a # are commands that should be run as a root user.
| Next | ||
| Introduction to the LDP and SGML |