====== Bloglinks Plugin ======




===== Description =====

The bloglinks plugin displays links to the previous and the next blog entry above the entries in configured namespaces. Additionally, it marks these links semantically, using XHTMLs ''rel="prev"'' and ''rel="next"'' and also inserts corresponding meta-headers into the created XHTML output. It needs the [[http://www.wikidesign.ch/en/plugin/blog/start|blog plugin]] (or rather its helper component) to work.

In case you come across any bugs in this plugin, don't hesitate to [[http://flyspray.foosel.net/index.php?do=newtask&project=9|report them]].

The Darcs repository of the plugin can be found [[http://devel.foosel.org/darcsweb/darcsweb.cgi?r=dokuwiki/bloglinks;a=summary|here]].

===== Updates =====

**Last updated:** 2008/07/07
  * 2008/07/07:
    * Adjusted to use new index format of blog plugin.
  * 2008/03/01:
    * Added config option ''excluded_pages'' to exclude pages matching a given regex from showing the bloglinks link. 
  * 2007/11/06:
    * Fixed small compatibility issue with stable Dokuwiki version
  * 2007/11/04:
    * Initial release

===== Installation =====

==== With plugin manager ====

Let the manager do the dirty work, just give him this link to eat: {{plugin-bloglinks.tar.gz}}

==== Without plugin manager ====

  - Download the plugin: {{plugin-bloglinks.tar.gz}}
  - Extract it into your dokuwiki plugin folder (eg ''lib/plugins'')


===== Configuration =====

The bloglinks plugin is initially configured to show the blog links only in the ''blog'' namespace. Using the configuration manager((or manipulating ''$conf['plugin']['bloglinks']['enabled_namespaces']'')), you can enter other or additional namespaces (as a comma-separated list) for the plugin to be active in. Additionally, you can configure the text to be used for the generated links((''$conf['plugin']['bloglinks']['prev_link']'' and ''$conf['plugin']['bloglinks']['prev_link']'')).The following variables can be used in this configuration setting:

^ Variable ^ replaced by ^
| ''@@TITLE@@'' | the linked entries title |
| ''@@AUTHOR@@'' | the linked entries author |
| ''@@DATE@@'' | the linked entries creation date |
| ''@@NAME@@'' | a language specific name of the linked entries type (eg "Previous post") |

Using a configurable regex((saved in ''$conf['plugin']['bloglinks']['excluded_pages']'')), you can exclude certain pages in the allowed namespaces from showing the bloglinks bar. If you for example want to maintain yearly and monthly archives of blogposts in a blog using the title prefix ''%Y:%m:'', using the regex ''!^blog:\d{4}(:\d{2})?(:start)?$!'' would exclude these archive pages from displaying the bloglinks bar. The regex pattern has to be properly escaped and delimited. Examples for other useful regex patterns for common usecases are welcome, just add them in the comments.

~~DISCUSSION~~