diff options
| -rw-r--r-- | doc/todo/allow_site-wide_meta_definitions.mdwn | 117 |
1 files changed, 66 insertions, 51 deletions
diff --git a/doc/todo/allow_site-wide_meta_definitions.mdwn b/doc/todo/allow_site-wide_meta_definitions.mdwn index f935a9acb..3c6c3b5aa 100644 --- a/doc/todo/allow_site-wide_meta_definitions.mdwn +++ b/doc/todo/allow_site-wide_meta_definitions.mdwn @@ -5,11 +5,39 @@ I'd like to define [[plugins/meta]] values to apply across all pages site-wide unless the pages define their own: default values for meta definitions essentially. -Here's a patch to achieve this (also in the "defaultmeta" branch of -my github ikiwiki fork): + <snip old patch, see below for latest> + +-- [[Jon]] + +> This doesn't support multiple-argument meta directives like +> `link=x rel=y`, or meta directives with special side-effects like +> `updated`. +> +> The first could be solved (if you care) by a syntax like this: +> +> meta_defaults => [ +> { copyright => "© me" }, +> { link => "about:blank", rel => "silly", }, +> ] +> +> The second could perhaps be solved by invoking `meta::preprocess` from within +> `scan` (which might be a simplification anyway), although this is complicated +> by the fact that some (but not all!) meta headers are idempotent. +> +> --[[smcv]] + +>> Thanks for your comment. I've revised the patch to use the config syntax +>> you suggest. I need to perform some more testing to make sure I've +>> addressed the issues you highlight. +>> +>> I had to patch part of IkiWiki core, the merge routine in Setup, because +>> the use of `possibly_foolish_untaint` was causing the hashrefs at the deep +>> end of the data structure to be converted into strings. The specific change +>> I've made may not be acceptable, though -- I'd appreciate someone providing +>> some feedback on that hunk! diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm - index b229592..3132257 100644 + index 6fe9cda..c4079fd 100644 --- a/IkiWiki/Plugin/meta.pm +++ b/IkiWiki/Plugin/meta.pm @@ -13,6 +13,7 @@ sub import { @@ -20,76 +48,63 @@ my github ikiwiki fork): } sub getsetup () { - @@ -302,6 +303,15 @@ sub match { + @@ -305,6 +306,17 @@ 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}; + + if($config{"meta_defaults"}) { + + 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..200c4b2 100644 + index 000f461..8d34ee4 100644 --- a/doc/ikiwiki/directive/meta.mdwn +++ b/doc/ikiwiki/directive/meta.mdwn - @@ -12,6 +12,12 @@ also specifies some additional sub-parameters. + @@ -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 `"` and so on. +You can also define site-wide defaults for meta values by including them - +in your setup file, e.g. + +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_copyright => "Copyright 2007 by Joey Hess", - + meta_license => "GPL v2+", + + meta_defaults = [ + + { copyright => "Copyright 2007 by Joey Hess" }, + + { license => "GPL v2+" }, + + { link => "somepage", rel => "site entrypoint", }, + + ], + Supported fields: * title --- [[Jon]] - -> This doesn't support multiple-argument meta directives like -> `link=x rel=y`, or meta directives with special side-effects like -> `updated`. -> -> The first could be solved (if you care) by a syntax like this: -> -> meta_defaults => [ -> { copyright => "© me" }, -> { link => "about:blank", rel => "silly", }, -> ] -> -> The second could perhaps be solved by invoking `meta::preprocess` from within -> `scan` (which might be a simplification anyway), although this is complicated -> by the fact that some (but not all!) meta headers are idempotent. -> -> --[[smcv]] - ->> Thanks for your comment. Tonight I had a go at implementing the syntax ->> you propose here. I decided the simplest thing to do might be for the scan ->> subroutine to convert any hashes found in the meta_defaults list into calls ->> to the preprocess routine. I've got a bit stuck trying to convert a hash to ->> a named parameter list (or just a subroutine parameter list that is). I may ->> try to look again in the morning (brain a bit sleepy) ->> ->> ...and on writing this comment I see your second suggestion was essentially ->> to do exactly that :) -- [[Jon]] - ->>> ok, it's easier than I thought, I just pass the hash and it's handled ->>> correctly. Right now can't figure out why my hashes get converted into ->>> strings prior to me seeing them in scan(): - - $VAR64 = [ - 'HASH(0xc2daf8)', - 'HASH(0xc2db40)' - ]; - ->>> ...but it *really* is bedtime :) -- [[Jon]] +>> -- [[Jon]] |