Date: Wed, 31 Jan 2001 05:44:43 +0000 From: Nik Clayton <nik@freebsd.org> To: doc@freebsd.org Subject: Basing freebsd.dtd on DocBook 4.1 Message-ID: <20010131054443.A13461@canyon.nothing-going-on.org>
next in thread | raw e-mail | index | archive | help
--pf9I7BMVVzbSWLtt
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Hi folks,
I think it's time to consider basing the FreeBSD Docbook customisation
layer on DocBook 4.1, rather than 3.1.
Rather than suggest that we cut all documentation over at once, I'm
planning on
1. Committing doc/share/sgml/freebsd41.dtd. This will be based on
the existing freebsd.dtd, but with a couple of minor changes.
The first patch attached to this message contains those changes.
2. Update doc/share/sgml/catalog to list the new FPI. The second
patch contains that change.
3. Work through the documentation set, changing them from using 3.1
to 4.1, changing some of the markup as necessary (where elements
were renamed, removed, or the content model was altered). I've
attached a patch to the Committer's Guide document, which shows
the sorts of changes that will be necessary.
Any thoughts, or objections?
N
--
Internet connection, $19.95 a month. Computer, $799.95. Modem, $149.95.
Telephone line, $24.95 a month. Software, free. USENET transmission,
hundreds if not thousands of dollars. Thinking before posting, priceless.
Somethings in life you can't buy. For everything else, there's MasterCard.
-- Graham Reed, in the Scary Devil Monastery
--pf9I7BMVVzbSWLtt
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=diff41
--- freebsd.dtd Sun Jan 14 17:13:33 2001
+++ freebsd41.dtd Wed Jan 31 05:40:31 2001
@@ -1,11 +1,11 @@
<!-- FreeBSD Documentation Project, Extended DocBook DTD
- This DTD builds upon the DocBook 3.1 DTD. It extends it in order to
+ This DTD builds upon the DocBook 4.1 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.1-Based Extension//EN"
+ The FPI for this DTD is "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN"
$FreeBSD: doc/share/sgml/freebsd.dtd,v 1.8 2001/01/06 18:26:11 alex Exp $
-->
@@ -30,9 +30,6 @@
<!ENTITY % local.cptr.char.mix "|CO">
-<!ENTITY % local.notation.class "|PNG">
-<!NOTATION PNG SYSTEM "PNG">
-
<!-- OS Version attributes ...............................................
Each element has three attributes which specify which version(s) of
@@ -67,8 +64,10 @@
<!ENTITY dollar "$">
]]>
+<!ENTITY % filename.element "IGNORE">
+
<!-- Pull in the original DTD -->
-<!ENTITY % orig-docbook PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!ENTITY % orig-docbook PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
%orig-docbook;
<!-- ...................................................................... -->
@@ -111,6 +110,14 @@
<!ATTLIST MakeVar
%common.attrib;
>
+
+<!-- The content model for <filename> was changed between DocBook 3.1 and
+ 4.1. Specifically, <envar> was disallowed. There's a suggestion from
+ the DocBook maintainers that this may have been a mistake. In the
+ meantime, explicitly allow it here.
+
+ In addition, allow our custom addition, <makevar> -->
+<!ELEMENT Filename - - (%smallcptr.char.mix;|Envar|MakeVar)+>
<!-- ...................................................................... -->
<!-- General entities for reuse ........................................... -->
--pf9I7BMVVzbSWLtt
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="catalog.patch"
Index: catalog
===================================================================
RCS file: /home/ncvs/doc/share/sgml/catalog,v
retrieving revision 1.13
diff -u -r1.13 catalog
--- catalog 2001/01/06 18:39:27 1.13
+++ catalog 2001/01/14 17:14:25
@@ -14,6 +14,9 @@
PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN"
"freebsd.dtd"
+PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN"
+ "freebsd41.dtd"
+
PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"
"man-refs.ent"
--pf9I7BMVVzbSWLtt
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="article.patch"
Index: article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO_8859-1/articles/committers-guide/article.sgml,v
retrieving revision 1.49
diff -u -r1.49 article.sgml
--- article.sgml 2001/01/25 00:09:15 1.49
+++ article.sgml 2001/01/31 05:29:54
@@ -1,4 +1,4 @@
-<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
+<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
%man;
@@ -10,7 +10,7 @@
]>
<article>
- <artheader>
+ <articleinfo>
<title>Committer Guide</title>
<authorgroup>
@@ -34,7 +34,7 @@
start, and existing committers are strongly encouraged to review it
from time to time.</para>
</abstract>
- </artheader>
+ </articleinfo>
<sect1 id="admin">
<title>Administrative Details</title>
@@ -1968,6 +1968,9 @@
file.</para>
<segmentedlist>
+ <segtitle>Revision number</segtitle>
+ <segtitle>Change</segtitle>
+
<seglistitem>
<seg>1.1.1.1</seg>
<seg>vendor import</seg>
--pf9I7BMVVzbSWLtt--
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010131054443.A13461>