ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / ikiwiki / directive / inline.mdwn
1 The `inline` directive is supplied by the [[!iki plugins/inline desc=inline]] plugin.
2
3 This is a directive that allows including one wiki page inside another.
4 The most common use of inlining is generating blogs and RSS or Atom feeds.
5
6 Example:
7
8         \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
9
10 Any pages that match the specified [[PageSpec]] (in the example, any
11 [[SubPage]] of "blog") will be part of the blog, and the newest 10
12 of them will appear in the page. Note that if files that are not pages
13 match the [[PageSpec]], they will be included in the feed using RSS
14 enclosures, which is useful for podcasting.
15
16 The optional `rootpage` parameter tells the wiki that new posts to this
17 blog should default to being [[SubPages|SubPage]] of "blog", and enables a
18 form at the top of the blog that can be used to add new items.
19
20 If you want your blog to have an archive page listing every post ever made
21 to it, you can accomplish that like this:
22
23         \[[!inline pages="blog/* and !*/Discussion" archive="yes"]]
24
25 You can even create an automatically generated list of all the pages on the
26 wiki, with the most recently added at the top, like this:
27
28         \[[!inline pages="* and !*/Discussion" archive="yes"]]
29
30 If you want to be able to add pages to a given blog feed by tagging them,
31 you can do that too. To tag a page, just make it link to a page or pages 
32 that represent its tags. Then use the special `link()` [[PageSpec]] to match
33 all pages that have a given tag:
34
35         \[[!inline pages="link(life)"]]
36
37 Or include some tags and exclude others:
38
39         \[[!inline pages="link(debian) and !link(social)"]]
40
41 ## usage
42
43 There are many parameters you can use with the `inline`
44 directive. These are the commonly used ones:
45
46 * `pages` - A [[PageSpec]] of the pages to inline.
47 * `show` - Specify the maximum number of matching pages to inline.
48   Default is 10, unless archiving, when the default is to show all.
49   Set to 0 to show all matching pages.
50 * `archive` - If set to "yes", only list page titles and some metadata, not
51   full contents.
52 * `description` - Sets the description of the rss feed if one is generated.
53   Defaults to the name of the wiki.
54 * `skip` - Specify a number of pages to skip displaying. Can be useful
55   to produce a feed that only shows archived pages.
56 * `postform` - Set to "yes" to enable a form to post new pages to a
57   blog.
58 * `postformtext` - Set to specify text that is displayed in a postform.
59 * `rootpage` - Enables the postform, and allows controling where
60   newly posted pages should go, by specifiying the page that
61   they should be a [[SubPage]] of.
62
63 Here are some less often needed parameters:
64
65 * `actions` - If set to "yes" add links to the bottom of the inlined pages 
66   for editing and discussion (if they would be shown at the top of the page
67   itself).
68 * `rss` - controls generation of an rss feed. If the wiki is configured to
69   generate rss feeds by default, set to "no" to disable. If the wiki is
70   configured to `allowrss`, set to "yes" to enable.
71 * `atom` - controls generation of an atom feed. If the wiki is configured to
72   generate atom feeds by default, set to "no" to disable. If the wiki is
73   configured to `allowatom`, set to "yes" to enable.
74 * `feeds` - controls generation of all types of feeds. Set to "no" to
75   disable generating any feeds.
76 * `emptyfeeds` - Set to "no" to disable generation of empty feeds.
77   Has no effect if `rootpage` or `postform` is set.
78 * `id` - Set to specify the value of the HTML `id` attribute for the
79  feed links or the post form. Useful if you have multiple forms in the
80  same page.
81 * `template` - Specifies the template to fill out to display each inlined
82   page. By default the `inlinepage` template is used, while
83   the `archivepage` template is used for archives. Set this parameter to
84   use some other, custom template, such as the `titlepage` template that
85   only shows post titles or the `microblog` template, optimised for
86   microblogging. Note that you should still set `archive=yes` if
87   your custom template does not include the page content.
88 * `raw` - Rather than the default behavior of creating a blog,
89   if raw is set to "yes", the page will be included raw, without additional
90   markup around it, as if it were a literal part of the source of the 
91   inlining page.
92 * `sort` - Controls how inlined pages are [[sorted|pagespec/sorting]].
93   The default is to sort the newest created pages first.
94 * `reverse` - If set to "yes", causes the sort order to be reversed.
95 * `feedshow` - Specify the maximum number of matching pages to include in
96   the rss/atom feeds. The default is the same as the `show` value above.
97 * `feedonly` - Only generate the feed, do not display the pages inline on
98   the page.
99 * `quick` - Build archives in quick mode, without reading page contents for
100   metadata. This also turns off generation of any feeds.
101 * `timeformat` - Use this to specify how to display the time or date for pages
102   in the blog. The format string is passed to the strftime(3) function.
103 * `feedpages` - A [[PageSpec]] of inlined pages to include in the rss/atom
104   feeds. The default is the same as the `pages` value above, and only pages
105   matched by that value are included, but some of those can be excluded by
106   specifying a tighter [[PageSpec]] here.
107 * `guid` - If a URI is given here (perhaps a UUID prefixed with `urn:uuid:`),
108   the Atom feed will have this as its `<id>`. The default is to use the URL
109   of the page containing the `inline` directive.
110 * `feedfile` - Can be used to change the name of the file generated for the
111   feed. This is particularly useful if a page contains multiple feeds.
112   For example, set "feedfile=feed" to cause it to generate `page/feed.atom`
113   and/or `page/feed.rss`. This option is not supported if the wiki is
114   configured not to use `usedirs`.
115 * `pagenames` - If given instead of `pages`, this is interpreted as a
116   space-separated list of absolute page names ([[SubPage/LinkingRules]] are
117   not taken into account), and they are inlined in exactly the order given:
118   the `sort` and `pages` parameters cannot be used in conjunction with
119   this one.
120 * `trail` - If set to "yes" and the [[!iki plugins/trail desc=trail]] plugin
121   is enabled, turn the inlined pages into a trail with next/previous links,
122   by passing the same options to [[ikiwiki/directive/trailitems]]. The `skip`
123   and `show` options are ignored by the trail, so the next/previous links
124   traverse through all matching pages.
125
126 [[!meta robots="noindex, follow"]]