Changes between Version 9 and Version 10 of BreadCrumbsNavPlugin


Ignore:
Timestamp:
Nov 9, 2011, 2:18:00 AM (3 years ago)
Author:
hasienda
Comment:

major edit to announce new development branch

Legend:

Unmodified
Added
Removed
Modified
  • BreadCrumbsNavPlugin

    v9 v10  
    11[[PageOutline(2-5,Contents,pullout)]]
     2[[NewsFlashStart]]
     3'''!ToDo'''
     4 * short-term: new feature-extended release `breadcrumbs-0.2`
     5'''News'''
     6 08-Nov-2011:: Official maintainer change (open: 10)
     7 16-Nov-2010:: Starting ticket list cleanup and triage (open: 9)
     8[[NewsFlashEnd]]
     9
    210= Recently visited pages as navigational bread crumbs =
    3 
    411== Description ==
    512
     
    1724
    1825== Installation and Configuration ==
    19 
    2026=== Prerequisites ===
    2127
    22 Requires Trac >= 0.11.
     28Requires Trac >= 0.11 and Genshi >= 0.5 .
    2329
    24 === Download ===
     30=== Release Status, Downloads and Source ===
    2531
    26  * Download the zipped source from [download:breadcrumbsnavplugin here].
    27  * You can check out BreadCrumbsNavPlugin from [http://trac-hacks.org/svn/breadcrumbsnavplugin here] using Subversion, or [source:breadcrumbsnavplugin browse the source] with Trac.
     32While 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).
     33
     34|| '''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] ||
     35|| Under Development ||easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/trunk ||[download:breadcrumbsnavplugin/trunk download] ||[http://trac-hacks.org/svn/breadcrumbsnavplugin/trunk subversion] ||
     36
     37For Subversion checkout use {{{svn co <url>}}} with URL depending on your Trac version and target release (see links above).
     38
     39Other alternatives:
     40 * Download the zipped source of all branches from [download:breadcrumbsnavplugin here].
     41 * You can [source:breadcrumbsnavplugin browse the source] with Trac.
    2842
    2943=== Installation ===
    3044
    3145The easiest way to install the BreadCrumbsNavPlugin is to simply point easy_install at the t-h.o SVN repository, a la:
    32 
    3346{{{
    3447 easy_install http://trac-hacks.org/svn/breadcrumbsnavplugin/0.11
    3548}}}
    3649
    37 Alternatively, you may download the source and go into the 0.11 directory and then run:
    38 
     50Alternatively, you may download the source, go into the directory containing `setup.py` and run:
    3951{{{
    4052 python setup.py install
    4153}}}
    4254
    43 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:
     55or prepare a packaged version and move that into the `plugin` directory inside your Trac environment:
     56{{{
     57 python setup.py bdist_egg
     58 cp ./dist/BreadCrumbsNav-<version> <path-to-trac-env>/plugins/
     59}}}
    4460
     61'''Hint:''' Using `tracd` standalone server or another webserver you will most probably need to restart it to detect the plugin.
     62
     63Depending 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:
    4564{{{
    4665[components]
     
    4867}}}
    4968
     69In 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:
     70{{{
     71[components]
     72breadcrumbsnav.* = enabled
     73}}}
     74
    5075=== Configuration ===
    5176
    52 There are three options you may set into the trac.ini:
     77There are four options you may set in `trac.ini`:
    5378
    5479 ignore_pattern::
    5580 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.
     81 label::
     82 A custom label to replace the implicite "Breadcrumbs:" default value. Beware that this will interfere with i18n, maybe even depreciated by it.
    5683 max_crumbs::
    5784 The maximum total of crumbs that should be kept per-user. Defaults to 6.
     
    6592[breadcrumbs]
    6693ignore_pattern =
     94label =
    6795max_crumbs = 6
    68 paths = /wiki*,/ticket*,/milestone*
     96paths = /wiki/,/ticket/,/milestone/
    6997}}}
    7098