PhD: PHP DocBook Rendering System

For PhD documentation see the PhD: The definitive guide to PHP's DocBook Rendering System section.

PhD releases:

Version 1.1.10

  • PhD_Generic
    • Render segmentedlist elements as XHTML tables (Adam)
  • PhD_PHP
    • Fix phd:chunk="false" (Adam)
    • Render segmentedlist elements as XHTML tables (Adam)
  • PhD_PEAR
    • Render segmentedlist elements as XHTML tables (Adam)

Version 1.1.9

  • PhD_Generic
    • Removed <em> wrapper around parameters. (Levi)
  • PhD_PHP
    • Fixed bug #66644 - Remove ()'s when rendering methodname in constructorsynopsis/destructorsynopsis (Peter)
  • PhD_PEAR

Version 1.1.8

Version 1.1.7

  • Fixed bug #64850 - move placement of space between <type> and <methodname>. (Peter)
  • Fixed bug #66316 - HTML is malformed. (Peter)
  • Fixed bug PhD generates garbled chm on PHP 5.4.0 or later. (Yoshinari)
  • Change the unknown version reference to Git, not SVN. (Adam)
  • PhD_Generic
  • PhD_PHP
  • PhD_PEAR

Version 1.1.6

  • Fixed indexing of content with markup. (Hannes)
  • Added support for generate-changelog-for, extension-membership and related phpdoc PI. (Hannes)
  • PhD_Generic
  • PhD_PHP
    • Added phd:args support for <function;> and <methodname>. (Hannes)
  • PhD_PEAR

Version 1.1.5

  • Show individual package version in --version. (Hannes)
  • Fixed bug #54217 - Warn about nonexisting parameters. (Moacir)
  • Fixed bug #50725 - Generate nav links at top of function index (Peter Cowburn)
  • Fixed bug #47392 - Option to specify filename for bightmls. (Hannes)
  • PhD_Generic
    • Fixed bug #46772 - Add class reference pages to the man files. (Hannes)
    • Fixed bug #47650 - Overwrite the TOC on changes. (Hannes)
    • Fix invalid ID on multiple unknown refsect roles. (Hannes)
    • Added support for "soft-deprecation-notice" attribute on refsynopsisdiv to collect alternate suggestions into the $setup phpweb array. (Hannes)
  • PhD_PHP
  • PhD_PEAR

Version 1.1.4

  • PhD_Generic
  • PhD_PHP
    • Link callable types (Jakub)
    • Link langauge constructs from <function> (Jakub)
    • Show "next" link on the frontpage (Moacir)
  • PhD_PEAR

Version 1.1.3

  • Removed redundant align and valign attributes on table-related tags (Alexey Borzov)
  • PhD_Generic
    • Allow link to methodsynopsis (Jakub Vrana)
    • Got rid of presentational tags: <b>, <i>, <tt> changed to <strong>, <em>, <code> (Alexey Borzov)
    • Make presentational attributes on table related-tags (align, valign, width) output as inline styles (Alexey Borzov)
    • Fixed ID generation for refsections (Alexey Borzov)
  • PhD_PHP
    • Changed <b> tag to <strong> (Alexey Borzov)
  • PhD_PEAR
    • Fixed bug #54208 - No attributes for table-related tags (Alexey Borzov)
    • Allow linking to refsections (Alexey Borzov)
    • Package now generates (almost) valid HTML5:
      • Got rid of presentational tags: <b>, <i>, <tt> changed to <strong>, <em>, <code> (Alexey Borzov)
      • <p> tags are now properly closed before block level tags and reopened after them if needed (Alexey Borzov)

Version 1.1.2

  • Fixed bug #51853 - Added phpdoc PI handler to handle manually added version information (Hannes)
  • Fixed bug #49927 - Added the possiblity of adding version information for classes
  • PhD_Generic
    • Added support for authorinitials, printhistory, revhistory, revision and revremark (Hannes)
    • Added generate-index-for=(refentry,function,examples) support for the phpdoc PI handler
  • PhD_PHP (released 18 Jun 2011)
    • Use transliteration for the Windows CHM TOC and Index - Romanian only (Richard Q)
    • Allow Windows CHM files to use the url() loaded content defined in the CSS files (Richard Q)
  • PhD_PEAR (released 18 Jun 2011)
    • Use transliteration for the Windows CHM TOC and Index - Romanian only (Richard Q)

