From ca30d95a78ca974c040c152b8c31bdd63f219e6b Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sat, 12 Jul 2008 10:59:45 -0400 Subject: [PATCH] rename uuid to guid --- IkiWiki/Plugin/inline.pm | 4 ++-- IkiWiki/Plugin/meta.pm | 4 ++-- debian/changelog | 4 ++-- doc/plugins/meta.mdwn | 12 ++++++------ doc/tips/howto_avoid_flooding_aggregators.mdwn | 2 +- ...lity_to_force_particular_UUIDs_on_blog_posts.mdwn | 4 ++++ templates/atomitem.tmpl | 4 ++-- templates/rssitem.tmpl | 4 ++-- 8 files changed, 21 insertions(+), 17 deletions(-) diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm index 2226e5723..2dcd1a90a 100644 --- a/IkiWiki/Plugin/inline.pm +++ b/IkiWiki/Plugin/inline.pm @@ -443,8 +443,8 @@ sub genfeed ($$$$@) { #{{{ ); if (exists $pagestate{$p} && - exists $pagestate{$p}{meta}{uuid}) { - $itemtemplate->param(uuid => $pagestate{$p}{meta}{uuid}); + exists $pagestate{$p}{meta}{guid}) { + $itemtemplate->param(guid => $pagestate{$p}{meta}{guid}); } if ($itemtemplate->query(name => "enclosure")) { diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm index 02c99e9f6..d7f56a8bd 100644 --- a/IkiWiki/Plugin/meta.pm +++ b/IkiWiki/Plugin/meta.pm @@ -84,14 +84,14 @@ sub preprocess (@) { #{{{ $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value); # fallthrough } - elsif ($key eq 'uuid') { + elsif ($key eq 'guid') { my $abs = $value; if ($abs =~ m/^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{12}$/) { $abs = lc "urn:uuid:$abs"; } - $pagestate{$page}{meta}{uuid}=HTML::Entities::encode_numeric($abs); + $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($abs); # fallthrough } elsif ($key eq 'license') { diff --git a/debian/changelog b/debian/changelog index f2ead8bad..e1d5ccb80 100644 --- a/debian/changelog +++ b/debian/changelog @@ -15,8 +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. + * meta: Support a guid option, to allow forcing a particular url or + 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 fa37a8246..12240422d 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -123,16 +123,16 @@ Supported fields: contents. In particular, it does not check the values against the set of valid values but serves whatever you pass it. -* uuid +* guid - Specifies a globally unique ID for a page. This ID will be used, - rather than the page url, in RSS and Atom feeds. + Specifies a globally unique ID for a page. This guid will be used, + rather than the page url, to identify the page 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 + The guid can either be a 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 + This is mostly useful when a page's feed has moved, to keep the guids for pages unchanged and [[avoid_flooding_aggregators|howto_avoid_flooding_aggregators]]. diff --git a/doc/tips/howto_avoid_flooding_aggregators.mdwn b/doc/tips/howto_avoid_flooding_aggregators.mdwn index 0f7906b1e..71077859f 100644 --- a/doc/tips/howto_avoid_flooding_aggregators.mdwn +++ b/doc/tips/howto_avoid_flooding_aggregators.mdwn @@ -24,5 +24,5 @@ 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, +Alternatively, you can add the [[plugins/meta]] guid 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 d8f7c99ab..9ee670f84 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 @@ -16,5 +16,9 @@ Perhaps ikiwiki's blogging functionality could be hooked up to the [meta plugin] > [[merged|done]], thank you! > +> I chose to use the term guid, since it's both a generic term that fits +> very well and describes both using a uuid and an url, and also happens +> to be the term rss uses. ;-) +> > Of course I'm happy if you can improve the feeds. They do already > use some meta information (author, copyright). --[[Joey]] diff --git a/templates/atomitem.tmpl b/templates/atomitem.tmpl index fdc629e39..19c557f30 100644 --- a/templates/atomitem.tmpl +++ b/templates/atomitem.tmpl @@ -1,7 +1,7 @@ <TMPL_VAR TITLE> - - + + diff --git a/templates/rssitem.tmpl b/templates/rssitem.tmpl index 4e2020269..1144cd5e2 100644 --- a/templates/rssitem.tmpl +++ b/templates/rssitem.tmpl @@ -5,8 +5,8 @@ <TMPL_VAR TITLE> - - + + -- 2.26.2