[Share] Auto-run Better Notes template when opening an item, only when no other notes present

[wklimowicz]

Description

Based on #108 but doesn't add notes to items which already have notes:

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 any note is already present, 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, only if other notes aren't present.
// @author windingwind
// @author wklimowicz
// @link https://github.com/windingwind/zotero-tag/discussions/109
// @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());

// Replace the original if statement
// if (notes.some(note => note.getTags().some(obj => obj.tag === autoTemplateTag))) {
// 	return "[Action:Auto-Template] Auto-template already exists";
// }
// With this:
if (notes.length > 0) {
	return;
}

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

[niao004]

大佬，这个反复打开反复生成啊，这个你看能不能修改一下。

[muyi123567]

Thanks for your work, I found the feature I was looking for!

[Geo123abc]

the selections can't display correctly in zotero beta 97, but the function is right.
How to fix it ?

[pioneerRick]

当我使用这个脚本的时候，我发现它显示了一个Problem loading Page。这是什么问题