Version 1.1.1

  • Improved the performance of the indexer by ~ 75%. (Hannes)
  • Added --quit option to quit after processing command line params. Useful when used with --saveconfig to just save the config (Richard Quadling)
  • Output directory can now be nested (for example /rendering/PHP/en) (Richard Quadling)
  • New translations:
    • Spanish (Pablo Bangueses)
    • Serbian (Nikola Smolenski)
  • Added --packagedir option to use external packages. (Moacir)
  • Added Format::getDebugTree() method to allow the current location in the tree to be reportable. (Richard Quadling)
  • Fixed bug #52664 - "Missing" example#1. (Hannes)
  • PhD_Generic
    • Fixed bug #54705 - Tables in manpages not visible. (Hannes)
  • PhD_PHP
    • Added support for local CSS files (Richard Quadling)
    • Fixed bug #54436 - gzip issues with -P PHP -f manpage (Moacir)
    • Fixed bug #53536 - Small display bug in attribute description for mysqli->insert_id. (Hannes)
  • PhD_IDE
    • Added first version of PHPStub package format (Alexey Shein)
    • Added changelog information (Philip)
    • Added the description of parameters (Moacir)

Version 1.1.0

  • Added support for package cli options (Moacir)
  • Do not disable color configuration settings when loading from phd.config.php on Windows when saved setting is enabled (Richard Quadling)
  • Using saveconfig once no longer saves the config on every call to render (Richard Quadling)
  • Restoring a saved config now correctly sets the error reporting level to the restored verbosity (Richard Quadling)
  • PhD_Generic
    • Allow xml:id on <table> (Richard Quadling)
    • Add class="note" to <note>s generated <blockquote> (Hannes)
    • Generate an ID for <refsect1> (Hannes)
    • Generate IDS for all <example>s (Hannes)
  • PhD_PHP
    • New output format Epub (Moacir)
    • Prepare CHM rendering to use the new CSS rules (Richard Quadling)
    • Display a message when loading an external stylesheet (Richard Quadling)
    • Incorporate stylesheet names supplied at the command line into the CHM file (Richard Quadling)
    • New output format EnhancedCHM - the same as CHM but with the User Notes (Requires ext/bz2) (Richard Quadling)
  • PhD_PEAR

