Changes between Version 5 and Version 6 of RevtreePlugin


Ignore:
Timestamp:
Dec 17, 2006, 4:29:16 PM (8 years ago)
Author:
eblot
Comment:

Add info about enhancers, revamp the page, move the changelog out of the page

Legend:

Unmodified
Added
Removed
Modified
  • RevtreePlugin

    v5 v6  
    4545   changesets, whichever the changeset branch.
    4646
     47==== Example ====
     48
     49[[Image(revtree.png)]]
    4750
    4851=== User preference persistence ===
     
    206209`mainnav` setting, see [t:wiki:TracIni#trac-section TracIni].
    207210
    208 For example, to make the ''revtree'' menu item appear at the right hand
    209 side of the ''browser'' item, update the `mainnav` line as follows:
     211For example, to make the ''revtree'' menu item appear at the right hand side
     212of the ''browser'' item, update the `mainnav` line as follows:
    210213{{{
    211214[trac]
     
    219222and to give access to the revtree feature.
    220223
    221 == Example ==
    222 
    223 [[Image(revtree.png)]]
    224 
    225 == Recent Changes ==
    226 
    227 [[ChangeLog(revtreeplugin, 3)]]
     224== Revision tree enhancements ==
     225
     226The RevtreePlugin has been written with customization in mind: it provides
     227extension points so that one can write his own plugin(s) to add information
     228to the rendered graph and enhance it.
     229
     230For now, there are two ways to enhance the revision tree graph:
     231 * Change the appearance of the rendered items, and add ''operations'' to
     232   the graph. An operation is a relation between two distinct branches, such
     233   as a merge operation.[[BR]]
     234   -> this extension point is dedicated to provide operations that are not
     235   maintained by the underlying repository. These operations can be stored
     236   in revision properties, log message, or any other way: it depends on how
     237   a team use the repository.
     238 * Improve the branch placement. One of the most difficult task to draw a
     239   graphical representation of the repository is to find the best location for
     240   each branch. The ''best'' location depends on how a team work, what is the
     241   most important information to be represented, and to limit the number of
     242   operation intersections as much as possible.[[BR]]
     243   -> this extension point allows to provide a custom branch sorting. There
     244   are probably great algorithms that would allow to find the best branch
     245   placement.
     246     
     247=== Default enhancers ===
     248
     249The RevtreePlugin comes with default enhancers:
     250 * !SimpleEnhancer is a very basic enhancer that is only able to cope with
     251   branch creation and tagging.
     252 * It uses a dummy placement algorithm, which placesthe trunk at the center of
     253   the graph, and tries to minimize (but often fails) the operation
     254   intersections.
     255
     256=== More enhancers ===
     257
     258The RevtreePlugin/LogEnhancer plugin is provided as an implemenation example
     259of the first kind of enhancer.
     260
     261(More technical doc to come about how to write your own enhancers)
     262
     263== Miscelleanous ==
     264
     265=== Recent Changes ===
     266
     267See RevtreePlugin/Changelog
    228268
    229269=== How is this plugin related to the previous plugin? ===
     
    239279The older plugin code has been removed from the TracHacks.org repository.
    240280
    241 == Author/Contributors ==
    242 
    243 ==== Author ====
    244  * [wiki:eblot]
    245  
    246 ==== Contributors ====
    247 
    248 ==== Libraries ====
     281=== Author/Contributors ===
     282 * '''Author''' [wiki:eblot]
     283 * '''Contributors'''
     284
     285=== Libraries ===
    249286
    250287The RevtreePlugin uses the following libraries: