[PHP-DOC] PhD Improvements (Plugin System) - Status Report 3
hi all, This is my third status report (7 June to 13 June). This week I proposed a design for merging PhD Enterprise to HEAD http://img30.yfrog.com/img30/2370/design2.png. With that design we will be able to use all the features of PhD Enterprise and the current output formats of HEAD (using adapters), the formats will be grouped in packages and the packages are pluggable. We will reuse almost all the classes of PhD Enterprise, the PhDFormatFactory class was written in my first week. To reuse the themes of HEAD is necessary to write packages to adapt them to formats. This week I also begin coding the abstract formats and the default package. In my schedule the current task is Make concrete formats plug and play but it's already done, so my tasks now are: - Discuss the interface of the abstract formats. - Finish coding the Default package. - Begin porting the old PhD Themes to the current design. Important Note: This week we are planning to begin moving PhD to use the PEAR filename and class convention. --- You can find my schedule here: http://wiki.php.net/gsoc/2009/phdplugins Blog: http://moacirdeoliveira.blogspot.com Regards, Moacir de Oliveira
[PHP-DOC] Conforming documentation style - how to document classes
Hi, I'm not a big contributor (in fact, haven't done much more than test PhD and send some feedback) but I do work with the raw documentation quite a bit. I've found some apparent irregularities in how classes are documented. For example, the tidy.html has both procedural and OO versions of the function. The procedural version follows the convention found in other function definitions but the OO version seems to be missing the CLASSSYNOPSIS, OOCLASS, etc. elements thus there is no way to select just the OO methods. Is there an exemplary class definition in the existing documentation I could use as a foundation for fixing the structure of the Tidy classes (and other classes that I periodically run across with odd structure)? Thanks in advance. Ted Stresen-Reuter http://tedmasterweb.com
[PHP-DOC] Enterprise classes
Hello Moacir, Do I assume correctly that files like include/PhDEnterpriseReader.class.php are meant to replace include/PhDReader.class.php? -- Regards/Mit freundlichen Grüßen Christian Weiske -= Geeking around in the name of science since 1982 =- signature.asc Description: PGP signature
Re: [PHP-DOC] Conforming documentation style - how to document classes
On Jun 15, 2009, at 1:18 AM, G. T. Stresen-Reuter wrote: Hi, I'm not a big contributor (in fact, haven't done much more than test PhD and send some feedback) but I do work with the raw documentation quite a bit. I've found some apparent irregularities in how classes are documented. For example, the tidy.html has both procedural and OO versions of the function. The procedural version follows the convention found in other function definitions but the OO version seems to be missing the CLASSSYNOPSIS, OOCLASS, etc. elements thus there is no way to select just the OO methods. Is there an exemplary class definition in the existing documentation I could use as a foundation for fixing the structure of the Tidy classes (and other classes that I periodically run across with odd structure)? Greetings Ted, Do you feel like determining what might work best? This could begin the process of knowing. Let's list all OOP+Procedural API extensions then determine the differences, and use one syntax. This may or may not be a complete list (likely not, but close): - Date/datetime (toc has both) - Dir (toc has both (sort of)) - DOM (not really, but domxml is procedural) - Fileinfo (toc is procedural) - Intl (toc is oop) - MaxDB (toc is procedural) - MySQLi (toc is oop) - SQLite (toc is procedural) - Tidy (???) - XMLWriter (toc is oop) While some were Procedural but are now OOP (so they differ): - Imagick (procedural api not listed (which seems fine, as it's dead/ old)) - Tidy? (???) - Zip (partial procedural exists for BC, needs clearer definition of difference) Unsure how to classify some: - Rar (appears to use both together (weird)) - SimpleXML (not sure why the procedural exists...) Summary: - We do it differently per extension, so are inconsistent - The TOC for these also differ (lists OOP and/or Procedural) - This is a problem Notes: - Eludes to it: http://cvs.php.net/viewvc.cgi/phpdoc/RFC/skeletons/method.xml - Docgen commit to handle it: http://news.php.net/php.doc.cvs/3884 Regards, Philip
[PHP-DOC] Re: Enterprise classes
Hi Christian 2009/6/15 Christian Weiske cwei...@cweiske.de Do I assume correctly that files like include/PhDEnterpriseReader.class.php are meant to replace include/PhDReader.class.php? The classes PhDReader and PhDFormat still there just for compatibility with the themes, and now are deprecated. I don't think is a good idea remove them now. The idea is write packages that will adapt the old themes to the enterprise formats. regards, Moacir
[PHP-DOC] PhD class renamings
Hi all, especially bjori, My proposed renamings for the classes are: http://tmp.cweiske.de/phd-moveclasses Any objections? #!/bin/sh #copy phd classes around #make sure you are in phd/ mkdir PhD mkdir PhD/Format mkdir PhD/Format/Abstract mkdir PhD/Reader mkdir PhD/Theme mkdir PhD/Theme/PEAR mkdir PhD/Theme/PHP mkdir PhD/Package mkdir PhD/Package/Default mkdir PhD/data mkdir PhD/data/langs cp include/langs/*.xml PhD/data/langs/ cp formats/AbstractXHTMLFormat.php PhD/Format/Abstract/XHTML.php cp formats/manpage.php PhD/Format/Manpage.php cp formats/pdf.php PhD/Format/PDF.php cp formats/xhtml.php PhD/Format/XHTML.php cp include/PhDFormat.class.php PhD/Format/Legacy.php cp include/PhDEnterpriseFormat.class.php PhD/Format.php cp include/PhDFormatFactory.php PhD/Format/Factory.php cp config.php PhD/Config.php cp include/PhDBuildOptions.class.php PhD/BuildOptionsParser.php cp include/PhDHelper.class.php PhD/Helper.php cp include/PhDHighlighter.class.php PhD/Highlighter.php cp include/PhDIndex.class.php PhD/Index.php cp include/PhDMediaManager.class.php PhD/MediaManager.php cp include/PhDRender.class.php PhD/Render.php cp include/PhDErrors.php PhD/functions.php cp include/PhDObjectStorage.class.php PhD/ObjectStorage.php cp include/PhDTheme.class.php PhD/Theme.php cp include/PhDThemeXhtml.class.php PhD/Theme/XHTML.php cp include/PhDReader.class.php PhD/Reader/Legacy.php cp include/PhDPartialReader.class.php PhD/Reader/Partial.php cp include/PhDEnterpriseReader.class.php PhD/Reader.php cp packages/Default/DefaultFactory.class.php PhD/Package/Default/Factory.php cp packages/Default/xhtml.php PhD/Package/Default/XHTML.php cp themes/pear/pearbightml.php PhD/Theme/PEAR/BigHTML.php cp themes/pear/pearchm.php PhD/Theme/PEAR/CHM.php cp themes/pear/pearchunkedhtml.php PhD/Theme/PEAR/ChunkedHTML.php cp themes/pear/peartheme.php PhD/Theme/PEAR/Base.php cp themes/pear/pearweb.php PhD/Theme/PEAR/Web.php cp themes/php/bightml.php PhD/Theme/PHP/BigHTML.php cp themes/php/chmsource.php PhD/Theme/PHP/CHMSource.php cp themes/php/chunkedhtml.php PhD/Theme/PHP/ChunkedHTML.php cp themes/php/howto.php PhD/Theme/PHP/HowTo.php cp themes/php/phpbigpdf.php PhD/Theme/PHP/BigPDF.php cp themes/php/phpdotnet.php PhD/Theme/PHP/PHPDotNet.php cp themes/php/phpfunctions.php PhD/Theme/PHP/Functions.php cp themes/php/phpkdevelop.php PhD/Theme/PHP/KDevelop.php cp themes/php/phppdf.php PhD/Theme/PHP/PDF.php cp themes/php/phpweb.php PhD/Theme/PHP/Web.php -- Regards/Mit freundlichen Grüßen Christian Weiske -= Geeking around in the name of science since 1982 =- signature.asc Description: PGP signature
Re: [PHP-DOC] PhD class renamings
The directory structure is compatible with the intheworks namespace naming convention cs, right? (Meaning if we move to namespaces no change is needed) Shame we loose the history... but this needs to be done -Hannes On Jun 15, 2009 7:22 p.m., Christian Weiske cwei...@cweiske.de wrote: Hi all, especially bjori, My proposed renamings for the classes are: http://tmp.cweiske.de/phd-moveclasses Any objections? #!/bin/sh #copy phd classes around #make sure you are in phd/ mkdir PhD mkdir PhD/Format mkdir PhD/Format/Abstract mkdir PhD/Reader mkdir PhD/Theme mkdir PhD/Theme/PEAR mkdir PhD/Theme/PHP mkdir PhD/Package mkdir PhD/Package/Default mkdir PhD/data mkdir PhD/data/langs cp include/langs/*.xml PhD/data/langs/ cp formats/AbstractXHTMLFormat.php PhD/Format/Abstract/XHTML.php cp formats/manpage.php PhD/Format/Manpage.php cp formats/pdf.php PhD/Format/PDF.php cp formats/xhtml.php PhD/Format/XHTML.php cp include/PhDFormat.class.php PhD/Format/Legacy.php cp include/PhDEnterpriseFormat.class.php PhD/Format.php cp include/PhDFormatFactory.php PhD/Format/Factory.php cp config.php PhD/Config.php cp include/PhDBuildOptions.class.php PhD/BuildOptionsParser.php cp include/PhDHelper.class.php PhD/Helper.php cp include/PhDHighlighter.class.php PhD/Highlighter.php cp include/PhDIndex.class.php PhD/Index.php cp include/PhDMediaManager.class.php PhD/MediaManager.php cp include/PhDRender.class.php PhD/Render.php cp include/PhDErrors.php PhD/functions.php cp include/PhDObjectStorage.class.php PhD/ObjectStorage.php cp include/PhDTheme.class.php PhD/Theme.php cp include/PhDThemeXhtml.class.php PhD/Theme/XHTML.php cp include/PhDReader.class.php PhD/Reader/Legacy.php cp include/PhDPartialReader.class.php PhD/Reader/Partial.php cp include/PhDEnterpriseReader.class.php PhD/Reader.php cp packages/Default/DefaultFactory.class.php PhD/Package/Default/Factory.php cp packages/Default/xhtml.php PhD/Package/Default/XHTML.php cp themes/pear/pearbightml.php PhD/Theme/PEAR/BigHTML.php cp themes/pear/pearchm.php PhD/Theme/PEAR/CHM.php cp themes/pear/pearchunkedhtml.php PhD/Theme/PEAR/ChunkedHTML.php cp themes/pear/peartheme.php PhD/Theme/PEAR/Base.php cp themes/pear/pearweb.php PhD/Theme/PEAR/Web.php cp themes/php/bightml.php PhD/Theme/PHP/BigHTML.php cp themes/php/chmsource.php PhD/Theme/PHP/CHMSource.php cp themes/php/chunkedhtml.php PhD/Theme/PHP/ChunkedHTML.php cp themes/php/howto.php PhD/Theme/PHP/HowTo.php cp themes/php/phpbigpdf.php PhD/Theme/PHP/BigPDF.php cp themes/php/phpdotnet.php PhD/Theme/PHP/PHPDotNet.php cp themes/php/phpfunctions.php PhD/Theme/PHP/Functions.php cp themes/php/phpkdevelop.php PhD/Theme/PHP/KDevelop.php cp themes/php/phppdf.php PhD/Theme/PHP/PDF.php cp themes/php/phpweb.php PhD/Theme/PHP/Web.php -- Regards/Mit freundlichen Grüßen Christian Weiske -= Geeking around in the name of science since 1982 =-
Re: [PHP-DOC] PhD class renamings
Hi Bjori, The directory structure is compatible with the intheworks namespace naming convention cs, right? (Meaning if we move to namespaces no change is needed) No. The new namespace convention would mean that - if we chose phd as namespace (note, lowercase!), the directory wouldn't be PhD/ but phd/. Shame we loose the history... but this needs to be done We don't - philip wants to get someone to move them on the server, preserving history. -- Regards/Mit freundlichen Grüßen Christian Weiske
