[Share] Copy Annotation(s)

[garth74]

Description

Copy a selected annotation (or all annotations in an item) using premade templates.

Event

None

Operation

Script

Data

/**
 * Copy annotations.
 * @author garth74
 * @usage Item menu, collection menu, annotation menu
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/303
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/303
 */

// Only run once for efficiency
if (item) return;

// EDIT THESE SETTINGS

/** Which template do you want to use?
 * @type {'default' | 'highlightedTextOnly'}
 */
const templateName = "default";

/**
 * The new Zotero URI protocol uses 'open' for newer item types. However, if you
 * aren't using the newer Zotero or are having issues, try using the open-pdf
 * version.
 * @type {'zotero://open-pdf' | 'zotero://open'}
 */
const baseURI = "zotero://open";

// END OF EDITABLE SETTINGS

// ========================================================================== //
// Main
// ========================================================================== //

// ========================================================================== //
// Template Declarations

/**
 * The Template class holds all the template functions. Each function should
 * accept an `_Annotations` object and return a string. If a string is empty, it
 * will be removed in the final output.
 */
class Templates {
  /**
   * Only includes the highlighted text. This is useful if you, like me, do not
   * put comments directly on highlights.
   * @param {_Annotation} annot
   * @returns {string}
   */
  highlightedTextOnly(annot) {
    return `- "${annot.text}" ${annot.pandocCitation} | [📖](${annot.uri})`;
  }
  /**
   * Default copy annotations template.
   * @param {_Annotation} annot
   * @returns {string}
   */
  default(annot) {
    let comment = annot.comment || "";
    if (comment) comment = `**${comment}**: `;
    let text = annot.text;
    if (text) text += " ";
    return `${comment}${text}${annot.pandocCitation} | [📖](${annot.uri})\n`;
  }
}

// ========================================================================== //
// _Annotation class

class _Annotation {
  /**
   * @param {Zotero.Item} annot The annotation.
   */
  constructor(annot) {
    /** @type {Zotero.Item} */
    this._annot = annot;
    /** @type {Zotero.Item} */
    this._topLevelItem = annot.topLevelItem;
    this._parentKey = annot.parentKey;

    this.author = annot.annotationAuthorName;
    this.color = annot.annotationColor;
    this.comment = annot.annotationComment;
    this.pageLabel = annot.annotationPageLabel;
    this.position = annot.annotationPosition;
    this.sortIndex = annot.annotationSortIndex;
    this.text = annot.annotationText;
    this.type = annot.annotationType;
  }
  /**
   * @param {Zotero.Item.ItemField} itemField
   * @returns {string}
   */
  getField(itemField) {
    return this._topLevelItem.getField(itemField);
  }
  get pandocCitation() {
    return `[@${this.getField("citationKey")}, p. ${this.pageLabel}]`;
  }
  get uri() {
    let annot = this._annot;
    let libOrGrp = "library";
    if (annot.library.libraryType != "user") {
      // @ts-ignore
      libOrGrp = `groups/${Zotero.Libraries.get(annot.libraryID).groupID}`;
    }
    let collOrItems = `items/${this._parentKey}`;
    let pageIndex = 1;
    try {
      pageIndex = JSON.parse(annot.annotationPosition).pageIndex + 1;
    } catch (e) {
      Zotero.warn(e);
    }
    let params = `page=${pageIndex}&annotation=${annot.key}`;

    return `${baseURI}/${libOrGrp}/${collOrItems}?${params}`;
  }
}

// ========================================================================== //
// Helpers

/**
 * @param {Zotero.Item[]} items
 */
async function _applyTemplate(items) {
  const renderTemplate = new Templates()[templateName];
  const lines = [];
  for (const item of items) {
    for (const annot of await _getAnnotations(item)) {
      const line = renderTemplate(annot);
      if (line.length) lines.push(line);
    }
  }
  return lines.join("\n");
}

/**
 * @param {Zotero.Item} item
 */
async function _getAnnotations(item) {
  let annots = [];
  if (item.isAnnotation()) {
    annots.push(new _Annotation(item));
  } else if (item.isAttachment()) {
    annots.push(...item.getAnnotations().map((a) => new _Annotation(a)));
  } else if (item.isTopLevelItem()) {
    let att = await item.getBestAttachment();
    if (att) {
      annots.push(...att.getAnnotations().map((a) => new _Annotation(a)));
    }
  }
  return annots;
}

// ========================================================================== //
// Main Invocation

async function copyAnnotations(items) {
  try {
    const text = await _applyTemplate(items);
    const clipboard = new Zotero.ActionsTags.api.utils.ClipboardHelper();
    clipboard.addText(text, "text/unicode");
    clipboard.copy();
    return `[Copy Annotation] Copied to clipboard.`;
  } catch (err) {
    return err;
  }
}

return await copyAnnotations(items)

[aleksmasternak]

I made a template that adds a tag based on the colour of the annotation. For example if the annotation is blue it adds "#D" (for definition). I also changed the formatting of @garth74 default template so it works a bit better with Obsidian (e.g. change link icon so it is clickable). To add this template, you can copy the code and paste it below the default template. Make sure to change the templateName from "default" to "colorCode"

 /**
   * Color Coded copy annotations template.
   * @param {_Annotation} annot
   * @returns {string}
   */
  colorCode(annot) {
    let comment = annot.comment ? `*${annot.comment}*\n` : "";
    let text = annot.text ? `"${annot.text}"` : "";
    let color = annot.color ? `${annot.color}` : "";

    if (color === "#ff6666") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #A\n${comment}`;
    } else if (color === "#5fb236") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #C\n${comment}`;
    } else if (color === "#2ea8e5") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #D\n${comment}`;
    } else if (color === "#a28ae5") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #P\n${comment}`;
    } else if (color === "#e56eee") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #L\n${comment}`;
    } else if (color === "#f19837") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #I\n${comment}`;
    } else if (color === "#aaaaaa") {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri}) #M\n${comment}`;
    } else {
        return `${text} ${annot.pandocCitation}. [✎](${annot.uri})\n${comment}`;
    }
}

[catherrien]

This is my template for html formatting. I use it to merge specific annotations into single Item note, while keeping reference to each individual annotation.

  /**
   * Copy annotation template, with Html formatting
   */
  html(annot) {
	let link = `<a href="${annot.uri}">➡</a>`;
	let text = annot.text;
	if (text) text = `<blockquote>${text}<br />${link}</blockquote>`;
	let comment = annot.comment || "";
	comment = `<p style="color:red;font-style:italic">${comment}</p>`;
	return `${text}${comment}<hr />`;
  }

I also had to add this line to the copyAnnotations function :
clipboard.addText(text, "text/html");