[Item] Generate overview from annotations with bracketed tags

[vandrw]

Description

This is a small script inspired by a few others I've seen around here. However, instead of relying on Zotero tags or colors, it allows users to prepend a comment with curly brackets to append a comment to a specific section. For example, adding a comment containing "[Methodology] Example" to a highlighted text, the plugin will create a new section named "Methodology" and add the comment within it.

This could potentially be useful for others who require more freedom while annotating their PDFs.

Screenshots

Test on Zotero version

7.0.9

Test on Better Notes version

2.1.4

Template Type

Item

Template Share Code

# This template is specifically for importing/sharing, using better 
# notes 'import from clipboard': copy the content and
# goto Zotero menu bar, click Tools->New Template from Clipboard.  
# Do not copy-paste this to better notes template editor directly.
name: "[item]Generate overview from annotations (by brackets tag)"
zoteroVersion: "7.0.9"
pluginVersion: "2.1.4"
savedAt: "2024-11-14T03:04:05.143Z"
content: |-
  ${
      // This script organizes and displays annotations from your Zotero items.
      //
      // Annotation Formatting:
      // - Use comments in your annotations to label sections.
      // - Example: `[Introduction] This is an important point...`
      // - Annotations without a label will be categorized under "Unlabeled."
      //
      // Run the script in your Zotero environment to generate a structured HTML
      // output with your annotations neatly organized.
      await(async () => {
          // Helper function to get author display names
          const getAuthorDisplay = (creators) => {
              let authorDisplay = ["", ""];
              if (creators.length > 0) {
                  authorDisplay[0] = creators.length > 1 ? `${creators[0].lastName} et al.` : `${creators[0].lastName} ${creators[0].firstName}`;
                  authorDisplay[1] = creators.length > 7
                      ? creators.slice(0, 7).map((v) => `${v.firstName} ${v.lastName}`).join("; ") + "; et al."
                      : creators.map((v) => `${v.firstName} ${v.lastName}`).join("; ");
              }
              return authorDisplay;
          };
  
          // Helper function to generate hyperlinks to annotations
          const createAnnotationLink = (attachment, annoItem, text) => {
              return `<a href="zotero://open-pdf/0_${attachment.key}?annotation=${annoItem.key}">${text || 'Annotation'}</a>`;
          };
  
          // Function to organize annotations by sections
          const getAnnotationsBySection = async (_item) => {
              let annots = await _item.getAnnotations();
              let sectionedAnnotations = {};
  
              for (let annoItem of annots) {
                  let content = (await Zotero.Annotations.toJSON(annoItem)).text || '';
                  let comment = annoItem.annotationComment || '';
  
                  let annotationHTML = "";
                  if (["image", "ink"].includes(annoItem.annotationType)) {
                      annotationHTML += `<blockquote>${await Zotero.BetterNotes.api.convert.annotations2html([annoItem], { noteItem: targetNoteItem, ignoreComment: true })}</blockquote>`;
                  } else if (["note", "text", "highlight", "underline"].includes(annoItem.annotationType)) {
                      annotationHTML += content ? `<blockquote>${content}</blockquote>` : '';
                  }
  
                  // Proceed only if annotationHTML has been created and not empty
                  if (annotationHTML || comment) {
                      // Use regex to parse section label and comment content
                      let parsed = comment.match(/^\[(.*?)\](.*)/);
                      let sectionLabel = parsed ? parsed[1].trim() : "Unlabeled";
                      let sectionComment = parsed ? parsed[2].trim() : comment;
  
                      // Initialize the section if it doesn't exist
                      if (!sectionedAnnotations[sectionLabel]) {
                          sectionedAnnotations[sectionLabel] = [];
                      }
  
                      if (content) {
                          // Adding hyperlink to the quote if content exists
                          sectionedAnnotations[sectionLabel].push(
                              `<blockquote>${content}<br><b>${createAnnotationLink(_item, annoItem, "Link")}</b></blockquote>` +
                              `<p>${sectionComment}</p>`
                          );
                      } else if (annoItem.annotationType === "image") {
                          // Adding comment for images or sections without a quote
                          sectionedAnnotations[sectionLabel].push(
                              annotationHTML + `<p>${sectionComment}</p>`
                          );
                      } else {
                          // Adding hyperlink to other annotations
                          sectionedAnnotations[sectionLabel].push(
                              annotationHTML + `<p>${createAnnotationLink(_item, annoItem, sectionComment)}</p>`
                          );
                      }
                  }
              }
              // Separate "Unlabeled" annotations and sort others
              let sortedAnnotations = { ...sectionedAnnotations };
              let unlabeledAnnotations = sortedAnnotations["Unlabeled"];
              delete sortedAnnotations["Unlabeled"];
  
              if (unlabeledAnnotations && unlabeledAnnotations.length > 0) {
                  sortedAnnotations["Unlabeled"] = unlabeledAnnotations;
              }
  
              return sortedAnnotations;
          };
  
          let creators = topItem.getCreators();
          let authorDisplay = getAuthorDisplay(creators);
  
          let annotationsCollection = {};
          const attachments = await Zotero.Items.get(topItem.getAttachments()).filter((i) => i.isPDFAttachment() || i.isSnapshotAttachment() || i.isEPUBAttachment());
  
          for (let attachment of attachments) {
              let annotations = await getAnnotationsBySection(attachment);
              for (let section in annotations) {
                  if (!annotationsCollection[section]) {
                      annotationsCollection[section] = [];
                  }
                  annotationsCollection[section] = annotationsCollection[section].concat(annotations[section]);
              }
          }
  
          // Generate publication details
          let otherName = topItem.getField("proceedingsTitle") + topItem.getField("university")
              + topItem.getField("publisher") + topItem.getField("repository")
              + topItem.getField("institution") + topItem.getField("meetingName");
  
          let publicationName = topItem.getField("publicationTitle") + otherName;
          let sourceName = topItem.getField("journalAbbreviation") + otherName;
  
          // HTML Output
          let res = `
          <h1>${topItem.getField('title')}</h1>
          <hr/>
          <p><b>Author:</b> ${authorDisplay[1]}</p>
          <p><b>Date:</b> ${topItem.getField('date')}</p>
          <p><b>Source:</b> ${publicationName}</p>
          <p>${(() => {
                  const doi = topItem.getField("DOI");
                  return doi
                      ? `<b>DOI:</b> <a href="https://doi.org/${doi}">${doi}</a>`
                      : `<b>URL:</b> <a href="${topItem.getField('url')}">${topItem.getField('url')}</a>`;
              })()}</p>
          <p><b>Full Text:</b> ${(() => {
                  const pdfAttachment = attachments.find((i) => i.isPDFAttachment());
                  return pdfAttachment
                      ? `<a href="zotero://open-pdf/0_${pdfAttachment.key}">${pdfAttachment.getFilename()}</a>`
                      : '';
              })()}</p>
          <p><b>Abstract:</b> <i>${topItem.getField('abstractNote')}</i></p>
          <hr/>
          ${(() => {
                  let output = "";
                  for (let section in annotationsCollection) {
                      if (annotationsCollection[section].length > 0) {
                          output += `<h2>${section}</h2>`;
                          output += annotationsCollection[section].join('');
                      }
                  }
                  return output;
              })()}
      `;
          return res;
      })()
  }

Anything else

No response

[ch-sander]

How would it be possible to use the actual annotation tag instead of the inline [...] element? How is multi-tagging per annotation reflected in the at-a-glance note generated?

[fkgruber]

would it be possible to update the existing note when you run it instead of creating a new node everytime?