tagging: Allow using titles in for related stories.
[matthijs/upstream/blosxom-plugins.git] / general / breadcrumbs
1 # Blosxom Plugin: breadcrumbs
2 # Author(s): Rael Dornfest <rael@oreilly.com> 
3 # Version: 2003-12-29
4 # Documentation: See the bottom of this file or type: perldoc readme
5
6 package breadcrumbs;
7
8 # --- Configurable variables -----
9
10 # Should I prepend a link back home to the path?
11 # Specify a word to use for the link back to $blosxom::url or leave blank
12 # to exclude it
13
14 my $home = 'home';
15
16 # What divider should I use between path components (e.g. a > path > to...)
17 my $divider = " :: ";
18
19 # True or false: should we show a breadcrumb containing only $home
20 # when looking at $blosxom::url?  Optional; default is false.
21 my $home_breadcrumb = 0;
22
23 # Code reference which is applied to each path name to make it more
24 # user friendly.  Example : { ucfirst } to capitalize first letter.
25 # Value to modify is in $_; change $_ to what should be displayed.
26 # Optional; set to undef for no action.
27 #
28 # Example: Convert each word to upper case, and change - or _ to space:
29 # my $pretty = sub { my @words = split /[-_]+/;
30 #                    $_=join(" ", map { ucfirst} @words ) };
31 my $pretty = sub { my @words = split /[-_]+/;
32                    $_=join(" ", map { ucfirst} @words ) };
33
34 # --------------------------------
35
36 $breadcrumbs; # use as $breadcrumbs::breadcrumbs in flavour templates
37
38 use FileHandle;
39
40 my $fh = new FileHandle;
41
42 sub start {
43   1;
44 }
45
46 sub head {
47   my($pkg, $path, $head_ref) = @_;
48
49   unless($path) {
50     $breadcrumbs = $home if $home && $home_breadcrumb;
51     return 0;
52   }
53
54   $path =~ s/\.$blosxom::flavour$//;
55
56   my(@p, $p);
57   $home and push @p, qq{<a href="$blosxom::url/index.$blosxom::flavour">$home</a>};
58
59   foreach ( split /\//, $path ) {
60     $p .= "/$_";
61
62     &$pretty if ref $pretty eq "CODE";
63     push @p,
64       $p ne "/$path"
65       ? qq{<a href="$blosxom::url$p/index.$blosxom::flavour">$_</a>}
66       : qq{$_};
67   }
68
69   $breadcrumbs = join $divider, @p;
70
71   return 1;
72 }
73
74 1;
75
76 __END__
77
78 =head1 NAME
79
80 Blosxom Plug-in: breadcrumbs
81
82 =head1 SYNOPSIS
83
84 Populates $breadcrumbs::breadcrumbs with a clickable trail to
85 your current path in the weblog hierarchy (a la Yahoo!).
86
87 e.g. a/path/to/somewhere becomes 
88 <a href="/a">a</a> :: <a href="/a/path">path</a> :: ...
89
90 Optionally prepends the path with a link back to home.  Alter $home
91 as you please, leaving it blank to turn off the link to home.
92
93 =head1 VERSION
94
95 2003-12-29
96
97 Version number coincides with the version of Blosxom with which the 
98 current version was first bundled.
99
100 =head1 AUTHOR
101
102 Rael Dornfest  <rael@oreilly.com>, http://www.raelity.org/
103
104 This plugin is now maintained by the Blosxom Sourceforge Team,
105 <blosxom-devel@lists.sourceforge.net>.
106
107 =head1 SEE ALSO
108
109 Blosxom Home/Docs/Licensing: http://blosxom.sourceforge.net/
110
111 Blosxom Plugin Docs: http://blosxom.sourceforge.net/documentation/users/plugins.html
112
113 =head1 BUGS
114
115 None known; please send bug reports and feedback to the Blosxom
116 development mailing list <blosxom-devel@lists.sourceforge.net>.
117
118 =head1 LICENSE
119
120 Blosxom and this Blosxom Plug-in
121 Copyright 2003, Rael Dornfest 
122
123 Permission is hereby granted, free of charge, to any person obtaining a
124 copy of this software and associated documentation files (the "Software"),
125 to deal in the Software without restriction, including without limitation
126 the rights to use, copy, modify, merge, publish, distribute, sublicense,
127 and/or sell copies of the Software, and to permit persons to whom the
128 Software is furnished to do so, subject to the following conditions:
129
130 The above copyright notice and this permission notice shall be included
131 in all copies or substantial portions of the Software.
132
133 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
134 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
135 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
136 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
137 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
138 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
139 OTHER DEALINGS IN THE SOFTWARE.