Code Monkey home page Code Monkey logo

zotero-better-notes's Introduction

Better Notes for Zotero

zotero target version Using Zotero Plugin Template

Everything about note management. All in Zotero.

Better Notes Handbook (outdated, for version<=0.8.9): 中文 (provide translation)

🧩 Outline

🧐 What is this?

🤔 What can it do?

👋 Install

😎 Quick start

More

Getting Started with the Workspace

Note Editor

Note Link

Note Template

Syncing: Note 🔄️ Markdown

Note Export

GPT Integration

Action Workflow

Other Features

🧲 API

🔧 Development

🔔 Disclaimer

🔎 My Zotero Plugins

🫶 Sponsors

🤗 Contributors

🧐 What is this?

Better Notes (BN) is a plugin for Zotero.

BN streamlines your workflows of:

  • paper reading
  • annotating
  • note taking
  • metadata analyzing
  • knowledge exporting
  • AI writing assistant

and:

  • works out of the box
  • highly customizable
  • all in Zotero

🤔 What can it do?

🖇️ Connect knowledge fragments with note link. With one click. Learn more →

🗂️ Simplify and automate knowledge analysis with extensive note templates. With one click. Learn more →

🔄️ Keep in sync with your Markdown files. Two-way, automatically. Learn more →

🖨️ Export notes to different formats: Markdown, Docx, PDF, and mind map. Learn more →

📝 Enhancements for Zotero's note editor with outline, link relation, view images.... Open as much note tabs/windows as you like!

👋 Install

  • Download the latest release (.xpi file) from:

    Note: If you're using Firefox as your browser, right-click the .xpi and select "Save As.."

  • In Zotero click Tools in the top menu bar and then click Plugins

  • Go to the Extensions page and then click the gear icon in the top right.

  • Select Install Add-on from file.

  • Browse to where you downloaded the .xpi file and select it.

  • Finish!

😎 Quick start

BN offers a range of features that can be combined like Lego blocks to build your own note-taking workflow.

Start taking notes in Zotero with BN in 5 minutes!

Getting Started with the Workspace

💡 This section is outdated and will be removed. For the latest beta version, the workspace is no longer a thing. You can open unlimited number of note tab/window, which is what we call workspace in the past.

The workspace serves as the central hub where input flows (papers and annotations) converge with output flows (summaries and comparisons).

To open the workspace, click the icon button in the tabs bar.

The workspace contains a default note called the workspace note. You can create a new note as the workspace note if prompted on opening workspace.

💡 How to set an existing note as the workspace note?

  1. In the library: select a note item and right-click
  2. In the note editor: click on the Tools button

You can change the workspace note at any time.

The workspace allows you to take notes and write, just like you would in MS Word or a markdown editor (e.g., Obsidian).

Explore the Workspace!
💡 The layout from left to right is:

  • Outline
  • Workspace note editor (main editor)
  • Note link preview (hidden by default)
  • Reader notes pane (hidden by default)

💡 To toggle these panes, hover the workspace tab and click corresponding buttons.
💡 To open the workspace in a new window, drag the workspace tab.

Note Editor

The workspace includes the note editor for the workspace note. You can use it to take notes and write summaries.

💡 How to open note editor?

  • In the library: click to open a note editor and double-click to open note editor in a standalone window.
  • In the PDF reader: right-side bar

💡 How to create a new note?
Click the note icon in the library tools bar (the row under the tabs bar).

Note Link

To create a note link between current note and the workspace note, simply click the button in the title bar of current note editor.

Note Template

Still spending a lot of time writing summaries or doing copy-pasting while taking notes? Say hello to Note Template!

Note Template is designed for tasks like:

  • Summarize metadata and annotations from multiple papers, with customized filters
  • Compare papers across sections
  • Generate content programmatically

💡 Need help or looking for community templates? See here →

💡 Want to write/share your own templates?

How to write →

How to share →

Syncing: Note 🔄️ Markdown

With BN, you can integrate your note-taking into your existing workflow seamlessly. If you use markdown editors like Obsidian, you can keep your notes in sync with external Markdown files easily.

