From 770dc95a6bd7344b037d052b03472b1f84cefdf4 Mon Sep 17 00:00:00 2001 From: Amitai Schlair Date: Tue, 19 Feb 2013 19:47:47 -0500 Subject: [PATCH] Start documenting eventual docwiki changes. --- doc/features.mdwn | 8 +++++--- doc/ikiwiki/directive/inline.mdwn | 3 ++- doc/ikiwiki/directive/meta.mdwn | 5 +++++ 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/features.mdwn b/doc/features.mdwn index 66f7ecb73..5bbe5ef21 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -64,9 +64,11 @@ Ikiwiki can also [[plugins/aggregate]] external blogs, feeding them into the wiki. This can be used to create a Planet type site that aggregates interesting feeds. -You can also mix blogging with podcasting by dropping audio files where -they will be picked up like blog posts. This will work for any files that -you would care to syndicate. +You can also mix blogging with podcasting. Simply drop media files +where they will be picked up like blog posts. For fuller-featured +podcast feeds, enclose media files in blog posts using [[plugins/meta]]. +Either way, this will work for any files that you would care to +syndicate. ## Valid html and [[css]] diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn index a9c241afc..c0d4e035b 100644 --- a/doc/ikiwiki/directive/inline.mdwn +++ b/doc/ikiwiki/directive/inline.mdwn @@ -11,7 +11,8 @@ 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. +enclosures, which is useful for simple podcasting; for fuller-featured +podcast feeds, enclose media files in blog posts using [[meta]]. The optional `rootpage` parameter tells the wiki that new posts to this blog should default to being [[SubPages|SubPage]] of "blog", and enables a diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn index 984f68540..fbbffa575 100644 --- a/doc/ikiwiki/directive/meta.mdwn +++ b/doc/ikiwiki/directive/meta.mdwn @@ -136,6 +136,11 @@ Supported fields: [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled, since it can be used to insert unsafe content. +* enclosure + + Specifies a link to a file to be rendered as an "enclosure" in + RSS/Atom feeds (and a plain old link in HTML). Useful for podcasting. + * redir Causes the page to redirect to another page in the wiki.