142 lines
5.1 KiB

<TITLE>HOWTO-template for small HOWTOs : Introduction</TITLE>
<LINK HREF="small-howto-template-ld-2.html" REL=next>
<LINK HREF="small-howto-template-ld.html#toc1" REL=contents>
<A HREF="small-howto-template-ld-2.html">Next</A>
<A HREF="small-howto-template-ld.html#toc1">Contents</A>
<H2><A NAME="s1">1. Introduction</A></H2>
(your index root)!introduction
<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>
<P>For various reasons this brand new release is codenamed
the <B>unleash</B> release.
<P>New code names will appear as per industry standard guidelines
to emphasize the state-of-the-art-ness of this document.
<P><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>
<P>Stating the background is a simple way to getting started
writing the intro.
<P><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>
<P>This is the first update featuring an improved structure.
<P><EM>Tell people where the document home page is so the very newest
release could be found in case of problems with the main
<A HREF="http://www.linuxdoc.org/">Linux Documentation Project</A>
<P>The latest version number of this document can be gleaned from my
plan entry if you
<A HREF="http://www.cs.indiana.edu/finger/nox.nyx.net/sgjoen">finger</A> my Nyx account.
<P>First of all we need a bit of legalese. Recent development shows it is
quite important.
<H2><A NAME="ss1.1">1.1 Copyright</A>
<P><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>
<A HREF="http://www.LinuxDoc.org/">LinuxDoc</A>
<EM>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.</EM>
<P>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.
<P><EM>Replace with your name, or
supply a new license, when you use this template for a new HOWTO.</EM>
<H2><A NAME="ss1.2">1.2 Disclaimer</A>
<P>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.
<P>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.
<P>Naming of particular products or brands should not be seen as endorsements.
<P>You are strongly recommended to take a backup of your system before
major installation and backups at regular intervals.
<P><EM>If you have the capacity it would be nice to make the HOWTO
available in a number of formats.</EM>
<P>Also, the latest version of the Template will be available on
my web space on Nyx in a number of formats:
<A HREF="http://www.nyx.net/~sgjoen/mintplt.html">HTML</A>.
<A HREF="http://www.nyx.net/~sgjoen/mintplt.txt">plain ASCII text</A>.
<A HREF="http://www.nyx.net/~sgjoen/mintplt.sgml">SGML source</A>.</LI>
<H2><A NAME="ss1.3">1.3 Credits</A>
<P><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>
<P>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
<P><EM>Scramble the addresses so email harvesters cannot get
addresses from your HOWTO and then spam people. That has
happened in the past.</EM>
<P>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.
<P>Any comments or suggestions can be mailed to my mail address on Nyx:
<A HREF="mailto:sgjoen@nyx.net/">sgjoen@nyx.net</A>
(replace with your own address.)
<A HREF="small-howto-template-ld-2.html">Next</A>
<A HREF="small-howto-template-ld.html#toc1">Contents</A>