meta: generalize meta_title into meta(title); support author, updated, date
authorSimon McVittie <smcv@debian.org>
Sat, 3 Apr 2010 13:17:48 +0000 (14:17 +0100)
committerSimon McVittie <smcv@debian.org>
Sun, 4 Apr 2010 00:43:02 +0000 (01:43 +0100)
I've left meta_title in, undocumented, as a possible replacement for
sort=title in IkiWiki 4.0 or something.

IkiWiki/Plugin/meta.pm
doc/ikiwiki/directive/meta.mdwn
doc/ikiwiki/pagespec/sorting.mdwn

index cd7d0d1277a47d4fcdd889961e81204d2a470010..c9fdbc9341ac32f899be991a4956fa06b2a5b96c 100644 (file)
@@ -122,6 +122,12 @@ sub preprocess (@) {
        }
        elsif ($key eq 'author') {
                $pagestate{$page}{meta}{author}=$value;
        }
        elsif ($key eq 'author') {
                $pagestate{$page}{meta}{author}=$value;
+               if (exists $params{sort}) {
+                       $pagestate{$page}{meta}{authorsort}=$params{sort};
+               }
+               else {
+                       $pagestate{$page}{meta}{authorsort}=$value;
+               }
                # fallthorough
        }
        elsif ($key eq 'authorurl') {
                # fallthorough
        }
        elsif ($key eq 'authorurl') {
@@ -288,14 +294,31 @@ sub pagetemplate (@) {
        }
 }
 
        }
 }
 
-sub titlesort {
-       my $key = $pagestate{$_[0]}{meta}{titlesort};
+sub get_sort_key {
+       my $page = $_[0];
+       my $meta = $_[1];
 
 
-       if (defined $key) {
-               return $key;
-       }
+       # e.g. titlesort (also makes sense for author)
+       my $key = $pagestate{$page}{meta}{$meta . "sort"};
+       return $key if defined $key;
+
+       # e.g. title
+       $key = $pagestate{$page}{meta}{$meta};
+       return $key if defined $key;
 
 
-       return pagetitle(IkiWiki::basename($_[0]));
+       # fall back to closer-to-core things
+       if ($meta eq 'title') {
+               return pagetitle(IkiWiki::basename($page));
+       }
+       elsif ($meta eq 'date') {
+               return $IkiWiki::pagectime{$page};
+       }
+       elsif ($meta eq 'updated') {
+               return $IkiWiki::pagemtime{$page};
+       }
+       else {
+               return '';
+       }
 }
 
 sub match {
 }
 
 sub match {
@@ -350,10 +373,27 @@ sub match_copyright ($$;@) {
 
 package IkiWiki::SortSpec;
 
 
 package IkiWiki::SortSpec;
 
+sub cmp_meta {
+       my $left = $_[0];
+       my $right = $_[1];
+       my $meta = $_[2];
+       error(gettext("sort=meta requires a parameter")) unless defined $meta;
+
+       if ($meta eq 'updated' || $meta eq 'date') {
+               return IkiWiki::Plugin::meta::get_sort_key($left, $meta)
+                       <=>
+                       IkiWiki::Plugin::meta::get_sort_key($right, $meta);
+       }
+
+       return IkiWiki::Plugin::meta::get_sort_key($left, $meta)
+               cmp
+               IkiWiki::Plugin::meta::get_sort_key($right, $meta);
+}
+
+# A prototype of how sort=title could behave in 4.0 or something
 sub cmp_meta_title {
 sub cmp_meta_title {
-       IkiWiki::Plugin::meta::titlesort($_[0])
-       cmp
-       IkiWiki::Plugin::meta::titlesort($_[1])
+       $_[2] = 'title';
+       return cmp_meta(@_);
 }
 
 1
 }
 
 1
index 8d2a5b1ad40129622f2d20724955c0bfdeeeb845..c5f74fac5a8c00b25096945a6f29f4ef30f00182 100644 (file)
@@ -24,7 +24,7 @@ Supported fields:
   differently in this case.
 
   An optional `sort` parameter will be used preferentially when
   differently in this case.
 
   An optional `sort` parameter will be used preferentially when
-  [[ikiwiki/pagespec/sorting]] by `meta_title`:
+  [[ikiwiki/pagespec/sorting]] by `meta(title)`:
 
        \[[!meta title="The Beatles" sort="Beatles, The"]]
 
 
        \[[!meta title="The Beatles" sort="Beatles, The"]]
 
@@ -44,6 +44,11 @@ Supported fields:
 
   Specifies the author of a page.
 
 
   Specifies the author of a page.
 
+  An optional `sort` parameter will be used preferentially when
+  [[ikiwiki/pagespec/sorting]] by `meta(author)`:
+
+       \[[!meta author="Joey Hess" sort="Hess, Joey"]]
+
 * authorurl
 
   Specifies an url for the author of a page.
 * authorurl
 
   Specifies an url for the author of a page.
index ba995a521632edaddd97d120ddd039e41e73e139..fbf598340983633616be065aa18ce5e10f508f27 100644 (file)
@@ -11,9 +11,10 @@ orders can be specified.
   as such, ("1 2 9 10 20" instead of "1 10 2 20 9")
 """]]
 [[!if test="enabled(meta)" then="""
   as such, ("1 2 9 10 20" instead of "1 10 2 20 9")
 """]]
 [[!if test="enabled(meta)" then="""
-* `meta_title` - Order according to the `\[[!meta title="foo" sort="bar"]]`
+* `meta(title)` - Order according to the `\[[!meta title="foo" sort="bar"]]`
   or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
   or `\[[!meta title="foo"]]` [[ikiwiki/directive]], or the page name if no
-  full title was set.
+  full title was set. `meta(author)`, `meta(date)`, `meta(updated)`, etc.
+  also work.
 """]]
 
 In addition, you can combine several sort orders and/or reverse the order of
 """]]
 
 In addition, you can combine several sort orders and/or reverse the order of