cc (original msg : peardoc mailing list)

Hi Pear guys !

Here is an exhaustive list of changes (for the Pear documentation) you'll have to do to migrate to Docbook 5. I've build a test .manual.xml version (I've some changes as described in the list) if you want to process it with PhD (http://iutinfoa1.free.fr/SoC/.manual.xml) and a buggy CHM version processed by PhD with PHP theme (http://iutinfoa1.free.fr/SoC/pear_manual_en.chm).

The Pear XHTML/CHM theme will come soon !

List of changes to migrate to DB5 :

* changes doctype declaration :
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.0//EN"
"docbook-xml/docbook.dtd" [

* add the phpdoc/docbook/docbook-xml folder in peardoc/

* adds in the doctype declaration (between square brackets) of manual.xml :
<!ENTITY % isopub            SYSTEM "dbxml/ent/iso-pub.ent">
<!ENTITY % isonum            SYSTEM "dbxml/ent/iso-num.ent">
<!ENTITY % isolat1            SYSTEM "dbxml/ent/iso-lat1.ent">
<!ENTITY euro "&#x20AC;">
%isopub;
%isonum;
%isolat1;

* ; expected (even for DB 4.3) in :
en/package/console/console-commandline.xml line 7
en/package/console/console-commandline/intro.xml line 24
en/package/webservices/services-google/intro.xml line 10

* <chapterinfo>, <bookinfo>, <sect1info>, <refentryinfo> and <refsynopsisdivinfo> become <info>
* <title>, <subtitle> and <titleabbrev> have to be before <info>

* replaces all the attributes lang and id by xml:lang and xml:id

* <firstname> and <surname> have to be surrounded by <personname>
* <authorblurb> is replaced by <personblurb> (in <author>)

* all <ulink url="..."> became <link xmlns:xlink="http://www.w3.org/1999/xlink"; xlink:href="...">

* <abstract> has now to be surrounded by <info> (if there was a <title> before <abstract>, it has to be surrounded too)

* <userinput> and <filename> couldn't be surrounded by <command> anymore

* <option>, <optional>, <type> and <constant> cannot be surrounded by <parameter> anymore.
* <optional> can be replaced by the attribute choice="opt" in <paramdef>

* <constant> (as in &true; &false; and &null;) cannot be surrounded by <parameter> anymore

* <graphic> has to be replaced by <mediaobject><imageobject>

* <interface> is no longer exists

* to put <refentry> in a <sect1-5>, it's needed to replace it with <section>

* <function> cannot surround neither <classname> nor <methodname>

* <methodsynopsis> has now to include <void> if there is no parameter

Regards,
Rudy Nappée

Reply via email to