You are here: start » en » Internal Documentation » DokuWiki extensions (WvdS) » Blog » Quickstart: publish the first blog entry

Quickstart: publish the first blog entry

The shortest way from “the plugin is installed” to “a post is in the list”. Four steps, about ten minutes. The screen Add New Post writes the metadata block for you that you would otherwise type by hand.

Prerequisites

  • wkblog is installed and enabled — and with it wkcore and wksqliteds. Both are required, not optional: the blog engine runs on named SQL routines that wksqliteds supplies and wkcore publishes. There is no inline-SQL fallback.
  • You are signed in as superuser.
  • You may create pages in the namespace the blog will live in.

Step 1: open the screen

Admin → Manage Blogs (WvdS Blog), directly /doku.php?do=admin&page=wkblog.

Step 2: create the post

Choose Add New Post (/doku.php?do=admin&page=wkblog&admin=newpost) and fill in:

Field What goes in it
Title The post's headline. The page name is derived from it unless you give a slug.
Target namespace (visibility) The namespace the page is created in, for example en:site:blog. It also decides who may see the post — through the ordinary DokuWiki ACL.
Blog template The blog the post belongs to.
Status Published for this run.

Choose Create and edit.

Step 3: write the text

You are now in the page editor. At the top sits the metadata block the screen wrote, roughly:

<wk:blog type="post" status="published" blog="default" />

Write the post below it and save.

Note what did not happen: you did not write to a database. You wrote a page; the index followed it on first render.

Step 4: create the list

Create the blog's start page, for example en:site:blog:start, and write:

<blog>
blog: default
limit: 10
sortby: created
</blog>

Check the result

  • The list page shows your post with title and teaser.
  • The post itself opens as an ordinary wiki page — with revision history, diffs, search and permissions, because it is one.
  • A counter-check on how disposable the index is: Reindex blog on the administration screen. The post is unchanged afterwards, because it was in the page the whole time. An index problem therefore has the answer “rebuild”, not “recover”.

Next step

  • wkopengraph — so a shared post gets a proper preview card. wkblog writes the same page metadata, so a separate <og> block is not needed.
  • wksqliteds — the layer the routines run on.
  • wkblog (German) — the package page: every attribute of the metadata block, list kinds, ~~READMORE~~, scheduled posts, comments.
en/wiki/dwe/wkblog/quickstart.txt · Last modified: by rollout