c6bb359c12
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…</para>
<para>…</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.
105 lines
3.1 KiB
DTD
105 lines
3.1 KiB
DTD
<!-- FreeBSD Documentation Project, Extended DocBook DTD
|
|
|
|
This DTD builds upon the DocBook 3.0 DTD. It extends it in order to
|
|
add some new elements.
|
|
|
|
The comment style and section headings are drawn from the DocBook DTD.
|
|
|
|
The FPI for this DTD is "-//FreeBSD//DTD DocBook V3.0-Based Extension//EN"
|
|
|
|
$Id: freebsd.dtd,v 1.1 1998-06-29 08:08:52 nik Exp $
|
|
-->
|
|
|
|
<!-- ..................................................................... -->
|
|
<!-- Entities for element classes and mixtures ........................... -->
|
|
|
|
<!-- Object-level classes ................................................ -->
|
|
|
|
<!ENTITY % local.list.class "|FAQList">
|
|
|
|
<!-- Character level classes -->
|
|
<!ENTITY % local.tech.char.class "|HostID|Username|Devicename|MakeTarget|MakeVar">
|
|
|
|
|
|
<!-- Pull in the original DTD -->
|
|
<!ENTITY % orig-docbook PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
|
|
%orig-docbook;
|
|
|
|
<!-- ...................................................................... -->
|
|
<!-- Lists ................................................................ -->
|
|
|
|
<!ELEMENT FAQList - - (FAQListItem+)>
|
|
<!ATTLIST FAQList
|
|
--
|
|
Mark: Keyword, e.g., bullet, dash, checkbox, none;
|
|
list of keywords and defaults are implementation specific
|
|
--
|
|
%mark.attrib;
|
|
%common.attrib;
|
|
>
|
|
|
|
<!-- FAQ Question/Answers ................................................. -->
|
|
|
|
<!ELEMENT FAQListItem - O (FAQQuestion, FAQAnswer)>
|
|
<!ATTLIST FAQListItem
|
|
--
|
|
Override: Indicates the mark to be used for this FAQListItem
|
|
instead of the default mark or the mark specified by
|
|
the Mark attribute on the enclosing FAQList
|
|
--
|
|
Override CDATA #IMPLIED
|
|
%common.attrib;
|
|
>
|
|
|
|
<!ELEMENT FAQQuestion - - ((%component.mix;)+)>
|
|
<!ATTLIST FAQQuestion
|
|
%common.attrib;
|
|
>
|
|
|
|
<!ELEMENT FAQAnswer - - ((%component.mix;)+)>
|
|
<!ATTLIST FAQAnswer
|
|
%common.attrib;
|
|
>
|
|
|
|
|
|
<!-- ...................................................................... -->
|
|
<!-- Inline, link, and ubiquitous elements ................................ -->
|
|
|
|
<!-- Technical and computer terms ......................................... -->
|
|
|
|
<!ELEMENT HostID - - ((%cptr.char.mix;)+)>
|
|
<!ATTLIST HostID
|
|
--
|
|
Role: More specific information about this hostname.
|
|
If not specified then the default is 'hostname'.
|
|
--
|
|
Role (Hostname
|
|
|Domainname
|
|
|FQDN
|
|
|IPAddr
|
|
|Netmask
|
|
|MAC) #IMPLIED
|
|
%common.attrib;
|
|
>
|
|
|
|
<!ELEMENT Username - - ((%cptr.char.mix;)+)>
|
|
<!ATTLIST Username
|
|
%common.attrib;
|
|
>
|
|
|
|
<!ELEMENT Devicename - - ((%cptr.char.mix;)+)>
|
|
<!ATTLIST Devicename
|
|
%common.attrib;
|
|
>
|
|
|
|
<!ELEMENT MakeTarget - - ((%cptr.char.mix;)+)>
|
|
<!ATTLIST MakeTarget
|
|
%common.attrib;
|
|
>
|
|
|
|
<!ELEMENT MakeVar - - ((%cptr.char.mix;)+)>
|
|
<!ATTLIST MakeVar
|
|
%common.attrib;
|
|
>
|
|
|
|
|