From: Gustav Eek <gustav.eek@fripost.org>
Date: Mon, 20 Jan 2020 17:42:59 +0000 (+0100)
Subject: Feature. Provide sets of meta keys for inclusion
X-Git-Url: https://git.g-eek.se/?a=commitdiff_plain;h=9c02eb2aad73c077779c490cd31ef74066b5cae9;p=ikiwiki-pandoc.git

Feature. Provide sets of meta keys for inclusion

Add further lists of meta keys to include (*hash_meta_keys*
and *list_hash_meta_keys*), add them to the *list_meta* map in
subroutine *htmlize* and provide them to *pagestate* *meta*.

This makes available, e.g. the *reference* attribute in page
templates.

The commit require some explanation.

Until now, meta attributes were available as

 * Bolean meta (*bool_meta*)
 * Scalar meta (*scalar_meta*)
 * List meta (*list_meta*)

All meta attributes in documents are provided as page template
variables with a 'pandoc_'-prefix. On top of that, attributes listed
in *scalar_meta_keys* are made available as regular template
variables, without prefix.

Lists are problematic. Pure lists are pushed with 'pandoc_' prefix,
but they can not be used. The alternative would be via loops (see
<https://metacpan.org/pod/HTML::Template#TMPL_LOOP>), but inside loops
one need to call for a variable and the pushed attribute does not
provide one.

This commit properly makes available the *reference* attribute, which
is of type list of associated list. This construct actually fully
natural fulfil the limitations of lists. Template loops generate the
items, whose values are available with keys as variable names:

    ---
    references:
     - id: refone
       title: Ref-MetaInlines-in-MetaList
     - id: reftwo
       title: Ref-MetaInlines-in-MetaList
    ...

Which is called like this:

    <TMPL_IF REFERENCES>
      <TMPL_LOOP REFERENCES>
         <TMPL_VAR ID>
         <TMPL_VAR TITLE>
      </TMPL_LOOP>
    </TMPL_IF>

How is hacky. The items in *hash_meta_keys* and *list_hash_meta_keys*
are added to *list_meta_keys* and undergo the list processing. The
list processing contradictory adopted better for *list_hash_meta_keys*
than for *list_meta_keys*.
---

diff --git a/pandoc.pm b/pandoc.pm
index 9f945bf..34bdd89 100755
--- a/pandoc.pm
+++ b/pandoc.pm
@@ -30,6 +30,14 @@ my @list_meta_keys = qw/
     author
     /;
 
+my @hash_meta_keys = qw/
+    experiment
+    /;
+
+my @list_hash_meta_keys = qw/
+    references
+    /;
+
 sub import {
     my $markdown_ext = $config{pandoc_markdown_ext} || "mdwn";
 
@@ -470,7 +478,8 @@ sub htmlize ($@) {
     my %scalar_meta = map { ($_=>undef) } @scalar_meta_keys;
     $scalar_meta{$_.'_template'} = undef for @format_keys;
     my %bool_meta = map { ("generate_$_"=>0) } keys %extra_formats;
-    my %list_meta = map { ($_=>[]) } @list_meta_keys;
+    my %list_meta = map { ($_=>[]) } (
+        @list_meta_keys, @list_hash_meta_keys, @hash_meta_keys);
     $list_meta{$_.'_extra_options'} = [] for @format_keys;
     my $have_bibl = 0;
     foreach my $k (keys %scalar_meta) {
@@ -499,6 +508,7 @@ sub htmlize ($@) {
         $list_meta{$k} = unwrap_c($meta->{$k});
         $list_meta{$k} = [$list_meta{$k}] unless ref $list_meta{$k} eq 'ARRAY';
         $have_bibl = 1 if $k eq 'references';
+        $pagestate{$page}{meta}{$k} = $list_meta{$k};
         $pagestate{$page}{meta}{"pandoc_$k"} = $list_meta{$k};
     }
     # Try to add other keys as scalars, with pandoc_ prefix only.
@@ -612,7 +622,9 @@ sub pagetemplate (@) {
     my $template = $params{template};
     foreach my $k (keys %{$pagestate{$page}{meta}}) {
         next unless
-            (grep {/^$k$/} (@scalar_meta_keys, @list_meta_keys)) ||
+            (grep {/^$k$/} (
+                 @scalar_meta_keys, @list_meta_keys,
+                 @hash_meta_keys, @list_hash_meta_keys)) ||
             ($k =~ /^(pandoc_)/);
         $template->param($k => $pagestate{$page}{meta}{$k});
     }