OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook-apps message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Trouble with funcynopsis


I am using xmlmind xmleditor for editing docbook files and produce html / pdf documents.

I have had a lot of trouble in finding the correct way to represent function syposis for php, which is a typeless (or loosely typed) language.

The worst part is, even if I add type info to all function parameters, some weird stuff happens.

The XSL transforms applied are apparently taken from a stock dockbook-xsl-1.70.1.

Here's the xml source (4.4 dtd):
        <funcsynopsis>

          <funcprototype>
            <funcdef>$myVal = new <function>xmlrpcval</function></funcdef>
            <paramdef></paramdef>
          </funcprototype>

          <funcprototype>
            <funcdef>$myVal = new <function>xmlrpcval</function></funcdef>
            <paramdef><type>string</type><parameter>$stringVal</parameter></paramdef>
          </funcprototype>

          <funcprototype>
            <funcdef>$myVal = new <function>xmlrpcval</function></funcdef>
            <paramdef><type>mixed</type><parameter>$scalarVal</parameter></paramdef>
            <paramdef><type>string</type><parameter>$scalartyp</parameter></paramdef>
          </funcprototype>

        </funcsynopsis>

What I get is:

- for first prototype, an emtpy line with a semi-colon is appended to the line with the function prototype. Probably because there is an empty paramdef.
Is there a better way to specify functions taking no arguments?

- for second prototype, I get "string$stringVal;" on a line by itself, no whitespace separating param type and name (ugly)

- for third one, I get this:

$myVal = new xmlrpcval(	$scalarVal, 	 
                        $scalarVal, 	 
                        $scalartyp);	 
mixed 	$scalarVal;
string 	$scalartyp;

ie. the first param is repetaed twice, while param names are separated form param types using a table-like layout

Shall I file bugs on the sf.net docbook project?

Thanks
Gaetano Giunta

ps: the complete html generated follows, with a slight formatting added:
<div class="funcsynopsis">
<p><code class="funcdef">$myVal = new <b class="fsfunc">xmlrpcval</b>(</code><code>)</code>;<br><code></code>;</p>
<p><code class="funcdef">$myVal = new <b class="fsfunc">xmlrpcval</b>(</code><var class="pdparam">$stringVal</var><code>)</code>;<br><code>string<var class="pdparam">$stringVal</var></code>;</p>
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">$myVal = new <b class="fsfunc">xmlrpcval</b>(</code></td><td><var class="pdparam">$scalarVal</var>, </td><td>&nbsp;</td></tr><tr><td>&nbsp;</td><td><var class="pdparam">$scalarVal</var>, </td><td>&nbsp;</td></tr><tr><td>&nbsp;</td><td><var class="pdparam">$scalartyp</var><code>)</code>;</td><td>&nbsp;</td></tr></table>
<table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>mixed</code>&nbsp;</td><td><code><var class="pdparam">$scalarVal</var>;</code></td></tr><tr><td><code>string</code>&nbsp;</td><td><code><var class="pdparam">$scalartyp</var>;</code></td></tr></table>
</div>


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]