general/readme

   1 # Blosxom Plugin: readme
   2 # Author(s): Rael Dornfest <rael@oreilly.com>
   3 # Version: 2003-11-12
   4 # Documentation: See the bottom of this file or type: perldoc readme
   5
   6 package readme;
   7
   8 # --- Configurable variables -----
   9
  10 my $before_readme = qq{<span class="readme">};
  11 my $after_readme = qq{</span>};
  12
  13 # --------------------------------
  14
  15 $readme; # use as $readme::readme in flavour templates
  16
  17 use FileHandle;
  18
  19 my $fh = new FileHandle;
  20
  21 sub start {
  22   1;
  23 }
  24
  25 sub head {
  26   my($pkg, $path, $head_ref) = @_;
  27
  28   LOOK: {
  29     do {
  30       $fh->open("< $blosxom::datadir/$path/readme") || $fh->open("< $blosxom::datadir/$path/readme.$blosxom::flavour") and $readme = join('', $before_readme, <$fh>, $after_readme), $fh->close, last LOOK;
  31     } while ($path =~ s/(\/*[^\/]*)$// and $1);
  32   }
  33
  34   return 1;
  35 }
  36
  37 1;
  38
  39 __END__
  40
  41 =head1 NAME
  42
  43 Blosxom Plug-in: readme
  44
  45 =head1 SYNOPSIS
  46
  47 Purpose: Populates $readme::readme with the contents of any readme.flavour
  48 (specific to a particular flavour) or readme (general, regardless of flavour)
  49 file found along a particular category path/directory, preferring those found
  50 closest to the point of the path at hand.
  51
  52 =head1 VERSION
  53
  54 2003-11-12
  55
  56 Version number coincides with the version of Blosxom with which the
  57 current version was first bundled.
  58
  59 =head1 AUTHOR
  60
  61 Rael Dornfest  <rael@oreilly.com>, http://www.raelity.org/
  62
  63 =head1 SEE ALSO
  64
  65 Blosxom Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/
  66
  67 Blosxom Plugin Docs: http://www.raelity.org/apps/blosxom/plugin.shtml
  68
  69 =head1 BUGS
  70
  71 Address bug reports and comments to the Blosxom mailing list
  72 [http://www.yahoogroups.com/group/blosxom].
  73
  74 =head1 LICENSE
  75
  76 Blosxom and this Blosxom Plug-in
  77 Copyright 2003, Rael Dornfest
  78
  79 Permission is hereby granted, free of charge, to any person obtaining a
  80 copy of this software and associated documentation files (the "Software"),
  81 to deal in the Software without restriction, including without limitation
  82 the rights to use, copy, modify, merge, publish, distribute, sublicense,
  83 and/or sell copies of the Software, and to permit persons to whom the
  84 Software is furnished to do so, subject to the following conditions:
  85
  86 The above copyright notice and this permission notice shall be included
  87 in all copies or substantial portions of the Software.
  88
  89 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  90 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  91 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  92 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  93 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  94 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  95 OTHER DEALINGS IN THE SOFTWARE.