summaryrefslogtreecommitdiff
path: root/doc/examples
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-28 23:41:39 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-28 23:41:39 +0000
commit4109ef94fd53a03fd8f402e1baed18d27c5c4f42 (patch)
tree324badd702e5890d3c5966ea1e5d8a3a22abded6 /doc/examples
parent74b5fb09aae8166b3614c206a9e7e4a227cd9a16 (diff)
* Add a default stylesheet entry for the pagecloud.
* Add examples page with some examples of things that can be done using ikiwiki, like a weblog. The examples can be copied into a user's wiki for a quick start, without needing to learn everything about how to put them together.
Diffstat (limited to 'doc/examples')
-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
8 files changed, 49 insertions, 0 deletions
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]]