Re: Moving peardoc to XSLT
| From: | Hannes Magnusson | Date: | Fri, 01 Jun 2007 09:37:38 +0000 |
| Subject: | Re: Moving peardoc to XSLT | ||
| References: | 1 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-46922@lists.php.net to get a copy of this message | ||
On 6/1/07, Christian Weiske <cweiske@cweiske.de> wrote:
Hello all, Most of you which ever tried to compile peardoc know that the dsssl stylesheets are a pain to setup and get running. Since we all want more documentation and have it easy to write documentation, we need to do something. The first thing that needs to be done is dropping the DSSSL stylesheets in favor of XSLT. It has several advantages: - XSLT is faster than DSSSL (citation needed) - I know nobody in PEAR that is familiar customizing the current dsssl stylesheets - There are some PEAR devs that know XSLT - XSLT is more easy to setup - phpdoc, php-gtk-doc and Livedocs use XSLT, too - Switching to XSLT would bring us livedocsThats not true. livedocs has (almost) nothing to do with either DSSSSSSL or XSL.
- We could finally customize the looks of the manual on the webpage and make it more user friendly. See http://www.markwiesemann.eu/tmp/pear-manual4.png and the discussion in http://news.php.net/php.pear.doc/9704 (click the references to get more shots) Since I currently am working on my diploma thesis, someone else would need to take the lead in this project. The following tasks are to be done: - Check out phpdoc and see if we can use its system with as few changes as possible - Contact phpdoc people and ask them how to start best - Contact livedoc gsoc people and ask what we need to do to be livedoc-compatible - When all info is collected, make peardoc's build system to use xslt and support different sheets - Create XSLT sheets for the website, maybe modify the standard html xslt for offline docs Having customized php-gtk-doc in a great deal, I have experience in editing XSLT. You can count on my help once this stage is reached. peardoc bug entry: http://pear.php.net/bugs/bug.php?id=10843 Livedocs gsoc project: http://de3.php.net/ideas.php and http://wiki.phpdoc.info/LiveDocsGreg and I talked about this couple of months ago (moving to XSL) and I am willing to take weekend in porting phpdoc-xsl to peardoc if you really really wants this... but I don't think its really worth the effort. I will be working on livedocs for the next few months and I would much rather spend time on peardoc+livedocs than xsl -Hannes