LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

new entry;stripped down template (linuxdoc)

This commit is contained in:
gferg 2001-01-08 22:08:40 +00:00
parent 71f34e4ed6
commit 37de4d27f3
1 changed files with 234 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

234
LDP/howto/linuxdoc/small-howto-template-ld.sgml Normal file
View File

@ -0,0 +1,234 @@
<!doctype linuxdoc system>
<!--
The line above starts a comments section
A changelog is useful if you don't use cvs etc.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Changelog:
291000: Created this minimal Template for small HOWTOs
The line below ends the comments section.
-->
<article>
<!-- insert title here, include the word HOWTO -->
<title>HOWTO-template for Small HOWTOs
<author>Stein Gjoen, <tt/sgjoen@nyx.net/ <!-- insert your name and email here -->
<!-- always have a version number and a date (YYYY-MM-DD format) -->
<date>0.05, 2001-01-08
<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
</abstract>
<!-- Table of contents -->
<toc>
<!-- Begin the document -->
<sect>Introduction
<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.
<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>
Stating the background is a simple way to getting started
writing the intro.
First of all we need a bit of legalese. Recent development shows it is
quite important.
<sect1>Copyright
<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>
<url url="http://www.LinuxDoc.org/"
name="LinuxDoc">
site.
<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>
Copyright (c) 2000 by John Doe (change to your name)
<P>
Please freely copy and distribute (sell or give away) this document in
any format. It's requested that corrections and/or comments be forwarded
to the document maintainer. You may create a derivative work and distribute
it provided that you:
<itemize>
<item>
Send your derivative work (in the most suitable format such as
sgml) to the LDP (Linux Documentation Project) or the like for posting
on the Internet. If not the LDP, then let the LDP know where it is
available.
<item>
License the derivative work with this same license or use GPL.
Include a copyright notice and at least a pointer to the license used.
<item>
Give due credit to previous authors and major contributors.
</itemize>
<P>
If you're considering making a derived work other than a translation,
it's requested that you discuss your plans with the current maintainer.
<sect1>Disclaimer
<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.
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.
<sect1>News
<p>
<nidx>(your index root)!news on</nidx>
<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 release featuring more samples and an improved structure.
<!-- This is the first release. No news yet. -->
<!-- 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">
homepage.
</em>
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.
<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:
<itemize>
<item>
<url url="http://www.nyx.net/&tilde;sgjoen/mintplt.html"
name="HTML">.
<item>
<url url="http://www.nyx.net/&tilde;sgjoen/mintplt.txt"
name="plain ASCII text">.
<item>
<url url="http://www.nyx.net/&tilde;sgjoen/mintplt.sgml"
name="SGML source">.
</itemize>
<sect1>Credits
<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>
In this version I have the pleasure of acknowledging
<tscreen><verb>
corff (at) ZEDAT.FU-Berlin.DE
dwood (at) plugged.net.au
lcl (at) spiretech.com
kgh12351 (at) nifty.ne.jp
dave (at) lafn.org
name (at) site.org
</verb></tscreen>
<em>Scramble the addresses so email harvesters cannot get
addresses from your HOWTO and then spam people. That has
happened in the past.</em>
<sect1>Translations
<p>
Not everyone speaks English, pointers to translations are nice.
Also your translators tend to give very important inputs.
<itemize>
<item><url url="http://linuxdoc.org/"
name="German Translation"> by <tt/someone (at) somewhere.de/
<item><url url="http://www.swe-doc.linux.nu"
name="Swedish Translation "> by <tt/someone (at) somewhere.se/
<item><url url="http://linuxdoc.org/"
name="French Translation"> by <tt/someone (at) somewhere.fr/
<item><url url="http://linuxdoc.org/"
name="Chinese Translation"> by <tt/someone (at) somewhere.cn/
<item><url url="http://linuxdoc.org/"
name="Italian Translation"> by <tt/someone (at) somewhere.it/
</itemize>
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/"
name="sgjoen@nyx.net">
(replace with your own address.)
<p>
<!--
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-->
<sect>The Main Text
<p>
<em>Here comes the documentation itself.</em>
</article>