* Add a default stylesheet entry for the pagecloud.
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Sat, 28 Oct 2006 23:41:39 +0000 (23:41 +0000)
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Sat, 28 Oct 2006 23:41:39 +0000 (23:41 +0000)
* 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.

12 files changed:
doc/examples.mdwn [new file with mode: 0644]
doc/examples/blog.mdwn [new file with mode: 0644]
doc/examples/blog/index.mdwn [new file with mode: 0644]
doc/examples/blog/posts.mdwn [new file with mode: 0644]
doc/examples/blog/posts/first_post.mdwn [new file with mode: 0644]
doc/examples/blog/sidebar.mdwn [new file with mode: 0644]
doc/examples/blog/tags.mdwn [new file with mode: 0644]
doc/examples/blog/tags/life.mdwn [new file with mode: 0644]
doc/examples/blog/tags/tech.mdwn [new file with mode: 0644]

index 2947851f498cd502dd7fc797e3e78444138587af..0334670e1273bcf13d414f245d9bac8ee258c619 100644 (file)
@@ -83,6 +83,13 @@ td.changelog {
        font-style: italic;
+.pagecloud {
+       padding: 10px 10px;
+       border: 1px solid #aaa;
+       background: #eee;
+       color: black !important;
 /* Used for adding a blog page. */
 #blogform {
        padding: 10px 10px;
index bebe5ec9684476e029cd3bb689826011c6e15d26..3f0941cedc03bb75bc971222c6e5d79f84016e69 100644 (file)
@@ -13,8 +13,13 @@ ikiwiki (1.32) UNRELEASED; urgency=low
     (thousands) of pages.
   * Stylish update to the ikiwiki logo, thanks to Recai Oktaş and Selçuk
+  * 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.
- -- Joey Hess <joeyh@debian.org>  Sat, 28 Oct 2006 13:14:04 -0400
+ -- Joey Hess <joeyh@debian.org>  Sat, 28 Oct 2006 19:23:03 -0400
 ikiwiki (1.31) unstable; urgency=low
diff --git a/doc/examples.mdwn b/doc/examples.mdwn
new file mode 100644 (file)
index 0000000..8b52c2f
--- /dev/null
@@ -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 (file)
index 0000000..14e9b38
--- /dev/null
@@ -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 (file)
index 0000000..201abed
--- /dev/null
@@ -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
+[[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 (file)
index 0000000..c19ca15
--- /dev/null
@@ -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 (file)
index 0000000..f8a6988
--- /dev/null
@@ -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 (file)
index 0000000..203d2e0
--- /dev/null
@@ -0,0 +1,4 @@
+Example sidebar
+[[map pages="*blog/tags/* and !*/Discussion"]]
diff --git a/doc/examples/blog/tags.mdwn b/doc/examples/blog/tags.mdwn
new file mode 100644 (file)
index 0000000..08e7e5c
--- /dev/null
@@ -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 (file)
index 0000000..b6cf801
--- /dev/null
@@ -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 (file)
index 0000000..dff92f3
--- /dev/null
@@ -0,0 +1,3 @@
+This feed contains pages in the "tech" category.
+[[inline pages="link(tags/tech) and !*/Discussion" show=10 actions=yes]]
index 5eafcbfbdbe61f34990f0082498f9840250b4071..092da603dc2ae541999889d5074dc8bf17146808 100644 (file)
@@ -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