[Share] [Custom-Template] Run selected Better Notes template for current item

[ramonmi]

Description

• Based on [Share] Auto-run Better Notes template when opening an item #108, select the template every time Instead of remembering the chosen template.
• When triggering the shortcut, create a custom template note and insert the chosen template to the note using the opened item as template input.

Require Better Notes for Zotero >= 1.1.4-21
This script is effective for a current item in the reader tab or a chosen item in the library/collection.

Event

None

Operation

Script

Data

Hint: The JS code in the first comment below (version edit date: 2025-1-8) is more recommended. i.e., #319 (comment)

/**
 * Select the Better Notes template when triggering the shortcut.
 * @author windingwind, ramonmi
 * @usage Trigger with shortcuts
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/319
 */

const Zotero = require("Zotero");
const window = require("window");

if (!Zotero.BetterNotes?.api.note?.insert) {
	return "[Custom-Template] Better Notes for Zotero > 1.1.4-21 is not installed or disabled.";
}
if (!item) { return; }

// Select template name from input
const templateNames = Zotero.BetterNotes.api.template.getTemplateKeys();

function selectItems(itemList) {
	var io = { dataIn: itemList, dataOut: null };
	window.openDialog("chrome://scaffold/content/select.xhtml",
		"_blank", "chrome,modal,centerscreen,resizable=yes", io);
	return io.dataOut;
}

templateName = Object.values(selectItems(templateNames))[0];
templateContent = Zotero.BetterNotes.api.template.getTemplateText(templateName);
if (!templateContent) {
	return "[Custom-Template] Template is invalid";
}

const parentItem = Zotero.Items.getTopLevel([item])[0];

const noteItem = new Zotero.Item("note");
noteItem.libraryID = parentItem.libraryID;
noteItem.parentID = parentItem.id;
await noteItem.saveTx();

let html = "";
html = await Zotero.BetterNotes.api.template.runItemTemplate(templateName, {
	itemIds: [parentItem.id],
	targetNoteId: noteItem.id,
});
await Zotero.BetterNotes.api.note.insert(
	noteItem,
	html,
	-1,
);

return `[Custom-Template] Note ${noteItem.getNoteTitle()} is created on item ${item.getField("title")} from template ${templateName}`;

Anything else

[ramonmi]

• Use Better Notes Picker to select the template Instead of the default window dialog. Thanks for @windingwind [Feature] Allow adjust the template order in Template Editor zotero-better-notes#1250
• Add a refreshable-template tag when using the templates with refreshable content for batch invoking update content for templates later (if applicable).

Require Better Notes for Zotero >= v2.2.3-beta.4
This script is effective for a current item in the reader tab or a chosen item in the library/collection.

/**
 * Select the Better Notes template when triggering the shortcut.
 * @author windingwind, ramonmi
 * @usage Trigger with shortcuts
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @ref https://github.com/windingwind/zotero-better-notes/issues/1250
 */

if (!Zotero.BetterNotes?.api.note?.insert) {
	return "[Custom-Template] Better Notes for Zotero > 1.1.4-21 is not installed or disabled.";
}
if (!item) { return; }

// Select template name from input
templateName = (await Zotero.BetterNotes.hooks.onShowTemplatePicker("pick"))[0]
templateContent = Zotero.BetterNotes.api.template.getTemplateText(templateName);
if (!templateContent) {
	return "[Custom-Template] Template is invalid";
}

// Define refreshable template array
// change the array with your template names with refreshable content
// Hint: [item] or [text] mush be lower case!
const templateArray = ['[item]item_Academic_Vocabulary','[item]item_Extensive_Reading','[item]item_Flow_Notes','[item]item_Intensive_Reading','[item]item_Tag_Journal'];
// check if the template have refreshable content
if (templateName && templateArray.includes(templateName)) {
	var refreshableTag = "refreshable-template";
}

const parentItem = Zotero.Items.getTopLevel([item])[0];

const noteItem = new Zotero.Item("note");
noteItem.libraryID = parentItem.libraryID;
noteItem.parentID = parentItem.id;
if (refreshableTag) {
	noteItem.addTag(refreshableTag, 0);
}
await noteItem.saveTx();

let html = "";
html = await Zotero.BetterNotes.api.template.runItemTemplate(templateName, {
	itemIds: [parentItem.id],
	targetNoteId: noteItem.id,
});
await Zotero.BetterNotes.api.note.insert(
	noteItem,
	html,
	-1,
);

return `[Custom-Template] Note ${noteItem.getNoteTitle()} is created on item ${item.getField("title")} from template ${templateName}`;

[ramonmi]

Add a refreshable-template tag when using the templates with refreshable content for batch invoking update content for templates later (if applicable).

A workable scheme to batch update refreshable notes using update content from templates : [Share] Batch update refreshable notes using update content from templates

[ramonmi]

• Add an option to open the note just created.
  • By modifying the script, you can choose one of the three ways (in a separate window, as a BN tab, or as a BN window) to open it.

/**
 * Select the Better Notes template when triggering the shortcut.
 * @author windingwind, ramonmi
 * @usage Trigger with shortcuts
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @ref https://github.com/windingwind/zotero-better-notes/issues/1250
 */

if (!Zotero.BetterNotes?.api.note?.insert) {
	return "[Custom-Template] Better Notes for Zotero > 1.1.4-21 is not installed or disabled.";
}
if (!item) { return; }

