update: readme

README.md

@@ -1,6 +1,15 @@
-# Knowledge4Zotero
+# Knowledge for Zotero
 
-Knowledge management for Zotero!
+[User Guide(EN)](./UserGuide.md) | [用户指引(中文)](./UserGuideCN.md)
+
+A full knowledge management workflow in Zotero.
+
+- Note as you go. Open note links as your will;
+- Foward-link to sub-notes and back-link to PDF attachments;
+- Quick link from note/annotation with just a click;
+- Export your knowledge including linked sub-notes in MarkDown/rich-text format.
+
+![k4z](./image/README/knowledge-app.png)
 
 # Quick Start Guide
 
@@ -14,74 +23,12 @@ Knowledge management for Zotero!
 - Restart Zotero, by clicking `restart now` in the extensions list where the
   Zotero PDF Translate plugin is now listed.
 
-## Introduction
-
-**Note**: an atomized **note** including a point, or a method described in a paper, or your thoughts while reading the paper, or anything else you drew from a paper.
-
-A note in Zotero looks something like this (below), with quote sentences and your own thoughts.
-
-![](image/README/1651892918746.png)
-
-**Knowledge**: Simply, knowledge = note**s**.
-
-![](image/README/1651895948057.png)
-
-**Knowledge Workspace**: a place to manage your **notes** in a hierarchical outline.
-
-![](image/README/1651896006854.png)
-
 ## Usage
 
-### Set a new knowledge
-
-After the plugin installtion, click the menu on the top panel to "create new knowledge workspace" to set a new knowledge.
-
-Or, switch the main knowledge to another existing knowledge
-
-![img](image/README/1651896159066.png)
-
-![](image/README/1651896602114.png)
-
-### Add note to knowledge
-
-select some sentences you interested (1) and add to pdf annotation (2);
-
-put some thoughts when you are reading these sentences and add to the certain place of knowledge (3 - 5);
-
-![](image/README/1651897206384.png)
-
-Add an existing note to your knowledge
-
-![](image/README/1651898023847.png)
-
-### Manage your knowledge
-
-Open your main knowledge
-
-![](image/README/1651898106681.png)
-
-manage your notes after you added from pdf annotation
-
-![](image/README/1651897924046.png)
-
-### Backlinks
-
-Go back to the paper from your knowledge (bi-directional links or backlinks).
-
-Click the note and Zotero link, back to the paper when you need (this is my favorite part).
-
-![img](image/README/1651898254827.png)
-
-### Outline mindmap
-
-Click the switch outline mode to see the mindmap
-
-![](image/README/1651900109443.png)
-
-Click the button again to switch outline mode
-
-![](image/README/1651900283206.png)
+For new users, a **User Guide** will help you get started quickly and create a user guide note for you. Use it as a playground and explore your own workflow!
 
+Documentation:  
+[User Guide(EN)](./UserGuide.md) | [用户指引(中文)](./UserGuideCN.md)
 
 ## Development & Contributing
 
