[Item] collect annotations by color(sort by color)

[windingwind]

Details

Author: @windingwind
Discuss: #49
Type: A

Template Code for Importing

# This template is specifically for importing/sharing, using better 
# notes 'import from clipboard': copy the content and
# goto Zotero menu bar, click Edit->New Template from Clipboard.  
# Do not copy-paste this to better notes template editor directly.
name: "[item] collect annotations by color(sort by color) "
content: |-
  // @author windingwind
  // @link https://github.com/windingwind/zotero-better-notes/discussions/227
  ${{
    async function getAnnotationsByColor(item, colorFilter) {
      const annots = item.getAnnotations().filter(colorFilter);
  	return await Zotero.BetterNotes.api.convert.annotations2html(annots, { noteItem: targetNoteItem });
    }
  
    const attachments = Zotero.Items.get(topItem.getAttachments()).filter((i) =>
      i.isPDFAttachment() || i.isSnapshotAttachment() || i.isEPUBAttachment()
    );
    let res = "";
    const colors = ["#ffd400", "#ff6666", "#5fb236", "#2ea8e5", "#a28ae5", "#e56eee", "#f19837", "#aaaaaa"];
    const colorNames = ["Yellow", "Red", "Green", "Blue", "Purple", "Magenta", "Orange", "Gray"];
    for (let attachment of attachments) {
      res += `<h1>${attachment.getFilename()}</h1>`;
      for (let i in colors) {
        const renderedAnnotations = (
          await getAnnotationsByColor(
            attachment,
            (annot) => annot.annotationColor === colors[i]
          )
        );
        if (renderedAnnotations) {
          res += `<h2><p style="background-color:${colors[i]};">${colorNames[i]} Annotations</p></h2>\n${renderedAnnotations}`;
        }
      }
      const renderedAnnotations = (
        await getAnnotationsByColor(
          attachment,
          (annot) => !colors.includes(annot.annotationColor)
        )
      );
      if (renderedAnnotations) {
        res += `<h2><p>Other Annotations</p></h2>\n${renderedAnnotations}`;
      }
    }
    return res;
  }}$

[MengjieLi-Cora]

Hello, I am a beginner of Zotero. I want to collect annotations by color (sort by color). But code here seems not work in zotero 6. Same code, but colored annotations did not sorted. Is there any steps I have missed? I would appreciated if any related information you want to share with me.

[Superflash1]

I have the same problem.

[AlCATO42]

Hola Comparto el código de esta plantilla actualizado para que reconozca los nuevos colores que se agregaron al lector de Zotero.
${await new Promise(async (r) => {
async function getAnnotation(item) {
try {
if (!item || !item.isAnnotation()) {
return null;
}
let json = await Zotero.Annotations.toJSON(item);
json.id = item.key;
delete json.key;
for (let key in json) {
json[key] = json[key] || "";
}
json.tags = json.tags || [];
return json;
} catch (e) {
Zotero.logError(e);
return null;
}
}

async function getAnnotationsByColor(_item, color) {
const annots = _item
.getAnnotations()
.filter((_annot) => _annot.annotationColor === color);
let annotations = [];
for (let annot of annots) {
const annotJson = await getAnnotation(annot);
annotJson.attachmentItemID = _item.id;
annotations.push(annotJson);
}

const editor =
  await Zotero.Knowledge4Zotero.knowledge.getWorkspaceEditorInstance();
await editor.importImages(annotations);
return Zotero.EditorInstanceUtilities.serializeAnnotations(annotations);

}

const attachments = Zotero.Items.get(topItem.getAttachments()).filter((i) =>
i.isPDFAttachment()
);
let res = "";
let colorYellow = "#ffd400";
let colorRed = "#ff6666";
let colorGreen = "#5fb236";
let colorBlue = "#2ea8e5";
let colorPerple = "#a28ae5";
let colorMagenta = "#e56eee";
let colorOrange = "#f19837";
let colorGray = "#aaaaaa";
for (let attachment of attachments) {
res += <h2><p style="background-color:${colorYellow};">Yellow Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorYellow)).html} ;
res += <h2><p style="background-color:${colorRed };">Red Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorRed )).html} ;
res += <h2><p style="background-color:${colorGreen };">Green Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorGreen )).html} ;
res += <h2><p style="background-color:${colorBlue };">Blue Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorBlue )).html} ;
res += <h2><p style="background-color:${colorPerple };">Perple Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorPerple )).html} ;
res += <h2><p style="background-color:${colorMagenta };">Magenta Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorMagenta )).html} ;
res += <h2><p style="background-color:${colorOrange };">Orange Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorOrange )).html} ;
res += <h2><p style="background-color:${colorGray };">Gray Heading</p></h2> ${(await getAnnotationsByColor(attachment, colorGray )).html} ;
}
r(res);
})}

