diff options
Diffstat (limited to 'ikiwiki')
| -rw-r--r-- | ikiwiki/blog.mdwn | 110 | ||||
| -rw-r--r-- | ikiwiki/directive.mdwn | 20 | ||||
| -rw-r--r-- | ikiwiki/formatting.mdwn | 6 | ||||
| -rw-r--r-- | ikiwiki/pagespec.mdwn | 10 | ||||
| -rw-r--r-- | ikiwiki/pagespec/attachment.mdwn | 41 |
5 files changed, 40 insertions, 147 deletions
diff --git a/ikiwiki/blog.mdwn b/ikiwiki/blog.mdwn index 53d4c7a..0a5a524 100644 --- a/ikiwiki/blog.mdwn +++ b/ikiwiki/blog.mdwn @@ -1,108 +1,8 @@ [[!meta robots="noindex, follow"]] -[[!if test="enabled(inline)" - then="This wiki has the inline plugin **enabled**." - else="This wiki has the inline plugin **disabled**."]] -[[!if test="enabled(inline)" - then="You can" - else="If this wiki had the inline plugin enabled, you could"]] -turn any page on this wiki into a weblog by using the `inline` -[[directive]]. For example: +This page has been removed from ikiwiki's basewiki. For documentation about +creating a blog with ikiwiki, see the documentation of the +[[!iki ikiwiki/directive/inline desc=inline]] directive. - \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]] - -Any pages that match the specified [[PageSpec]] (in the example, any -[[SubPage]] of "blog") will be part of the blog, and the newest 10 -of them will appear in the page. Note that if files that are not pages -match the [[PageSpec]], they will be included in the feed using RSS -enclosures, which is useful for podcasting. - -The optional `rootpage` parameter tells the wiki that new posts to this -blog should default to being [[SubPages|SubPage]] of "blog", and enables a -form at the top of the blog that can be used to add new items. - -If you want your blog to have an archive page listing every post ever made -to it, you can accomplish that like this: - - \[[!inline pages="blog/* and !*/Discussion" archive="yes"]] - -You can even create an automatically generated list of all the pages on the -wiki, with the most recently added at the top, like this: - - \[[!inline pages="* and !*/Discussion" archive="yes"]] - -If you want to be able to add pages to a given blog feed by tagging them, -you can do that too. To tag a page, just make it link to a page or pages -that represent its tags. Then use the special `link()` [[PageSpec]] to match -all pages that have a given tag: - - \[[!inline pages="link(life)"]] - -Or include some tags and exclude others: - - \[[!inline pages="link(debian) and !link(social)"]] - -## usage - -There are many parameters you can use with the `inline` -directive. These are the commonly used ones: - -* `pages` - A [[PageSpec]] of the pages to inline. -* `show` - Specify the maximum number of matching pages to inline. - Default is 10, unless archiving, when the default is to show all. - Set to 0 to show all matching pages. -* `archive` - If set to "yes", only list page titles and some metadata, not - full contents. -* `description` - Sets the description of the rss feed if one is generated. - Defaults to the name of the wiki. -* `skip` - Specify a number of pages to skip displaying. Can be useful - to produce a feed that only shows archived pages. -* `postform` - Set to "yes" to enable a form to post new pages to a - [[blog]]. -* `postformtext` - Set to specify text that is displayed in a postform. -* `rootpage` - Enable the postform, and allows controling where - newly posted pages should go, by specifiying the page that - they should be a [[SubPage]] of. - -Here are some less often needed parameters: - -* `actions` - If set to "yes" add links to the bottom of the inlined pages - for editing and discussion (if they would be shown at the top of the page - itself). -* `rss` - controls generation of an rss feed. If the wiki is configured to - generate rss feeds by default, set to "no" to disable. If the wiki is - configured to `allowrss`, set to "yes" to enable. -* `atom` - controls generation of an atom feed. If the wiki is configured to - generate atom feeds by default, set to "no" to disable. If the wiki is - configured to `allowatom`, set to "yes" to enable. -* `feeds` - controls generation of all types of feeds. Set to "no" to - disable generating any feeds. -* `template` - Specifies the template to fill out to display each inlined - page. By default the `inlinepage` template is used, while - the `archivepage` template is used for archives. Set this parameter to - use some other, custom template, such as the `titlepage` template that - only shows post titles. Note that you should still set `archive=yes` if - your custom template does not include the page content. -* `raw` - Rather than the default behavior of creating a [[blog]], - if raw is set to "yes", the page will be included raw, without additional - markup around it, as if it were a literal part of the source of the - inlining page. -* `sort` - Controls how inlined pages are sorted. The default, "age" is to - sort newest created pages first. Setting it to "title" will sort pages by - title, and "mtime" sorts most recently modified pages first. -* `reverse` - If set to "yes", causes the sort order to be reversed. -* `feedshow` - Specify the maximum number of matching pages to include in - the rss/atom feeds. The default is the same as the `show` value above. -* `feedonly` - Only generate the feed, do not display the pages inline on - the page. -* `quick` - Build archives in quick mode, without reading page contents for - metadata. By default, this also turns off generation of any feeds. -* `timeformat` - Use this to specify how to display the time or date for pages - in the blog. The format string is passed to the strftime(3) function. -* `feedpages` - A [[PageSpec]] of inlined pages to include in the rss/atom - feeds. The default is the same as the `pages` value above, and only pages - matches by that value are included, but some of those can be excluded by - specifying a tighter [[PageSpec]] here. -* `guid` - If a URI is given here (perhaps a UUID prefixed with `urn:uuid:`), - the Atom feed will have this as its `<id>`. The default is to use the URL - of the page containing the `inline` directive. +Please update your links, as this redirection page will be removed in a +future ikiwiki release. diff --git a/ikiwiki/directive.mdwn b/ikiwiki/directive.mdwn index a0a4e1f..c4342de 100644 --- a/ikiwiki/directive.mdwn +++ b/ikiwiki/directive.mdwn @@ -1,5 +1,5 @@ [[!meta robots="noindex, follow"]] -Directives are similar to a [[WikiLink]] in form, except they +Directives are similar to a [[ikiwiki/WikiLink]] in form, except they begin with `!` and may contain parameters. The general form is: \[[!directive param="value" param="value"]] @@ -29,11 +29,17 @@ of text with triple-quotes: """]] ikiwiki also has an older syntax for directives, which requires a -space in directives to distinguish them from [[wikilinks|wikilink]]. This -syntax has several disadvantages: it requires a space after directives with no -parameters (such as `\[[pagecount ]]`), and it prohibits spaces in -[[wikilinks|wikilink]]. ikiwiki now provides the `!`-prefixed syntax shown -above as the preferred alternative. However, ikiwiki still supports wikis -using the older syntax, if the `prefix_directives` option is not enabled. +space in directives to distinguish them from [[wikilinks|ikiwiki/wikilink]]. +This syntax has several disadvantages: it requires a space after directives +with no parameters (such as `\[[pagecount ]]`), and it prohibits spaces in +[[wikilinks|ikiwiki/wikilink]]. ikiwiki now provides the `!`-prefixed syntax +shown above as the preferred alternative. However, ikiwiki still supports +wikis using the older syntax, if the `prefix_directives` option is not enabled. For backward compatibility with existing wikis, this option currently defaults to off, so ikiwiki supports the old syntax. + +[[!if test="enabled(listdirectives)" then=""" +Here is a list of currently available directives in this wiki: + +[[!listdirectives ]] +"""]] diff --git a/ikiwiki/formatting.mdwn b/ikiwiki/formatting.mdwn index 0145f9d..2ed5cc2 100644 --- a/ikiwiki/formatting.mdwn +++ b/ikiwiki/formatting.mdwn @@ -77,7 +77,7 @@ you use the following additional features: * Insert various [[directives|directive]] onto a page to perform useful actions. -[[!if test="enabled(toc) or enabled(meta) or (enabled(inline) and blog)" then=""" +[[!if test="enabled(toc) or enabled(meta) or enabled(inline)" then=""" For example, you can: """]] @@ -94,8 +94,8 @@ you use the following additional features: \[[!meta title="full page title"]] """]] -[[!if test="enabled(inline) and blog" then=""" - * Create a [[blog]] by inlining a set of pages: +[[!if test="enabled(inline)" then=""" + * Create a blog by inlining a set of pages: \[[!inline pages="blog/*"]] """]] diff --git a/ikiwiki/pagespec.mdwn b/ikiwiki/pagespec.mdwn index 156e3f6..c78666c 100644 --- a/ikiwiki/pagespec.mdwn +++ b/ikiwiki/pagespec.mdwn @@ -22,8 +22,7 @@ match all pages except for Discussion pages and the SandBox: * and !SandBox and !*/Discussion -Some more elaborate limits can be added to what matches using any of these -functions: +Some more elaborate limits can be added to what matches using these functions: * "`link(page)`" - match only pages that link to a given page (or glob) * "`backlink(page)`" - match only pages that a given page links to @@ -41,6 +40,13 @@ functions: * "`title(glob)`", "`author(glob)`", "`authorurl(glob)`", "`license(glob)`", "`copyright(glob)`" - match pages that have the given metadata, matching the specified glob. +* "`user(username)`" - tests whether a modification is being made by a + user with the specified username. If openid is enabled, an openid can also + be put here. +* "`admin()`" - tests whether a modification is being made by one of the + wiki admins. +* "`ip(address)`" - tests whether a modification is being made from the + specified IP address. For example, to match all pages in a blog that link to the page about music and were written in 2005: diff --git a/ikiwiki/pagespec/attachment.mdwn b/ikiwiki/pagespec/attachment.mdwn index 6b86c51..2d33db7 100644 --- a/ikiwiki/pagespec/attachment.mdwn +++ b/ikiwiki/pagespec/attachment.mdwn @@ -16,41 +16,22 @@ check all attachments for virii, something like this could be used: The regular [[ikiwiki/PageSpec]] syntax is expanded with the following additional tests: -* maxsize(size) - - Tests whether the attachment is no larger than the specified size. - The size defaults to being in bytes, but "kb", "mb", "gb" etc can be - used to specify the units. +* "`maxsize(size)`" - Tests whether the attachment is no larger than the + specified size. The size defaults to being in bytes, but "kb", "mb", "gb" + etc can be used to specify the units. -* minsize(size) - - Tests whether the attachment is no smaller than the specified size. - -* ispage() +* "`minsize(size)`" - Tests whether the attachment is no smaller than the + specified size. - Tests whether the attachment will be treated by ikiwiki as a wiki page. - (Ie, if it has an extension of ".mdwn", or of any other enabled page - format). +* "`ispage()`" - Tests whether the attachment will be treated by ikiwiki as a + wiki page. (Ie, if it has an extension of ".mdwn", or of any other enabled + page format). So, if you don't want to allow wiki pages to be uploaded as attachments, use `!ispage()` ; if you only want to allow wiki pages to be uploaded as attachments, use `ispage()`. -* user(username) - - Tests whether the attachment is being uploaded by a user with the - specified username. If openid is enabled, an openid can also be put here. - -* ip(address) - - Tests whether the attacment is being uploaded from the specified IP - address. - -* mimetype(foo/bar) - - This checks the MIME type of the attachment. You can include a glob - in the type, for example `mimetype(image/*)`. - -* virusfree() +* "`mimetype(foo/bar)`" - This checks the MIME type of the attachment. You can + include a glob in the type, for example `mimetype(image/*)`. - Checks the attachment with an antiviral program. +* "`virusfree()`" - Checks the attachment with an antiviral program. |