101 lines
4.0 KiB
HTML
101 lines
4.0 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21">
|
|
<TITLE></TITLE>
|
|
<LINK HREF="Howtos-with-LinuxDoc-1.html" REL=next>
|
|
|
|
|
|
</HEAD>
|
|
<BODY>
|
|
<A HREF="Howtos-with-LinuxDoc-1.html">Next</A>
|
|
Previous
|
|
Contents
|
|
<HR>
|
|
<H1></H1>
|
|
|
|
<H2>David S. Lawyer</H2>v0.09, November 2007
|
|
<HR>
|
|
<EM>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.</EM>
|
|
<HR>
|
|
<P>
|
|
<H2><A NAME="toc1">1.</A> <A HREF="Howtos-with-LinuxDoc-1.html">Introduction </A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc1.1">1.1</A> <A HREF="Howtos-with-LinuxDoc-1.html#ss1.1">If you want to start immediately</A>
|
|
<LI><A NAME="toc1.2">1.2</A> <A HREF="Howtos-with-LinuxDoc-1.html#ss1.2">Copyright and License</A>
|
|
<LI><A NAME="toc1.3">1.3</A> <A HREF="Howtos-with-LinuxDoc-1.html#ss1.3">Should you write a HOWTO ?</A>
|
|
<LI><A NAME="toc1.4">1.4</A> <A HREF="Howtos-with-LinuxDoc-1.html#ss1.4">Why I wrote this</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc2">2.</A> <A HREF="Howtos-with-LinuxDoc-2.html">Information on Writing a HOWTO</A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc2.1">2.1</A> <A HREF="Howtos-with-LinuxDoc-2.html#ss2.1">Copyright</A>
|
|
<LI><A NAME="toc2.2">2.2</A> <A HREF="Howtos-with-LinuxDoc-2.html#ss2.2">Choosing a topic</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc3">3.</A> <A HREF="Howtos-with-LinuxDoc-3.html">The Format of HOWTOs </A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc3.1">3.1</A> <A HREF="Howtos-with-LinuxDoc-3.html#ss3.1">Introduction</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc4">4.</A> <A HREF="Howtos-with-LinuxDoc-4.html">Comparing LinuxDoc to DocBook </A></H2>
|
|
|
|
<P>
|
|
<H2><A NAME="toc5">5.</A> <A HREF="Howtos-with-LinuxDoc-5.html">Learning LinuxDoc </A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc5.1">5.1</A> <A HREF="Howtos-with-LinuxDoc-5.html#ss5.1">Introduction</A>
|
|
<LI><A NAME="toc5.2">5.2</A> <A HREF="Howtos-with-LinuxDoc-5.html#ss5.2">Example 1 (file name: example1.sgml) </A>
|
|
<LI><A NAME="toc5.3">5.3</A> <A HREF="Howtos-with-LinuxDoc-5.html#ss5.3">Example 2 (file name: example2.sgml)</A>
|
|
<LI><A NAME="toc5.4">5.4</A> <A HREF="Howtos-with-LinuxDoc-5.html#ss5.4">Example 3 </A>
|
|
<LI><A NAME="toc5.5">5.5</A> <A HREF="Howtos-with-LinuxDoc-5.html#ss5.5">LinuxDoc Quick Reference Sheet</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc6">6.</A> <A HREF="Howtos-with-LinuxDoc-6.html">Getting/Using the LinuxDoc Software</A></H2>
|
|
|
|
<P>
|
|
<H2><A NAME="toc7">7.</A> <A HREF="Howtos-with-LinuxDoc-7.html">Errors and Error Messages</A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc7.1">7.1</A> <A HREF="Howtos-with-LinuxDoc-7.html#ss7.1">Errors That Don't Create Error Messages</A>
|
|
<LI><A NAME="toc7.2">7.2</A> <A HREF="Howtos-with-LinuxDoc-7.html#ss7.2">Actual Error Messages</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc8">8.</A> <A HREF="Howtos-with-LinuxDoc-8.html">Jargon in Error Messages</A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc8.1">8.1</A> <A HREF="Howtos-with-LinuxDoc-8.html#ss8.1">Introduction</A>
|
|
<LI><A NAME="toc8.2">8.2</A> <A HREF="Howtos-with-LinuxDoc-8.html#ss8.2">Elements</A>
|
|
<LI><A NAME="toc8.3">8.3</A> <A HREF="Howtos-with-LinuxDoc-8.html#ss8.3">Literals and Delimiters</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc9">9.</A> <A HREF="Howtos-with-LinuxDoc-9.html">Writing the HOWTO</A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc9.1">9.1</A> <A HREF="Howtos-with-LinuxDoc-9.html#ss9.1">Before you start writing</A>
|
|
<LI><A NAME="toc9.2">9.2</A> <A HREF="Howtos-with-LinuxDoc-9.html#ss9.2">Guidelines</A>
|
|
<LI><A NAME="toc9.3">9.3</A> <A HREF="Howtos-with-LinuxDoc-9.html#ss9.3">Submitting the HOWTO, etc.</A>
|
|
</UL>
|
|
<P>
|
|
<H2><A NAME="toc10">10.</A> <A HREF="Howtos-with-LinuxDoc-10.html">More Information </A></H2>
|
|
|
|
<P>
|
|
<H2><A NAME="toc11">11.</A> <A HREF="Howtos-with-LinuxDoc-11.html">Appendix</A></H2>
|
|
|
|
<UL>
|
|
<LI><A NAME="toc11.1">11.1</A> <A HREF="Howtos-with-LinuxDoc-11.html#ss11.1">Old Problem of Escape Sequences in Text Output</A>
|
|
</UL>
|
|
<HR>
|
|
<A HREF="Howtos-with-LinuxDoc-1.html">Next</A>
|
|
Previous
|
|
Contents
|
|
</BODY>
|
|
</HTML>
|