====== Blog Plugin ======


---- plugin ----
description: Use DokuWiki as blogging tool. (previous authors: Esther Brunner)
author     : Gina Häußge, Michael Klier
email      : dokuwiki@chimeric.de
type       : syntax, action, helper
lastupdate : 2009-09-12
compatible : 2010-11-07, 2009-02-14, 2008-05-05
depends    : include, pagelist
conflicts  : 
similar    : 
tags       : blog, news

downloadurl: http://github.com/dokufreaks/plugin-blog/tarball/master
bugtracker : http://github.com/dokufreaks/plugin-blog/issues
sourcerepo : http://github.com/dokufreaks/plugin-blog/
----

===== Download =====

^  Download   | [[http://github.com/dokufreaks/plugin-blog/tarball/master|plugin-blog.tgz]] |
^  BundleHub  | Configure your own DokuWiki blogsuite install package, consisting of all mandatory plugins plus any optional features you want to include: \\ [[http://dokuwiki.foosel.org/blogsuite/index.php|BlogSuite BundleHub]]!:! ** The Bundle Hub might not always be in sync with the downloads provided by github** :!: |
^  Tips       | If you intend to use this plugin be sure to take a look at the [[tips:blogging|blogging tips page]] |


===== Description =====

The Blog [[plugins|Plugin]] makes blogs in your wiki easily possible. The [[#blog]] component shows the latest entries (pages) from a namespace in reverse chronological order. In this new version, the creation date is the sort key -- no longer the date of the last non-minor modification as in previous versions. The [[#archive]] component lists all entries that were written (created) in the given month.

If you use this plugin for blogging you might want to join [[http://planet.dokuwiki.org/|Planet DokuWiki]].

===== Configuration =====
The blog plugin can be configured using the DokuWiki configuration manager available in the admin menu.

^ ''namespace'' | The default namespace which is used if no namespace was given in the syntax |
^ ''formposition'' | You can choose to display the new entry form either above or below the blog entries |
^ ''dateprefix'' | A date prefix that automatically gets added to pages created with the new entry form. You can use the options from the [[phpnet>strftime]] PHP function; namespace separators work as well, e.g. ''%Y:%m%d'' |
^ ''sortkey'' | Defines how the blog entries are sorted. Available options are creation date, modification date, page name, page ID and page title (first headline) |
^ ''sortorder'' | Sort the blog entries ascending/descending |
^ ''showhistogram'' | Display a histogram in normal archive mode (not for autoarchive) |

===== Components =====

==== Blog ====

  {{blog>[namespace]?[number]&[flags]}}

^ [namespace] | namespace for the blog; subspaces will be searched as well; ''*'' is the whole wiki, ''.'' is the same namespace as the page lies in  | optional; default is the blog namespace set in the configuration |
^ [number] | number of entries to show per page | optional; default is 5 |
^ [flags] | include flags delimited by ''&'', see [[include#flags]] + topform/bottomform/noform | optional |

This includes a specified number of most recent blog entries from the given namespace into the current page. Below the entries a link to the page (permalink), the author, the creation date and the number of comments are shown. Link, author, date and comments info can be hidden. At the end of the blog a link to older entries lets you navigate in the history of the blog. At the very end, if you have enough rights to create new pages, a form for new blog entries is displayed.


==== Archive ====

  {{archive>[namespace]?[month]&[flags]}}

^ [namespace] | the namespace for which you want an archive list; ''*'' is the whole wiki, ''.'' is the same namespace as the page lies in | optional; default is the namespace specified in the configuration |
^ [month] | the month for the archive list in YYYY-MM format; ''*'' for all pages | required |
^ [flags] | pagelist flags delimited by ''&'', see [[pagelist#flags]] | optional |

Shows a table with all pages of the given namespace that were created in the specified month.

  {{autoarchive>[namespace]}}

Creates an automatic archive.

===== Demo =====

You can try this plugin using the [[http://chimeric.de/_demo/plugin:blog|live demo]]. FIXME


===== Bugs / Feature Requests =====
Please report bugs or feature requests at the [[http://github.com/dokufreaks/plugin-blog/issues|Bug tracker]].



===== Further Resources =====
  * [[http://github.com/dokufreaks/plugin-blog/tree/master|Git Repository]]
  * [[http://github.com/dokufreaks/plugin-blog/issues|Bug Tracker]]


===== Changes =====

{{rss>http://github.com/feeds/dokufreaks/commits/plugin-blog/master date}}


===== FAQ =====
Please also have a look at the [[tips:blogging]] tips page!

==== My dates are shown wrong. What can I do? ====
Make sure you run the latest version of all required plugins and DokuWiki.

==== Is it possible to change the way the date is displayed? ====
Yes, the plugin uses the [[config:dformat]] option to format the date.

==== How can I alter the date of a blog post? ====
You can use the [[plugin:meta]] plugin to manually set the creation date (and modification date) in the page source, then select the modification date in the blog plugins order setting. An alternative solution would be to alter the timestamps of the created files, and remove the ''<dokuwiki>/data/index/cdate.idx'' (make backups if you intend to do that!!)

==== Is it possible to show table of contents? ====
Table of contents may be useful for looking at the contents of a huge blog.