To set up auto-sync, click Set Auto-Sync the first time you export your note. There is no need for any third-party tools or complicated setups!

Any changes made to your note or its corresponding Markdown file will be automatically synced. This feature makes it easy to keep all of your notes up to date and in one place.

💡 Note: The note being edited will be synced after the editor is closed.

Note Export

BN offers various options to export your notes, giving you the flexibility to choose the format that suits your needs.

You can export your note to the following formats:

  • A new note in Zotero
  • Markdown file (embedded or linked, with images)
  • MS Word document (.docx)
  • PDF document (.pdf)
  • FreeMind file (.mm)

Simply click on the corresponding export button in the toolbar and follow the prompts.

GPT Integration

The Zotero-GPT plugin provides GPT Integration. If you also have Better Notes installed, you can wake up GPT pane in the workspace note editor with space key.

You can:

  • Ask GPT questions about current note
  • Summarize/fix spelling and grammar/translate/polish the selection
  • Accept suggestions/modifications from GPT with enter key.

Action Workflow

The Actions & Tags plugin provides a powerful workflow engine for Zotero. If you also have Better Notes installed, you can use the following actions to automate note generation/editing/syncing/etc.:

Other Features

  • Quick Note: convert annotation to note with one click.
  • Resize images with right-click menu.
  • Preview images with double-click/ctrl-click.

🧲 API

BN provides APIs for other plugin developers in Zotero.BetterNotes.api.${API_MODULE}. See api.ts.

  • workspace: Workspace APIs
  • sync: Syncing APIs
  • convert: Lossless conversion between note, HTML, Markdown, note link, and annotation
  • template: Manipulate note templates
  • $export: Export note
  • $import: Import note
  • editor: Note editor APIs. Give your script the full control of contents in the note editor.

🔧 Development

This plugin is built based on the Zotero Plugin Template. See the setup and debug details there.

To startup, run

git clone https://github.com/windingwind/zotero-better-notes.git
cd zotero-better-notes
npm install
npm run build

