<<< Date Index >>>     <<< Thread Index >>>

Re: Patches



Hi,

* Ralf Wildenhues [06-04-28 14:20:01 +0200] wrote:
* Rocco Rutte wrote on Fri, Apr 28, 2006 at 12:08:32PM CEST:
* Thomas Roessler [06-04-28 10:36:26 +0200] wrote:
>On 2006-04-27 23:45:58 +0000, Rocco Rutte wrote:

>>  - pdmef+fix+noent.diff
>>    This removes HTML entities from the DocBook XML manual and stops
>>    xsltproc printing tons of errors

>Need to have a look at this one; I don't see the tons of errors
>that you refer to.

I get exactly 1530 of the following errors:

Since --nonet is used, I guess the exact DTD version used would be of
interest as well, I guess.  IOW: try without --nonet and see which
errors remain.

The errors remain. I have everything installed which should matter to the build process (i.e. DocBook DTDs). For me, the attached patch solves the problem. I'm not that much of an XML expert, but it looks like mutt used the wrong doctype for the DTD it requests so I ask for applying it.

But still I want to see the entities removed (though I can confirm they're really part of the DocBook DTD in iso-num.ent somewhere in ent/ subdirectory) for several reasons.

First, with the UTF-8 encoding, there's no need to use &auml; in the ACK section. What's left is just ASCII characters and as these are just raw character data to the XSL processor, they're passed as is. It just makes the manual unreadable and unwriteable for people who want to contribute documentation. And it bloats the manual quite a lot.

For example, for writing just $header_cache_verify, we now need:

  &dollar;header&lowbar;cache&lowbar;verify

which is ugly. Also, personally I don't like being limited to DocBook only. In my opinion, DocBook is an intermediate format people convert to to get fancy HTML output, but it's not really suitable for humans to write docs in. In the very end, I think a custom mutt XML dialect is much better as it allows us to have the documentation much more consistent. That means we could have tags to reference functions and variables and let XSL add a '$' (plus the link) for variables and '<>' for functions (plus the link) automatically. The XSL processing from it to DocBook will take around a second since now it's only the DocBook XSL stylesheets taking that long.

IMHO it would be cool to have just:

  <option>header_cache_verify</option>

and let XSL expand it to:

  <link 
linkend="header-cache-verify"><literal>$header_cache_verify</literal></link>

because that's what it's for.

Oh, I could do that (or know somebody who would do it).

  bye, Rocco
--
:wq!
diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 84aa399..e6a1e4e 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -1,5 +1,5 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
 <article>