Add $blog_encoding to rss20.
[matthijs/upstream/blosxom-plugins.git] / general / storytitle
1 # Blosxom plugin: storytitle
2 # Author(s): Struan Donald <code@exo.org.uk>
3 # Version: 0.5
4 # Documentation: see bottom of file or perldoc title
5
6 package storytitle;
7
8 # ------------------ Config variables ---------------------
9
10 # default seperator to add to story title
11
12 my $sep = ' : ';
13
14 # do we default to the right aligned title
15 # 1 for right aligned, 0 for left
16
17  my $right = 0;
18
19 # seperator for right aligned title 
20
21 my $right_sep = ''
22     || $sep;
23
24 # seperator for left aligned title
25
26 my $left_sep = ''
27     || $sep;
28
29 # ---------------------------------------------------------
30
31 sub start { 1; }
32 sub head {
33     my ($p, $dir, $head) = @_;
34     my $title;
35     if (!$dir) {
36         $title = (defined $blosxom::path_info_da ? "$blosxom::path_info_da/" : "") . (defined $blosxom::path_info_mo ? "$blosxom::path_info_mo/" : "") . "$blosxom::path_info_yr" ;
37         
38     } elsif ($dir =~ m#(.*?)/?([\-\.\w]+)\.(\w+)$# and $2 ne 'index') {
39         $file = join('/', $blosxom::datadir, $1, "$2.txt");
40         my $fh = new FileHandle;
41         if (-f "$file" && $fh->open("< $file")) {
42             chomp($title = <$fh>);
43             $fh->close;
44         }
45     }
46     if (defined $title and $title =~ /\S/) {
47         $page_title_right = $right_sep . $title;
48         $page_title_left = $title . $left_sep;
49         $page_title =  $right ? $page_title_right : $page_title_left;
50     } else { # these need to be reset otherwise we'll get the last value
51         $page_title_right = undef;
52         $page_title_left = undef;
53         $page_title = undef;
54     } 
55 }
56
57 1;
58
59 __END__
60 =head1 NAME
61
62 Blosxom Plug-in: storytitle
63
64 =head1 SYNOPSIS
65
66 Allows you to include the story title in the page header for individually views blosxom stories.
67
68 =head2 QUICK START
69
70 Put title in your plug-ins directory.
71
72 If required change the $sep variable. This controls the seperator that goes at the start of the story title. E.g. if $sep is ' : ' and the story title is 'A blosxom entry' then the plugin will return ' : A blosxom entry'.
73
74 Now all individually displayed stories can have their title in the pages title tag, or anywhere else in the page header you want. Just place $storytitle::page_title where you want to display the story title.
75
76 =head2 LEFT AND RIGHT ALIGNED TITLES
77
78 If you have a need for a left aligned title (i.e. you want to have 'story title : somethign else') then you can use either $storytitle::page_title_left or set the value of $right in the configuration to 0. In that case $storytitle::page_title will have the seperator at the left.
79
80 You can also individually configure the left and right sided seperators with the left_sep and right_sep configuration options. $storytitle::page_title_left and $storytitle::page_title_right will access the left and right sided titles.
81
82 =head1 VERSION
83
84 0.5
85
86 =head2 CHANGES
87
88 0.5 - deals with filenames with like foo.bar.txt and foo-bar.txt (thanks to
89       Antti Vähä-Sipilä for pointing this out)
90       catches titles containing only white space.
91
92 0.4 - bugfix to stop title values hanging around under static generation
93
94 0.3 - fixed left_title to actually be a left title
95
96 0.2 - introduced left and right options
97
98 =head1 AUTHOR
99
100 Struan Donald <code@exo.org.uk>, http://exo.org.uk/code/
101
102 =head2 CREDITS
103
104 Lim Chee Aun <http://phoenity.com/> for the left/right sided titles idea.
105
106 =head1 SEE ALSO
107
108 Blosxom Home/Docs/Licensing:http://blosxom.sourceforge.net/
109
110 Blosxom Plugin Docs: http://blosxom.sourceforge.net/documentation/users/plugins.html
111
112 =head1 BUGS
113
114 None known; please send bug reports and feedback to the Blosxom
115 development mailing list <blosxom-devel@lists.sourceforge.net>.
116
117 =head1 COPYRIGHT
118
119 Copyright (C) 2003 Struan Donald. 
120
121 This program is free software; you can redistribute
122 it and/or modify it under the same terms as Perl itself.
123
124 =cut