digraphs: page metadata in subpage includes

[sheet.git] / tools / mkdigraphlist

diff --git a/tools/mkdigraphlist b/tools/mkdigraphlist
index 535698712117af07f6f162873bbf12eecc7af747..2f6acc8d111ca0588510dd8c5256e6d6ae70d8f5 100755 (executable)
--- a/tools/mkdigraphlist
+++ b/tools/mkdigraphlist
@@ -43,7 +43,28 @@ $table{$_} = [
        ($uninfo->{ $di->{$_} }->[0] // '') =~ s/ u-di| u-prop| ex//gr,  # class
        $uninfo->{ $di->{$_} }->[4] // (),  # string
 ] for sort keys %{$di};
-print JSON->new->ascii->canonical->encode(\%table);
+
+print JSON->new->ascii->canonical->encode({
+       title => 'RFC-1345',
+       key  => \%table,
+       intro => join("\n",
+               'Character mnemonics following compose key ⎄:',
+               'i^k in <a href="/vi">Vim</a>,',
+               '^u^\ in <a href="/readline">Emacs</a>,',
+               '^a^v in <a href="/screen">Screen</a>.',
+               'Similar but different from <a href="/digraphs/xorg">X.Org</a>.',
+               'Also see <a href="/unicode">common Unicode</a>.</p>',
+               '<p class="aside">Unofficial <span class="u-l2">proposals</span>',
+               'are available as <a href="/digraphs.vim">ex commands</a>.',
+       ),
+       flag => {
+               l4 => 'full support',
+               l3 => 'vim extension',
+               'l3 ex' => 'vim v8.0',
+               l2 => 'proposal',
+               l1 => 'not in vim',
+       },
+});
 
 __END__
 
@@ -53,14 +74,14 @@ mkdigraphlist - Output character list of combined digraph data
 
 =head1 SYNOPSIS
 
-    mkdigraphlist | jq -r '."DO"[0]' | perl -nE 'say chr' # $
+    mkdigraphlist | jq -r '.key."DO"[0]' | perl -nE 'say chr' # $
 
 =head1 DESCRIPTION
 
 Combines precompiled digraph includes of rfc (1345), vim, and shiar
 and outputs a complete map including character details and usage classes.
 
-The value can either be a scalar string containing another
+The C<key> values can either be a scalar string containing another
 digraph which can be considered identical (usually inverted),
 or an array ref containing at least the resulting character's
 Unicode code point value.  If available, the following UCD data
@@ -69,8 +90,10 @@ and replacement output string.
 For example:
 
   {
-   "AE" => [198, "LATIN CAPITAL LETTER AE", "u-di", "Latin Lu Xl u-v11"],
-   "EA" => "AE",
+   "key": {
+    "AE" => [198, "LATIN CAPITAL LETTER AE", "u-di", "Latin Lu Xl u-v11"],
+    "EA" => "AE",
+   }
   }
 
 =head1 AUTHOR