201 lines
6.3 KiB

<!doctype linuxdoc system>
The line above starts a comments section
A changelog is useful if you don't use cvs etc.
291000: Created this minimal Template for small HOWTOs
311000: Fixed a typo and folded "News" into "Intro" and deleted "Translations"
The line below ends the comments section.
<title>HOWTO-template for small HOWTOs <!-- insert your title here -->
<author>Stein Gjoen, <tt/sgjoen@nyx.net/ <!-- insert your name here -->
<date>v0.03, 20 May 2002 <!-- always have a version number and a date -->
<abstract> <!-- the abstract: a short and precise description -->
<nidx>(your index root)</nidx> <!-- add indexing keywords as you go along -->
<!-- nidx means the indexed word is not in output of main text, only in the index -->
This is a fully working template for small HOWTOs. The source contains
fully described slots to make a convenient framework for you to fill in
for making your own HOWTO, suggesting some names, conventions and contents
for the chapters.
While derived from the Template for big HOWTOs this
is a minimalistic Template that only lists the
minimal requirements to fit into the
Linux Documentation Project archives
<!-- Table of contents -->
<!-- Begin the document -->
<p> <!-- always use a p tag (paragraph) immediately after a sect tag -->
<nidx>(your index root)!introduction</nidx> <!-- here introduction is a sub entry of template, exclamationmark is separator -->
<em>My comments to the reader is in this style (emphasized)</em>.
Example lines are in plain roman style.
<em>Note that extra comments and advice is found in comments
within the SGML source.</em> <!-- such as this comment -->
For various reasons this brand new release is codenamed
the <bf/unleash/ release.
New code names will appear as per industry standard guidelines
to emphasize the state-of-the-art-ness of this document.
<em>This Template is a suggestion and a starting point, a check list
for minimum features and also examples for authors.
Over time HOWTOs will outgrow any template since
in the end the goal is to inform readers efficiently.</em>
Stating the background is a simple way to getting started
writing the intro.
<em>This is where you make a summary of what it news. When a HOWTO exceeds
20 pages it takes more than a casual read to find the updates. This is
where you help your readers with that, alerting them to specific and
important news.</em>
This is the first update featuring an improved structure.
<!-- Note that you might wish to keep old news commented out for reference
and perhaps state news as latest and next to latest update. -->
<em>Tell people where the document home page is so the very newest
release could be found in case of problems with the main
<url url="http://www.linuxdoc.org/"
name="Linux Documentation Project">
The latest version number of this document can be gleaned from my
plan entry if you <!-- do "finger sgjoen@nox.nyx.net" -->
<url url="http://www.cs.indiana.edu/finger/nox.nyx.net/sgjoen"
name="finger"> my Nyx account.
First of all we need a bit of legalese. Recent development shows it is
quite important.
<em>Copyright is a source of much and continuous debate on the
LDP mailing list. For more in depth information please consult
the Manifesto at the </em>
<url url="http://www.LinuxDoc.org/"
The purpose of having a license is to allow appropriate distribution.
You can use any license that meets the Manifesto.
What follows is a boilerplate licence.
This document is Copyright 2000 by John Doe (change to your name).
Permission is granted to
copy, distribute and/or modify this document under the terms of the
GNU Free Documentation License, Version 1.1 or any later version
published by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts. A copy of the license
can be found in Appendix A.
<em>Replace with your name, or
supply a new license, when you use this template for a new HOWTO.</em>
Use the information in this document at your own risk. I disavow any
potential liability for the contents of this document. Use of the
concepts, examples, and/or other content of this document is entirely
at your own risk.
All copyrights are owned by their owners, unless specifically noted
otherwise. Use of a term in this document should not be regarded as
affecting the validity of any trademark or service mark.
Naming of particular products or brands should not be seen as endorsements.
You are strongly recommended to take a backup of your system before
major installation and backups at regular intervals.
<em>If you have the capacity it would be nice to make the HOWTO
available in a number of formats.</em>
Also, the latest version of the Template will be available on
my web space on Nyx in a number of formats:
<url url="http://www.nyx.net/&tilde;sgjoen/mintplt.html"
<url url="http://www.nyx.net/&tilde;sgjoen/mintplt.txt"
name="plain ASCII text">.
<url url="http://www.nyx.net/&tilde;sgjoen/mintplt.sgml"
name="SGML source">.
<em>It is always nice to acknowledge people who help you with inputs, it
is also regarded by many as important in the Linux world new economy</em>
In this version I have the pleasure of acknowledging
corff (at) ZEDAT.FU-Berlin.DE
dwood (at) plugged.net.au
lcl (at) spiretech.com
kgh12351 (at) nifty.ne.jp
dave (at) lafn.org
gferg (at) hoop.timonium.sgi.com
name (at) site.org
<em>Scramble the addresses so email harvesters cannot get
addresses from your HOWTO and then spam people. That has
happened in the past.</em>
Also Somecompany is acknowledged for sending me documentation
on their gizmos as well as permission to quote from the material.
These quotes have been approved before appearing here and will
be clearly labelled.
Any comments or suggestions can be mailed to my mail address on Nyx:
<htmlurl url="mailto:sgjoen@nyx.net/"
(replace with your own address.)
<sect>The Main Text
<em>Here comes the documentation itself.</em>