Changes between Version 50 and Version 51 of RevtreePlugin


Ignore:
Timestamp:
Mar 27, 2016, 9:28:18 PM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • RevtreePlugin

    v50 v51  
    3131   * '''branch name''': this filter selects a single branch, along with all branches declared as 'trunks'
    3232   * '''author''': this filter selects all the branches for which the selected author has to be a participant (ie has committed at least one changeset)
    33    * '''show terminated branches''': this filter makes all branches  visible, including deleted ones. Default setting hides all ''terminated''
     33   * '''show terminated branches''': this filter makes all branches visible, including deleted ones. Default setting hides all ''terminated''
    3434     branches.
    3535
     
    4141 * '''compact''': in this mode, the revtree graph is kept as compact as possible, in an attempt to make all the changesets visible on the web
    4242   browser page and thereby minimize the scrolling actions.
    43    Changesets are placed along on their branch, irrespectively of the nearby branches.
     43   Changesets are placed along on their branch, irrespective of the nearby branches.
    4444 * '''timeline''': in this mode, the revtree graph maintains a time view of the repository: each changeset can be seen relatively to the other
    4545   changesets, whichever the changeset branch.[[br]]
    46    See [attachment:revtree-stresstest.png] for a totally useless, gigantic sample image of the timeline mode with about 300 changesets.
     46   See [attachment:revtree-stresstest.png] for a sample image of the timeline mode with about 300 changesets.
    4747
    4848The timeline view will look as follows:
     
    6464This plugin has the following known limitations:
    6565
    66 '''RevtreePlugin assumes that each revision contains changes in a single branch - and only one.'''[[br]]
    67 If it's not the case, RevtreePlugin may not work or behave badly.
    68 
    69 See #1090 and #1191 for details about this design choice, as well as #1354 and #1635.
    70 
    71 CVS switchers, please be sure to read the dedicated [RevtreePlugin#SVNrepositoryimportedfromCVS section]
     66'''RevtreePlugin assumes that each revision contains changes in a single branch - and only one.''' If it's not the case, RevtreePlugin may not work or behave unpredictably. See #1090 and #1191 for details about this design choice, as well as #1354 and #1635.
     67
     68CVS switchers, please be sure to read the dedicated [RevtreePlugin#SVNrepositoryimportedfromCVS section].
    7269
    7370 1. the RevtreePlugin generates inlined SVG.
    74    * SVG is only supported on modern browsers
    75    * ''inlined SVG'' means that the plugin generates XHTML+SVG data, which are only supported by a few browsers. Many browsers that support SVG do not accept ''inlined SVG''. Checkout the following section for a non-exhaustive list of supported browsers.
    76  1. the RevtreePlugin only works with SVN repositories
    77  1. it does not support SVN authz
    78  1. it has not been thought with multiple projects per repository in mind, so its support for this kind of configuration is probably weak
    79  1. filters do not support multiple selections: one can only select all or one branch, all or one author
     71   * SVG is supported on most modern browsers
     72   * ''inlined SVG'' means that the plugin generates XHTML+SVG data, which are supported by a few browsers. Many browsers that support SVG do not accept ''inlined SVG''. Checkout the following section for a non-exhaustive list of supported browsers.
     73 1. the RevtreePlugin only works with SVN repositories.
     74 1. it does not support SVN authz.
     75 1. it has not been thought with multiple projects per repository in mind, so its support for this kind of configuration is probably weak.
     76 1. filters do not support multiple selections: one can only select all or one branch, all or one author.
    8077 
    8178See RevtreePlugin/Limitations for a technical 'discussion' about the current limitations.
    8279
    83 The plugin output has been tested against the [http://validator.w3.org w3 validator] and generates ''Valid XHTML 1.1 plus MathML 2.0 plus SVG 1.1''.
     80The plugin output has been tested against the [http://validator.w3.org W3 Validator] and generates ''Valid XHTML 1.1 plus MathML 2.0 plus SVG 1.1''.
    8481
    8582=== Supported browsers
    8683
    87 Any browser that supports ''inlined SVG'' should work. However, as it seems that some browsers are not able to cope with this kind of data, the following table sums up what you can expect from your favorite browser:
    88 
    89 RST support is broken on Trac Hacks for now. You can get the compatibility matrix from [attachment:compatmatrix.txt].
    90 
    91 The browser compatibility matrix has been created with RevtreePlugin 0.5.15 on April '08, 17^th^.
     84Any browser that supports ''inlined SVG'' should work. However, for those browsers that do not, the following table sums up what you can expect [attachment:compatmatrix.txt compatibility matrix]. This matrix has been created with RevtreePlugin 0.5.15 on 17-Apr-2008.
    9285
    9386== Bugs/Feature Requests
    9487
    95 Existing bugs and feature requests for RevtreePlugin are [query:status!=closed&component=RevtreePlugin&order=priority here]. If you have any issues, create a [/newticket?component=RevtreePlugin&cc=sylvain.delisle new ticket].
     88Existing bugs and feature requests for RevtreePlugin are
     89[report:9?COMPONENT=RevtreePlugin here].
     90
     91If you have any issues, create a
     92[/newticket?component=RevtreePlugin&cc=sylvain.delisle new ticket].
    9693
    9794[[TicketQuery(component=RevtreePlugin&group=type,format=progress)]]
     
    107104
    108105To build the plugin, run setup.py:
    109 {{{
    110 #!sh
     106{{{#!sh
    111107python setup.py bdist_egg
    112108}}}
     
    114110Copy the generated egg file (from the `dist/` directory) to your project plugin directory, or in the global plugin directory if you want to use it for several Trac projects.
    115111
    116 From the WebAdmin plugin interface or from your trac.ini file, enable the RevtreePlugin.
    117 
    118 In `trac.ini`, edit the ''components'' section to add the revtree entry as follows:
    119 {{{
    120 #!ini
     112From the WebAdmin plugin interface or from your `trac.ini` file, enable the RevtreePlugin.
     113
     114In your `trac.ini` file, edit the ''components'' section to add the revtree entry as follows:
     115{{{#!ini
    121116[components]
    122117revtree.* = enabled
     
    127122The revtree plugin can be configured with the help of the following settings:
    128123 * Mandatory parameters defined in the Trac section:
    129 {{{
    130 #!ini
     124{{{#!ini
    131125[trac]
    132126# SVN repositories only
     
    138132
    139133 * Optional parameters are defined in the `revtree` section of `trac.ini`:
    140 {{{
    141 #!ini
     134{{{#!ini
    142135[revtree]
    143136# regular expression for branch recognition
     
    173166
    174167The following regex would better match the ''multiple-project'' repository layout:
    175 {{{
    176 #!python
     168{{{#!python
    177169branch_re = ^(?P<branch>[^/]+/(?:(?:tags|branches)/[^/]+|trunk))(?:/(?P<path>.*))?$
    178170}}}
     
    184176Revtree menu may either appears as a main menu item, ie in the menu bar, or as a contextual menu item.
    185177 * to make revtree link appear as a contextual menu item, define a `contexts` option in the `[revtree]` section of your `trac.ini` file and use a comma-separated list of the page contexts where the revtree menu should appear:
    186 {{{
    187 #!ini
     178{{{#!ini
    188179[revtree]
    189180contexts = changeset, browser
     
    202193
    203194For example, to make the ''revtree'' menu item appear at the right hand side of the ''browser'' item, update the `mainnav` line as follows:
    204 {{{
    205 #!ini
     195{{{#!ini
    206196[trac]
    207197mainnav = wiki,timeline,roadmap,browser,revtree,tickets,newticket,search
     
    242232 * the RevtreePlugin/MergeInfoEnhancer plugin can be used with the latest SVN release (SVN >= 1.5) to show the inter-branch merge operations of a repository. It is in early development stage and may not be reliable.
    243233 
    244  * the RevtreePlugin/MergeEnhancer plugin can be used in conjunction with the svnmerge tool to show the inter-branch merge operations of a repository. This enhancer is not actually maintained and is provided as an example of enhancer implementation
    245 
    246 == Miscelleanous
     234 * the RevtreePlugin/MergeEnhancer plugin can be used in conjunction with the svnmerge tool to show the inter-branch merge operations of a repository. This enhancer is not actually maintained and is provided as an example of enhancer implementation.
     235
     236== Miscellaneous
    247237
    248238=== SVN repository imported from CVS