[Share] Auto-run Better Notes template when opening an item

[windingwind]

Description

Auto-run Better Notes template when opening an item

• During the first run (opening file), you will be asked to choose a template to be executed. Your choice will be remembered.
• When opening an item, create an auto-template note and insert the chosen template to the note using the opened item as template input (see about-note-template#item for more details about BN template). If an auto-template is already generated, skip it.

If you want to reset the remembered template, go to preferences - advanced - config editor - search extensions.actionsTags.customAction.autoRunBNTemplate and reset.

Require Better Notes for Zotero >= 1.1.4-21

Action Script

Event: Open File
Operation: Script
Data:

// Auto-run Better Notes template when opening an item for the first time
// @author windingwind
// @link https://github.com/windingwind/zotero-tag/discussions/108
// @usage Event=Open File

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

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

// Check if an auto-template note already exists
const autoTemplateTag = "auto-template";
const notes = Zotero.Items.get(item.getNotes());
if (notes.some(note => note.getTags().some(obj => obj.tag === autoTemplateTag))) {
	return "[Action:Auto-Template] Auto-template already exists";
}

const prefsKey = "extensions.actionsTags.customAction.autoRunBNTemplate";

// Get template name
let templateName = Zotero.Prefs.get(prefsKey, true);
let templateContent = Zotero.BetterNotes.api.template.getTemplateText(templateName);
if (!templateContent) {
	// Template name is not defined or invalid. Get from input
	const templateNames = Zotero.BetterNotes.api.template.getTemplateKeys();

	function selectItems(itemList) {
		var io = { dataIn: itemList, dataOut: null };
		window.openDialog("chrome://zotero/content/ingester/selectitems.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 "[Action:Auto-Template] Template is invalid";
	}
	Zotero.Prefs.set(prefsKey, templateName, true);
}

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

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

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

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

[wklimowicz]

This will create a new note on every object that doesn't have an auto-template note. If users want to change this to run only if there is no other note already attached to an item, change the code starting with // Check if an auto-template note already exists, to:

// Check if any note exists for the item
const autoTemplateTag = "auto-template";
const notes = Zotero.Items.get(item.getNotes());
if (notes.length > 0) {
    return "A note exists for this item";
}

[windingwind]

Better start a new discussion thread and share there, as this is a different action.

[wklimowicz]

Added as #109.

[niao004]

[windingwind]

the image link is broken

[janeluyip]

I do not find the extensions.actionsTags.customAction.autoRunBNTemplate
which extensions it belongs to？

[windingwind]

i use the prefix of the actions & tags plugin, but it does not belong to any plugin.

[janeluyip]

期待早日推出正式版

[horaynia]

大佬，我添加后运行后的模版和您图里的模版不一样呢？请问是咋回事儿

[horaynia]

我导入您的上面的代码，运行后笔记模版不是您图示的那个。是我之前构建的那个模版。就很奇怪。但是我已经将它禁用了啊。我删除它看看

[horaynia]

难道是和bn的默认模版有关？

[windingwind]

在第一次运行动作时弹窗选择需要的笔记模板。如果已经运行过一次，要换成其他笔记模板，则需要通过高级设置修改extensions.actionsTags.customAction.autoRunBNTemplate为目标笔记模板的名称。如何修改zotero高级设置请善用搜索

[horaynia]

弄好了，感谢大佬

[horaynia]

在第一次运行动作时弹窗选择需要的笔记模板。如果已经运行过一次，要换成其他笔记模板，则需要通过高级设置修改extensions.actionsTags.customAction.autoRunBNTemplate为目标笔记模板的名称。如何修改zotero高级设置请善用搜索

感谢大佬

[iampearl918]

“During the first run (opening file), you will be asked to choose a template to be executed.”为什么我打开笔记工作区，没有弹出来呢？
而且若点击“新建工作区笔记”，弹出提示“JavaScript Application-请选择一个有效的分类“，只给出”Ok“选项，点按之后就没有任何反应了，创建不了新笔记。

[windingwind]

“During the first run (opening file), you will be asked to choose a template to be executed.”为什么我打开笔记工作区，没有弹出来呢？

first run=首次运行本action，与工作区无关

而且若点击“新建工作区笔记”，弹出提示“JavaScript Application-请选择一个有效的分类“，只给出”Ok“选项，点按之后就没有任何反应了，创建不了新笔记。

字面意思，当前选中的分类不合理（例如选中了feed或回收站等，无法在此处创建笔记）。需在library的左侧栏选择合理的collection