Help with a Script [Share]

[MCancian]

I have been enjoying this plug-in very much. However, I have been struggling to get a script working that will automatically sort my annotations into a templated note based on the color of the annotation. Currently, it prints the proper name of the section that the annotation should go under, but they are all put into the end of the note. Can anyone find the problem in my script or template?

// Automatic script that finds sections based on their visible text titles.
// If a section is found, the annotation is added. If not, it's appended to the end.

const Zotero = require("Zotero");

(function () {
const observerKey = 'autoAnnotationProcessorObserverID';

if (Zotero.getMainWindow().hasOwnProperty(observerKey)) {
    try { Zotero.Notifier.unregisterObserver(Zotero.getMainWindow()[observerKey]); } catch (e) {}
}

const annotationObserver = {
    notify: async function(event, type, ids, extraData) {
        if (event !== 'add' || type !== 'item') return;

        const processedParentItems = new Set();
        const items = await Zotero.Items.getAsync(ids);
        
        for (const item of items) {
            if (!item.isAnnotation()) continue;
            const attachment = item.parentItem;
            if (!attachment) continue;
            const workingItem = attachment.parentItem;
            if (!workingItem || processedParentItems.has(workingItem.id)) continue;

            processedParentItems.add(workingItem.id);

            const noteIDs = workingItem.getNotes();
            if (noteIDs.length === 0) continue;
            const noteToUpdate = Zotero.Items.get(noteIDs[0]);
            let noteContent = noteToUpdate.getNote();

            // Map colors to the exact text of the section headers
            const colorToHeaderText = {
                '#FF6666': '⚠️ Critiques',
                '#FFD400': '➡️ Follow-on Reading',
                '#2EA8E5': '⭐ Importance',
                '#F19837': '📖 Key Definitions',
                '#5FB236': '⚗️ Method',
                '#A28AE5': '📊 Result',
                '#E56EEE': '❓ Research Question',
                '#AAAAAA': '📚 Literature Engaged With',
            };

            const headerText = colorToHeaderText[item.annotationColor?.toUpperCase()];
            if (!headerText) continue;

            let entry = '';
            if (item.annotationComment && item.annotationText) entry = `${item.annotationComment} "${item.annotationText}"`;
            else if (item.annotationText) entry = `"${item.annotationText}"`;
            else entry = item.annotationComment || '';
            if (item.annotationPageLabel) entry += ` (p. ${item.annotationPageLabel})`;

            if (!entry) continue;

            // --- New Matching Logic: Find section by its text title ---
            // This regex looks for a header tag (h1-h6) containing the header text,
            // and then captures the <p> tag that follows it.
            const escapeRegExp = (str) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
            const sectionRegex = new RegExp(`(<h[1-6][^>]*>.*?${escapeRegExp(headerText)}.*?<\/h[1-6]>\\s*<p>)(.*?)(<\/p>)`, 'is');
            const match = noteContent.match(sectionRegex);

            let updatedContent;

            if (match) {
                // Section header was found, insert the annotation there.
                const [, openingTags, existingContent, closingTag] = match;
                const newContent = existingContent ? `${existingContent}<br>• ${entry}` : `• ${entry}`;
                updatedContent = noteContent.replace(sectionRegex, `${openingTags}${newContent}${closingTag}`);
            } else {
                // Section header was NOT found, append to the end of the note.
                const fallbackEntry = `<p><b>[${headerText.substring(2).trim()}]:</b> • ${entry}</p>`;
                
                if (noteContent.trim().endsWith('</div>')) {
                    const lastDivIndex = noteContent.lastIndexOf('</div>');
                    updatedContent = noteContent.substring(0, lastDivIndex) + fallbackEntry + noteContent.substring(lastDivIndex);
                } else {
                    updatedContent = noteContent + fallbackEntry;
                }
            }

            if (updatedContent !== noteContent) {
                noteToUpdate.setNote(updatedContent);
                await noteToUpdate.saveTx();
            }
        }
    }
};

const observerID = Zotero.Notifier.registerObserver(annotationObserver, ['item']);
Zotero.getMainWindow()[observerKey] = observerID;

})();

return "Automatic annotation processor with text-based matching started.";

Template:

<h1 style="color:#193c47; background-color:#eef9fd; padding:8px;">
  ${(() => {
    const date = topItem.getField("date").split('T')[0];
    const title = topItem.getField("title");
    const titleTranslation = topItem.getField("titleTranslation");
    if (date && titleTranslation) {
      return `${title}`;
    } else if (date) {
      return `${title}`;
    } else {
      return `${title}`;
    }
  })()}
</h1>

⚙️ Metadata

• Item Type: ${topItem.itemType}

<li><b>Author:</b> 
${{
  let author=topItem.getCreators().slice(0, 10).map((v) => v.firstName + " " + v.lastName).join("; ") + (topItem.getCreators().length > 10 ? "; et al." : ";");
  let names = String(author);
  if (names.endsWith(';')) {
  names = names.slice(0, -1);
}
  names=names.split(/;\s*/)
    let wrappedNames = names.map(name => `${name.trim()}`);
    return wrappedNames.join(', ');
}}$
</li>


<li><b>Date Added:</b>
${new Date().toLocaleString()}
</li>

<li><b>Cite key: </b>
${topItem.getField("citationKey")}
</li>

<li><b>Journal: </b>
${topItem.getField('publicationTitle')}
</li>

• Publication Date: ${topItem.getField("date").split('T')[0]}

<li><b>Tags:</b> 
${{
  let str=topItem.getTags().map(tagObj=>tagObj.tag);
  let templatestr=", zotero";
  let words=(String(str)+templatestr).split(/,\s*/);
  let hashtaggedWords = words.map(word => `#${word.trim()}`);
  return hashtaggedWords.join(', ');
}}$
</li>

<li> <b>PDF Attachments: </b>
${(() => {
        const attachments = Zotero.Items.get(topItem.getAttachments());
        const pdf = attachments.filter((i) => i.isPDFAttachment());
        if (pdf && pdf.length > 0) {
          return `<a href="zotero://open-pdf/library/items/${pdf[0].key}">${pdf[0].getFilename()}</a>`;
        } else if (attachments && attachments.length > 0) {
          return `<a href="zotero://open-pdf/library/items/${attachments[0].key}">${attachments[0].getFilename()}</a>`;
        } else {
          return ``;
        }
      })()}
</li>

  <h2 style="color:#20b2aa; background-color:#afeeee;">📜 Abstract</h2>

      ${(() => {
        const abstractTranslation = topItem.getField('abstractTranslation');
        if (abstractTranslation) {
          return `${abstractTranslation}</i>`;
        } else {
          return `${topItem.getField('abstractNote')}`;
        }
      })()}

📊 Basic Information

❓ Research Question

📚 Literature Engaged With

➡️ Follow-on Reading

⭐ Importance

📖 Key Definitions

⚗️ Method

📊 Result

⚠️ Critiques

[windingwind]

I would suggest using windingwind/zotero-better-notes#227 along with actions like:

#319

or

#109

[MCancian]

Thank you very much! That is another great plug-in that you have made. I will adapt those examples to my use case.