Version 1.0.1

  • Now searches the include-path for custom package classes in the \phpdotnet\phd namespace (Paul M Jones)
  • Added --ext command line option to specify filename extension (Paul M Jones)
  • Added --saveconfig option to generate a config file to load (Hannes)
  • Added 'package_dirs' config option to specify package directories to autoload from (Hannes)
  • Corrected grammar in Danish translation + fixed encoding (Daniel Egeberg)
  • Allow colored output on Windows, but not by default (Richard Quadling)
  • Allow <void/> as return type for methodsynopsis tags rather than <type>void</type> (Richard Quadling)
  • Added support for <sidebar> (Richard Quadling)
  • Now builds toc/* by default for the PHP package, and added --notoc option to use cached version (Philip)
  • Changed the VERBOSE_DEFAULT error level to exclude VERBOSE_TOC_WRITING messages (Philip)
  • Fixed encoding problems with the function iconv() in the CHM format (Moacir)
  • Fixed the --lang option that was creating an infinite recursion (Moacir)
  • PhD_Generic
    • Several formatting fixes for the unix manual pages (Hannes)
    • Added Generic Unix Manual pages output format (Hannes)
    • Added format_option to bold options (Philip)
    • Fixed bug #50666 - Missing entries in table (man pages) (Hannes)
    • Fixed bug #51301 - Wrong escape sequence (man pages) (Hannes)
    • Fixed bug #51346 - Extra whitespace when using <type> and plural (Daniel Egeberg)
    • Fixed bug #51514 - Added tr, th and td mappings (Patch provided by Paul M Jones) (Richard Quadling)
    • Fixed bug #51833 - Multiple paragraphs in notes render incorrectly (Daniel Egeberg)
  • PhD_PHP
    • Added the Persian language for CHM builds (Philip)
    • Made all >refentry< create a new Unix Manual Page (Hannes)
    • Create Unix Manual Page for the predefined variables too (Hannes)
    • Fixed bug #51750 - Add ()'s when rendering methodname elements (Hannes)
  • PhD_PEAR
    • Added the Persian language for CHM builds (Philip)

Version 1.0.0

  • Use textual descriptions for VERBOSE_xxx messages (Richard Quadling)
  • Added support for DBTimestamp Processing Instruction. (Moacir)
  • Added support for edition, inlinemediaobject, exceptionname, firstterm, trademark and edition Docbook5 elements. (Hannes)
  • Updated translations: (Kalle)
    • Danish
    • Swedish
  • Disabled colored output on Windows. (Kalle)
  • Stopped double encoding of entities in CHM TOC, Index and keyword lists (Richard Quadling)
  • Fixed bug #45098 - Named constants require long opt. (Hannes)
  • Fixed bug #50668 - Add xinclude processing in PhD. (Shahar Evron)
  • Fixed bug #50799 - No text mapping for screen. (Paul Jones)
  • Fixed bug #51070 - Double acronym tags in HTML output. (Moacir)
  • PhD_IDE
    • Initial Release \o/
  • PhD_Generic
  • PhD_PHP
  • PhD_PEAR
  • PhD_GeSHi
  • PhD_GeSHi11x 1.0.0

Version 0.9.1

  • Added fallback option to find English files when unable to find translated files (Richard Quadling)
  • Added VERBOSE_ERRORS, VERBOSE_INFO and VERBOSE_WARNINGS to group verbose levels (Richard Quadling)
  • Added VERBOSE_MISSING_ATTRIBUTES verbose level (Richard Quadling)
  • Separated PhD verbose messages into informational and warnings (Richard Quadling)
  • PhD verbose warning messages are colored magenta (Richard Quadling)
  • Added MediaManager->findFile() method to return full filename of required image (Richard Quadling)
  • Added the --css option (Moacir)
  • Added the --forceindex option (Christian)
  • Fixed --noindex option which did not work properly (Christian)
  • Fixed --verbose option which did not work properly (Moacir)
  • Fixed bug #45071 - Links to require/include(_once) not rendered (Moacir)
  • Fixed bug #47406 - Add support for external css (Moacir)
  • Fixed bug #48264 - No style for HTML version of php docs (Moacir)
  • Fixed bug #49547 - default of --color is true, not false (Richard Quadling)
  • Fixed bug #49675 - Missing links in SeeAlso (Moacir)
  • Fixed bug #49743 - Problem with functions both procedural and oo (Moacir)
  • Fixed bug #49839 - Patch to clean up peardoc output (Michael Gauthier)
  • PhD_Generic
    • Added support for <errortext> (Hannes)
    • Implemented PEAR request #2390: RSS feeds for PEAR Dcumentation Index (Christian)
    • Removed the format php (Moacir)
    • VERBOSE_MISSING_ATTRIBUTE message generated when missing one of the width/height attributes on imagedata (Richard Quadling)
    • VERBOSE_MISSING_ATTRIBUTE message generated when missing alt attributes on mediaobject > imagedata (Richard Quadling)
    • Fixed bug #49925 - imagedata now supports width and/or depth (becomes width and/or height) (Richard Quadling)
  • PhD_PHP
    • Added new output format TocFeed (Moacir)
  • PhD_PEAR
    • Added Next/Prev and Image Zoom buttons to CHM build (Richard Quadling)
    • Add title attribute to anchor tags so address can be seen in CHM files for external links (Richard Quadling)
    • Implemented PEAR request #2390: RSS feeds for PEAR Dcumentation Index (Christian)
  • PhD_GeSHi
    • Initial Release (Christian)
  • PhD_GeSHi11x
    • Initial Release (Christian)

Version 0.9.0

  • Use namespaces (Moacir)
  • Use PEAR classname conventions (Christian)
  • Add support for dbhtml Process Instructions (PI) (Moacir)
  • Add the --package option (Moacir)
  • Add the Generic Package (Moacir)
  • Add the phpdotnet/phd namespace (Christian)
  • Kill themes and add a concept of "packages" (Moacir)
  • Rewrite indexer (Hannes, Rudy, Moacir)
  • Rewrite program flow (Hannes)

Version 0.4.8

  • Add support for external troff highlighter in man pages (Christian)
  • Add title attribute to anchor tags so address can be seen in CHM files for external links (Richard Q.)
  • CVS->SVN langs migration (Philip)
  • Fixed bug #49006 (The manpage format groups function arguments incorrectly) (Moacir)
  • Fixed bug #49005 (Reference sign in function prototypes in the manpage rendering) (Moacir)

Version 0.4.7

  • Added support for <token> (Christian)
  • Added support for <simplesect> (Richard Q, Nilgun)
  • Improved support for <tag> classes (Christian)
  • Improved support for <variablelist> (Nilgun)
  • Updated translations:
    • Danish (Kalle)
    • Swedish (Kalle)
    • Turkish (Nilgun)

Version 0.4.6

  • Added language support with unknownversion into phpdotnet theme. (Philip)
  • phpbook/phpbook-xsl/version.xml is no longer used (Hannes)
  • Fix PEAR bug #15967: Wrong ID passed to pearweb manualFooter() (Christian)

Version 0.4.5

  • Changed copyright year to 2007-2009. (Christian)
  • Fixed PEAR chm manual title for french. (Laurent)
  • Fixed PEAR chm navbar alignment. (Laurent)
  • Fixed bug #47408 (Same image directory used for each theme). (Christian)
  • Fixed bug #47413 (PEAR themes don't work when rendered together at once). (Christian)

Version 0.4.4

  • Add support for <package> in pear theme. (Christian)
  • Replace ereg_replace with preg_replace. (Richard Quadling)
  • Implement request #47201 (Allow custom source code highlighter (e.g. Geshi)). (Christian)
  • Support <uri> and <screenshot>. (Christian)
  • Copy images automatically using MediaManager. (Christian)
  • Update polish phd translation. (Jarosław Głowacki)
  • Generate syntactically correct php files for pearweb when description or title have a quote in it. (Christian)
  • Improve object orientated version info support. (Hannes)
  • Fixed HTML problems with empty paragraphs in examples and qandaset questions. (Christian)
  • Fixed encoding issues in the Polish CHM builds. (Jarosław Głowacki)
  • Fixed bug #47362 (<h1> tag gets omitted in bightml). (Christian)
  • Fixed bug #47196 (improve render of initializer tag). (Laurent)

Version 0.4.3

  • Automatically add anchors for refsect roles. (Hannes)
  • Added description for seealso links. (Hannes)
  • Fixed a bug where prefaces had unlisted childrens. (Hannes)
  • Compressed methodnames in classsynopsis again. (Hannes)
  • Added Next/Prev and Image Zoom buttons to CHM build (Richard Quadling)
  • Fixed bug #46941 (FR: Find broken links). (Hannes)
  • Fixed bug #46931 (wrong order of the META tag in the HEAD element). (Chen Gang)
  • Fixed bug #46924 (parameter elements force incorrect line breaks). (Hannes)
  • Fixed bug #46726 (Incorrect HTML output). (Hannes)
  • Fixed bug #46714 (change deprecated ereg_replace(Since PHP 5.3.0) to preg_replace). (Chen Gang)
  • Fixed bug #45570 (PhD doesn't use the colspec "align" attribute in xhtml output). (Hannes)
  • Fixed bug #45318 (table colspec rendering issues). (Hannes)
  • Fixed bug #44598 (Much space on 'expected output' section). (Hannes)

Version 0.4.2

  • Added support for phd:chunk="false" attribute on chunks. (Christian)
  • Added Turkish support for CHM. (Nilgun)
  • Added option (-L/--lang language) to use for CHM headers. (Hannes)
  • Added support for orderedlist numeration. (Hannes)
  • Added fallback to PHP_Compat getopt() on Windows. (Christian)
  • Added anchors for tips, warnings, important and notes. (Nilgun)
  • <interfacename> now automagically links to interfaces. (Hannes)
  • Automatically use the phpdoc configure.php generated version information file if it exists. (Hannes)
  • Removed default border for formal tables. (Philip)

Version 0.4.1

  • Fixed bug #46413 Weird examples in Unix manual pages (Rudy)
  • Added varlistentries to the CHM index. (Rudy)
  • Language support (for autogenerated texts):
    • Turkish (by Nilgün Belma Bugüner)
  • Prevent prev/next errors in combination with chunking elements without ids (Christian)
  • Support double nested chunking elements without ids (Christian)
  • Make table captions render properly in peardoc (Christian)
  • add support for <arg> and <cmdsynopsis> used in peardoc (Christian)
  • Fixed bug #46415: Don't chunk first section on parent site when it has children. (Christian)
  • Implement request #46411: Allow random chunking depths (Christian)
  • Implement request #46412: Allow random TOC depths (Christian)
  • Implement request #46493: Implement new pear api linking tag (Christian)
  • Make pear chm theme work (Christian)
  • Make html generated in pear themes nearly 100% valid XHTML (Christian)
  • Make "Prev" links work correctly on last pages (e.g. last in chapter) (Christian)
  • Change double quotes to single ones, gives speedup for pear builds (Brett)
  • Docblock enhancements and Coding Standards fixes (Brett)

Version 0.4.0

  • Added PEAR XHTML theme. (Rudy, Christian)
  • Added support for new elements (Christian)
    • glossentry
    • glossdef
    • glosslist
    • important
    • paramdef
    • personblurb
    • phrase
    • prompt
    • releaseinfo
    • spanspec
    • qandadiv
  • Improved <email> support (now creates mailto: links). (Christian)
  • Chunks without xml:id are no longer chunked. (Christian)
  • Fixed bug #46252 (Class properties links to a function if theres one with the same name). (Hannes)
  • Fixed bug #46094 (and then from now on italic). (Hannes)
  • Fixed bug #45071 (Links to require/include(_once) not rendered). (Hannes)
  • Fixed a bug where it was only possible to pass one parameter to phd.bat. (Kalle)
  • Fixed a bug where it wasn't possible to have paths with spaces in when using phd.bat. (Kalle)
  • Fixed xhtml validation issue for itemizedlist. (Christian)

Version 0.3.1

  • Added PDF output format. (Rudy)
  • Added support for phpdoc:classref. (Hannes)
  • Added support for phpdoc:varentry. (Hannes)
  • Added support for the phpdoc howto. (Hannes)
  • Renamed phpdoc:exception to phpdoc:exceptionref. (Hannes)
  • Fixed bug #45627 (Unix manpages using non-standard folder name). (Rudy)
  • Fixed bug #45626 (Unix manpages should be gzipped). (Rudy)
  • Fixed bug #45618 (Bad filenames in man pages). (Rudy)
  • Fixed unclosed div element on set pages. (Hannes)

Version 0.3.0

  • Added CHM output format. (Rudy)
  • Added KDevelop (Index & Table of contents) output theme. (Rudy)
  • Added Man page output format. (Rudy)
  • Added support for phpdoc:exception. (Hannes)

Version 0.2.4

  • Fixed bug #44906 (Missing space after modifier in properties list). (Hannes)
  • Fixed bug #44881 (Class constants with $). (Hannes)
  • Fixed bug #44786 (Remove irrelevant version information). (Hannes)
  • Fixed bug #44785 (Separating <title> from <note>). (Hannes)
  • Fixed bug #44776 (Request for change in titles). (Hannes)
  • Fixed bug #44750 (Request for generic phd logger). (Hannes)
  • Fixed bug #44690 (Please restore manual main page). (Hannes)
  • Added French support (for autogenerated texts). (Yannick)
  • Added Danish support (for autogenerated texts). (Kalle Sommer)
  • Added Swedish support (for autogenerated texts). (Kalle Sommer)
  • Added experimental option (-c/--color) for color in verbose output. (Gwynne)

Version 0.2.3

  • Added initial hCalendar support for <author>. (Hannes)
  • Added initial eRDF support for <refentry>. (Hannes)
  • Added support for <footnote> and <footnoteref>. (Gwynne, Hannes)
  • Added anchor generation for various elements. (Hannes)
  • Added option (-s/--skip) to skip rendering of chunks. (Hannes)
  • Added option (-o/--output) to specify output directory (FR#43193). (Richard)
  • Added support for <sect4> titles . (Gwynne)
  • Added an 'infdec' role to <literal> in XHTML. (Gwynne)
  • Fixed couple of typos in PhD info messages. (Richard Q.)
  • Reformatted package.xml for readability and consistency. (Gwynne)
  • Merged README.RENDERER into README and updated README with current information. (Gwynne)
  • Gwynne is a developer of PhD, unfortunately. (Gwynne)
  • Made 'Example #' text localizeable. (Gwynne)
  • Added Russion support (for autogenerated texts). (Tony)
  • Updated translations:
    • Japanese (Masahiro)
    • Brazilian Portuguese (Felipe)
    • German (Mark)

Version 0.2.2

  • Removed support for phnotify. (Hannes)
  • Added index caching. (Edward Z.)
  • Added option (-l/--list) to list the supported formats/themes.(Hannes)
  • Added support for linkend in fieldsynopsis varnames. (Hannes)
  • Added autogenerated "Edited by" text for <editor>. (Hannes)
  • Added autogenerated "by" text for the first <author> element in <authorgroup>. (Hannes)
  • Added missing closing "}" for classsynopsis. (Hannes)
  • Fixed E_NOTICE on empty references. (Hannes)
  • Fixed weird error message when no arguments are given, reported by Tony. (Hannes)
  • Fixed typos in the argument descriptions (--help), reported by Tony. (Hannes)
  • Fixed bug #43972 (PhD doesn't warn on missing partial IDs). (Hannes)
  • Fixed bug #43904 (PhD doesn't detect <section> without xml:id). (Hannes)
  • Fixed bug #43489 (Class synopsis return types are not links). (Hannes)
  • Fixed bug #43440 (Wrong encoding on some parts of the page). (Hannes)
  • Fixed bug #43428 (Empty TOC). (Hannes)
  • Fixed bug #43421 (All intra-document hyperlinks broken in the Single HTML file form of manual). (Hannes)
  • Fixed bug #43416 (Function links do not render as links). (Hannes)

Version 0.2.1

  • Multiple <term>s should be line seperated. (Hannes)
  • Fixed autogenerated links to methods. (Edward Z.)
  • Compressed methodnames in classsynopsis. (Edward Z.)
  • Added HTML headers for the bightml theme. (Hannes)
  • Removed warnings about missing translation files. (Hannes)

Version 0.2.0

  • Added partial rendering. (Hannes)
  • Added various verbosity levels. (Hannes)
  • Added getopt() parsing for few configuration options. (Hannes)
  • Added support for errorcode, symbol and superscript elements (used by few translations). (Hannes)
  • Suppressed the contrib element. (Hannes)
  • Fixed bug #43192 (Chunked HTML output difficult to use without TOC). (Edward Z. Yang)
  • Fixed bug #43191 (build.php fails to included necessary theme dependencies). (Edward Z. Yang, Richard Q)

Version 0.1.0

  • Added example numbering. (Hannes)
  • Improved support for modifiers in fieldsynopsis. (Hannes)
  • Remove () from refname when looking for version info, reported by Paul Reinheimer. (Hannes)
  • Print notes inline with its title, reported by Philip Olson. (Hannes)
  • Check if we have an open "{" before we print "}". (Hannes)
  • Escape the version info. (Richard Q.)
  • Fixed variablelist titles. (Hannes)
  • Fixed table info titles. (Hannes)
  • Fixed empty table cells, reported by Mark Wiesemann. (Hannes)
  • Fixed table title markup, reported by Richard Q. (Hannes)
  • Fixed non-closing b element for empty <title />s, reported by Joshua Thompson and Philip Olson. (Hannes)
  • Fixed bug #43013 (Description rather then function name for right arrows on extension pages). (Richard Q.)
  • Fixed bug #42906 (docs.php.net bold instead of links). (Hannes)
  • Fixed bug #42860 (cannot render <orgname> element). (Hannes)
  • Fixed bug #42845 (Copyright page has no TOC). (Hannes)
  • Language support (for autogenerated texts):
    • Bulgarian (by Kouber Saparev)
    • Czech (by Jakub Vrana)
    • German (by Oliver Albers)
    • Italian (by Marco Cucinato)
    • Japanese (by TAKAGI Masahiro)
    • Polish (by Jaroslaw Glowacki)
    • Brazilian Portuguese (by Diego Feitosa)
    • Romanian (by Simion Onea)

Version 0.1.0

  • Initial release