Commit graph

3 commits

Author SHA1 Message Date
Nik Clayton
5b1efe184f This is a DSSSL stylesheet. It builds upon Norm Walsh's modular
DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it
in three ways.

First, Norm's stylesheets have a number of documented 'knobs' that can be
twiddled to produce specific effects. For example, one of the options I've
turned on names the generated HTML files after the id attribute of a
section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'.

Second, some of Norm's design choices don't follow our existing practice.
For example, we indicate application names in bold, command names in a
monospace font. Norm's sheets just render command names in bold. So we
override his definition with our own for some elements.

Thirdly, we tell the stylesheet about elements that don't exist in DocBook
but do exist in our extended DTD.

Tim Vanderhoek is probably sliding off his seat about now :-)

There's more that needs doing to this, but it's enough to get start with.
1998-06-30 08:52:15 +00:00
Nik Clayton
44198605b2 Catalog file to map the FPI "-//FreeBSD//DTD DocBook V3.0-Based Extension//EN"
back to a filename.
1998-06-29 08:10:48 +00:00
Nik Clayton
c6bb359c12 DTD for the FreeBSD Documentation Project.
Extends DocBook v3.0, with (currently) the following additions.

 1. <hostid>, <username>, <devicename>, <makevar>, and <maketarget> have
    been added. Sample uses would be be.

      <para>By convention, the the local machine can always be referred
	to as <hostid>localhost</hostid>, with the IP address
	<hostid role="ipaddr">127.0.0.1</hostid>.</para>

      <para>The most powerful account on the system is
	<username>root</username>, able to leap tall buildings in a single
	bound.</para>

      <para>Some devices have an entry in <filename>/dev</filename>. For
	example, <filename>/dev/cuaa0</filename> corresponds to
	<devicename>sio0</devicename>. Other devices, such as
	<devicename>ed0</devicename> do not have entries in
	<filename>/dev</filename>.

      <para>To rebuild the system, use the <maketarget>world</maketarget>
	target. If you do not want to build profiled libraries then ensure
	that <makevar>NOPROFILE</makevar> is set.</para>

 2. <FAQList> has been added as a new list type, with its own listitem.

    Use like so;

      <FAQList>
	<FAQListItem>
	  <FAQQuestion>
	    <para>I have bad blocks on my hard drive!</para>

	    <!-- Nothing restricting a question to one paragraph -->
          </FAQQuestion>

	  <FAQAnswer>
	    <para>With SCSI drives, the drive should be capable&hellip;</para>

	    <para>&hellip;</para>
          </FAQAnswer>
	</FAQListItem>
      </FAQList>

    Long winded, but comprehensive, and in keeping with the rest of DocBook.

As I convert the handbook from LinuxDoc to DocBook I'm working on an
extensive markup guide for the project, where constructs like these will be
fully documented.
1998-06-29 08:08:52 +00:00