[Item] Generate note from annotations (by brackets tag)/根据标注注释内自定义的标签生成笔记-支持多级标题嵌套 (2024.11.21更新/updated)

[zhikaiyici]

更新日志

2024.11.21更新： 1. 支持同一条目下多个附件标注；2. 使用允许刷新。（使用允许刷新后将在笔记开头生成一段“代码”用于更新笔记，如下图所示。如不需要更新笔记请删除模板中// @use-refresh。）

Description

修改于#1194 和#1129 ，支持了嵌套多级标签（标题）。期刊标签功能需要安装Style插件。
不依赖于 Zotero 标注的标签或颜色，允许在标注的评论区内以方括号“[]”自定义标签，并以其为标题自动生成笔记。例如，在多个标注中分别添加"[Heading1]示例1"，”[Heading1][Heading1.1]示例1.1“，”[Heading2]示例2“，等评论，使用将模板生成如下笔记：

Heading1

标注原文1

示例1

Heading1.1

标注原文1.1

示例1.1

Heading2

标注原文2

示例2

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 note from annotations (by brackets tag)"
zoteroVersion: "7.0.9"
pluginVersion: "2.1.6"
savedAt: "2024-11-21T07:00:41.337Z"
content: |-
  // @use-refresh
  // @author zhikaiyici
  // @link [PUBLISH PAGE URL](https://github.com/windingwind/zotero-better-notes/discussions/1202)
  ${ await(async() => {
      // 辅助函数：检测字符串是否包含中文字符
      const containsChinese = (text) => /[\u4e00-\u9fa5]/.test(text);
  
      // 检查标题是否为中文
      let isChineseTitle = containsChinese(topItem.getField("title"));
  
      // 获取作者显示内容
      let creators = topItem.getCreators();
      let authorDisplay = ["", ""];
      if (isChineseTitle) {
          // 中文标题：显示第一作者全名，格式为“姓名”
          if (creators.length > 0) {
              let firstAuthor = creators[0];
              let fullName = firstAuthor.lastName + firstAuthor.firstName;
              if (creators.length > 1) {
                  authorDisplay[0] = fullName + "等";
              }
              else {
                  authorDisplay[0] = fullName;
              }
              // 正文中显示前10位作者，多于10位加等
              if (creators.length > 10) {
                  authorDisplay[1] = creators.splice(0, 10).map((v) => v.firstName + v.lastName).join("; ");
                  authorDisplay[1] = authorDisplay + "等";
              }
              else {
                  authorDisplay[1] = creators.map((v) => v.firstName + v.lastName).join("; ");
              }
          }
      }
      else {
          // 非中文标题：显示第一作者姓氏并附加“et al.”
          if (creators.length > 0) {
              let firstAuthorLastName = creators[0].lastName;
                  if (creators.length > 1) {
                      authorDisplay[0] = `${firstAuthorLastName} et al.`;
                  }
                  else {
                      authorDisplay[0] = creators[0].lastName + " " + creators[0].firstName;
                  }
                  // 正文中显示前10位作者，多于10位加et al.
                  if (creators.length > 10) {
                      authorDisplay[1] = creators.splice(0, 10).map((v) => v.firstName + " " + v.lastName).join("; ");
                      authorDisplay[1] = authorDisplay[1] + "; et al.";
                  }
                  else {
                      authorDisplay[1] = creators.map((v) => v.firstName + " " + v.lastName).join("; ");
                  }
              }
      }
  
      const getAnnotationLabelsAndComment = (_comment) => {
          let result = { labels: [], sectionComment: "" };
          let parsed = _comment.match(/^\[(.*?)\](.*)/);
          if (!parsed) {
              result.labels.push("Unlabeled");
              result.sectionComment = _comment;
          }
          else {
              while (parsed) {
                  result.labels.push(parsed[1].trim());
                  result.sectionComment = parsed[2].trim();
                  parsed = result.sectionComment.match(/^\[(.*?)\](.*)/);
              }
          };
          return result;
      }
  
      const processAnnotations = (grouped) => {
          let result = "";
          // 遍历每个组
          for (const label in grouped) {
              if (label != "Unlabeled") {
                  const group = grouped[label];
                  const heading = `<h${group.level}>${label}</h${group.level}>`;
                  result += heading; // + "\n";
                  // 添加内容
                  group.content.forEach(content => {
                      result += content; // + "\n";
                  });
                  // 递归处理子标签
                  result += processAnnotations(group.childLabels);
              }
          }
          for (const label in grouped) {
              if (label === "Unlabeled") {
                  const group = grouped[label];
                  const heading = `<h${group.level}>${label}</h${group.level}>`;
                  result += heading; // + "\n";
                  // 添加内容
                  group.content.forEach(content => {
                      result += content; // + "\n";
                  });
                  // 递归处理子标签
                  // result += processAnnotations(group.childLabels, _attachment);
                  break;
              }
          }
          return result;
      }
  
      let myAnnotations = "";
      const attachments = Zotero.Items.get(topItem.getAttachments()).filter((i) => i.isPDFAttachment() || i.isSnapshotAttachment() || i.isEPUBAttachment());
      let annotatedAttachment = 0;
      for (let attachment of attachments) {
          if (attachment.getAnnotations().length > 0)
              annotatedAttachment++; 
      }
      const groupedAnnotations = {};
      for (let attachment of attachments) {
          let annots = attachment.getAnnotations();
          let attachmentTitle = `<i>📄For Document: <a href="zotero://open-pdf/0_${attachment.key}">${attachment.getField("title")}</a></i>`;     
          for (let annoItem of annots) {
              let myAnnotation = { labels: "", content: "" };
              let myComment = annoItem.annotationComment || "";
              let myLabelsAndComment = getAnnotationLabelsAndComment(myComment);
              myAnnotation.labels = myLabelsAndComment.labels;
  
              if (["note", "text", "highlight", "underline"].includes(annoItem.annotationType)) {
                  if(["highlight", "underline"].includes(annoItem.annotationType) && myComment){
                      annoItem.annotationComment = "";
                  }
                  const res = Zotero.EditorInstanceUtilities.serializeAnnotations([{
                      ...(await Zotero.Annotations.toJSON(annoItem)), ...{ attachmentItemID: annoItem.parentID }
                  }]);
                  if (["note", "text"].includes(annoItem.annotationType)) {
                      myAnnotation.content += res.html.replace("[" + myAnnotation.labels.join('][') + "]", "");
                  }
                  else {
                      myAnnotation.content += "<blockquote>" + res.html + "</blockquote>";
                      myAnnotation.content += myLabelsAndComment.sectionComment;
                  }
                  if (myComment){
                      annoItem.annotationComment = myComment;
                  }
              }
              else {
                  //if (["image", "ink"].includes(annoItem.annotationType)) {
                      myAnnotation.content += "<blockquote>" + await Zotero.BetterNotes.api.convert.annotations2html([annoItem], { noteItem: targetNoteItem, ignoreComment: true }) + "</blockquote>";
                  //}
                  if (myComment){
                      annoItem.annotationComment = myComment;
                  }
                  myAnnotation.content += myLabelsAndComment.sectionComment;
              }
  
              let currentLevel = groupedAnnotations;
              // 遍历每个标签，构建分组结构
              myAnnotation.labels.forEach((label, index) => {
                  // 如果当前标签在结果中不存在，则初始化
                  if (!currentLevel[label]) {
                      currentLevel[label] = {
                          level: index + 2, // 一级标题为h2，二级标题为h3，依此类推
                          content: [],
                          childLabels: {} // 存储子标签
                      };
                  }
                  // 如果是最后一个标签，添加内容
                  if (index === myAnnotation.labels.length - 1) {
                      if (annotatedAttachment > 1 && !currentLevel[label].content.includes(attachmentTitle))
                          currentLevel[label].content.push(attachmentTitle);
                      currentLevel[label].content.push(myAnnotation.content);
                  }
                  else {
                      // 移动到下一个层级
                      currentLevel = currentLevel[label].childLabels;
                  }
              });
          }
      }
      myAnnotations += processAnnotations(groupedAnnotations) ? processAnnotations(groupedAnnotations) : "";
  
      // 非期刊条目显示论文集、大学、出版社、仓库...
      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;
      let res = `
          <h1> ${topItem.getField('title')} (${topItem.getField("year")}, ${sourceName}, ${authorDisplay[0]})</h1>
          <!--<hr/>-->
          <p><tr><td>
              <b><span style="color: #3c5acc">Author: </span></b> ${authorDisplay[1]}
          </td></tr></p>
  
          <p><tr><td><b><span style="color: #3c5acc">Source: </span></b>
              ${(topItem.getField("volume") + topItem.getField("issue") + topItem.getField("pages")) ? 
              (publicationName + " (" + 
              (topItem.getField("volume") ? "volume: " + topItem.getField("volume") + ", " : '') + 
              (topItem.getField("issue") ? "issue: " + topItem.getField("issue") + ", " : '') + 
              (topItem.getField("pages") ? "pages: " + topItem.getField("pages") : '') + ")") : publicationName}
              ${(() => {
                  if (Zotero.ZoteroStyle) {
                      let space = " ";
                      return Array.prototype.map.call(
                          Zotero.ZoteroStyle.api.renderCell(topItem, "publicationTags").childNodes,
                          e => {
                              e.innerText = space + e.innerText + space;
                              return e.outerHTML
                          }
                      ).join(space);
                  }
              })()}
          </td></tr></p>
  
          <p><tr><td>
              ${(() => {
                  const doi = topItem.getField("DOI");
                  if (doi) {
                      return `<b><span style="color: #3c5acc">DOI: </span></strong></b> 
                      <a href="https://doi.org/${topItem.getField('DOI')}">${topItem.getField('DOI')}</a>`;
                  } else {
                      return `<b><span style="color: #3c5acc">URL: </span></strong> </b> 
                      <a href="${topItem.getField('url')}">${topItem.getField('url')}</a>`;
                  }
             })()}
          </td></tr></p>
  
          <p><tr><td>
              <b><span style="color: #3c5acc">Date: </span></b> ${topItem.getField('date')}
          </td></tr></p>
  
          <!-- 本地链接 -->
          <p><tr><td>
              ${(() => {
                  const attachments = Zotero.Items.get(topItem.getAttachments());
                  if (attachments && attachments.length > 1) {
                      return `<b><span style="color: #3c5acc">Full Text: </span></b> 
                      <a href=zotero://open-pdf/0_${Zotero.Items.get(topItem.getAttachments()).filter((i) => i.isPDFAttachment())[0].key}>
                      ${Zotero.Items.get(topItem.getAttachments()).filter((i) => i.isPDFAttachment())[0].getFilename()}</a>`;
                  } else {
                      if (attachments && attachments.length > 0) {
                          return `<b><span style="color: #3c5acc">Full Text: </span> </b> 
                          <a href="zotero://open-pdf/0_${attachments[0].key}">${attachments[0].getFilename()}</a>`;
                      }
                      else {
                          return `<b><span style="color: #3c5acc">Full Text: </span></b>`;
                      }
                  }
              })()}
          </td></tr></p>
  
          <!-- 摘要 -->
          <p><tr><td>
              <b><span style="color: #3c5acc">Abstract: </span></b> <i>${topItem.getField('abstractNote')}</i>
          </td></tr></p>
          <!--<hr/>-->
  
          <!-- 生成标签笔记 -->
          ${myAnnotations}
  
      `;
      return res;        
  })()}

