DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:blog

Blog Plugin

Compatible with DokuWiki

  • 2013-12-08 "Binky" unknown
  • 2013-05-10 "Weatherwax" yes
  • 2012-10-13 "Adora Belle" yes
  • 2012-01-25 "Angua" yes

plugin Use DokuWiki as blogging tool. (previous authors: Esther Brunner)

Last updated on
2013-10-20
Provides
Syntax, Helper, Action
Repository
Source
Requires
include, pagelist

Similar to bliki, blogtng, content

Tagged with blog, news

Needed for bloglinks, feed

Description

The Blog 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.

You can try this plugin using the live demo.

If you use this plugin for blogging you might want to join Planet DokuWiki.

Installation

Download plugin-blog.tgz
BundleHub Configure your own DokuWiki blogsuite install package, consisting of all mandatory plugins plus any optional features you want to include:
BlogSuite BundleHub :!: The Bundle Hub is currently out of date and not updated anymore, please install the plugins individually :!:
FIXME Site seems to be down for sime time, here is the archived version if you want to see possible optional plugins & features.
Tips If you intend to use this plugin be sure to take a look at the blogging tips page

Syntax

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] flags are delimited by &
all Include plugin flags are supported optional
Form placement: topform/bottomform/noform optional, default is topform
Custom new-entry form title: newentrytitle=Custom title optional, can also be set as a configuration option

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 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.

Configuration and Settings

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
newentrytitle Set a custom title for all new entry forms. This can also be set on individual blog forms.
dateprefix A date prefix that automatically gets added to pages created with the new entry form. You can use the options from the 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)

Changes

  • 2013-10-20: Translation updates, fix cache handling for empty blog listings
  • 2013-03-27: Better cache handling for the archive syntax
    • the syntax that lists everything till now correctly updates the cache now whenever a page is changed or a comment or linkback is added.
    • the cache is not used anymore when it contains an archive listing with a page that the current user can't access. The excluded pages won't be included again automatically unless the cache expires for other reasons, the ~~NOCACHE~~ macro can be used if this is needed.

Development

Change Log

Bugs / Feature Requests

Please report bugs or feature requests at the Bug tracker.

FAQ

Please also have a look at the 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 dformat option to format the date.

How can I alter the date of a blog post?

You can use the 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.

Is it possible to show table of contents?

The table of contents is shown automatically (depending on the settings in DokuWiki itself) from version 2013-02-07 on.

The blog plugin assumes that in the context of a blog the header should be a link. However from version 2013-02-26 on it is possible to disable this behavior by using the nolink-flag, the blog plugin now only sets a default without overriding the nolink flag.

Discussion

Please report bugs or feature requests at the Bug tracker.

plugin/blog.txt · Last modified: 2014/03/20 10:52 by Aleksandr