restore my original patch
[ikiwiki.git] / doc / todo / allow_site-wide_meta_definitions.mdwn
1 [[!tag plugins/meta patch]]
2 [[!template id=gitbranch branch=jon/defaultmeta author="[[Jon]]"]]
3
4 I'd like to define [[plugins/meta]] values to apply across all pages
5 site-wide unless the pages define their own: default values for meta
6 definitions essentially.
7
8     <snip old patch, see below for latest>
9
10 -- [[Jon]]
11
12 > This doesn't support multiple-argument meta directives like
13 > `link=x rel=y`, or meta directives with special side-effects like
14 > `updated`.
15 >
16 > The first could be solved (if you care) by a syntax like this:
17 >
18 >     meta_defaults => [
19 >         { copyright => "© me" },
20 >         { link => "about:blank", rel => "silly", },
21 >     ]
22 >
23 > The second could perhaps be solved by invoking `meta::preprocess` from within
24 > `scan` (which might be a simplification anyway), although this is complicated
25 > by the fact that some (but not all!) meta headers are idempotent.
26
27 > --[[smcv]]
28
29 >> Thanks for your comment. I've revised the patch to use the config syntax
30 >> you suggest. I need to perform some more testing to make sure I've
31 >> addressed the issues you highlight.
32 >> 
33 >> I had to patch part of IkiWiki core, the merge routine in Setup, because
34 >> the use of `possibly_foolish_untaint` was causing the hashrefs at the deep
35 >> end of the data structure to be converted into strings. The specific change
36 >> I've made may not be acceptable, though -- I'd appreciate someone providing
37 >> some feedback on that hunk!
38
39     diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
40     index 6fe9cda..2f8c098 100644
41     --- a/IkiWiki/Plugin/meta.pm
42     +++ b/IkiWiki/Plugin/meta.pm
43     @@ -13,6 +13,8 @@ sub import {
44         hook(type => "needsbuild", id => "meta", call => \&needsbuild);
45         hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
46         hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
47     +   hook(type => "scan", id => "meta", call => \&scan)
48     +           if $config{"meta_defaults"};
49      }
50      
51      sub getsetup () {
52     @@ -305,6 +307,15 @@ sub match {
53         }
54      }
55      
56     +sub scan() {
57     +   my %params = @_;
58     +   my $page = $params{page};
59     +   foreach my $default (@{$config{"meta_defaults"}}) {
60     +           preprocess(%$default, page => $page,
61     +                   destpage => $page, preview => 0);
62     +   }
63     +}
64     +
65      package IkiWiki::PageSpec;
66      
67      sub match_title ($$;@) {
68     diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
69     index 8a25ecc..e4d50c9 100644
70     --- a/IkiWiki/Setup.pm
71     +++ b/IkiWiki/Setup.pm
72     @@ -51,7 +51,13 @@ sub merge ($) {
73                                         $config{$c}=$setup{$c};
74                                 }
75                                 else {
76     -                                   $config{$c}=[map { IkiWiki::possibly_foolish_untaint($_) } @{$setup{$c}}]
77     +                                   $config{$c}=[map {
78     +                                           if(ref $_ eq 'HASH') {
79     +                                                   $_
80     +                                           } else {
81     +                                                   IkiWiki::possibly_foolish_untaint($_)
82     +                                           }
83     +                                   } @{$setup{$c}}];
84                                 }
85                         }
86                         elsif (ref $setup{$c} eq 'HASH') {
87     diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
88     index 000f461..8d34ee4 100644
89     --- a/doc/ikiwiki/directive/meta.mdwn
90     +++ b/doc/ikiwiki/directive/meta.mdwn
91     @@ -12,6 +12,16 @@ also specifies some additional sub-parameters.
92      The field values are treated as HTML entity-escaped text, so you can include
93      a quote in the text by writing `&quot;` and so on.
94      
95     +You can also define site-wide defaults for meta values by including them
96     +in your setup file. The key used is `meta_defaults` and the value is a list
97     +of hashes, one per meta directive. e.g.:
98     +
99     +   meta_defaults = [
100     +           { copyright => "Copyright 2007 by Joey Hess" },
101     +           { license   => "GPL v2+" },
102     +           { link => "somepage", rel => "site entrypoint", },
103     +   ],
104     +
105      Supported fields:
106      
107      * title
108
109 -- [[Jon]]
110
111 >> Ok, I've had a bit of a think about this. There are currently 15 supported
112 >> meta fields. Of these: title, licence, copyright, author, authorurl,
113 >> and robots might make sense to define globally and override on a per-page
114 >> basis.
115 >> 
116 >> Less so, description (due to its impact on map); openid (why would
117 >> someone want more than one URI to act as an openid endpoint to the same
118 >> place?); updated. I can almost see why someone might want to set a global
119 >> updated value. Almost.
120 >> 
121 >> Not useful are permalink, date, stylesheet (you already have a global
122 >> stylesheet), link, redir, and guid.
123 >>
124 >> In other words, the limitations of my first patch that [[smcv]] outlined
125 >> are only relevant to defined fields that you wouldn't want to specify a
126 >> global default for anyway.
127 >>
128 >> Due to this, and the added complexity of the second patch (having to adjust
129 >> `IkiWiki/Setup.pm`), I think the first patch makes more sense. I've thus
130 >> reverted to it here.
131
132     diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
133     index b229592..3132257 100644
134     --- a/IkiWiki/Plugin/meta.pm
135     +++ b/IkiWiki/Plugin/meta.pm
136     @@ -13,6 +13,7 @@ sub import {
137         hook(type => "needsbuild", id => "meta", call => \&needsbuild);
138         hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
139         hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
140     +   hook(type => "scan", id => "meta", call => \&scan);
141      }
142      
143      sub getsetup () {
144     @@ -302,6 +303,15 @@ sub match {
145         }
146      }
147      
148     +sub scan() {
149     +   my %params = @_;
150     +   my $page = $params{page};
151     +    foreach my $type (map { s/^meta_//; $_ } grep /^meta_/, keys %config) {
152     +           $pagestate{$page}{meta}{$type} = $config{"meta_$type"}
153     +                   unless defined $pagestate{$page}{meta}{$type};
154     +   }
155     +}
156     +
157      package IkiWiki::PageSpec;
158      
159      sub match_title ($$;@) {
160     diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn
161     index 000f461..200c4b2 100644
162     --- a/doc/ikiwiki/directive/meta.mdwn
163     +++ b/doc/ikiwiki/directive/meta.mdwn
164     @@ -12,6 +12,12 @@ also specifies some additional sub-parameters.
165      The field values are treated as HTML entity-escaped text, so you can include
166      a quote in the text by writing `&quot;` and so on.
167      
168     +You can also define site-wide defaults for meta values by including them
169     +in your setup file, e.g.
170     +
171     +   meta_copyright => "Copyright 2007 by Joey Hess",
172     +   meta_license   => "GPL v2+",
173     +
174      Supported fields:
175      
176      * title
177
178 -- [[Jon]]