[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.

Do not run builtin note templates of the BN plugin

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 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://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 "[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]

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

感谢大佬

[iampearl918]

请问：
本帖子给出的是action的代码，按我目前的理解，是在Zotero Actions & Tags插件中要进行的设置。

During the first run (opening file), you will be asked to choose a template to be executed.

图片中笔记模版的代码是否应该要另外下载呢？这个模版的代码是哪个呢？

[windingwind]

关于其他插件的使用方法，参见对应插件文档

[iampearl918]

好的，已经找到了类似模版，要图片中的效果需要稍作改写

[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

[iampearl918]

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

谢谢您的耐心解释，是我将基础的概念搞混了，因为首次接触和摸索Markdown和BN这类笔记软件，突然接触到大量新概念和功能，有些蒙没弄明白。还有个问题想请教：

在查看BN相关资料时，经常出现的“item”，是指Zotero里存储的单篇文章吗？
这样的理解，让我在很多地方能暂时读的通。
有的地方，我又感觉item是指单篇文献中的“元素”，也就是图表、标题、期刊名称、作者等等。
但又似乎都不对，比如您这个帖子正文中链接里about-note-template#item，我实在弄不明白item是指什么。

因为BN相关使用说明基本是英文的，对于我都是一些新的计算机软件术语，看得懂英文单词、却不太明白指什么。谢谢您
@windingwind

[windingwind]

https://zotero-chinese.com/user-guide/add-items

善用搜索

[fredericky123]

这里能不能完善一下，事件为关闭tag时，先删除已有的annotation，再自动生成一个，因为每次打开tag的目的是阅读更新，阅读完标注后期待模板能自动更新一下，就免去手动导入了

[DWCY3574]

找到好方法了吗？楼下的大佬分享的是好用，但自己编辑的笔记更新后就没了

[thebetter2]

根据颜色分类整理注释到笔记中的笔记模板需要每次打开时更新笔记。因此修改一下大佬的action 插件内容为 检测到存在 auto-template标签笔记则删除它，然后继续创建。
action插件配置如图

action代码如下。另附传送门windingwind/zotero-better-notes#668 (comment) 可以根据注释颜色分类整理进笔记的better note笔记模板。二者可以结合使用。

// 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 and delete it
const autoTemplateTag = "auto-template";
const notes = Zotero.Items.get(item.getNotes());

for (const note of notes) {
    if (note.getTags().some(obj => obj.tag === autoTemplateTag)) {
        // Delete the existing note with the "auto-template" tag
        await Zotero.Items.erase(note.id);
    }
}

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}`;

[DWCY3574]

使用这个自己输入的笔记就没了

[fredericky123]

所以我目前想的用另一个笔记保存自己输入的笔记，如果有更好的合二为一的办法，期待了

[kepbod]

如何和颜色标签模版联合使用？我看是要有auto-template的 tag的 note？windingwind/zotero-better-notes#668 (comment)

[thebetter2]

如何和颜色标签模版联合使用？我看是要有auto-template的 tag的 note？windingwind/zotero-better-notes#668 (comment)
tag不用手动写，是自动创建的。
使用方法很简单，你首次运行这个action的时候会出现如下图，选择模板界面，之后每次打开文献就会自动按照这个模板生成。

打开生成的笔记后，就会在标签页看的生成的标签。你的其他用别的模板生成的、没有这个标签的笔记不会被删除。

如果相更换或者同时自动生成多个别的笔记模板，需要删除这个action，新建或者复制一个新的，选别的模板就行，需要设置时，将标签改成不同的就行。

[wzr-ms]

提出一个问题，更新之后，我在笔记上写的批注也被删除了

[xjtusjtu]

如果模板数量足够多，会导致模板显示不完全，以及 SelectAll，Deselect All，OK，Cancel 等按钮不显示，请问此时应该如何修改 window.openDialog 代码？

例如

let tags = await Zotero.Tags.getAll();
let templateNames = tags.map(t =>t.tag);

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.slice(0,40)));
console.log(templateName);

[ramonmi]

• Zotero 7.0.9及以上版本，将select.xhtml由chrome://zotero/content/ingester/selectitems.xhtml移至chrome://scaffold/content/select.xhtml，see https://github.com/zotero/zotero/pull/4747/files#diff-a5cc4a0d67b871fc25c8a4710168be2043bfdc47b1b43eecb76b6fe8ea97db80R1200
  • 因此上述代码需做如下更改

window.openDialog("chrome://zotero/content/ingester/selectitems.xhtml",

修改为

// window.openDialog("chrome://zotero/content/ingester/selectitems.xhtml",
window.openDialog("chrome://scaffold/content/select.xhtml",

即可正常使用，新版本增加了滑动翻页显示，避免模板较多时显示不全。

• BTW，better notes更新了新的对话框选择（如下图按钮，现在是新的重构对话框），请问 @windingwind 可以使用脚本调用吗？谢谢！
  

[xjtusjtu]

感谢！

[hogan-github]

太牛了

[Dani-v-tue]

Hey, I used google translate to join this conversation so I'm not sure if I missed something, but:

window.openDialog("chrome://scaffold/content/select.xhtml",

Broke the popup on my machine (MacOS), and using

window.openDialog("chrome://zotero/content/ingester/selectitems.xhtml",

fixed it. Also relevant for anyone else that sees this :).

[Calorion]

I installed this, and it worked, but it automatically chose the wrong template; it never asked what template I wanted.

I tried resetting extensions.actionsTags.customAction.autoRunBNTemplate, but…what does “reset” mean? I changed it from True to False, and it stopped working entirely. I changed it back to True, and it still doesn’t function.

[windingwind]

The template is updated, please clear that field and try again.

[Calorion]

That’s working, but now it’s bringing up the dialog asking for which template to use every time.

[Calorion]

Is this a bug, or am I doing something wrong?

[ramonmi]

but now it’s bringing up the dialog asking for which template to use every time.

Based on my test, the template works well. May be you can check the extensions.actionsTags.customAction.autoRunBNTemplate argument in the Zotero-Settings-Advanced-Config Editor, normally it is a string titled [Item] template name.

[Calorion]

Deleting that argument (and changing it from Boolean to String, not sure that mattered) worked, thanks.