Creating documentation with LinuxDoc

Writing LinuxDoc

You can skip this section if you just received a LinuxDoc file (for instance one of the Linux HOWTOs, such as you can find in the LinuxDoc servers).

You may write LinuxDoc documents with Emacs' SGML mode, psgml. Here is a sample example:

<!doctype linuxdoc system>
<article>

<title>Quick SGML Example
<author>Matt Welsh, <tt>[email protected]</tt>
<date>v1.0, 28 March 1994
<abstract>
This document is a brief example using the Linuxdoc-SGML DTD.
</abstract>

<sect>Introduction

<p>
This is an SGML example file using the Linuxdoc-SGML DTD.

</article>

	

A more complete example of a LinuxDoc document is Debian documentation (the link will work only if you installed the package "sgml-tools").

To learn the list of legal elements, see Debian documentation (the link will work only if you installed the package "sgml-tools")or see Matt Welsh's guide.

Processing LinuxDoc

You will use sgml-tools, version 1. To convert a LinuxDoc document to HTML:

	sgml2html document.sgml
      

To ordinary text, for instance to post it on the News:

	sgml2txt  document.sgml
      

And to PostScript, using LaTeX:

	sgml2latex --output=ps document.sgml
      

You can have more information in sgmltools.v1(1).