[Share] 文献矩阵

[mulei000]

Description

多选条目后，输入指定注释标签，生成文献矩阵

Event

None

Operation

Script

Data

/**
  * @author Mulei
 * 脚本功能：从所有选中的条目中提取指定 PDF 附件内带有指定“注释标签”(Zotero 注释自身的 tag)的注释（转换为 HTML），
 * 并将同一文献中同一注释标签的内容合并到同一单元格，最后生成一个表格。
 * 
 * 使用说明：
 * 1. 在 Zotero 中，使用自带的 PDF 阅读器打开 PDF，并对需要的文字做高亮或注释，然后在注释的右侧面板中添加标签（tag），如“背景”、“材料”。
 * 2. 选中一个或多个条目后运行此脚本（使用传入的 items 或 item 变量）。
 * 3. 脚本会弹窗依次提示输入新笔记的标题和要提取的注释标签（多个标签请用英文/中文逗号、英文/中文分号分隔，如“背景；材料”或“背景,材料”等）。
 * 4. 脚本会先自动删除每个条目中已生成的、包含这些标签关键字的提取注释笔记（避免重复）。
 * 5. 然后遍历每个条目，找出其 PDF 附件中带有相应标签的注释，将注释文本（高亮或注释内容）放到对应列中。
 * 6. 最后将所有提取到的注释内容以表格形式合并生成一个新的独立笔记，并弹窗显示处理结果。
 */

if (item) return; // 仅对所有选中项执行一次

const Zotero = require("Zotero");
const window = require("window");
const console = require("console");

// 使用传入的 items 或 item 变量
let selectedItems = [];
if (typeof items !== "undefined" && items.length > 0) {
  selectedItems = items;
} else if (typeof item !== "undefined") {
  selectedItems = [item];
} else {
  window.alert("请先选择要处理的文献");
  return;
}

// 弹窗提示输入新笔记的标题
let noteTitle = window.prompt("请输入新笔记的标题：");
if (!noteTitle) {
  noteTitle = "合并注释";
}

// 弹窗提示输入需要提取的注释标签
let annotationTag = window.prompt(
  "请输入需要提取的注释标签（逗号、分号分隔），例如：\n（默认包含标题）\n\n创新，背景，材料，方法，结论，摘录，笔记\n\n"
);
if (!annotationTag) {
  window.alert("未输入注释标签，操作终止");
  return;
}


/**
 * 将输入拆分成数组，支持：
 * - 英文逗号 (,)
 * - 中文逗号 (，)
 * - 英文分号 (;)
 * - 中文分号 (；)
 */
let annotationTags = annotationTag.split(/[,，;；]/)
  .map(tag => tag.trim())
  .filter(tag => tag.length > 0);

window.alert(`开始处理 ${selectedItems.length} 个条目，请稍候...\n你输入的标签: [${annotationTags.join(", ")}]`);

/**
 * 删除每个条目中已生成的、包含任一指定注释标签关键字的提取注释笔记
 * 删除条件：笔记内容以 <div data-citation-items 开头且包含 annotationTags 中任意一个关键字
 * （此处只是简单地用 includes 判断 HTML 内容）
 */
async function deleteIndividualAnnotationNotes(items, annotationTags) {
  for (let item of items) {
    const noteIDs = item.getNotes();
    for (let id of noteIDs) {
      let note = Zotero.Items.get(id);
      let noteHTML = note.getNote();
      if (noteHTML && noteHTML.startsWith('<div data-citation-items')) {
        // 如果笔记中包含任意一个用户输入的标签关键字，就将其删除
        if (annotationTags.some(tag => noteHTML.includes(tag))) {
          Zotero.Items.trashTx(id);
        }
      }
    }
  }
}

/**
 * 从单个条目中，提取其 PDF 附件中所有带有 annotationTags 中任意一个标签的注释，
 * 并将同一标签的注释文本合并到同一个字符串。
 * @param {Zotero.Item} item - 当前处理的条目
 * @returns {Object} 注释对象，键为注释标签，值为合并后的注释内容
 */
async function extractAnnotationsFromItem(item) {
  // 预先给每个用户指定的标签初始化为空字符串
  let annotationsObj = {};
  annotationTags.forEach(tag => {
    annotationsObj[tag] = "";
  });
  
  const attachments = item.getAttachments();
  for (let attachmentId of attachments) {
    const attachment = await Zotero.Items.getAsync(attachmentId);
    // 仅处理 PDF 附件
    if (attachment.attachmentContentType === "application/pdf") {
      const annots = attachment.getAnnotations();
      if (annots && annots.length > 0) {
        for (let annot of annots) {
          // 检查此注释的标签
          if (annot.getTags && Array.isArray(annot.getTags())) {
            let tagsOnAnnot = annot.getTags().map(tagObj => tagObj.tag);
            console.log("此注释的标签:", tagsOnAnnot, "；用户指定的标签:", annotationTags);
            // 如果此注释至少包含 annotationTags 中的一个标签，就把文本归到相应标签下
            for (let wantedTag of annotationTags) {
              if (tagsOnAnnot.includes(wantedTag)) {
                try {
                  // 获取此注释的完整HTML（高亮或批注）
                  let annotJSON = await Zotero.Annotations.toJSON(annot);
                  let res = Zotero.EditorInstanceUtilities.serializeAnnotations([
                    { ...annotJSON, attachmentItemID: annot.parentID }
                  ]);
                  let cleanHTML = res.html;
                  // 去掉外层 <div>（如果有）
                  if (cleanHTML.startsWith('<div') && cleanHTML.endsWith('</div>')) {
                    cleanHTML = cleanHTML.replace(/^<div[^>]*>/, '').replace(/<\/div>$/, '');
                  }
                  // 累加到对应标签下（此处没有添加分隔符，如果需要换行可自行加上 "<br>"）
                  annotationsObj[wantedTag] += cleanHTML;
                } catch (error) {
                  console.error("转换注释为 HTML 时出错:", error);
                }
              }
            }
          }
        }
      }
    }
  }
  
  return annotationsObj;
}

