Commit graph

21 commits

Author SHA1 Message Date
Nik Clayton
f18b900b84 Fix many typos. Much kudos to the submitter for this effort.
PR:             docs/12956
Submitted by:   Neil Blakey-Milner <nbm@rucus.ru.ac.za>
1999-08-05 20:48:25 +00:00
Nik Clayton
ca138ea9df Updated information on the Archive Python 28454 -- the Sun model number
is 595-3067, not 441 (which is the type of external enclosure it is in!).
And throughput is roughly 1.5 MBytes/sec.

Submitted by:   Robert E. Seastrom <rs@seastrom.com>
1999-07-30 21:11:27 +00:00
Nik Clayton
f85b87db80 Refer to the DE450 ethernet card at the same time as the DE435. Apparently
the 435 is no longer made, the 450 supercedes it.  Keep the references to
the 435 around though, so that potential users who have one aren't put off.

Submitted by:   Kevin Eliuk <kevin_eliuk@sunshine.net>
1999-07-19 22:21:29 +00:00
Bill Fumerola
05d191f662 freebsd.org -> FreeBSD.org, which seems to be the domain name of choice.
FreeBSD, Inc. now owes me a new keyboard as I've seemed to have worn out
my "shift" and "`" key from sending vi so many "~"s. :->
1999-06-20 21:19:40 +00:00
Nik Clayton
d757fe2a69 Added information about the Tandberg TDC 3800 QIC tape
Submitted by:           jhs
1999-06-06 18:57:18 +00:00
Nik Clayton
1ba63645ec Add a section describing the Archive Python 04687 drive.
PR:             docs/10819
Submitted by:   regisr@regix.com
1999-05-29 13:04:59 +00:00
Nick Sayer
60afe67c8e 1. Add <devicename> around one instance of "si"
2. Add <literal> around an address (nik's suggestion).
1999-04-08 21:11:36 +00:00
Nik Clayton
c4914d21f7 Fix up the white space damage from Nick Sayer's commit.
It's not technically required, but it keeps things looking nice, and much
easier to understand.  This is important if people are going to be able
to learn DocBook by looking at the Handbook.  It also makes it easier
to follow the structure if you don't have an SGML savvy editor.

I'm going to be *at least* as anal about this as bde is about style(9).
Sorry folks :-)
1999-04-07 22:49:55 +00:00
Nick Sayer
c3e4204e90 Add handbook section on si driver for Specialix SI/XIO/SX cards.
PR:		6036
1999-04-07 20:45:45 +00:00
Nik Clayton
10b0b0a21e Add SGML comments at the top of the files with the $Id$ string. Remove
most of the other spurious comments.

Two comments relating to copyright have *not* been merged in from the
LinuxDoc version yet -- I've contacted the original authors to ask if
they would be willing to assign the copyright to the project. When I
get their response the copyright comments will either be merged in, or
left out, as necessary.
1999-03-08 22:04:49 +00:00
Nik Clayton
1e28ab5a96 Huge whitespace changes. Translators can ignore this commit completely.
Rationale: All the changes to the DocBook handbook so far have been
careful to keep whitespace changes to a minimum. This is so the
translators have as easy a job as possible in identifying exactly what's
changed.

This has meant the English version has become more and more 'ugly'. Lines
indented by the wrong amount, some lines longer than 130 characters,
others shorter than 20, gaps of 3 or 4 lines between paragraphs (and
sometimes within paragraphs). This makes it difficult to follow the
structure of the document, and needlessly complicates fixing SGML
problems.

It also makes the source practically useless as a teaching aid; the
more baroque the source looks, the less likely people are to dive in and
contribute.

This commit fixes all that -- and boy was it tedious. The snag is, it's
touched almost every line in every file in the Handbook.

Technically, the changes were made by running (in Emacs)
sgml-indent-or-tab (bound to the TAB key) on almost each line (except
those in <programlisting>, <screen>, <literallayout>, and other
verbatim sections), and then running sgml-fill-element (bound to
C-c C-q) on most paragraphs.

FWIW, this is the first, only, and last change of this type contemplated.
1999-03-07 21:26:43 +00:00
Nik Clayton
62a7d13816 Created a new set of entities for manual pages.
The construct:

    <citerefentry>
      <refentrytitle>foobar</refentrytitle>
      <manvolnum>1</manvolnum>
    </citerefentry>