// Select template name from input
templateName = (await Zotero.BetterNotes.hooks.onShowTemplatePicker("pick"))[0]
templateContent = Zotero.BetterNotes.api.template.getTemplateText(templateName);
if (!templateContent) {
	return "[Custom-Template] Template is invalid";
}

// Define refreshable template array
// change the array with your template names with refreshable content
// Hint: [item] or [text] mush be lower case!
const templateArray = ['[item]item_Academic_Vocabulary','[item]item_Extensive_Reading','[item]item_Flow_Notes','[item]item_Intensive_Reading','[item]item_Tag_Journal'];
// check if the template have refreshable content
if (templateName && templateArray.includes(templateName)) {
	var refreshableTag = "refreshable-template";
}

const parentItem = Zotero.Items.getTopLevel([item])[0];

const noteItem = new Zotero.Item("note");
noteItem.libraryID = parentItem.libraryID;
noteItem.parentID = parentItem.id;
if (refreshableTag) {
	noteItem.addTag(refreshableTag, 0);
}
await noteItem.saveTx();

let html = "";
html = await Zotero.BetterNotes.api.template.runItemTemplate(templateName, {
	itemIds: [parentItem.id],
	targetNoteId: noteItem.id,
});
await Zotero.BetterNotes.api.note.insert(
	noteItem,
	html,
	-1,
);

const window = require("window");
const TipLabel = window.prompt(`[Custom-Template] Note ${noteItem.getNoteTitle()} is created on item ${item.getField("title")} from template ${templateName}. Open it? (y/n):`);
if (TipLabel && TipLabel.toLowerCase() === "y" || TipLabel.toLowerCase() === "yes") {
        // modify the below three lines and choose one to be the default note viewer
	Zotero.getActiveZoteroPane().openNoteWindow(noteItem.id); // open in Zotero default separate window
	// Zotero.BetterNotes.hooks.onOpenNote(noteItem.id, "window"); // open as a Better Notes window
	// Zotero.BetterNotes.hooks.onOpenNote(noteItem.id, "tab"); // open as a Better Notes tab
	return `[Custom-Template] Note created and opened!`;
} else if (TipLabel && TipLabel.toLowerCase() === "n" || TipLabel.toLowerCase() === "no") {
	return "Execution cancelled, nothing to do!";
} else {
	return "Invalid input, nothing to do!";
}

[fredericky123]

直接复制进来不能用 请问是模版名字没有替换好吗 如何替换呢

[ramonmi]

请问使用的哪个版本的脚本？报错是什么

[fredericky123]

最上面4.26 修改后的版本
先是显示这个加载错误，叉掉后又提示图2的错误

[ramonmi]

已更新，使用最新edited的版本可正常使用。

不过建议使用2025-1-8的版本，该版本使用BNotes的Picker，可以过滤掉内置的模板，只显示自定义的笔记模板。

[fredericky123]

可以用了，谢谢！建议最新edit可以放25-01-8或者在前面写个说明呢
本以为最新的有效，原来是01-08非常简洁明了

[ramonmi]

谢谢建议，已添加说明

[fredericky123]

发现其实是1.13最好用，因为创建之后肯定是需要打开的，能否进一步增加一个版本，默认创建后打开，不需要再选择yes了呢

[ramonmi]

/**
 * Select the Better Notes template when triggering the shortcut.
 * @author windingwind, ramonmi
 * @usage Trigger with shortcuts
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/319
 * @ref https://github.com/windingwind/zotero-better-notes/issues/1250
 */

if (!Zotero.BetterNotes?.api.note?.insert) {
	return "[Custom-Template] Better Notes for Zotero > 1.1.4-21 is not installed or disabled.";
}
if (!item) { return; }

// Select template name from input
templateName = (await Zotero.BetterNotes.hooks.onShowTemplatePicker("pick"))[0]
templateContent = Zotero.BetterNotes.api.template.getTemplateText(templateName);
if (!templateContent) {
	return "[Custom-Template] Template is invalid";
}

// Define refreshable template array
// change the array with your template names with refreshable content
// Hint: [item] or [text] mush be lower case!
const templateArray = ['[item]item_Academic_Vocabulary','[item]item_Extensive_Reading','[item]item_Flow_Notes','[item]item_Intensive_Reading','[item]item_Tag_Journal'];
// check if the template have refreshable content
if (templateName && templateArray.includes(templateName)) {
	var refreshableTag = "refreshable-template";
}

const parentItem = Zotero.Items.getTopLevel([item])[0];

const noteItem = new Zotero.Item("note");
noteItem.libraryID = parentItem.libraryID;
noteItem.parentID = parentItem.id;
if (refreshableTag) {
	noteItem.addTag(refreshableTag, 0);
}
await noteItem.saveTx();

let html = "";
html = await Zotero.BetterNotes.api.template.runItemTemplate(templateName, {
	itemIds: [parentItem.id],
	targetNoteId: noteItem.id,
});
await Zotero.BetterNotes.api.note.insert(
	noteItem,
	html,
	-1,
);

// modify the below three lines and choose one to be the default note viewer
Zotero.getActiveZoteroPane().openNoteWindow(noteItem.id); // open in Zotero default separate window
// Zotero.BetterNotes.hooks.onOpenNote(noteItem.id, "window"); // open as a Better Notes window
// Zotero.BetterNotes.hooks.onOpenNote(noteItem.id, "tab"); // open as a Better Notes tab
return `[Custom-Template] Note ${noteItem.getNoteTitle()} is created on item ${item.getField("title")} from template ${templateName} and opened!`;

[fredericky123]

多谢多谢！