Changes between Version 7 and Version 8 of PhpdocPlugin

Timestamp:

Mar 22, 2016, 10:06:33 PM (8 years ago)

Author:

figaro

Comment:

Cosmetic changes

PhpdocPlugin

@@ -44 +44 @@
 You may prefer the easy_install way:
 {{{#!sh
-sudo easy_install http://trac-hacks.org/svn/phpdocplugin/0.11
+sudo easy_install https://trac-hacks.org/svn/phpdocplugin/0.11
 }}}
 
-You may need to restart web server to see PHPDoc button in navigation tab.
-
-add the following to your configuration:
+You may need to restart your web server to see a PHPDoc button in the navigation tab.
 
 == Configuration
@@ -55 +53 @@
 A `[phpdoc]` section should be created in TracIni. 
 There is only one mandatory setting, it is 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 is a relative path, you'll need to prepend the current working directory used 
-when running `phpdoc`.
+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 is 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'.
+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
@@ -73 +69 @@
 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
+/path/to/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 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:
@@ -90 +85 @@
 On a first view, it appears to work good enough for me with this source and configuration.
 
-'''Note''': If you install the plugin globally, you'll also need to enable it in trac.ini as follows:
+'''Note''': If you install the plugin globally, you'll also need to enable it in `trac.ini` as follows:
 {{{#!ini
 [components]