is a pain to type, and messes up the pretty-printing of the source code.
Replace every occurence of a entry like that with:

    &man.foobar.1;

Adjusting the manual page name and section number appropriately.

The definitions for these entities are stored in man-refs.ent. This
file is in doc/share/sgml because it is not just specific to the Handbook.
I expect the DocBook'd FAQ and Tutorials (coming RSN) to use them as
well.

A new PUBLIC identifier has been created for these entities, and added to
the catalog file.
1999-03-07 16:32:22 +00:00
Nik Clayton
fe79ecbe4d Revert one of my previous changes. Sentences now have two spaces after
the period. Apologies for the repository bloat. This is entirely a
whitespace change.
1999-03-04 22:42:55 +00:00
Nik Clayton
7321b94099 Suddenly realised none of the
<informalexample>
    <screen>
      ...
    </screen>
  </informalexample>

need the <informalexample> element. So remove it. Simple search and
replace does the trick.
1999-01-30 23:35:05 +00:00
Nik Clayton
829eb2cc4b Pull a footnote out of an <informaltable> and into a <note> at the end
of the table, to work around a JadeTeX bug.
1999-01-27 23:32:48 +00:00
Nik Clayton
7e09961472 The JadeTeX macros appear to have problems dealing with footnotes in tables.
Rather than delay any longer for a fix from Sebastien Rahtz (my TeX is not
up to fixing it, natch) replace footnotes in tables with <note>...</note>
after the table.

When the JadeTeX macros DTRT, this change can be reverted.
1999-01-20 22:15:52 +00:00
Nik Clayton
9fc2fa5197 * Added boothelp.sgml
* Merged in changes between tags LINUXDOC_2_DOCBOOK and
  LINUXDOC_2_DOCBOOK_2. The merges are as follows (if a file isn't listed
  here it's because there are no changes to merge since the
  LINUXDOC_2_DOCBOOK tag was put down).

  File                 From  ->  To      Merged to files...
  ---------------------------------------------------------------
  authors.sgml         1.118 ->  1.128   authors.ent
  boothelp.sgml        Added
  contrib.sgml         1.312 ->  1.329   staff/chapter.sgml
  eresources.sgml      1.50  ->  1.51    eresources/chapter.sgml
  handbook.sgml        1.91  ->  1.95    handbook.sgml
  mirrors.sgml         1.92  ->  1.99    mirrors/chapter.sgml
  porting.sgml         1.112 ->  1.118   [1]
  ports.sgml           1.31  ->  1.33    ports/chapter.sgml
  printing.sgml        1.22  ->  1.23    printing/chapter.sgml
  stable.sgml          1.17  ->  1.18    cutting-edge/chapter.sgml [2]
  submitters.sgml      1.246 ->  1.261   contrib/chapter.sgml

  [1] Merged changes. Part of these changes are the migration of the
      "Making a port" section from contrib/chapter.sgml to
      ports/chapter.sgml

  [2] Merged some changes. 1.18 demotes some of the section headings so
      that the -stable section will appear on one HTML page. This is not
      the case with the DocBook stylesheets we're using, so wasn't
      necessary. For the time being, the -stable headings will follow
      the -current headings. This can be revisited after the migration
      is complete.

  There will be one more merge pass once the Handbook in doc/handbook/ is
  frozen, and then a pass to reformat (refill) most of the lines in the
  Handbook so it's more aesthetically pleasing. The SGML parsers don't
  care, but it makes it easier to follow the structure when editing the
  documents.

* Removed

      sgml-shorttag: nil
      sgml-minimize-attributes: max

  from the Emacs local variables at the bottom of each file. It didn't
  do quite what I was expecting.
1998-12-10 20:44:09 +00:00
Nik Clayton
276c9344d5 Merged in the following changes. This was done by taking diffs between the
tags LINUXDOC_2_DOCBOOK_START and LINUXDOC_2_DOCBOOK from doc/handbook/.

Note that the LINUXDOC_2_DOCBOOK tag is not necessarily at the HEAD of
the file. So some files won't show changes because changes were applied
after I laid down the LINUXDOC_2_DOCBOOK tag.

Not everything was merged. In some cases, URLs had been shortened;

    http://www.freebsd.org/docproj/

becomes

     ../docproj/

