Changes between Initial Version and Version 1 of PhpdocPlugin

Timestamp:

May 29, 2009, 1:06:34 PM (15 years ago)

Author:

Robert Verspuy

Comment:

New hack PhpdocPlugin, created by exarv

PhpdocPlugin

@@ +1 @@
+= PHPDocumentor plugin for Trac =
+
+== Description ==
+
+Integrates [http://www.phpdoc.org phpdocumentor] documentation into Trac.
+
+Started as a simple copy of the DoxygenPlugin
+
+The phpdoc plugin provides a new main navigation tab (named PHPDoc by default), which will present the doxygen index page. 
+
+Configuring the PHPDoc plugin should be easy if you have only one PHPDoc generated documentation to wrap, and a bit more involved if you have many --but the goal is to have a great deal of flexibility, in the latter case.
+
+This plugin is tested with the following releases of Trac:
+
+    * Trac 0.11: Started development with Trac 0.11.3
+
+
+== Bugs/Feature Requests == 
+
+Existing bugs and feature requests for PhpdocPlugin are 
+[report:9?COMPONENT=PhpdocPlugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=PhpdocPlugin&owner=exarv new ticket].
+
+== Download ==
+
+Download the zipped source from [download:phpdocplugin here].
+
+== Source ==
+
+You can check out PhpdocPlugin from [http://trac-hacks.org/svn/phpdocplugin here] using Subversion, or [source:phpdocplugin browse the source] with Trac.
+
+== Example ==
+
+----
+=== Installation ===
+
+ - Download the zipped source.
+ - Extract the zip file
+ - Go to the phpdocplugin/0.11 directory
+ - run:
+{{{
+python ./setup.py install
+}}}
+
+This will generate a python egg and copy it into the trac/plugins directory and follow the Configuration steps outlined below.
+
+You may need to restart web server to see PHPDoc button in navigation tab.
+
+add the following to your configuration:
+
+=== Configuring Trac ===
+==== Basic Configuration ====
+A `[phpdoc]` section should be created in TracIni. 
+There's only one mandatory setting, it's the `path` to the generated documentation.
+This should match the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.target -t] parameter of the phpdoc command (if that's a relative path, you'll need to prepend the current working directory used 
+when running `phpdoc`).  Also, don't forget to grant the users the PHPDOC_VIEW permission, or you'll just get a blank page.
+
+Note that there's also the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.output -o] 
+parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'
+
+'''Example:''' [[br]]
+
+First checkout the latest version of your trunk:
+{{{
+mkdir/var/cache/phpdoc
+cd /var/cache/phpdoc
+mkdir myproject
+cd myproject
+svn co http://my.svn.server.org/svn/myproject/trunk source
+mkdir doc
+/whereever/you/installed/phpdoc -o HTML:Smarty:PHP -d source -t doc
+}}}
+Now you should have the latest source in /var/cache/phpdoc/myproject/source
+And the generated documentation in /var/cache/phpdoc/myproject/doc
+
+Now setup Trac's configuration:
+{{{
+[phpdoc]
+path = /var/cache/phpdoc/myproject/doc
+}}}
+
+The next time, you only need to run "svn up" in stead of "svn co" and runphpdoc again with the same parameters.
+
+It's possible all other options (configuration options multiple documentation projects, links in wiki) will work also, just like the ones specified with DoxygenPlugin, but I can't garranty anything.
+On a first view, it appears to work good enough for me with this source and configuration.
+
+== Recent Changes ==
+
+[[ChangeLog(phpdocplugin, 3)]]
+
+== Author/Contributors ==
+
+'''Author:''' [wiki:exarv] [[BR]]
+'''Contributors:'''