Библиотека сайта rus-linux.net
LDP Author Guide
Jorge Godoy
Emma Jane Hogbin
Mark F. Komarinski
David C. Merrill
david -AT- lupercalia.net
2005-03-04
| Revision History | ||
|---|---|---|
| Revision 4.8 4.7 4.6 4.5 4.4 4.3 4.2 4.1 | 2006-04-20 2005-03-04 2005-01-23 2004-07-14 2004-04-19 2004-04-04 2004-04-02 2004-01-27 | Revised by: MG ejh ejh ejh ejh ejh ejh ejh |
| Added notes about prefered submission formats, corrected links, packaged templates.Typo fixed in sample DocBook markup. Added new web-based authoring tool and information on LaTeX to DocBook conversions.Typos fixed in xmlto notes and book template. Copied information about DocBook-capable word processing tools into the "Converting Documents to DocBook XML" Appendix; added new XML editors; and information about tools to convert other formats to DocBook XML.Updated information regarding CVS accounts and connecting to the CVS server.Added editor credit requirements to the Using DocBook section. Updated the submission procedure. New documents can now only be added by one of the Review Coordinators after the successful completion of each of the required reviews.Removed the section Contributing to The LDP (replaced by Summary of The LDP Process).Added references for LyX to DocBook conversions in the bibliography.Updated the license requirements and added them to the table of contents (moved them out of the sub-section). | ||
This guide describes the process of submitting and publishing a document with The Linux Documentation Project (TLDP). It includes information about the tools, toolchains and formats used by TLDP. The document's primary audience is new TLDP authors, but it also contains information for seasoned documentation authors.
- Table of Contents
- 1. About this Guide
- 1.1. About this Guide
- 1.2. About The LDP
- 1.3. Feedback
- 1.4. Copyrights and Trademarks
- 1.5. Acknowledgments and Thanks
- 1.6. Document Conventions
- 2. Authoring TLDP Documents: An Introduction
- 2.1. Summary of The LDP Process
- 2.2. Mailing Lists
- 3. Writing Your Proposal
- 4. Write
- 5. Markup
- 6. Distributing Your Documentation
- 7. Maintenance
- 7.1. Maintaining Your Document
- 7.2. Fixing Errors
- References
- A. Templates
- A.1. Document Templates
- A.2. Style Sheets
- A.3. GNU Free Documentation License
- B. System Setup: Editors, Validation and Transformations
- B.1. Tools for your operating system
- B.2. Editing tools
- B.3. Validation
- B.4. Transformations
- B.5. DocBook DTD
- B.6. Formatting Documents
- C. Concurrent Version System (CVS)
- C.1. Getting a CVS account
- C.2. Using CVS
- C.3. CVS Resources
- D. DocBook: Sample Markup
- E. Converting Documents to DocBook XML
- Glossary
- F. GNU Free Documentation License
- F.1. 0. PREAMBLE
- F.2. 1. APPLICABILITY AND DEFINITIONS
- F.3. 2. VERBATIM COPYING
- F.4. 3. COPYING IN QUANTITY
- F.5. 4. MODIFICATIONS
- F.6. 5. COMBINING DOCUMENTS
- F.7. 6. COLLECTIONS OF DOCUMENTS
- F.8. 7. AGGREGATION WITH INDEPENDENT WORKS
- F.9. 8. TRANSLATION
- F.10. 9. TERMINATION
- F.11. 10. FUTURE REVISIONS OF THIS LICENSE
- F.12. Addendum
- List of Tables
- D-1. Useful markup
- List of Figures
- B-1. epcEdit screen shot
- B-2. nedit screen shot
- B-3. Adding shell commands to nedit
- B-4. nsgmls output on success
- List of Examples
- B-1. Setting the SGML_CATALOG_FILES and XML_CATALOG_FILES Environmental Variables
- B-2. Example of an SGML catalog
- B-3. Sample XML Catalog file
- B-4. Debugging example using xmllint
- B-5. "Installing" DSSSL style sheets
- B-6. Example creating HTML output
- B-7. "Installing" DocBook Document Type Definitions
- B-8. Style sheet to insert summaries in articles
- B-9. Configuring an external entity to include the index
- D-1. Command Prompt with
programlisting - D-2. Command Prompt with
screen - D-3. Code for the generation of an index
- D-4. Use of the attribute
zone - D-5. Usage of values
startofrangeandendofrangeon the attributeclass - D-6. Inserting a picture
- D-7. Using
<imageobject> - D-8. Other Credit
- D-9. Editor
- D-10. Sample Meta Data
- D-11. A Bibliography
- D-12. Adding Entities
- D-13. Use of parameter entities
| Next | ||
| About this Guide |