@@ -94,3 +41,8 @@ Use this code under AGPL (open source required). No warranties are provided. Kee
 Part of the code of this repo refers to other open-source projects within the allowed scope.
 
 - [zotero-pdf-translate](https://github.com/windingwind/zotero-pdf-translate)
+
+
+## My Other Zotero Addons
+- [zotero-pdf-translate](https://github.com/windingwind/zotero-pdf-translate) PDF translation for Zotero 6
+- [zotero-tag](https://github.com/windingwind/zotero-tag) Automatically tag items/Batch tagging

UserGuide.md

@@ -0,0 +1,127 @@
+# Knowledge for Zotero User Guide: Workflow
+
+Welcome to **Knowledge for Zotero** !
+
+This note helps you quickly learn how to use this addon in 3 min!
+
+Let's start now.
+
+## 1 What is Knowledge
+
+Knowledge is an extension of Zotero's built-in note function.
+
+Zotero's note is much like a markdown/rich-text editor. You can edit the format with the tools above⬆️.
+
+### 1.1 Workspace Window
+
+The knowledge workspace window contains an outline area(left side⬅️), the main note area, and the preview area(right side➡️).
+
+![workspace](./image/README/workspace.png)
+
+Open workspace by clicking the 'Open Workspace' line above the 'My Library' line in Zotero main window. Alternatively, open it with the '🏠home' button on the top-left of note editors.
+
+### 1.2 Main note
+
+This addon uses a Zotero note item as the main note. It will show up on the main area of the workspace window.
+
+All links will be added to the main note.
+
+Change the main note with the '📂folder' button on the bottom of the outline area(left side⬅️).
+
+![workspace-usage](./image/README/workspace-usage.png)
+
+## 2 Gather Ideas to Main Note
+
+### 2.1 From Note
+
+Select a note outside the workspace window(in Zotero items view or PDF viewer), you may realize a button with the addon's icon on the top of the note editor toolbar.
+
+Click it, the current note link will be inserted into the main note's cursor position;
+
+Select a heading, the note's link will be inserted into the end of this heading.
+
+![insert-link-from-note](./image/README/from-note.png)
+
+> **💡 Try it now!**
+>
+> Open a PDF and open/create a note(in the right side bar of PDF viewer). Add a link below.
+
+#### 2.1.1 INSERT HERE
+
+You can insert the link here.
+
+### 2.2 From Annotation
+
+You can find a button with the addon's icon on every annotation(in the left sidebar of PDF viewer).
+
+Click it, and a new note with this annotation will be created under the PDF item. You can also add the link to the main note in the note editor.
+
+![insert-link-from-annotation](./image/README/from-annotation.png)
+
+> **💡 Try it now!**
+>
+> Open a PDF and open/create an annotation(in the left sidebar of PDF viewer). Add a link.
+
+## 3 Check Linked Notes in Workspace Window
+
+### 3.1 View Linked Notes
+
+Suppose you have added a lot of links to the main note. Now, it's time to view what you've got.
+
+Go back to the workspace window.
+
+Click links, the linked note will show up in the preview area(right side➡️).
+
+![preview-link](./image/README/preview-note.png)
+
+> **💡 Try it now!**
+>
+> Open a note link.
+
+### 3.2 View Linked Note's PDF
+
+Click the '📄PDF' button on the top-left of the preview area.
+
+> **💡 Try it now!**
+>
+> Open a linked note's PDF.
+
+## 4 Outline Mode
+
+Switch the outline mode with the '📊mode' button on the bottom of the outline area.
+
+![outline](./image/README/outline-mode.png)
+
+> **💡 Try it now!**
+>
+> Try different outline modes.
+
+## 5 Export
+
+Click the '⬆️export' button on the top-right of the main note area. Choose a format to export, e.g. MarkDown.
+
+![export](./image/README/export.png)
+
+If you are using MS Word/OneNote, export to clipboard and paste there.
+
+> **💡 Try it now!**
+>
+> Export this main note!
+
+## 6 Start a New Job
+
+After the export, you may want to start a new job with a new empty main note.
+
+Create a note and right-click to set it as the main note, or just create a new main note.
+
+Switch between different main notes with the '📂folder' button on the bottom of the outline area.
+
+> **✨ Hint**
+>
+> Create a new collection and save all main notes there is the best way to manage them.
+>
+> The user guide should have done this for you.
+
+Congratulations!
+
+You can select a new main note and start working with **Knowledge for Zotero** now. Have fun!

UserGuideCN.md

@@ -0,0 +1,127 @@
+# Knowledge for Zotero 用户指引：工作流
+
+欢迎使用 **Knowledge for Zotero** !
+
+本笔记帮助您在 3 分钟内快速学习如何使用此插件！
+
+现在开始吧。
+
+## 1 认识 Knowledge
+
+Knowledge 是 Zotero 内置 note 功能的扩展。
+
+Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工具编辑格式 ⬆️。
+
+### 1.1 工作区窗口
+
+知识工作区窗口包含一个大纲区域（左侧 ⬅️），主笔记区域和预览区域（右侧 ➡️）。
+
+![workspace](./image/README/workspace.png)
+
+在 Zotero 主窗口中单击“我的文库”上方的“Open Workspace”来打开工作区。或者，用笔记编辑器左上角的“🏠 主页”按钮。
+
+### 1.2 主笔记
+
+这个插件使用某一个 Zotero note 作为主笔记。它将显示在工作区窗口的主笔记区域。
+
+所有链接都将添加到主笔记中。
+
+点击位于大纲区域左下方的 📂“文件夹”按钮 来选择不同的 note 作为主笔记。
+
+![workspace-usage](./image/README/workspace-usage.png)
+
+## 2 在主笔记中收集想法
+
+### 2.1 从 Note
+
+在工作区窗口外选择一个 note（在 Zotero 条目视图或 PDF 阅读器中），您会在笔记编辑器工具栏顶部看到一个带有本插件图标的按钮。
+
+点击它，当前笔记的链接将插入主笔记的光标位置；
+
+选择一个标题层级，笔记的链接将插入该标题的末尾。
+
+![insert-link-from-note](./image/README/from-note.png)
+
+> **💡 尝试一下!**
+>
+> 打开 PDF 并打开/创建笔记（在 PDF 阅读器的右侧栏中）。用上面的方法在这条主笔记添加一个链接。
+
+#### 2.1.1 用来插入链接的位置
+
+你可以在这里插入链接。
+
+### 2.2 从 Annotation（批注高亮）
+
+你可以在每个批注上找到一个带有插件图标的按钮（在 PDF 阅读器的左侧栏中）。
+
+单击它，PDF 项目下将创建一个带有此批注的新笔记。也可以在打开的笔记编辑器中将链接添加到主笔记。
+
+![insert-link-from-annotation](./image/README/from-annotation.png)
+
+> **💡 尝试一下!**
+>
+> 打开 PDF 并打开/创建批注高亮（在 PDF 阅读器的左侧栏中）。用上面的方法在这条主笔记添加一个链接。
+
+## 3 查看工作区窗口中的链接笔记
+
+### 3.1 查看链接笔记
+
+假设你已经在主笔记添加了很多的链接。现在，是时候看看你的结果了。
+
+返回工作区窗口。
+
+单击链接，链接的笔记将显示在预览区域（右侧 ➡️）。
+
+![preview-link](./image/README/preview-note.png)
+
+> **💡 尝试一下!**
+>
+> 在工作区窗口打开一个笔记链接。
+
+### 3.2 查看链接笔记的 PDF
+
+在上一步打开的预览笔记中，点击预览区左上角的“📄PDF”按钮。
+
+> **💡 尝试一下!**
+>
+> 打开一个链接笔记的 PDF。
+
+## 4 大纲视图
+
+点击大纲区域左下角的 ‘📊 大纲模式‘ 按钮 来切换大纲视图模式。
+
+![outline](./image/README/outline-mode.png)
+
+> **💡 尝试一下!**
+>
+> 尝试不同的大纲模式（思维导图）
+
+## 5 导出
+
+点击主笔记区域右上角的“⬆️ 导出”按钮。选择要导出的格式，比如 MarkDown。
+
+![export](./image/README/export.png)
+
+如果您使用的是 MS Word/OneNote，请导出到剪贴板并粘贴到那里。
+
+> **💡 尝试一下!**
+>
+> 导出这个主笔记！
+
+## 6 开始新的任务
+
+导出后，您可能希望使用新的空主笔记开始新任务。
+
+创建一个 note 笔记，然后右键单击将其设置为主笔记；或者直接创建一个新的主笔记。
+
+使用大纲区域底部的“📂 文件夹”按钮切换不同的主笔记。
+
+> **✨ 提示**
+>
+> 创建一个新的文件夹并在其中专门保存所有的主笔记——这是管理主笔记的最佳方法。
+>
+> 用户指引应该已经为您做到了这一点。
+
+恭喜!
+
+你现在可以选择或新建一个主笔记，然后开始使用 **Knowledge for Zotero**了。用的开心！