Next Previous Contents

---

Howtos with LinuxDoc

David S. Lawyer

v0.09, November 2007

---

This is about how to write HOWTOs using the simple LinuxDoc markup. It's primarily for Linux Documentation Project authors (and future fledging authors who want to get started fast). If you want to use the more difficult and complex DocBook markup (including XML) see the LDP Authoring Guide.

---

1. Introduction

• 1.1 If you want to start immediately
• 1.2 Copyright and License
• 1.3 Should you write a HOWTO ?
• 1.4 Why I wrote this

2. Information on Writing a HOWTO

• 2.1 Copyright
• 2.2 Choosing a topic

3. The Format of HOWTOs

• 3.1 Introduction

4. Comparing LinuxDoc to DocBook

5. Learning LinuxDoc

• 5.1 Introduction
• 5.2 Example 1 (file name: example1.sgml)
• 5.3 Example 2 (file name: example2.sgml)
• 5.4 Example 3
• 5.5 LinuxDoc Quick Reference Sheet

6. Getting/Using the LinuxDoc Software

7. Errors and Error Messages

• 7.1 Errors That Don't Create Error Messages
• 7.2 Actual Error Messages

8. Jargon in Error Messages

• 8.1 Introduction
• 8.2 Elements
• 8.3 Literals and Delimiters

9. Writing the HOWTO

• 9.1 Before you start writing
• 9.2 Guidelines
• 9.3 Submitting the HOWTO, etc.

10. More Information

11. Appendix

• 11.1 Old Problem of Escape Sequences in Text Output

---

Next Previous Contents