Bug #51667 [Asn]: improve fieldsynopsis (property) rendering in descriptions

Edit report at http://bugs.php.net/bug.php?id=51667&edit=1 ID: 51667 Updated by: danielc@php.net Reported by: danielc@php.net Summary: improve fieldsynopsis (property) rendering in descriptions Status: Assigned Type: Bug Package: Doc Build problem PHP Version: Irrelevant Assigned To: bjori New Comment: Some OOP methodsynopsis in our existing DocBook sources are marked up inside classsynopsis, even though the standard is to just have them on their own. So, while you're doing the fieldsynopsis changes, it seems like a good idea to also adjust the rendering engine produce the same HTML either way. DOCBOOK WITH CLASSYNOPSIS ------------------------- <classsynopsis> <ooclass><classname>XMLWriter</classname></ooclass> <methodsynopsis> <type>bool</type><methodname>openURI</methodname> <methodparam><type>string</type><parameter>uri</parameter></methodparam> </methodsynopsis> </classsynopsis> STANDARD DOCBOOK ---------------- <methodsynopsis> <type>bool</type><methodname>XMLWriter::openURI</methodname> <methodparam><type>string</type><parameter>uri</parameter></methodparam> </methodsynopsis> SHOULD BOTH PRODUCE THE FOLLOWING HTML -------------------------------------- <div class="methodsynopsis dc-description"> <span class="methodname"><b>XMLWriter::openURI</b></span>() </div> Previous Comments: ------------------------------------------------------------------------ [2010-04-26 18:06:17] danielc@php.net The following patch has been added/updated: Patch Name: fieldsynopsis-site.css Revision: 1272297977 URL: http://bugs.php.net/patch-display.php?bug=51667&patch=fieldsynopsis-site.css&revision=1272297977 ------------------------------------------------------------------------ [2010-04-26 18:04:47] danielc@php.net Description: ------------ Here are suggestions on improving how fieldsynopsis elements are rendered inside description sections, per discussion on php-doc ("improving object oriented / procedural combinations", http://news.php.net/php.doc/969381741). The CSS changes are attached. The DocBook sources and proposed HTML output are entered below. STATIC ------ DocBook: <classsynopsis> <ooclass><classname>foo</classname></ooclass> <fieldsynopsis> <modifier>public</modifier> <modifier>static</modifier> <type>int</type> <varname>bar</varname> </fieldsynopsis> </classsynopsis> HTML: <div class="refsect1 description"> <h3 class="title">Description</h3> <p class="para">Object oriented style</p> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">int</span> <span class="classname">foo</span>::$<var class="varname">bar</var> </div> </div> ------------ OBJECT ------ DocBook: <classsynopsis> <ooclass><classname>foo</classname></ooclass> <fieldsynopsis> <modifier>public</modifier> <type>int</type> <varname>bar</varname> </fieldsynopsis> </classsynopsis> HTML: <div class="refsect1 description"> <h3 class="title">Description</h3> <p class="para">Object oriented style</p> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="type">int</span> $<span class="classname">foo</span>-&gt;<var class="varname">bar</var> </div> </div> ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/bug.php?id=51667&edit=1