Merge pull request #415 from toasted-nutbread/anki-marker-document-title

Anki marker document title

6 files changed, 32 insertions, 11 deletions

diff --git a/ext/bg/data/default-anki-field-templates.handlebars b/ext/bg/data/default-anki-field-templates.handlebars
index 0442f7c5..6061851f 100644
--- a/ext/bg/data/default-anki-field-templates.handlebars
+++ b/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") ~}}
\ No newline at end of file
diff --git a/ext/bg/js/anki-note-builder.js b/ext/bg/js/anki-note-builder.js
index d0ff8205..51022da3 100644
--- a/ext/bg/js/anki-note-builder.js
+++ b/ext/bg/js/anki-note-builder.js
@@ -21,7 +21,7 @@ class AnkiNoteBuilder {
         this._renderTemplate = renderTemplate;
     }
 
-    async createNote(definition, mode, options, templates) {
+    async createNote(definition, mode, context, options, templates) {
         const isKanji = (mode === 'kanji');
         const tags = options.anki.tags;
         const modeOptions = isKanji ? options.anki.kanji : options.anki.terms;
@@ -35,7 +35,7 @@ class AnkiNoteBuilder {
         };
 
         for (const [fieldName, fieldValue] of modeOptionsFieldEntries) {
-            note.fields[fieldName] = await this.formatField(fieldValue, definition, mode, options, templates, null);
+            note.fields[fieldName] = await this.formatField(fieldValue, definition, mode, context, options, templates, null);
         }
 
         if (!isKanji && definition.audio) {
@@ -60,7 +60,7 @@ class AnkiNoteBuilder {
         return note;
     }
 
-    async formatField(field, definition, mode, options, templates, errors=null) {
+    async formatField(field, definition, mode, context, options, templates, errors=null) {
         const data = {
             marker: null,
             definition,
@@ -69,7 +69,8 @@ class AnkiNoteBuilder {
             modeTermKanji: mode === 'term-kanji',
             modeTermKana: mode === 'term-kana',
             modeKanji: mode === 'kanji',
-            compactGlossaries: options.general.compactGlossaries
+            compactGlossaries: options.general.compactGlossaries,
+            context
         };
         const pattern = /\{([\w-]+)\}/g;
         return await AnkiNoteBuilder.stringReplaceAsync(field, pattern, async (g0, marker) => {
diff --git a/ext/bg/js/backend.js b/ext/bg/js/backend.js
index 1e8c979f..d4c822ca 100644
--- a/ext/bg/js/backend.js
+++ b/ext/bg/js/backend.js
@@ -455,7 +455,7 @@ class Backend {
         return results;
     }
 
-    async _onApiDefinitionAdd({definition, mode, context, optionsContext}) {
+    async _onApiDefinitionAdd({definition, mode, context, details, optionsContext}) {
         const options = this.getOptions(optionsContext);
         const templates = this.defaultAnkiFieldTemplates;
 
@@ -468,19 +468,19 @@ class Backend {
             );
         }
 
-        if (context && context.screenshot) {
+        if (details && details.screenshot) {
             await this._injectScreenshot(
                 definition,
                 options.anki.terms.fields,
-                context.screenshot
+                details.screenshot
             );
         }
 
-        const note = await this.ankiNoteBuilder.createNote(definition, mode, options, templates);
+        const note = await this.ankiNoteBuilder.createNote(definition, mode, context, options, templates);
         return this.anki.addNote(note);
     }
 
-    async _onApiDefinitionsAddable({definitions, modes, optionsContext}) {
+    async _onApiDefinitionsAddable({definitions, modes, context, optionsContext}) {
         const options = this.getOptions(optionsContext);
         const templates = this.defaultAnkiFieldTemplates;
         const states = [];
@@ -489,7 +489,7 @@ class Backend {
             const notes = [];
             for (const definition of definitions) {
                 for (const mode of modes) {
-                    const note = await this.ankiNoteBuilder.createNote(definition, mode, options, templates);
+                    const note = await this.ankiNoteBuilder.createNote(definition, mode, context, options, templates);
                     notes.push(note);
                 }
             }
diff --git a/ext/bg/js/options.js b/ext/bg/js/options.js
index 5c68c403..abb054d4 100644
--- a/ext/bg/js/options.js
+++ b/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;
+        }
     }
 ];
 
diff --git a/ext/bg/js/settings/anki-templates.js b/ext/bg/js/settings/anki-templates.js
index c5222d30..e3852eb4 100644
--- a/ext/bg/js/settings/anki-templates.js
+++ b/ext/bg/js/settings/anki-templates.js
@@ -99,10 +99,15 @@ async function ankiTemplatesValidate(infoNode, field, mode, showSuccessResult, i
         const definition = await ankiTemplatesValidateGetDefinition(text, optionsContext);
         if (definition !== null) {
             const options = await apiOptionsGet(optionsContext);
+            const context = {
+                document: {
+                    title: document.title
+                }
+            };
             let templates = options.anki.fieldTemplates;
             if (typeof templates !== 'string') { templates = await apiGetDefaultAnkiFieldTemplates(); }
             const ankiNoteBuilder = new AnkiNoteBuilder({renderTemplate: apiTemplateRender});
-            result = await ankiNoteBuilder.formatField(field, definition, mode, options, templates, exceptions);
+            result = await ankiNoteBuilder.formatField(field, definition, mode, context, options, templates, exceptions);
         }
     } catch (e) {
         exceptions.push(e);
diff --git a/ext/bg/js/settings/anki.js b/ext/bg/js/settings/anki.js
index b706cd1b..f2e1ca76 100644
--- a/ext/bg/js/settings/anki.js
+++ b/ext/bg/js/settings/anki.js
@@ -243,6 +243,7 @@ function ankiGetFieldMarkers(type) {
                 'cloze-prefix',
                 'cloze-suffix',
                 'dictionary',
+                'document-title',
                 'expression',
                 'furigana',
                 'furigana-plain',
@@ -258,6 +259,7 @@ function ankiGetFieldMarkers(type) {
             return [
                 'character',
                 'dictionary',
+                'document-title',
                 'glossary',
                 'kunyomi',
                 'onyomi',