<literal remap=..> -> <literal>
<command remap=..> -> <command>
Or deleted <emphasis ..> altogether in some cases.
More redundant <para>..</para>'s removed.
things.
I'm now working through from the beginning of the handbook to end,
correcting as I go. I'll commit in chunks of 5,000 lines (or
thereabouts).
Most of the changes fall into the following categories.
* <emphasis remap=bf> --> <emphasis>
* Spurious <para>s around <*list>s deleted (but not reformatted)
"C-c -" in Emacs SGML mode (when the point is on an element starting
or end tags) will delete that element's starting or end tags.
* Marked smileys with <!-- smiley --> for possible future deletion
* Deleting <emphasis>, around
<term><emphasis>...</emphasis></term> -> <term>...</term>
* Fine tuning markup choices in some cases
- <filename>C:</filename> -> <devicename>C:</devicename>
* Extra <note>s here and there.
* Some <*list>s to <procedure> (and <listitem>s to <step>)
* ASCII emphasis converted to <emphasis>
i.e., do it like *this* -> do it like <emphasis>this</emphasis>
* <symbol> -> <replaceable>
There are very few whitespace changes, although a few have probably
cropped up. The vast majority of the whitespace changes will happen in
one megacommit, hopefully some time next week.
This does the first 5,000 lines or so.
this (in Emacs) by searching for
\s-+</para>
and replacing with
</para>
Do this for all occurences *except* where the element immediately before
the </para> is one of <itemizedlist>, <orderedlist>, <variablelist>,
<procedure>. The <para>...</para> wrapping these elements is mostly
redundant, and will be removed later.
<para> There is some leading space here.</para>
Get rid of it, doing an emacs search/replace for
<para> +\([^ ]\)
and replacing with
<para>\1
This can be done globally.
Some parts of the handbook had single spaces after stops, some had double
or triple. While the typographical convention for monospaced fonts may
be to use double spaces after them, that doesn't apply here. TeX will
ignore them, as will HTML. If we need them for a plain text version of the
Handbook then the stylesheet / conversion mechanism can insert them
as necessary.
Searching for
_\([;:!\.\?,]\) +_
in Emacs and replacing with
_\1 _
(ignore the '_', they're just to delineate the regexps) does the job
quite nicely. However, you can't do this everywhere, since some of the
double spaces might be in program listings or other literal sections
(e.g., the BSD Copyright), so you need to sit and bounce on the 'y' or
'n' key as appropriate for each occurance of a stop.
In some cases <informalexample> wasn't appropriate, and the markup was
changed to <programlisting> or other.
In some cases there were spurious <para> elements before and after the
<informalexample>. These were removed.
Reformatted text within <screen> elements because the whitespace *is*
significant.
Added <prompt> and <userinput> elements within <screen> where necessary.
If I spotted inappropriate use of markup within the immediate vicinity
of the <informalexample> elements then I fixed that (mostly the use of
<emphasis remap="...">).
This is part one of these changes -- there's a load of them, and this
goes up to line 11,284 or thereabouts, roughly one third of the way
through.
contract, start contract, work too many hours per day) I'm back working
on the DocBook conversion :-)
Create two new entities, prompt.root and prompt.user. Use these where the
user is shown an OS prompt, to indicate whether they should be a normal
user or do it as root.
Everything else that looks like a prompt (e.g., C:\> which occurs here
and there) is also marked up as <prompt>.
and near it. Most of the time this consisted of replacing the <emphasis>
with <replaceable> or <userinput>. Sometimes <screen> is the wrong element
to use, and will need replacing with something like <programlisting> or
<literallayout>.
command(number)) from the variety of different existing markup
(which included <command>, <emphasis>, and <ulink>s to man2html
CGI scripts) to a common format, which is
<citerefentry>
<refentrytitle>command</refentrytitle>
<manvolnum>number</manvolnum>
</citerefentry>
although in the interests of keeping the changes as simple as possible
for the translators, the above was flattened on to one line.
to link to it any more, and the version on my website is currently more
up to date. An AltaVista search to see if any one else had linked to it
didn't turn up anything, so I think this is pretty safe. I'll 'cvs remove'
the directory and its files shortly.
them with the correct markup.
The only quotes left now are either around items for which I'm not 100%
sure which element to use, or in literal blocks as part of commands the
user types in.
so I can check my progress, partly so that others can offer comments on
the result of the conversion.
See <URL:http://www.freebsd.org/~nik/handbook/book01.htm> for the first
results. Keep in mind that the conversion has not been fine tuned in any
way. That said, comments are welcome.
The file:/usr/src/sys/i386/boot/biosboot/README.386BSD is probably false,
but I don't have a checked out tree at hand, and I'd rather would let that
point to some http or ftp source (at least alternatively). Will check later
today.
Submitted by: "SSC Webmaster" <wwwadmin@ssc.com>
markup something that looks like a filename as <filename>...</filename>,
rather than <emphasis role="tt">...</emphasis> or whatever.
These changes can not be automated, the Japanese team will need to go
through the diffs to see which bits of markup have changed.
I'm halfway through (line 16704). It's been quite instructive, and I'm
learning lots about printing with FreeBSD :-)
Join me tomorrow, when I'll be doing the same thing to the other half of
the Handbook -- same Bat time, same Bat channel.
in English, to be consistent with the doc/ja/ hierarchy.
Rather than moving the existing FAQ and Handbook over to this directory,
they will be converted to the DocBook DTD, and the results of the conversion
will be committed to this new hierarchy. The existing doc/faq and
doc/handbook can then be removed.
The README file will be used to explain the current state of the DocBook
conversion process for the Handbook, so that people without easy access
to the CVS logs can keep track of what's going on, and lend a hand where
appropriate.
I plan to start converting the Handbook around 1830 BST.
clean up the build process a wee bit.
The basic change: instead of cheacking out bits and pieces of the
doc tree into the web build tree, check out the doc tree somewhere
else and put in a few symlinks from the web tree to the doc tree.
On catfish (soon to be hub) for example:
/usr/local/www/build/doc/...
/usr/local/www/build/www/...
where
/usr/local/www/build/www/data/handbook -> ../../doc/handbook
You have to manually put in the symlinks at the moment, but it
works better than the evil CVS hackery.
Also, install with -C to help avoid gratuitous cache-busting due to
gratuitous timestamp twiddling.
. Removed references that dangerously dedicated disks won't boot. Several
people on -questions have proved me wrong.
. Add credit to Greg Lemis for the above note.
Submitted by: Doug White <dwhite@gdi.uoregon.edu>
I have not personally done a "make world" since the 386BSD + patchkit days
so additional reviews from people who have would be good.
Submitted by: Nik Clayton <nik@blueberry.co.uk>
<code> seems to be not-liked by our HTML conversion right now, so I've
switched over to <tscreen><verb> sections which should accomplish the
same effect (and also look consistent with other examples).
that were revealed. Note: I didn't go through all of
the tutorials, so there is still some work to be
done here.
Made mailing addresses consistent with the handbook.
E.g:
freebsd-questions@FreeBSD.ORG
instead of:
questions@freebsd.org
Yes, this is supposed to be a new top level in the repository.
For the moment any changes to this area must be cleared by myself
or Jordan. Once the kinks are worked out, the policy will probably
be relaxed.
