Next Previous Contents

---

Howtos-with-LinuxDoc-mini-HOWTO

David S. Lawyer

v0.02, November 2003

---

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 advanced DocBook markup (including XML) see the LDP Authoring Guide.

---

1. Introduction

• 1.1 Should you write a HOWTO ?
• 1.2 Copyright (skip this if you're in a hurry)
• 1.3 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. Writing the HOWTO

• 7.1 Before you start writing
• 7.2 Guidelines
• 7.3 Submitting the HOWTO, etc.

8. More Information

---

Next Previous Contents
Linux HOWTO full list