Add support for {document-title}

README.md

@@ -156,6 +156,7 @@ Flashcard fields can be configured with the following steps:
     `{cloze-prefix}` | Text for the containing `{sentence}` from the start up to the value of `{cloze-body}`.
     `{cloze-suffix}` | Text for the containing `{sentence}` from the value of `{cloze-body}` to the end.
     `{dictionary}` | Name of the dictionary from which the card is being created (unavailable in *grouped* mode).
+    `{document-title}` | Title of the web page that the term appeared in.
     `{expression}` | Term expressed as Kanji (will be displayed in Kana if Kanji is not available).
     `{furigana}` | Term expressed as Kanji with Furigana displayed above it (e.g. <ruby>日本語<rt>にほんご</rt></ruby>).
     `{furigana-plain}` | Term expressed as Kanji with Furigana displayed next to it in brackets (e.g. 日本語[にほんご]).
@@ -175,6 +176,7 @@ Flashcard fields can be configured with the following steps:
     `{cloze-prefix}` | Text for the containing `{sentence}` from the start up to the value of `{cloze-body}`.
     `{cloze-suffix}` | Text for the containing `{sentence}` from the value of `{cloze-body}` to the end.
     `{dictionary}` | Name of the dictionary from which the card is being created.
+    `{document-title}` | Title of the web page that the Kanji appeared in.
     `{glossary}` | List of definitions for the Kanji.
     `{kunyomi}` | Kunyomi (Japanese reading) for the Kanji expressed as Katakana.
     `{onyomi}` | Onyomi (Chinese reading) for the Kanji expressed as Hiragana.

ext/bg/data/default-anki-field-templates.handlebars

@@ -158,4 +158,8 @@
     <img src="{{definition.screenshotFileName}}" />
 {{/inline}}
 
+{{#*inline "document-title"}}
+    {{~context.document.title~}}
+{{/inline}}
+
 {{~> (lookup . "marker") ~}}

ext/bg/js/options.js

@@ -91,6 +91,15 @@ const profileOptionsVersionUpdates = [
         if (utilStringHashCode(options.anki.fieldTemplates) === 1444379824) {
             options.anki.fieldTemplates = null;
         }
+    },
+    (options) => {
+        // Version 13 changes:
+        //  Default anki field tempaltes updated to include {document-title}.
+        let fieldTemplates = options.anki.fieldTemplates;
+        if (typeof fieldTemplates === 'string') {
+            fieldTemplates += '\n\n{{#*inline "document-title"}}\n    {{~context.document.title~}}\n{{/inline}}';
+            options.anki.fieldTemplates = fieldTemplates;
+        }
     }
 ];
 

ext/bg/js/settings/anki-templates.js

@@ -99,7 +99,11 @@ async function ankiTemplatesValidate(infoNode, field, mode, showSuccessResult, i
         const definition = await ankiTemplatesValidateGetDefinition(text, optionsContext);
         if (definition !== null) {
             const options = await apiOptionsGet(optionsContext);
-            const context = {};
+            const context = {
+                document: {
+                    title: document.title
+                }
+            };
             let templates = options.anki.fieldTemplates;
             if (typeof templates !== 'string') { templates = await apiGetDefaultAnkiFieldTemplates(); }
             const ankiNoteBuilder = new AnkiNoteBuilder({renderTemplate: apiTemplateRender});

ext/mixed/js/display.js

@@ -935,7 +935,11 @@ class Display {
     }
 
     _getNoteContext() {
-        return {};
+        return {
+            document: {
+                title: document.title
+            }
+        };
     }
 
     async _getAudioUri(definition, source) {