Changes between Version 5 and Version 6 of PhpdocPlugin


Ignore:
Timestamp:
Nov 8, 2015, 3:51:11 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • PhpdocPlugin

    v5 v6  
    1 = PHPDocumentor plugin for Trac =
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    3 == Description ==
     3= PHPDocumentor plugin for Trac
    44
    5 Integrates [http://www.phpdoc.org phpdocumentor] documentation into Trac.
     5== Description
    66
    7 Started as a simple copy of the DoxygenPlugin
     7This plugin integrates [http://www.phpdoc.org phpdocumentor] documentation into Trac. Started as a simple copy of the DoxygenPlugin.
    88
    99The phpdoc plugin provides a new main navigation tab (named PHPDoc by default), which will present the phpdoc index page.
    1010
    11 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.
     11Configuring 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.
    1212
    13 This plugin is tested with the following releases of Trac:
     13This plugin is tested with Trac 0.11.3.
    1414
    15     * Trac 0.11: Started development with Trac 0.11.3
    16 
    17 
    18 == Bugs/Feature Requests ==
     15== Bugs/Feature Requests
    1916
    2017Existing bugs and feature requests for PhpdocPlugin are
    … …  
    2219
    2320If you have any issues, create a
    24 [http://trac-hacks.org/newticket?component=PhpdocPlugin&owner=exarv new ticket].
     21[/newticket?component=PhpdocPlugin new ticket].
    2522
    26 == Download ==
     23[[TicketQuery(component=WinSvnHooksIntegration&group=type,format=progress)]]
    2724
    28 Download the zipped source from [download:phpdocplugin here].
     25== Download
    2926
    30 == Source ==
     27Download the zipped source from [export:phpdocplugin here].
    3128
    32 You can check out PhpdocPlugin from [http://trac-hacks.org/svn/phpdocplugin here] using Subversion, or [source:phpdocplugin browse the source] with Trac.
     29== Source
    3330
    34 == Example ==
     31You can check out PhpdocPlugin from [/svn/phpdocplugin here] using Subversion, or [source:phpdocplugin browse the source] with Trac.
    3532
    36 ----
    37 === Installation ===
     33== Installation
    3834
    3935 - Download the zipped source.
    4036 - Extract the zip file
    41  - Go to the phpdocplugin/0.11 directory
    42  - run:
    43 {{{
     37 - Go to the phpdocplugin/0.11 directory and run:
     38 {{{#!sh
    4439python ./setup.py install
    4540}}}
    4641
    47 This will generate a python egg and copy it into the trac/plugins directory and follow the Configuration steps outlined below.
     42This will generate a Python egg and copy it into the trac/plugins directory and follow the Configuration steps outlined below.
    4843
    4944You may prefer the easy_install way:
    50 {{{
    51  sudo easy_install http://trac-hacks.org/svn/phpdocplugin/0.11
     45{{{#!sh
     46sudo easy_install http://trac-hacks.org/svn/phpdocplugin/0.11
    5247}}}
    5348
    … …  
    5651add the following to your configuration:
    5752
    58 === Configuring Trac ===
    59 ==== Basic Configuration ====
     53== Configuration
     54
    6055A `[phpdoc]` section should be created in TracIni.
    6156There's only one mandatory setting, it's the `path` to the generated documentation.
    … …  
    6661parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'
    6762
    68 '''Example:''' [[br]]
     63== Example
    6964
    7065First checkout the latest version of your trunk:
    71 {{{
     66{{{#!sh
    7267mkdir/var/cache/phpdoc
    7368cd /var/cache/phpdoc
    … …  
    7873/whereever/you/installed/phpdoc -o HTML:Smarty:PHP -d source -t doc
    7974}}}
     75
    8076Now you should have the latest source in /var/cache/phpdoc/myproject/source
    8177And the generated documentation in /var/cache/phpdoc/myproject/doc
    8278
    8379Now setup Trac's configuration:
    84 {{{
     80{{{#!ini
    8581[phpdoc]
    8682path = /var/cache/phpdoc/myproject/doc
    … …  
    9288On a first view, it appears to work good enough for me with this source and configuration.
    9389
    94 Note: If you install the plugin globally, you'll also need to enable it in trac.ini as follows:
     90'''Note''': If you install the plugin globally, you'll also need to enable it in trac.ini as follows:
    9591
    96 {{{
     92{{{#!ini
    9793[components]
    9894phpdoctrac.* = enabled
    9995}}}
    10096
    101 
    102 == TracLinks ==
     97== TracLinks
    10398
    10499It's possible to create links to phpdoc documentation from anywhere within a Wiki text, by using the `phpdoc:` link prefix.
    … …  
    113108}}}
    114109
    115 == Recent Changes ==
     110== Recent Changes
    116111
    117112[[ChangeLog(phpdocplugin, 3)]]
    118113
    119 == Author/Contributors ==
     114== Author/Contributors
    120115
    121116'''Author:''' [wiki:exarv] [[BR]]
     117'''Maintainer:''' [[Maintainer]] [[BR]]
    122118'''Contributors:'''