# Blosxom Plugin: storyindex
# Author(s): Rob Ewaschuk
# Version: 0+1i
# Blosxom Home/Docs/Licensing: <a href="<a
# href="http://www.raelity.org/apps/blosxom/">http://www.raelity.org/apps/blosxom/</a>

package storyindex;

# --- Configurable variables -----

my $first_index = 1;

# --------------------------------

$storyindex = $first_index;
$storyindex--;

sub story {
  $storyindex++;
  1;
}

sub start {
  1;
}

sub template {
  return undef;
}

sub entries {
  return undef;
}

sub skip {
  return undef;
}

sub interpolate {
  return undef;
}

sub sort {
  return undef;
}

1;

=head1 NAME

Blosxom plugin: storyindex

=head1 SYNOPSIS

Keeps track of the index of each story on the front page, and makes it
available as $storyindex::storyindex.  Along with interpolate_conditional,
allows you to put certain text only after certain stories.

For example, in concert with interpolate_conditional and the syndicated
plugins, this places a special block containing an RDF feed from a Wiki.

NOTE: The following must all be on a single line for the
interpolate_conditional plugin to recognize it!

?{$storyindex::storyindex=2 <div class="block" id="wikifeed"> <h2>Recent
Changes on the Wiki</h2> <div class="wikifeedexplanation">This is magically
updated with the last few things done on the Wiki.</div> <ul>
$syndicated::content </ul></div>}

NOTE: Putting something below the first story is subtly different from
putting it above the second.  In the first case, it will show up on a page
that displays only that story, in the second it won't show up unless there
are at least two stories.

=head1 INSTALLATION

Drop storyindex into your Blosxom plugins directory.

=head1 CONFIGURATION

None needed - once you've dropped it into your plugin directory,
$storyindex::storyindex is available in your story templates.

$first_index Lets you control the index given to the first story.

=head1 VERSION

2004-04-03

=head1 AUTHOR

Rob Ewaschuk <rob@infinitepigeons.org>, <a href="<a
href="http://rob.infinitepigeons.org">http://rob.infinitepigeons.org</a>"><a
href="http://rob.infinitepigeons.org">http://rob.infinitepigeons.org</a></a>

=head1 BUGS

Address bug reports to the email above.  This is my first published perl
code, so please be gentle. :-)

=head1 LICENSE

storyindex plugin for Blosxom
Copyright 2004, Rob Ewaschuk

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.