/**
 * 遍历所有选中的条目，提取 PDF 附件中带有指定标签的注释，
 * 并以表格形式生成一个新的独立笔记。
 * 表格第一列为标题，后续列为用户输入的标签；同一标签的注释内容合并在同一单元格。
 */
async function combineAnnotationsIntoSingleNote(items) {
  let tableData = [];
  
  for (let item of items) {
    let title = item.getField("title") || "无标题";
    try {
      let itemAnnotations = await extractAnnotationsFromItem(item);
      tableData.push({ title, annotations: itemAnnotations });
    } catch (error) {
      console.error(`处理文献 "${item.getField("title")}" 时出错:`, error);
    }
  }
  
  if (tableData.length === 0) {
    window.alert("未找到任何符合条件的注释");
    return;
  }
  
  // 构建 HTML 表格，列顺序按照 annotationTags 顺序
  let combinedHTML = `<h1>${noteTitle}</h1>\n`;
  combinedHTML += `<table border="1" cellspacing="0" cellpadding="5">\n`;
  
  // 表头：第一列为标题，后续列为用户指定的各个标签
  combinedHTML += `<tr><th>标题</th>`;
  annotationTags.forEach(tag => {
    combinedHTML += `<th>${tag}</th>`;
  });
  combinedHTML += `</tr>\n`;
  
  // 每个文献对应一行
  tableData.forEach(row => {
    combinedHTML += `<tr>`;
    combinedHTML += `<td>${row.title}</td>`;
    annotationTags.forEach(tag => {
      let cellContent = row.annotations[tag] || "";
      combinedHTML += `<td>${cellContent}</td>`;
    });
    combinedHTML += `</tr>\n`;
  });
  
  combinedHTML += `</table>\n`;
  
  // 创建新的独立笔记（standalone note），使用第一个条目的库 ID
  let noteItem = new Zotero.Item("note");
  noteItem.libraryID = items[0].libraryID;
  noteItem.parentID = null;  // 独立笔记
  await noteItem.saveTx();
  
  // 设置笔记内容为生成的表格 HTML
  noteItem.setNote(combinedHTML);
  await noteItem.saveTx();
  
  return noteItem;
}

// 先删除旧的提取笔记，再合并生成新的独立笔记
deleteIndividualAnnotationNotes(selectedItems, annotationTags).then(() => {
  combineAnnotationsIntoSingleNote(selectedItems).then((noteItem) => {
    if (noteItem) {
      let successMsg = "成功创建合并笔记: " + noteItem.getNoteTitle();
      console.log(successMsg);
      window.alert(successMsg);
    } else {
      window.alert("处理过程中未能创建合并笔记。");
    }
  });
});

Anything else

欢迎修改指正分享你的思路。

[Bohan-code]

Hello, may I ask, when I was creating the template, I encountered the following error.
“Template Preview Error: SyntaxError: unexpected token: identifier ”

[mulei000]

You do not need to create a template; you can use it by creating an Action custom script.

[Bohan-code]

It's simply amazing! Thank you very much!

[cheng0713cqk]

为什么运行以后没有反应？有没有视频教程？

[mulei000]

你的注释要有对应的标签 发自我的iPhone

…

------------------ 原始邮件 ------------------ 发件人: cheng0713cqk ***@***.***> 发送时间: 2025年3月19日 17:27 收件人: windingwind/zotero-actions-tags ***@***.***> 抄送: mulei000 ***@***.***>, Author ***@***.***> 主题: Re: [windingwind/zotero-actions-tags] [Share] 文献矩阵 (Discussion #477) 为什么运行以后没有反应？有没有视频教程？ — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: ***@***.***>

[cheng0713cqk]

这个算吧？

[mulei000]

为什么不试试呢？

[cheng0713cqk]

就是注释带着标签情况下试得不行，所以想问下有视频教程无，想知道哪步弄错了

[mulei000]

https://www.bilibili.com/video/BV1LSX6YjELV/?vd_source=db6a41b2e759a9514fa2c897b0f7eb2d

[cheng0713cqk]

可以了 感谢大佬！！！！！非常感谢！！！！！