summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/examples.mdwn7
-rw-r--r--doc/examples/blog.mdwn18
-rw-r--r--doc/examples/blog/index.mdwn10
-rw-r--r--doc/examples/blog/posts.mdwn3
-rw-r--r--doc/examples/blog/posts/first_post.mdwn4
-rw-r--r--doc/examples/blog/sidebar.mdwn4
-rw-r--r--doc/examples/blog/tags.mdwn3
-rw-r--r--doc/examples/blog/tags/life.mdwn4
-rw-r--r--doc/examples/blog/tags/tech.mdwn3
-rw-r--r--doc/features.mdwn3
10 files changed, 58 insertions, 1 deletions
diff --git a/doc/examples.mdwn b/doc/examples.mdwn
new file mode 100644
index 000000000..8b52c2f08
--- /dev/null
+++ b/doc/examples.mdwn
@@ -0,0 +1,7 @@
+To make it easier to get started using ikiwiki for some common tasks, this
+page gives some examples of ways to use ikiwiki.
+
+* [[blog]] - a weblog with tags, a tag cloud, archives, and an optional sidebar
+
+Each example is contained in its own subdirectory; just copy the source
+files into your wiki to start using one of the examples.
diff --git a/doc/examples/blog.mdwn b/doc/examples/blog.mdwn
new file mode 100644
index 000000000..14e9b3804
--- /dev/null
+++ b/doc/examples/blog.mdwn
@@ -0,0 +1,18 @@
+This is an [[example_blog|index]]. Just copy the blog subdirectory into
+your wiki to quickly get started blogging with ikiwiki.
+
+Some additional configuration you might want to do:
+
+* Change the name of the blog, by editing `index.mdwn` and changing
+ the `title`.
+
+* Make sure to configure ikiwiki to generate RSS or Atom feeds.
+
+* Make sure you have the tag plugin enabled, and tag posts using it. An
+ example of how to tag a post is:
+ \[[tag tags/life]]
+
+* Enable the sidebar plugin to get a sidebar listing all the categories
+ you've tagged posts with.
+
+* Enable the pagestats plugin to get a tag cloud display on the [[index]].
diff --git a/doc/examples/blog/index.mdwn b/doc/examples/blog/index.mdwn
new file mode 100644
index 000000000..201abed20
--- /dev/null
+++ b/doc/examples/blog/index.mdwn
@@ -0,0 +1,10 @@
+[[meta title="example blog"]]
+
+[[pagestats pages="*blog/tags/*"]]
+
+Welcome to my blog. Have a look at the most recent posts below, or
+browse the tag cloud on the right. An archive of all [[posts]] is also
+available.
+
+[[inline pages="*blog/posts/* and !*/Discussion" show="10"
+actions=yes rootpage="*blog/posts"]]
diff --git a/doc/examples/blog/posts.mdwn b/doc/examples/blog/posts.mdwn
new file mode 100644
index 000000000..c19ca1516
--- /dev/null
+++ b/doc/examples/blog/posts.mdwn
@@ -0,0 +1,3 @@
+Here is a full list of posts to my [[blog|index]].
+
+[[inline pages="*blog/posts/* and !*/Discussion" archive="yes"]]
diff --git a/doc/examples/blog/posts/first_post.mdwn b/doc/examples/blog/posts/first_post.mdwn
new file mode 100644
index 000000000..f8a698801
--- /dev/null
+++ b/doc/examples/blog/posts/first_post.mdwn
@@ -0,0 +1,4 @@
+This is the first post to this example blog. To add new posts, just add
+files to the blog/posts/ subdirectory, or use the web form.
+
+[[tag tags/tech]]
diff --git a/doc/examples/blog/sidebar.mdwn b/doc/examples/blog/sidebar.mdwn
new file mode 100644
index 000000000..203d2e0c6
--- /dev/null
+++ b/doc/examples/blog/sidebar.mdwn
@@ -0,0 +1,4 @@
+Example sidebar
+
+Categories:
+[[map pages="*blog/tags/* and !*/Discussion"]]
diff --git a/doc/examples/blog/tags.mdwn b/doc/examples/blog/tags.mdwn
new file mode 100644
index 000000000..08e7e5c57
--- /dev/null
+++ b/doc/examples/blog/tags.mdwn
@@ -0,0 +1,3 @@
+[[pagestats pages="*blog/tags/*"]]
+
+On the right you can see the tag cloud for this blog.
diff --git a/doc/examples/blog/tags/life.mdwn b/doc/examples/blog/tags/life.mdwn
new file mode 100644
index 000000000..b6cf801e1
--- /dev/null
+++ b/doc/examples/blog/tags/life.mdwn
@@ -0,0 +1,4 @@
+This feed contains pages in the "life" category.
+
+[[inline pages="link(tags/life) and *blog/posts/* and !*/Discussion"
+show="10" actions=yes]]
diff --git a/doc/examples/blog/tags/tech.mdwn b/doc/examples/blog/tags/tech.mdwn
new file mode 100644
index 000000000..dff92f333
--- /dev/null
+++ b/doc/examples/blog/tags/tech.mdwn
@@ -0,0 +1,3 @@
+This feed contains pages in the "tech" category.
+
+[[inline pages="link(tags/tech) and !*/Discussion" show=10 actions=yes]]
diff --git a/doc/features.mdwn b/doc/features.mdwn
index 5eafcbfbd..092da603d 100644
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -53,7 +53,8 @@ specified [[PageSpec]] will be displayed as a weblog within the blog
page. And RSS or Atom feeds can be generated to follow the blog.
Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
-of some of the flexible ways that this can be used.
+of some of the flexible ways that this can be used. There is also an
+[[example_blog|examples/blog]] set up that you can copy into your own wiki.
Ikiwiki can also [[plugins/aggregate]] external blogs, feeding them into
the wiki. This can be used to create a Planet type site that aggregates