The plugin is built to ./builds/*.xpi.

🔔 Disclaimer

Use this code under AGPL. No warranties are provided. Keep the laws of your locality in mind!

🔎 My Zotero Plugins

🙌 Sponsors

Thanks peachgirl100, Juan Gimenez, and other anonymous sponsors!

If you want to leave your name here, please email me or leave a message with the donation.

🤗 Contributors

zotero-better-notes's People

Contributors

ashed avatar carbeer avatar dependabot[bot] avatar ezellohar avatar isharestuff avatar mbtt107 avatar muisedestiny avatar northword avatar virologist avatar windingwind avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

zotero-better-notes's Issues

Improvement request: moving headlines around in outline view

Hi! I've had a look at this new Zotero plugin and it looks very promising. I've been searching for something like this for a long time, and I'm very happy to see this becoming a reality.
My main use case would be to create outlines for writing academic papers, etc. For this, being able to promote and demote headings, and in general move stuff around by dragging and dropping headings and chunks of text, is essential. Right now it is possible to do this in outline view, but it's a bit clunky.
It'd be very nice to have some kind of visual clue of where things are gonna fall when dragging and dropping. The new zotero note editor does it very well (although it lacks the outline mode that your plugin introduces).
Could you improve this? Thank you!
BTW, I'd like to make a donation to kelp make this project sustainable. Is this possible? :)

【功能强化】同步注释tag

非常喜欢这个小插件!

有一个小建议,就是在zotero pdf阅读器中,可以对注释笔记加上标签。希望通过插件新增笔记时,标签信息也会同时给加新增的注释。
图1:
image
图2:(希望实现的效果)
image

TODO

Bugs

  • export with images sometimes contains an extra string
  • blank note page(on macOS?)
  • export to note/insert sub-note should copy images
  • copy image annotation only works on Windows(#68 )
  • jump to heading line(#82 )
  • tables cannot be selected(#99 )
  • extra link buttons disappear

Functions

  • citation/info quick insert(#1 )
  • note template(#1 )
  • update link text(#4 )
  • Sync note tag with the source annotation(#5 )
  • export remove duplicate link(#7 )
  • don't create duplicate collection in user guide(#8 )
  • generate main note from existing notes(#10 )
  • LaTex support(#14 )
  • quick view inserted position(#18 )
  • collapse the lowest headings by default(#19 )
  • insert metadata(#20 )
  • export sub notes as markdown file(#32 )
  • back-link to main note(#32 )
  • export to PDF
  • better heading opts support(#61 )
  • sync note to file(#45 )
  • update all link text(#55 )
  • insert annotations automatically(#70 #72 )
  • sync settings(#76 )
  • word count(#83 )
  • resize image
  • add more highlight colors
  • font color
  • export md with highlight(#89 )
  • export pdf with highlight(#95 )
  • template convert input(#97 )
  • insert table(#99 )

UI

  • drag/drop improvement(#2 )
  • workspace as a tab
  • memorize workspace window layout(#62 )
  • heading appearance(#93 )

Bug: new tools are shown above the PDF file content index

After installing the add-on, new tool are shown above the PDF file content index and I think this should not happen.

Another bug is that after click the icon "Add link of current note to the main note", it create a link to the main note in the main note rather than to the PDF content index or PDF.

image

Is it necessary to edit the link?& Differentiate display main note

1--
图片
手动修改链接的需求是否有必要呢?
此处有无必要加入修改标题名的选项,同时原笔记条目相应双向更新。
2--
图片
在My knowledges分类下的,有主笔记和多个独立笔记地情况,能否通过特殊标识符直观地区分一下?这样就不用选中每一个条目去找了。

LaTeX subscript showing as superscript

Current: Type a subscript only shows as superscript.
Image: as typed
sshot-001

Image: after clicking LaTeX view button:
sshot-002

It does not matter whether I use $...$, $$...$$, \[...\], or \(...\).

能否导出 Latex 格式

因加入 LatexView 之后,导出 word 公式仍然为$$y=a+x$$的文字,而能正式显示公式结果。
能否支持导出 Latex 格式?

duplicate content

  1. 将PDF内部的注释插入到主笔记时,重复显示3次,1注释条目名,2内部内容第一段,3内容。
    能否将1&2合并?或者将2隐藏。
    个人想法:以本条注释的tag内容为条目名,用来索引。
  2. 并且,条目名修改后,主笔记的索引并不更新。
    图片

小小建议

1.不知道up主能否设置一个按钮或者设置能将某篇文章的metadata(如文献题目、杂志、影响因子、作者等)引入到Knowledge中,这样的话,对于笔记的完整性会更好
2.能否将生成的Knowledge中思维导图的每一个条目设置呈可以调整长短或者设置显示字数是自由的,现在的情况,如果某一个层级标题字数多现在显示不好,只能看到几个字

从pdf中提取笔记支持颜色

我有多个插件,不知道上不上这个插件的功能,导出的笔记直接有引用链接,挺棒的。但是我想问一下能否支持导出的笔记带荧光笔的颜色?

之前自己折腾zotero的时候,希望倒出来的笔记带高亮颜色,并且进行了一番探索,需要改造几个地方

几个改造的值

extensions.zotfile.pdfExtraction.NoteTruePage;false
extensions.zotfile.pdfExtraction.formatAnnotationHighlight;<p>#%(color)# - <span style="background-color:%(color);">"%(content)"</span> (%(cite))</p>
extensions.zotfile.pdfExtraction.formatAnnotationNote;<p><i>%(content) (<a href="%(uri)">note on p.%(page)</a>BY.%(label)) </p><br>

下划线笔记有问题一直不能导出来可能是zotfile对新版zotero兼容性不太好
extensions.zotfile.pdfExtraction.formatAnnotationUnderline;<p>"<u>%(content)</u>" (%(label); p.%(page); %(uri))</p>
extensions.zotfile.pdfExtraction.formatAnnotationUnderline;<p>"<u>%(content)</u>" (%(cite))</p>

每行解读:“编辑->首选项->高级->设置编辑器”中的键;键值

导出来的效果:

参考

参考资料

ZotFile: Extracting more features of annotations - Zotero Forums

Using Zotero, Zotfile and Scrivener to carry out research, annotate PDFs and extract the annotations as notes. – AN -|- ANCIENT -|- ACADEMIC

notes [Zotero Documentation]

[Bug] Exported Images producing incorrect file structure and filenames.

macOS 12.4
Zotero 6
zotero-better-notes Release 0.4.7

  1. Open PDF for annotation in Zotero 6
  2. Add annotations to notes
  3. Export notes as Markdown

Result

Attachment folder creates new folder in root with the parent path in the file name. This is empty.
Image files are being created with the path in the filename rather than saving to the path ends up in the root.

image

Should be

image

标题层级操作

希望能够在思维导图状态下,选中某一个标题也能进行降低或者提升层级的操作,或者在右侧编辑栏中,划中某一个标题,也能进行降低或者提升层级的操作

希望笔记可以自动命名

每次把从注释中生成的笔记然后设置主笔记导出的markdown的文件名字都是注释两个字,能不能根据注释所在的条目的元数据自己设置命名规则自动命名啊?

增加一键引入metadata功能

设置一个按钮能将某篇文章的metadata(如article title、Journal name、IF、authors、published year、tags等)引入到Knowledge中,这样的话,对于笔记的完整性会更好

[Feature] 模板中能否插入citation key,或者自动生成@citationkey这样命名的markdown,或者是能自定义默认文件名?

模板中能否插入citation key,或者自动生成@citationkey这样命名的markdown,或者是能自定义默认文件名?
如果在支持批量导出markdown,我觉得就可以完全替代 mdnote和 obsidian里一些类似bibnotes 转换 better bibtex为markdown繁琐的工作流,实现一统天下了。

Originally posted by @seifer08ms in #23 (comment)

Please consider another name for the plugin

Probably "Knowledge4Zotero" is not a good name for it because zotero is a knowledge management tool. If you search "knowledge zotero" in google, you are unable to find the plugin. If you use "knowledge zotero plugin", you can only find the post in Zotero forum, rather then the github page.

Please consider a better name for it. "BetterNotes" or something else.

小建议

试用了一下,注释选择提取并建成一个新的笔记太有助于写作了,感觉ob已经不大能用到了,大神什么时候可以加入ob的dataview的功能啊,能有个表格整理文献笔记看起来会很清楚

Automatically add Citation Key when adding link to note

Hi,
Zotero-better-notes is a excellent add-on to my liking.
Here I have a suggetsion might make it more smart:
Is it possilbe to automatically add citation key along with the link added to note?
This will make writing much easier.

Best.

添加历史版本( Git)的 支持

请问是否能添加历史版本(或 Git)的 支持?在 Note 上方添加一个 push 的菜单?可自定义Git 或用 Github 进行同步?

大纲思维导图显示

在大纲思维导图显示中,在自己需要的情况下,可以手动设置思维导图能一直维持其状态,不因为更新而变小

导出笔记的特殊字符问题【已解决】

在导出笔记时,”###“会变成”\###“,”>“会变成”\>“。让原本写得好好的markdown笔记,原本的标记都没有了。
请问”自动加\“这个功能可以手动关闭吗?在哪里关闭呢?通过高级设置里的设置编辑器可以吗?谢谢大佬

Genealogies of Knowledge possible?

Hello, I posted this in Zotero forum:

Feature request: Genealogies of Knowledge plugin possible?
p.m.lykkja 39 minutes ago
Hello, I am wondering if it is possible to make a plugin with Genealogies of Knowledge software? https://sourceforge.net/projects/modnlp/ It would be nice to load up fulltext from a library so it can be text mined. It is a suprising easy to use and intuitive, and could be perfect as a plugin to Zotero: http://genealogiesofknowledge.net/software/manual/

增加标题层级

笔记里面的标题层级能再多加几个吗,现在只有标题1,2,3,剩下的还要手动降低标题层级

[Bug] The function of extension is invalid in v0.4.8

我更新了0.4.8,发现插件增加的 打开工作空间,和插件自己的导出按钮都不见了。安装回0.4.7,这两个又出现了。另外我测试了下0.4.7导出图片的功能,发现位置被修复正确,但图片没有嵌入,生成的这个图片路径是找不到图片的,

图片

不知道是不是这个问题 在0.4.8中修复了,但0.4.8又出现别的bug导致功能按钮不见了

item links broken in markdown export

  1. After exporting to markdown in obsidian links to annotaions are broken (both annotation page and the item). Item ID is missing.
  2. Shortcuts are missing in ouline area. There is only view mode.
    image

I am on widows 7 OS.
Thanks for the great addon.

自动给不同颜色的批注打标签,并提取到相应的笔记中

如题,作者是否可以考虑增加上述自动化功能。
让用户给每种颜色的批注添加一个标签,然后自动将该批注添加到以批注为标题的笔记中。
例如:
红色的批注添加一个“重要概念”的标签,并将其放到以“重要概念”为标题的笔记中
黄色的批注添加一个“主流观点”的标签,并将其放道以“主流观点”为标题的笔记中
……
这样可以在阅读完文献或书籍后,自动生成有用信息,方便后续的回顾,也可以通过现在插件中的模版功能,对笔记进行简单的横向和纵向的整合复用。

Add notes repeatedly in specific situations

image
After finishing the notes extracted to k4z at one time, delete the automatically generated entry notes (on the right) and completely delete them in the recycle bin. Click the Yellow Icon in the notes (on the left) again. Each click will generate an entry note and add a note link

[Bug] Issues about jumping of annotation in notes

After upgrading to releases v0.4.3 and v0.4.4, I found some issues with the jump function of annotations.

  1. The annotation in the note can only jump to selecting the item, not to the page where it is located. The show page button is disappeared.

1653991359(1)

2. The markdown file, exported from a note of annotations, contains the page links jumping to a specific location of annotations. However, the image is embedded incorrectly, and the page links of images are missing.

image
3. There is no page link in the main note( pdf link in the above screenshot ), and therefore the function of jumping to a page is not available. However, the markdown generated with the default export function has a page link, but it is impossible to embed the image.
image

Classified old notes cannot be updated in real time

After I have created a PDF note called"A", and have used k4z import into a collection of finishing notes. When I add / modify new notes in this PDF note "A", the collected sorting notes cannot be updated.

笔记截图路径问题

感谢作者!使用过程中(主力MAC+Zotero 6+OB)发现 Zotero 的截图存储路径是在本地,但在 OB 里打开笔记需要在绝对路径前面加上 file:/// 或file:/ 才能显示图片,一个一个替换太麻烦了,请问作者大大能否有好的解决办法?
image
image

Addon does not show up after installing and activating

I downloaded the .xpi file and tried to install this addon following the steps in the readme file, but after restarting Zotero nothing new about this plugin shows up. The only thing that I can notice is this set main note item in the drop-down menu: image, which does not give me any response after being clicked.

The following is a screenshot of Zetoro after installing the plugin, and making sure that in the addon manager, the status of this plugin is enabled.
image

I am new to Zotero so I am not sure if I missed anything. Thanks!

[Feature] 同步主笔记文件夹到obsidian

有没有考虑搞个ob插件,同步zotero的main notes到ob?以后主笔记多了还是有这个需求的。

可以参考ob微信读书插件的做法 ( https://github.com/zhaohongxuan/obsidian-weread-plugin ),
每个主笔记放入对应子文件夹,自己对这些笔记的再加工可以copy同步的主笔记,在上级目录编辑,以后再做进一步的整理 (当然也可以引用外部block的方式来reference这些主笔记):

-- Main Notes Folder for Synchronizing/
-- -- Folder 1 for Main Note 1/
-- -- -- Main Note 1.md
-- -- Folder N for Main Note N/
-- -- -- Main Note N.md
-- -- Self-Created Note 1.md (对Main Note 1的进一步加工和优化)
-- -- Self-Created Note M.md (整合几个Main Notes的自建文档)

加粗部分插件每次同步都会检查是否有更新/更改,自建部分插件不会改动。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.