Changes between Version 2 and Version 3 of HgTimelinePlugin

Timestamp:

Oct 25, 2007, 1:20:45 PM (17 years ago)

Author:

Dirkjan Ochtman

Comment:

Explain the idea behind this extension, provide sample configuration.

HgTimelinePlugin

@@ -3 +3 @@
 == Description ==
 
-A plugin to provide timeline events and wiki syntax for multiple [http://www.selenic.com/mercurial/ Mercurial] repositories.
+HgTimeline is an alternative to the [http://trac.edgewall.org/wiki/TracMercurial TracMercurial] plugin, which makes [http://www.selenic.com/mercurial/ Mercurial] repositories accessible from Trac. [http://trac.edgewall.org/wiki/TracMercurial TracMercurial] provides a very well-done plugin that tries to emulate the standard Subversion interface where it makes sense and diverges from it where Mercurial requires a different feature set. The way Trac currently works, though, means that you can only provide an interface to one Mercurial repository at a time.
+
+This plugin tries to provide access from Trac to several different Mercurial clones (whether they belong to one or more projects). This is done by not using the default Trac browser anymore, and instead linking to external hgweb instances (the web interface provided with Mercurial) from the timeline and through wiki syntax.
+
+Therefore, only use this plugin if you want to connect your Trac to multiple Mercurial clones or projects or if you prefer to use hgweb rather than Trac's own source browser.
 
 == Bugs/Feature Requests == 
@@ -15 +19 @@
 == Download ==
 
-Download the zipped source from [http://hg.xavamedia.nl/hgtl/archive/tip.tar.gz here].
+Download the zipped source from [http://hg.xavamedia.nl/hgtl/archive/tip.tar.gz here]. Requires Trac 0.11.
 
 == Source ==
@@ -23 +27 @@
 == Example ==
 
-Provides timeline events from multiple Mercurial repositories as well as enabling wiki syntax for linking to an external web interface for each of those repositories.
+Sample configuration needed in trac.ini:
+
+{{{
+[components]
+trac.versioncontrol.* = disabled
+hgtl.* = enabled
+
+[hg-timeline]
+web.href = http://example.com/hg/
+proj1-user = /home/user/src/proj1
+proj2-user = /home/user/src/proj2
+proj1-jdoe = /home/jdoe/src/proj1
+}}}
 
 == Author/Contributors ==