PhD seems to handle different way two similar cases

[email protected] (Laurent Laville)
Newsgroups php.pear.doc
Message-ID <[email protected]>
Hello,

As I don't know if it's the default behavior of PhD, or not yet 
implemented, or again just a bug, I prefer to ask.

On my work to migrate an external guide [1] to new PEAR Manual, I found 
a case that is not handle in same way by PhD.

I'll try to explain now.

=== 1. ===
The main page of QFAMS [2] provide a title with an introduction just 
followed by a table of contents.

Current render with PhD 0.4.3 gave something like
---------------------------------------------------------
HTML_QuickForm_advmultiselect

Element for HTML_QuickForm that emulate a multi-select.

Table of Contents

     * Summary
     * Reference guide
----------------------------------------------------------

If we have a look on html code given by "xhtml" renderer we can see 
something like:

<div class="book">
  </p><div class="info">
   <h1 class="title">HTML_QuickForm_advmultiselect</h1>

   <div class="abstract">
    <p class="para">
     Element for HTML_QuickForm that emulate a multi-select.
    </p>
   </div>
  </div><p>

  <strong>Table of Contents</strong>
  <ul class="chunklist chunklist_book">

   <li><a 
href="package.html.html-quickform-advmultiselect.summary.html">Summary</a></li>
   <li><a 
href="package.html.html-quickform-advmultiselect.ref.html">Reference 
guide</a></li>
  </ul>
</div>

-- DocBook source code is : ----------------------

<book xmlns="http://docbook.org/ns/docbook" version="lillet" 
xml:id="package.html.html-quickform-advmultiselect">
  <info>
   <title>HTML_QuickForm_advmultiselect</title>
   <abstract>
    <para>
     Element for HTML_QuickForm that emulate a multi-select.
    </para>
   </abstract>
  </info>

  <chapter xml:id="package.html.html-quickform-advmultiselect.summary">
   <info><title>Summary</title></info>

... blah blah ...

  </chapter>

  <chapter xml:id="package.html.html-quickform-advmultiselect.ref">
   <info><title>Reference guide</title>
   <abstract>

   <simpara>
    This reference describes every method in the 
HTML_QuickForm_advmultiselect class.
   </simpara>

... more intro here ...

   </abstract>
   </info>

  </chapter>

</book>
--------------------------------------------------
Until now, no problem, output is what I expected.


=== 2. ===
Now the different way in almost the same condition.

The "Reference guide" chapter has an introduction <abstract> tag 
followed by a table of contents (list of <renfentry>).


But output is different, TOC first, followed by introduction; something 
like :
---------------------------------------------
Reference guide
Table of Contents

     * constructor 
HTML_QuickForm_advmultiselect::HTML_QuickForm_advmultiselect -- Class 
constructor
     * HTML_QuickForm_advmultiselect::getElementCss -- Gets default 
element stylesheet for a single multi-select shape render
     * HTML_QuickForm_advmultiselect::getElementJs -- Returns the 
javascript code generated to handle this element
     * HTML_QuickForm_advmultiselect::setButtonAttributes -- Sets the 
button attributes
     * HTML_QuickForm_advmultiselect::setElementTemplate -- Sets element 
template
     * HTML_QuickForm_advmultiselect::toHtml -- Returns the HTML 
generated for the advanced mutliple select component

This reference describes every method in the 
HTML_QuickForm_advmultiselect class.

... more blah blah of intro ...
---------------------------------------------
"xtml" renderer produced such html code :

<div class="chapter" id="package.html.html-quickform-advmultiselect.ref">
   </p><div class="info"><h1>Reference guide</h1>

<div class="TOC">
  <strong>Table of Contents</strong>
  <ul class="chunklist chunklist_chapter">
   <li><a 
href="package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.html-quickform-advmultiselect.html">constructor 
HTML_QuickForm_advmultiselect::HTML_QuickForm_advmultiselect</a> -- 
Class constructor</li>
   <li><a 
href="package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.getelementcss.html">HTML_QuickForm_advmultiselect::getElementCss</a> 
-- Gets default element stylesheet for a single multi-select shape 
render</li>
   <li><a 
href="package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.getelementjs.html">HTML_QuickForm_advmultiselect::getElementJs</a> 
-- Returns the javascript code generated to handle this element</li>

   <li><a 
href="package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.setbuttonattributes.html">HTML_QuickForm_advmultiselect::setButtonAttributes</a> 
-- Sets the button attributes</li>
   <li><a 
href="package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.setelementtemplate.html">HTML_QuickForm_advmultiselect::setElementTemplate</a> 
-- Sets element template</li>
   <li><a 
href="package.html.html-quickform-advmultiselect.html-quickform-advmultiselect.tohtml.html">HTML_QuickForm_advmultiselect::toHtml</a> 
-- Returns the HTML generated for the advanced mutliple select 
component</li>
  </ul>

</div>

   <div class="abstract">

   <p class="simpara">
    This reference describes every method in the 
HTML_QuickForm_advmultiselect class.
   </p>
---------------------------------------------


In summary:
<book> -> <info> -> <abstract>
==> text intro follow by table of contents

<chapter> -> <info> -> <abstract>
==> table of contents follow by text intro


What do you think ?

Laurent Laville

[1] 
http://www.laurent-laville.org/pear/HTML_QuickForm_advmultiselect/docs/TDG/en/index.html
[2] HTML_QuickForm_advmultiselect
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.