NAME

Blosxom Plug-in: permalink


SYNOPSIS

Generate permalinks


VERSION

0.0.1


AUTHOR

Mark Ivey <zovirl@zovirl.com>, http://zovirl.com


DESCRIPTION

This plugin generates permalinks to help make it easier to use a consistent format throughout a site. For use in flavor files, two variables are exported: $permalink::story and $permalink::category. These link to the current story and category, respectively. For other plugins which may wish to generate links, $permalink::get_link() is provided. Given a path to a file, story, or category, it returns the correct permalink.

$permalink::get_link() expects the path to a file, category, or story (starting from $blosxom::datadir). If there is an extension present it is used as flavor.


SEE ALSO

Blosxom Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/

Blosxom Plugin Docs: http://www.raelity.org/apps/blosxom/plugin.shtml


BUGS

get_link() can't be used for files outside the $blosxom::datadir directory. This might be a problem if your $blosxom::datadir isn't publically available (by being under the web-server's document root, by using the static_file plugin, etc.)

Address bug reports and comments to the Blosxom mailing list [http://www.yahoogroups.com/group/blosxom].


LICENSE

permalink Blosxom Plugin Copyright 2003, Mark Ivey

(This plugin is release under the same license as Blosxom itself)

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.