response of potential user

[git.ikiwiki.info.git] / doc / todo / allow_site-wide_meta_definitions.mdwn

diff --git a/doc/todo/allow_site-wide_meta_definitions.mdwn b/doc/todo/allow_site-wide_meta_definitions.mdwn
index f56bf5c3c3e773f52ddb82e2539ab94818719ff0..62317ba1af687920fe5f0afd5c509527c4f70af5 100644 (file)
--- a/doc/todo/allow_site-wide_meta_definitions.mdwn
+++ b/doc/todo/allow_site-wide_meta_definitions.mdwn
@@ -36,8 +36,145 @@ definitions essentially.
 >> I've made may not be acceptable, though -- I'd appreciate someone providing
 >> some feedback on that hunk!
 
 >> I've made may not be acceptable, though -- I'd appreciate someone providing
 >> some feedback on that hunk!
 

-<code>
-[[!inline pages="allow site-wide meta definitions/current-patch" raw=yes quick=yes]]
-</code>
+    diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
+    index 6fe9cda..2f8c098 100644
+    --- a/IkiWiki/Plugin/meta.pm
+    +++ b/IkiWiki/Plugin/meta.pm
+    @@ -13,6 +13,8 @@ sub import {
+       hook(type => "needsbuild", id => "meta", call => \&needsbuild);
+       hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
+       hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
+    +  hook(type => "scan", id => "meta", call => \&scan)
+    +          if $config{"meta_defaults"};
+     }
+     
+     sub getsetup () {
+    @@ -305,6 +307,15 @@ sub match {
+       }
+     }
+     
+    +sub scan() {
+    +  my %params = @_;
+    +  my $page = $params{page};
+    +  foreach my $default (@{$config{"meta_defaults"}}) {
+    +          preprocess(%$default, page => $page,
+    +                  destpage => $page, preview => 0);
+    +  }
+    +}
+    +
+     package IkiWiki::PageSpec;
+     
+     sub match_title ($$;@) {
+    diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
+    index 8a25ecc..e4d50c9 100644
+    --- a/IkiWiki/Setup.pm
+    +++ b/IkiWiki/Setup.pm
+    @@ -51,7 +51,13 @@ sub merge ($) {
+                                       $config{$c}=$setup{$c};
+                               }
+                               else {
+    -                                  $config{$c}=[map { IkiWiki::possibly_foolish_untaint($_) } @{$setup{$c}}]
+    +                                  $config{$c}=[map {
+    +                                          if(ref $_ eq 'HASH') {
+    +                                                  $_
+    +                                          } else {
+    +                                                  IkiWiki::possibly_foolish_untaint($_)
+    +                                          }
+    +                                  } @{$setup{$c}}];
+                               }
+                       }
+                       elsif (ref $setup{$c} eq 'HASH') {
+    diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
+    index 000f461..8d34ee4 100644
+    --- a/doc/ikiwiki/directive/meta.mdwn
+    +++ b/doc/ikiwiki/directive/meta.mdwn
+    @@ -12,6 +12,16 @@ also specifies some additional sub-parameters.
+     The field values are treated as HTML entity-escaped text, so you can include
+     a quote in the text by writing `&quot;` and so on.
+     
+    +You can also define site-wide defaults for meta values by including them
+    +in your setup file. The key used is `meta_defaults` and the value is a list
+    +of hashes, one per meta directive. e.g.:
+    +
+    +  meta_defaults = [
+    +          { copyright => "Copyright 2007 by Joey Hess" },
+    +          { license   => "GPL v2+" },
+    +          { link => "somepage", rel => "site entrypoint", },
+    +  ],
+    +
+     Supported fields:
+     
+     * title

 
 

- -- [[Jon]]
+-- [[Jon]]
+
+>> Ok, I've had a bit of a think about this. There are currently 15 supported
+>> meta fields. Of these: title, licence, copyright, author, authorurl,
+>> and robots might make sense to define globally and override on a per-page
+>> basis.
+>> 
+>> Less so, description (due to its impact on map); openid (why would
+>> someone want more than one URI to act as an openid endpoint to the same
+>> place?); updated. I can almost see why someone might want to set a global
+>> updated value. Almost.
+>> 
+>> Not useful are permalink, date, stylesheet (you already have a global
+>> stylesheet), link, redir, and guid.
+>>
+>> In other words, the limitations of my first patch that [[smcv]] outlined
+>> are only relevant to defined fields that you wouldn't want to specify a
+>> global default for anyway.
+>>
+>> Due to this, and the added complexity of the second patch (having to adjust
+>> `IkiWiki/Setup.pm`), I think the first patch makes more sense. I've thus
+>> reverted to it here.
+>>
+>> Is this merge-worthy?
+
+    diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
+    index b229592..3132257 100644
+    --- a/IkiWiki/Plugin/meta.pm
+    +++ b/IkiWiki/Plugin/meta.pm
+    @@ -13,6 +13,7 @@ sub import {
+       hook(type => "needsbuild", id => "meta", call => \&needsbuild);
+       hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
+       hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
+    +  hook(type => "scan", id => "meta", call => \&scan);
+     }
+     
+     sub getsetup () {
+    @@ -302,6 +303,15 @@ sub match {
+       }
+     }
+     
+    +sub scan() {
+    +  my %params = @_;
+    +  my $page = $params{page};
+    +    foreach my $type (map { s/^meta_//; $_ } grep /^meta_/, keys %config) {
+    +          $pagestate{$page}{meta}{$type} = $config{"meta_$type"}
+    +                  unless defined $pagestate{$page}{meta}{$type};
+    +  }
+    +}
+    +
+     package IkiWiki::PageSpec;
+     
+     sub match_title ($$;@) {
+    diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
+    index 000f461..200c4b2 100644
+    --- a/doc/ikiwiki/directive/meta.mdwn
+    +++ b/doc/ikiwiki/directive/meta.mdwn
+    @@ -12,6 +12,12 @@ also specifies some additional sub-parameters.
+     The field values are treated as HTML entity-escaped text, so you can include
+     a quote in the text by writing `&quot;` and so on.
+     
+    +You can also define site-wide defaults for meta values by including them
+    +in your setup file, e.g.
+    +
+    +  meta_copyright => "Copyright 2007 by Joey Hess",
+    +  meta_license   => "GPL v2+",
+    +
+     Supported fields:
+     
+     * title
+
+-- [[Jon]]