Changes between Version 7 and Version 8 of PhpdocPlugin


Ignore:
Timestamp:
Mar 22, 2016, 10:06:33 PM (6 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • PhpdocPlugin

    v7 v8  
    4444You may prefer the easy_install way:
    4545{{{#!sh
    46 sudo easy_install http://trac-hacks.org/svn/phpdocplugin/0.11
     46sudo easy_install https://trac-hacks.org/svn/phpdocplugin/0.11
    4747}}}
    4848
    49 You may need to restart web server to see PHPDoc button in navigation tab.
    50 
    51 add the following to your configuration:
     49You may need to restart your web server to see a PHPDoc button in the navigation tab.
    5250
    5351== Configuration
     
    5553A `[phpdoc]` section should be created in TracIni.
    5654There is only one mandatory setting, it is the `path` to the generated documentation.
    57 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
    58 when running `phpdoc`.
     55This 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`.
    5956
    6057Also, don't forget to grant the users the PHPDOC_VIEW permission, or you'll just get a blank page.
    6158
    62 Note that there's also the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.output -o]
    63 parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'.
     59Note 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'.
    6460
    6561== Example
     
    7369svn co http://my.svn.server.org/svn/myproject/trunk source
    7470mkdir doc
    75 /whereever/you/installed/phpdoc -o HTML:Smarty:PHP -d source -t doc
     71/path/to/installed/phpdoc -o HTML:Smarty:PHP -d source -t doc
    7672}}}
    7773
    78 Now you should have the latest source in /var/cache/phpdoc/myproject/source
    79 And the generated documentation in /var/cache/phpdoc/myproject/doc
     74Now you should have the latest source in `/var/cache/phpdoc/myproject/source` and the generated documentation in `/var/cache/phpdoc/myproject/doc`.
    8075
    8176Now setup Trac's configuration:
     
    9085On a first view, it appears to work good enough for me with this source and configuration.
    9186
    92 '''Note''': If you install the plugin globally, you'll also need to enable it in trac.ini as follows:
     87'''Note''': If you install the plugin globally, you'll also need to enable it in `trac.ini` as follows:
    9388{{{#!ini
    9489[components]