From c522fffe09eea30a97213af1ecddfe6833d131e7 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sat, 12 Jul 2008 10:53:57 -0400 Subject: [PATCH] document uuid --- debian/changelog | 2 ++ doc/plugins/meta.mdwn | 13 +++++++++++++ doc/tips/howto_avoid_flooding_aggregators.mdwn | 3 +++ ...ity_to_force_particular_UUIDs_on_blog_posts.mdwn | 5 +++++ 4 files changed, 23 insertions(+) diff --git a/debian/changelog b/debian/changelog index 8c28e7238..f2ead8bad 100644 --- a/debian/changelog +++ b/debian/changelog @@ -15,6 +15,8 @@ ikiwiki (2.54) UNRELEASED; urgency=low * Change deb dependencies to list Text::Markdown before markdown, since the former, while slower, has a much better html parser that avoids numerous bugs. + * meta: Support a uuid option, to allow forcing a particular uuid + in feeds. -- Josh Triplett Wed, 09 Jul 2008 21:30:33 -0700 diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index c3f971d06..fa37a8246 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -123,6 +123,19 @@ Supported fields: contents. In particular, it does not check the values against the set of valid values but serves whatever you pass it. +* uuid + + Specifies a globally unique ID for a page. This ID will be used, + rather than the page url, in RSS and Atom feeds. + + The uuid can either be a literal uuid (ie, + "ec248d04-f347-4eb8-92b6-671b15d36980"), or it can be an alternative URl + for the page. + + This is mostly useful when a page's feed has moved, to keep the IDs for + pages unchanged and + [[avoid_flooding_aggregators|howto_avoid_flooding_aggregators]]. + If the field is not one of the above predefined fields, the metadata will be written to the generated html page as a <meta> header. However, this won't be allowed if the [[htmlscrubber]] is enabled, since it can be used to diff --git a/doc/tips/howto_avoid_flooding_aggregators.mdwn b/doc/tips/howto_avoid_flooding_aggregators.mdwn index 570baa5cc..0f7906b1e 100644 --- a/doc/tips/howto_avoid_flooding_aggregators.mdwn +++ b/doc/tips/howto_avoid_flooding_aggregators.mdwn @@ -23,3 +23,6 @@ parameter to the `inline` directive for your blog, with a condition such as: Where "old_post" is the name of the last post you made to the blog before making the change. This will limit the feed to only newer posts, while stil displaying the old posts in the blog page. + +Alternatively, you can add the [[plugins/meta]] uuid directives to pages, +to force the old url to be used. diff --git a/doc/todo/ability_to_force_particular_UUIDs_on_blog_posts.mdwn b/doc/todo/ability_to_force_particular_UUIDs_on_blog_posts.mdwn index 0f8f9bb73..d8f7c99ab 100644 --- a/doc/todo/ability_to_force_particular_UUIDs_on_blog_posts.mdwn +++ b/doc/todo/ability_to_force_particular_UUIDs_on_blog_posts.mdwn @@ -13,3 +13,8 @@ Perhaps ikiwiki's blogging functionality could be hooked up to the [meta plugin] > While I was there, I noticed that the quality of the generated Atom/RSS feeds could be improved by making more use of the meta plugin if it's also enabled - would anyone object to me hacking on this some more? > > -[smcv](http://smcv.pseudorandom.co.uk/) + +> [[merged|done]], thank you! +> +> Of course I'm happy if you can improve the feeds. They do already +> use some meta information (author, copyright). --[[Joey]] -- 2.32.0.93.g670b81a890