Anything else

No response

[yoyo2018520]

模板非常好！有个小的问题：题目和摘要能展示中英双语么？

[zhikaiyici]

在你想要显示翻译的位置添加topItem.getField('titleTranslation') 和 topItem.getField('abstractTranslation')。
比如在原标题和摘要后面显示翻译，用下面的代码替换原模板中对应部分：

<h1> ${topItem.getField('title') + topItem.getField('titleTranslation')} (${topItem.getField("year")}, ${sourceName}, ${authorDisplay[0]})</h1>

        <!-- 摘要 -->
        <p><tr>
            <td>
                ${(() => {
                    return `<b><span style="color: #3c5acc">Abstract: </span></b> <i>${topItem.getField('abstractNote') + topItem.getField('abstractTranslation')}</i>`;
                })()}
            </td>
        </tr></p>

需要先用翻译插件翻译标题和摘要。

[Susu20241010]

可以的 发自我的iPhone

…

------------------ 原始邮件 ------------------ 发件人: WANG Chao ***@***.***> 发送时间: 2024年11月21日 19:36 收件人: windingwind/zotero-better-notes ***@***.***> 抄送: Susu20241010 ***@***.***>, Mention ***@***.***> 主题: Re: [windingwind/zotero-better-notes] [Item] Generate note from annotations (by brackets tag)/根据标注注释内自定义的标签生成笔记-支持多级标题嵌套 (2024.11.21更新/updated) (Discussion #1202) 太晚了，明天吧 — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

[Susu20241010]

我在添加评论的区域输入了 [标题]xx 内容，再点击“生成笔记”，右边笔记区生成的内容显示 我的Heading在笔记的后面，咋回事
难道需要手动在笔记区打出 一级标题和二级标题吗？

[Susu20241010]

我是这样做的！

[w117247457]

请问生成笔记前面有这么一行是什么，怎么删掉

[windingwind]

去掉模板的@use-refresh行即可

[wsgwzlr]

去掉模板的@use-refresh行即可

但是我还想要保留随时更新的功能，这个能解决吗？

[Susu20241010]

请问生成笔记前面有这么一行是什么，怎么删掉

亲 使用什么插件出现 期刊标签的呀，

[w117247457]

去掉模板的@use-refresh行即可

但是我还想要保留随时更新的功能，这个能解决吗？

请问你解决了吗

[ddin13]

同问，是不是想要保留随时更新的功能就不能去掉第一行呀

[Susu20241010]

ToDesk:
设备代码:970 135 533
临时密码:4396in34

大佬能不能帮我远程一下 我今天有时间 一直开着电脑

[Susu20241010]

我已经解决了！！我复制的你发布的最新的代码

[Susu20241010]

哈哈哈 感激涕零 谢谢大佬的代码

[Susu20241010]

是的 发自我的iPhone

…

------------------ 原始邮件 ------------------ 发件人: WANG Chao ***@***.***> 发送时间: 2024年12月4日 15:05 收件人: windingwind/zotero-better-notes ***@***.***> 抄送: Susu20241010 ***@***.***>, Mention ***@***.***> 主题: Re: [windingwind/zotero-better-notes] [Item] Generate note from annotations (by brackets tag)/根据标注注释内自定义的标签生成笔记-支持多级标题嵌套 (2024.11.21更新/updated) (Discussion #1202) 不需要远程了是吗 — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>