correct a typo
[ikiwiki.git] / doc / ikiwiki / blog.mdwn
1 [[!if test="enabled(inline)"
2      then="This wiki has the inline plugin **enabled**."
3      else="This wiki has the inline plugin **disabled**."]]
4
5 [[!if test="enabled(inline)"
6      then="You can"
7      else="If this wiki had the inline plugin enabled, you could"]]
8 turn any page on this wiki into a weblog by using the `inline`
9 [[PreProcessorDirective]]. For example:
10
11         \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
12
13 Any pages that match the specified [[PageSpec]] (in the example, any
14 [[SubPage]] of "blog") will be part of the blog, and the newest 10
15 of them will appear in the page. Note that if files that are not pages
16 match the [[PageSpec]], they will be included in the feed using RSS
17 enclosures, which is useful for podcasting.
18
19 The optional `rootpage` parameter tells the wiki that new posts to this blog
20 should default to being [[SubPage]]s of "blog", and enables a form at the
21 top of the blog that can be used to add new items.
22
23 If you want your blog to have an archive page listing every post ever made
24 to it, you can accomplish that like this:
25
26         \[[!inline pages="blog/* and !*/Discussion" archive="yes"]]
27
28 You can even create an automatically generated list of all the pages on the
29 wiki, with the most recently added at the top, like this:
30
31         \[[!inline pages="* and !*/Discussion" archive="yes"]]
32
33 If you want to be able to add pages to a given blog feed by tagging them,
34 you can do that too. To tag a page, just make it link to a page or pages 
35 that represent its tags. Then use the special `link()` [[PageSpec]] to match
36 all pages that have a given tag:
37
38         \[[!inline pages="link(life)"]]
39
40 Or include some tags and exclude others:
41
42         \[[!inline pages="link(debian) and !link(social)"]]
43
44 ## usage
45
46 Here are descriptions of all the supported parameters to the `inline`
47 directive:
48
49 * `pages` - A [[PageSpec]] of the pages to inline.
50 * `show` - Specify the maximum number of matching pages to inline.
51   Default is 10, unless archiving, when the default is to show all.
52   Set to 0 to show all matching pages.
53 * `skip` - Specify a number of pages to skip displaying. Can be useful
54   to produce a feed that only shows archived pages.
55 * `rss` - controls generation of an rss feed. If the wiki is configured to
56   generate rss feeds by default, set to "no" to disable. If the wiki is
57   configured to `allowrss`, set to "yes" to enable.
58 * `atom` - controls generation of an atom feed. If the wiki is configured to
59   generate atom feeds by default, set to "no" to disable. If the wiki is
60   configured to `allowatom`, set to "yes" to enable.
61 * `feeds` - controls generation of all types of feeds. Set to "no" to
62   disable generating any feeds.
63 * `postform` - Set to "yes" to enables a form to post new pages to a [[blog]].
64 * `postformtext` - Set to specify text that is displayed in a postform.
65 * `rootpage` - Also enables a form to post new pages to a [[blog]], and
66   allows specifying of a page that is used as the parent page for new pages.
67 * `archive` - If set to "yes", only list page titles and some metadata, not
68   full controls.
69 * `quick` - Build archives in quick mode, without reading page contents for
70   metadata. By default, this also turns off generation of any feeds.
71 * `template` - Specifies the template to fill out to display each inlined
72   page. By default the `inlinepage` template is used, while
73   the `archivepage` template is used for archives. Set this parameter to
74   use some other, custom template, such as the `titlepage` template that
75   only shows post titles. Note that you should still set `archive=yes` if
76   your custom template does not include the page content.
77 * `raw` - Rather than the default behavior of creating a [[blog]],
78   if raw is set to "yes", the page will be included raw, without additional
79   markup around it, as if it were a literal part of the source of the 
80   inlining page.
81 * `description` - Sets the description of the rss feed if one is generated.
82   Defaults to the name of the wiki.
83 * `actions` - If set to "yes" add links to the bottom of the inlined pages 
84   for editing and discussion (if they would be shown at the top of the page
85   itself).
86 * `sort` - Controls how inlined pages are sorted. The default, "age" is to
87   sort newest created pages first. Setting it to "title" will sort pages by
88   title, and "mtime" sorts most recently modified pages first.
89 * `reverse` - If set to "yes", causes the sort order to be reversed.
90 * `feedpages` - A [[PageSpec]] of inlined pages to include in the rss/atom
91   feeds. The default is the same as the `pages` value above, and only pages
92   matches by that value are included, but some of those can be excluded by
93   specifying a tighter [[PageSpec]] here.
94 * `feedshow` - Specify the maximum number of matching pages to include in
95   the rss/atom feeds. The default is the same as the `show` value above.
96 * `feedonly` - Only generate the feed, do not display the pages inline on
97   the page.
98 * `timeformat` - Use this to specify how to display the time or date for pages
99   in the blog. The format string is passed to the strftime(3) function.