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

updated template (linuxdoc)

This commit is contained in:
gferg 2001-01-08 22:10:06 +00:00
parent 37de4d27f3
commit 633b9a3ea4
1 changed files with 59 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
LDP/howto/linuxdoc/big-howto-template-ld.sgml
View File

@ -14,6 +14,9 @@ Changelog:
050600: Clarified intent, added acknowledgements and note on conventions, moved samples to the end, added table sample, added small section on style
190600: Updated and corrected copyright section
240700: Added Troubleshooting section, cleaned up Getting Help and Bits and Pieces, fixed typo
161000: Added sample scripts to generate outputs from SGML-file and removed typos
291000: Updated sample scripts to generate outputs from SGML-file and removed old copyright
311000: Fixed a typo
The line below ends the comments section.
-->
@ -21,12 +24,16 @@ The line below ends the comments section.
<article>
<!-- insert title here, include the word HOWTO -->
<title>HOWTO-template for Big HOWTOs
<title>HOWTO-template for big HOWTOs <!-- insert your title here -->
<author>Stein Gjoen, <tt/sgjoen@nyx.net/ <!-- insert your name here -->
<date>v0.05, 24 July 2000 <!-- always have a version number and a date -->
<abstract> <!-- the abstract: a short and precise description -->
<nidx>template</nidx> <!-- add indexing keywords as you go along -->
<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.06, 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 big HOWTOs. The source contains
fully described slots to make a convenient framework for you to fill in
@ -35,7 +42,6 @@ for the chapters.
</abstract>
<!-- Table of contents -->
<toc>
@ -44,8 +50,8 @@ for the chapters.
<sect>Introduction
<p>
<nidx>template!introduction</nidx> <!-- here introduction is a sub entry of template, exclamationamrk is separator -->
<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
@ -89,38 +95,13 @@ What follows is a boilerplate licence.
</em>
<!--
This HOWTO is copyrighted 2000 Stein Gjoen. <em>Replace with your name
when you use this skeleton for a new HOWTO</em>
Unless otherwise stated, Linux HOWTO documents are copyrighted by their
respective authors. Linux HOWTO documents may be reproduced and distributed
in whole or in part, in any medium physical or electronic, as long as
this copyright notice is retained on all copies. Commercial redistribution
is allowed and encouraged; however, the author would like to be notified of
any such distributions.
All translations, derivative works, or aggregate works incorporating
any Linux HOWTO documents must be covered under this copyright notice.
That is, you may not produce a derivative work from a HOWTO and impose
additional restrictions on its distribution. Exceptions to these rules
may be granted under certain conditions; please contact the Linux HOWTO
coordinator at the address given below.
In short, we wish to promote dissemination of this information through as
many channels as possible. However, we do wish to retain copyright on the
HOWTO documents, and would like to be notified of any plans to redistribute
the HOWTOs.
If you have questions, please contact
at linux-howto@metalab.unc.edu via email.
Old style copyright removed
-->
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 fowarded
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:
@ -164,7 +145,7 @@ 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
<em>This is where you make a summary of what is new. 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>
@ -296,7 +277,7 @@ I will include it here as an introduction to how it works.
<sect1>Logical structure
<p>
<nidx>disk!structure, I/O subsystem</nidx>
<nidx>(your index root)!structure, I/O subsystem</nidx>
This is based on how each layer access each other, traditionally
with the application on top and the physical layer on the bottom.
It is quite useful to show the interrelationship between each of
@ -404,7 +385,7 @@ This is the place to explain it all, if applicable.</em>
<nidx>(your index root)!troubleshooting</nidx>
<em>Many problems can be solved by a simple structured approach,
analysing the symptoms, finding the cause and determining the
solution. The following is an exerpts from the Multi Disk HOWTO.</em>
solution. The following is an excerpts from the Multi Disk HOWTO.</em>
<sect1>During Installation
@ -439,7 +420,7 @@ of the disk, for instance <tt>/dev/hda1</tt> to the command line.
<p>
<nidx>(your index root)!information resources</nidx>
<em>A HOWTO cannot describe everything, some times the user
has to venture out on th enet to get more information or just
has to venture out on the net to get more information or just
updates. Here is the place to tell where and how. Again examples
from my HOWTO, replace as needed.</em>
There is wealth of information one should go through when setting up a
@ -448,7 +429,7 @@ The FAQs in the following groups are useful:
<sect1>News groups
<p>
<nidx>disk!information resources!news groups</nidx>
<nidx>(your index root)!information resources!news groups</nidx>
Some of the most interesting news groups are:
<itemize>
<item><url url="news:comp.arch.storage" name="Storage">.
@ -478,7 +459,7 @@ Some FAQs have their own home site, of particular interest here are
<sect1>Mailing Lists
<p>
<nidx>disk!information resources!mailing lists</nidx>
<nidx>(your index root)!information resources!mailing lists</nidx>
These are low noise channels mainly for developers. Think
twice before asking questions there as noise delays the development.
Some relevant lists are <tt/linux-raid/, <tt/linux-scsi/ and <tt/linux-ext2fs/.
@ -516,7 +497,7 @@ interesting lists from the
<sect1>HOWTO
<p>
<nidx>disk!information resources!HOWTOs</nidx>
<nidx>(your index root)!information resources!HOWTOs</nidx>
These are intended as the primary starting points to
get the background information as well as show you how to solve
a specific problem.
@ -535,7 +516,7 @@ DPT RAID system, check out the
<sect1>Mini-HOWTO
<p>
<nidx>disk!information resources!mini-HOWTOs</nidx>
<nidx>(your index root)!information resources!mini-HOWTOs</nidx>
These are the smaller free text relatives to the HOWTOs.
Some relevant mini-HOWTOs are
<tt/Backup-With-MSDOS/, <tt/Diskless/, <tt/LILO/, <tt/Large Disk/,
@ -551,7 +532,7 @@ The old <tt/Linux Large IDE mini-HOWTO/ is no longer valid, instead read
<sect1>Local Resources
<p>
<nidx>disk!information resources!local</nidx>
<nidx>(your index root)!information resources!local</nidx>
In most distributions of Linux there is a document directory installed,
have a look in the
<htmlurl url="file:///usr/doc"
@ -610,8 +591,8 @@ reported as being zero length. Reports are that <tt/less/ works well here.
<sect1>Web Pages
<p>
<nidx>disk!information resources!WWW</nidx>
<nidx>disk!information resources!web pages</nidx>
<nidx>(your index root)!information resources!WWW</nidx>
<nidx>(your index root)!information resources!web pages</nidx>
There is a huge number of informative web pages out there and by their very
nature they change quickly so don't be too surprised if these links become
quickly outdated.
@ -741,7 +722,7 @@ This is a balance and dependent on the number of physical drives you have.
<sect>Bits and Pieces <label id="bits-n-pieces">
<p>
<nidx>disk!miscellaneous</nidx>
<nidx>(your index root)!miscellaneous</nidx>
<em>This is basically a section where I stuff all the bits I have not yet
decided where should go, yet that I feel is worth knowing about. It is
a kind of transient area.</em>
@ -855,5 +836,36 @@ rather than just /usr/doc.
<tt>df (1)</tt> rather than just df.
</descrip>
<sect>Converting the SGML File
<p>
Having made the SGML file we are now ready to convert it to
the various output formats we need. The following is my
script to process my Multi Disk HOWTO:
<code>
sgml2txt -f disk.sgml
sgml2html disk.sgml
sgml2latex --papersize=a4 --language=english --output=ps ~stein/doc/disk.sgml
mv disk.ps disk-A4.ps
gzip -9 disk-A4.ps
sgml2latex --papersize=letter --language=english --output=ps ~stein/doc/disk.sgml
mv disk.ps disk-US.ps
gzip -9 disk-US.ps
</code>
The template can be converted as is, substitute "disk.sgml" with
the filename of this template to see what it looks like.
If your document is small (such as this template)
you might find it more convenient to
keep formatted versions in one single file
rather than splitting it for every chapter:
<code>
sgml2html --split=0 template.sgml
</code>
</article>