[Ariesssssssssss]

Hi, I met an issue that when I updated to the new version, I could not use this template. I tried to copy and paste this template again into the Template Editor, and name it with the prefix [item]. However, it still did not work. Can you tell me how to deal with this please? Thanks! @windingwind

[windingwind]

The template is updated for the latest beta version (1.1.4-18)

[zzlb0224]

这个功能分类整理太强了，感谢

[outsider15]

应用模板的时候显示错误：Template [item] collect annotations by color(sort by color) Error: SyntaxError: missing : after property id，怎么解决，谢谢！

[windingwind]

更新插件。仅适用于最新beta版本（zotero 7）

[judywang1111]

更新了。还是不行

[windingwind]

@judywang1111

1. 你需要描述怎么操作的，出了什么问题。看病不说病情，华佗也救不了
2. 是否按照文档描述的导入模板操作了
3. 当前插件和zotero什么版本

[Adammartain]

大佬好，我一时疏忽，没按文档描述操作，把collect annotations直接在模板编辑器里粘贴了，之后不论通过注释还是模板添加条目笔记时，都出现如下字段

求大佬帮忙看看na哪里出问题了呜呜呜，以后再也不不看文档就乱操作了

[windingwind]

删除这个模板，然后阅读一下模板开头几行

[yuancycle]

您好，模板报错SyntaxError: missing : after property id ，复制您上面的代码从剪切板导入新模板，zotero7 bn版本1.0.4，使用了几种导入模板到文件的方式都报错

[windingwind]

善用搜索，升级插件

[pinetreemoonlight]

Would it be possible to edit this template to

1. show the annotations as bullet points under each heading
2. to remove the parentheses for each annotation (" ")
3. to remove the part in brackets for each annotation (author name, year and page number)?

I have no idea how to do it myself, so I am asking kindly!

[windingwind]

you can ask for tools like GPT for help. sorry I do not have time to satisfy these customization requests.

[pinetreemoonlight]

I couldn't get it to work even with GPT. If anyone else can bother to try, I would appreciate it!

[pinetreemoonlight]

I figured it out. You have to go to Zotero Settings --> Advanced --> Config Editor and find annotations.notesTemplates.highlight and enter

<ul><li>{{highlight}}{{comment}}</li></ul>

[alic234]

大佬，能不能求一版按颜色获取 划了下划线 的笔记（高亮看的眼花）非常感谢！！！

[windingwind]

下划线应该也能用的？

[alic234]

我试了几篇都不行欸，只能获取高亮的文字，划了下划线得获取不了

[windingwind]

I'm not sure if you want to share your workflow (which should be in a separate discussion) or if you are looking for help with Zotero's built-in note template (which should go to Zotero forums).

[sBaydin]

I'm not sure if you want to share your workflow (which should be in a separate discussion) or if you are looking for help with Zotero's built-in note template (which should go to Zotero forums).

Sorry if i write it wrong place but actually i want help for this discussion.
I'm trying to group by colour in betternote but I couldn't do it. I finally read this method and arranged it myself as mentioned above. The reason I'm writing here is that I couldn't run the codes written as [item] in betternote. I can't understand if it's because I'm using Zotero 6 or if I'm making a mistake. The code I used for BetterNote is as follows:

<details>
    <summary>
        <h2 style="color: #004d99; background-color: #87cefa; margin: 0; padding: 8px">🌟 annotation</h2>
    </summary>
    <h3>🖊️ Writing</h3>
    <p></p>
    <h3>📈 Tables and Figures</h3>
    <p></p>
</details>

automatic retrieval of quotations as writing where it says [writing]
I want to have the sections that we have marked as fields where it says [tables and figures].

In addition to this, I am trying to arrange the subgroups of these groups according to the colours, i.e. yellow under one heading and red under one heading.
But I couldn't succeed somehow.
By the way, thanks for the quick response.

[huberdf]

论文过一段时间又看了一遍，又重新写了些highlighting和注释，笔记后面又更新了，笔记里的好像不能自动更新。

[fredericky123]

论文过一段时间又看了一遍，又重新写了些highlighting和注释，笔记后面又更新了，笔记里的好像不能自动更新。

期待能自动更新