Changes between Version 5 and Version 6 of RevtreePlugin

Timestamp:

Dec 17, 2006, 3:29:16 PM (17 years ago)

Author:

Emmanuel Blot

Comment:

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

RevtreePlugin

@@ -45 +45 @@
    changesets, whichever the changeset branch.
 
+==== Example ====
+
+[[Image(revtree.png)]]
 
 === User preference persistence ===
@@ -206 +209 @@
 `mainnav` setting, see [t:wiki:TracIni#trac-section TracIni].
 
-For example, to make the ''revtree'' menu item appear at the right hand 
-side of the ''browser'' item, update the `mainnav` line as follows:
+For example, to make the ''revtree'' menu item appear at the right hand side
+of the ''browser'' item, update the `mainnav` line as follows:
 {{{
 [trac]
@@ -219 +222 @@
 and to give access to the revtree feature.
 
-== Example ==
-
-[[Image(revtree.png)]]
-
-== Recent Changes ==
-
-[[ChangeLog(revtreeplugin, 3)]]
+== Revision tree enhancements ==
+
+The RevtreePlugin has been written with customization in mind: it provides 
+extension points so that one can write his own plugin(s) to add information
+to the rendered graph and enhance it.
+
+For now, there are two ways to enhance the revision tree graph:
+ * Change the appearance of the rendered items, and add ''operations'' to 
+   the graph. An operation is a relation between two distinct branches, such
+   as a merge operation.[[BR]]
+   -> this extension point is dedicated to provide operations that are not
+   maintained by the underlying repository. These operations can be stored
+   in revision properties, log message, or any other way: it depends on how
+   a team use the repository.
+ * Improve the branch placement. One of the most difficult task to draw a 
+   graphical representation of the repository is to find the best location for
+   each branch. The ''best'' location depends on how a team work, what is the
+   most important information to be represented, and to limit the number of 
+   operation intersections as much as possible.[[BR]]
+   -> this extension point allows to provide a custom branch sorting. There 
+   are probably great algorithms that would allow to find the best branch
+   placement.
+      
+=== Default enhancers ===
+
+The RevtreePlugin comes with default enhancers:
+ * !SimpleEnhancer is a very basic enhancer that is only able to cope with 
+   branch creation and tagging.
+ * It uses a dummy placement algorithm, which placesthe trunk at the center of
+   the graph, and tries to minimize (but often fails) the operation 
+   intersections.
+
+=== More enhancers ===
+
+The RevtreePlugin/LogEnhancer plugin is provided as an implemenation example
+of the first kind of enhancer.
+
+(More technical doc to come about how to write your own enhancers)
+
+== Miscelleanous ==
+
+=== Recent Changes ===
+
+See RevtreePlugin/Changelog
 
 === How is this plugin related to the previous plugin? ===
@@ -239 +279 @@
 The older plugin code has been removed from the TracHacks.org repository.
 
-== Author/Contributors ==
-
-==== Author ====
- * [wiki:eblot]
- 
-==== Contributors ====
-
-==== Libraries ====
+=== Author/Contributors ===
+ * '''Author''' [wiki:eblot]
+ * '''Contributors'''
+
+=== Libraries ===
 
 The RevtreePlugin uses the following libraries: