Changes between Version 9 and Version 10 of BreadCrumbsNavPlugin

Timestamp:

Nov 9, 2011, 1:18:00 AM (12 years ago)

Author:

Steffen Hoffmann

Comment:

major edit to announce new development branch

BreadCrumbsNavPlugin

@@ -1 +1 @@
 [[PageOutline(2-5,Contents,pullout)]]
+[[NewsFlashStart]]
+'''!ToDo'''
+ * short-term: new feature-extended release `breadcrumbs-0.2`
+'''News'''
+ 08-Nov-2011:: Official maintainer change (open: 10)
+ 16-Nov-2010:: Starting ticket list cleanup and triage (open: 9)
+[[NewsFlashEnd]]
+
 = Recently visited pages as navigational bread crumbs =
-
 == Description ==
 
@@ -17 +24 @@
 
 == Installation and Configuration ==
-
 === Prerequisites ===
 
-Requires Trac >= 0.11. 
+Requires Trac >= 0.11 and Genshi >= 0.5 .
 
-=== Download ===
+=== Release Status, Downloads and Source ===
 
- * Download the zipped source from [download:breadcrumbsnavplugin here].
- * You can check out BreadCrumbsNavPlugin from [http://trac-hacks.org/svn/breadcrumbsnavplugin here] using Subversion, or [source:breadcrumbsnavplugin browse the source] with Trac.
+While in general the branch name suggests the corresponding Trac version, `0.11` should work equally well for Trac 0.11 (old stable), 0.12 (current stable) and Trac 0.13dev (development).
+
+|| '''Stable Version''' ||easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/0.11 ||[download:breadcrumbsnavplugin/0.11 download] ||[http://trac-hacks.org/svn/breadcrumbsnavplugin/0.11 subversion] ||
+|| Under Development ||easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/trunk ||[download:breadcrumbsnavplugin/trunk download] ||[http://trac-hacks.org/svn/breadcrumbsnavplugin/trunk subversion] ||
+
+For Subversion checkout use {{{svn co <url>}}} with URL depending on your Trac version and target release (see links above).
+
+Other alternatives:
+ * Download the zipped source of all branches from [download:breadcrumbsnavplugin here].
+ * You can [source:breadcrumbsnavplugin browse the source] with Trac.
 
 === Installation ===
 
 The easiest way to install the BreadCrumbsNavPlugin is to simply point easy_install at the t-h.o SVN repository, a la:
-
 {{{
  easy_install http://trac-hacks.org/svn/breadcrumbsnavplugin/0.11
 }}}
 
-Alternatively, you may download the source and go into the 0.11 directory and then run:
-
+Alternatively, you may download the source, go into the directory containing `setup.py` and run:
 {{{
  python setup.py install
 }}}
 
-After you have installed the BreadCrumbsNavPlugin, you must enable it. You can do so in the Administration panel of Trac, or in trac.ini by adding:
+or prepare a packaged version and move that into the `plugin` directory inside your Trac environment:
+{{{
+ python setup.py bdist_egg
+ cp ./dist/BreadCrumbsNav-<version> <path-to-trac-env>/plugins/
+}}}
 
+'''Hint:''' Using `tracd` standalone server or another webserver you will most probably need to restart it to detect the plugin.
+
+Depending on your configuration you may still need to enable the plugin explicitly. You can do so in the Administration panel of Trac, or in trac.ini by adding:
 {{{
 [components]
@@ -48 +67 @@
 }}}
 
+In Trac applications, where you disabled this plugin or require explicit activation, `breadcrumbs-0.2` and later requires following different line due to a shortened path:
+{{{
+[components]
+breadcrumbsnav.* = enabled
+}}}
+
 === Configuration ===
 
-There are three options you may set into the trac.ini:
+There are four options you may set in `trac.ini`:
 
  ignore_pattern::
  A regular expression pattern that can be applied to the name of the resource; if it matches the resource will not be added to the user's breadcrumbs. Defaults to nothing.
+ label::
+ A custom label to replace the implicite "Breadcrumbs:" default value. Beware that this will interfere with i18n, maybe even depreciated by it.
  max_crumbs::
  The maximum total of crumbs that should be kept per-user. Defaults to 6.
@@ -65 +92 @@
 [breadcrumbs]
 ignore_pattern =
+label =
 max_crumbs = 6
-paths = /wiki*,/ticket*,/milestone*
+paths = /wiki/,/ticket/,/milestone/
 }}}