This commit is contained in:
gferg 2000-07-24 17:19:01 +00:00
parent 036ce6082b
commit 4442e8c6b5
2 changed files with 52 additions and 5 deletions

View File

@ -85,6 +85,7 @@
#t)
(define (toc-depth nd)
;; more depth, 2 levels, to toc, instead of flat hierarchy
2)
</style-specification-body>

View File

@ -13,6 +13,7 @@ Changelog:
280500: Released. Added examples for diagrams
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
The line below ends the comments section.
-->
@ -23,9 +24,10 @@ The line below ends the comments section.
<title>HOWTO-template for big HOWTOs <!-- insert your title here -->
<author>Stein Gjoen, <tt/sgjoen@nyx.net/ <!-- insert your name here -->
<date>v0.04 , 19 June 2000 <!-- always have a version number and a date -->
<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 -->
<!-- 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
for making your own HOWTO, suggesting some names, conventions and contents
@ -43,7 +45,7 @@ for the chapters.
<sect>Introduction
<p>
<nidx>disk!introduction</nidx>
<nidx>template!introduction</nidx> <!-- here introduction is a sub entry of template, exclamationamrk 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
@ -218,7 +220,7 @@ significantly.</em>
<sect1>Credits
<p>
<em>It is always nice to acknowledge people who help you with inputs, it
is also regarded by mane as important in the Linux world new economy</em>
is also regarded by many as important in the Linux world new economy</em>
In this version I have the pleasure of acknowledging
@ -397,6 +399,42 @@ For more serious use you would need to be a little more advanced.
This is the place to explain it all, if applicable.</em>
<sect>Troubleshooting <label id="troubleshooting">
<p>
<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>
<sect1>During Installation
<sect2>Locating Disks
<p>
<descrip>
<tag/Symptoms/Cannot find disk
<tag/Problem/How to find what drive letter corresponds to what disk/partition
<tag/Solution/Remember Linux does not use drive letters but device names. More
information can be found in section "Drive names".
</descrip>
<p>
<descrip>
<tag/Symptoms/Cannot partition disk
<tag/Problem/Most likely wrong input to the command line for <tt/fdisk/ or similar tool.
<tag/Solution/Remember to use <tt>/dev/hda</tt> rather than just <tt>hda</tt>. Also
do not use numbers behind <tt>hda</tt>, those indicate partitions.
</descrip>
<sect2>Formatting
<p>
<descrip>
<tag/Symptoms/Cannot format disk.
<tag/Problem/Strictly speaking you format partitions not disks.
<tag/Solution/Make sure you add the partition number after the device name
of the disk, for instance <tt>/dev/hda1</tt> to the command line.
</descrip>
<sect>Further Information
<p>
<nidx>(your index root)!information resources</nidx>
@ -589,6 +627,14 @@ Please let me know if you have any other leads that can be of interest.
<sect>Getting Help
<p>
<nidx>(your index root)!assistance, obtaining</nidx>
<em>Your reader might still end up in a situation where extra help is
needed from someone else, perhaps on the net. In order to get fast and
efficient help it is best first to get some details on your system.
What details matter depends on type of problem. For disk problems you
need to know the disk controllers etc, for networking problems you
have to know what ethernet card is used and version of drivers etc.
Here is the place to suggest what details to have ready when asking
for help.</em>
In the end you might find yourself unable to solve your problems and need
help from someone else. The most efficient way is either to ask someone
@ -696,9 +742,9 @@ 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>
This is basically a section where I stuff all the bits I have not yet
<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.
a kind of transient area.</em>
<sect>Examples
<p>