This is a mistake, since users browsing the Handbook on their own machine
can't be expected to have links like this work. Of course, for mirrors,
they'll end up pointing back to the main site. For the mean time, do
nothing -- this will need an entity defined to reference the base URL
of the FreeBSD site, individual mirrors can set this as necessary.

Notice how some files (on the left) are merged to the same file (on
the right). This is because the new Handbook file structure is organised
on DocBook chapter lines.

Files with no revision number in the "From" column didn't exist when I
started the conversion.

File                 From  ->  To      Merged to files...
---------------------------------------------------------------
anoncvs.sgml               ->  1.1     cutting-edge/chapter.sgml
authors.sgml         1.93  ->  1.118   authors.ent
backups.sgml               ->  1.4     backups/chapter.sgml
bibliography.sgml    1.33  ->  1.37    bibliography/chapter.sgml
contrib.sgml         1.274 ->  1.312   staff/chapter.sgml
ctm.sgml             1.22  ->  1.23    cutting-edge/chapter.sgml
cvsup.sgml           1.36  ->  1.40    cutting-edge/chapter.sgml
disks.sgml                 ->  1.3     disks/chapter.sgml
eresources.sgml      1.39  ->  1.50    eresources/chapter.sgml
firewalls.sgml       1.19  ->  1.20    security/chapter.sgml
handbook.sgml        1.83  ->  1.91    handbook.sgml
history.sgml         1.24  ->  1.25    introduction/chapter.sgml
install.sgml         1.65  ->  1.67    install/chapter.sgml
isdn.sgml            1.12  ->  1.15    advanced-networking/chapter.sgml
kerberos.sgml        1.12  ->  1.13    security/chapter.sgml
kernelconfig.sgml    1.31  ->  1.32    kernelconfig/chapter.sgml
kerneldebug.sgml     1.17  ->  1.19    kerneldebug/chapter.sgml
linuxemu.sgml        1.22  ->  1.24    linuxemu/chapter.sgml
memoryuse.sgml       1.11  ->  1.12    internals/chapter.sgml
mirrors.sgml         1.80  ->  1.92    mirrors/chapter.sgml
nutshell.sgml        1.14  ->  1.15    introduction/chapter.sgml
pgpkeys.sgml         1.25  ->  1.28    pgpkeys/chapter.sgml
policies.sgml        1.16  ->  1.18    policies/chapter.sgml
porting.sgml         1.93  ->  1.112   contrib/chapter.sgml
ports.sgml           1.29  ->  1.31    ports/chapter.sgml
printing.sgml        1.21  ->  1.22    printing/chapter.sgml
relnotes.sgml        1.24  ->  1.28    introduction/chapter.sgml  [1]
submitters.sgml      1.161 ->  1.246   contrib/chapter.sgml
synching.sgml        1.12  ->  1.13    cutting-edge/chapter.sgml
userppp.sgml         1.28  ->  1.30    ppp-and-slip/chapter.sgml

[1] A chunk of relnotes.sgml is in an IGNORED marked section. Why?

Submitted by:	A bunch (~ 50%) of merging done by Charles A. Wimmer
                (cawimm@FreeBSD.ORG), rest by Nik.
1998-11-12 01:26:39 +00:00
Nik Clayton
6ff34ef882 Replace
<xref linkend="target" remap="foo">

with

    <link linkend="target">foo</link>

Internal links within the Handbook now do the right thing.
1998-11-05 23:28:48 +00:00
Nik Clayton
336215d4e6 Added chapter.decl, which contains a declaration for a DocBook chapter.
Added

<!--
     Local Variables:
     mode: sgml
     sgml-declaration: "../chapter.decl"
     sgml-indent-data: t
     sgml-omittag: nil
     sgml-shorttag: nil
     sgml-always-quote-attributes: t
     sgml-minimize-attributes: max
     sgml-parent-document: ("../handbook.sgml" "part" "chapter")
     End:
-->

to the bottom of each chapter.sgml file so that Emacs can do the right
thing.
1998-11-03 23:28:30 +00:00
Nik Clayton
2207769022 Split the handbook into individual files. Each chapter is in a file called
chapter.sgml in a directory named according to the value the id
attribute on that chapter.

Added chapters.ent, which lists the entities for each chapter.

Updated handbook.sgml to use these entities.
1998-11-03 23:17:06 +00:00