diff --git a/UserGuide.md b/UserGuide.md index ffb3077..a0283d1 100644 --- a/UserGuide.md +++ b/UserGuide.md @@ -18,18 +18,69 @@ The knowledge workspace window contains an outline area(left side⬅️), the ma ![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. +Open workspace by clicking the 'Open Workspace' line above the 'My Library' line in Zotero main window. +![Open workspace](./image/README/openworkspace.png) + +Alternatively, open it with the '🏠home' button on the top-left of note editors. + +![main page](./image/README/mainpage.png) ### 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⬅️). +Set current note as the main note: + +* Select the current note + +* Use right mouse button to set it as the main note ![workspace-usage](./image/README/workspace-usage.png) +### 1.3 Menu + +**File menu**: + +* Create a new main notes [shortcut key Ctrl N] + +* Open the main note [shortcut key Ctrl O] + +* Import notes [shortcut key Ctrl I] + +* Export notes [shortcut key Ctrl E] + +* Close [shortcut key CTRL W] +* +![filemenu](./image/README/filemenu.png) + +**Edit menu**: + +* Insert the title + +* Reduce the title level + +* Improve the title level + +**View menu**: + +* Tree view + +* mind Mapping + +* Bubble map + + +![viewmenu](./image/README/viewmenu.png) + +You can also click the icon below to switch view : + +![changeview](./image/README/changeview.png) + +**Help menu**: + +* Open the user guidance ## 2 Gather Ideas to Main Note ### 2.1 From Note @@ -46,22 +97,30 @@ Select a heading, the note's link will be inserted into the end of this heading. > > 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 +### 2.2 From Annotation (including highlight and picture) 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) +Click it, and a new note with this annotation will be created under the PDF item, and the tag will be shown in the annotation. You can also add the link to the main note in the note editor. + +![noteunderitem](./image/README/noteunderitem.png) + +In addition, you can also click the translation to translate the notes. + > **💡 Try it now!** > -> Open a PDF and open/create an annotation(in the left sidebar of PDF viewer). Add a link. +> Open a PDF and open/create an annotation(in the left sidebar of PDF viewer). +### 2.3 Import notes from the menu area + +Support to import the notes into the main notes in batches from the existing notes. + +* File menu >> Import notes +* or shortcut key cmd/ctrl+I ## 3 Check Linked Notes in Workspace Window ### 3.1 View Linked Notes @@ -70,7 +129,7 @@ Suppose you have added a lot of links to the main note. Now, it's time to view w Go back to the workspace window. -Click links, the linked note will show up in the preview area(right side➡️). +Click links with Ctrl, the linked note will show up in the preview area(right side➡️). ![preview-link](./image/README/preview-note.png) @@ -82,10 +141,31 @@ Click links, the linked note will show up in the preview area(right side➡️). Click the '📄PDF' button on the top-left of the preview area. +![openpdf](./image/README/openpdf.png) + > **💡 Try it now!** > > Open a linked note's PDF. +### 3.3 Inserts a reference format for the parent entry of the current note + +Click the "Insert Citation" button in the middle of the preview area. + +![insertCitation](./image/README/insertCitation.png) + +If you can not quickly insert the citation, you need to set the citation style in the option settings, instead of export format! + +![citationstyle](./image/README/citationstyle.png) + +### 3.4 Insert the current note to the main note and update in real time + +Click the note link, there will be four functions. + +![importnoteandupdate](./image/README/importnoteandupdate.png) + +After insertion: + +![insertnote](./image/README/insertnote.png) ## 4 Outline Mode Switch the outline mode with the '📊mode' button on the bottom of the outline area. diff --git a/UserGuideCN.md b/UserGuideCN.md index 248ee7b..d4dc853 100644 --- a/UserGuideCN.md +++ b/UserGuideCN.md @@ -18,7 +18,13 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 ![workspace](./image/README/workspace.png) -在 Zotero 主窗口中单击“我的文库”上方的“Open Workspace”来打开工作区。或者，用笔记编辑器左上角的“🏠 主页”按钮。 +在 Zotero 主窗口中单击“我的文库”上方的“Open Workspace”来打开工作区。 + +![Open workspace](./image/README/openworkspace.png) + +或者，用笔记编辑器左上角的“🏠 主页”按钮。 + +![main page](./image/README/mainpage.png) ### 1.2 主笔记 @@ -26,19 +32,51 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 所有链接都将添加到主笔记中。 -点击位于大纲区域左下方的 📂“文件夹”按钮 来选择不同的 note 作为主笔记。 +设置当前笔记为主笔记： +* 选中当前笔记 +* 鼠标右键设置为主笔记 ![workspace-usage](./image/README/workspace-usage.png) +### 1.3 功能区 +**文件菜单**： + * 创建新的主笔记【快捷键Ctrl N】 + * 打开主笔记【快捷键Ctrl O】 + * 导入笔记【快捷键Ctrl I】 + * 导出笔记【快捷键Ctrl E】 + * 关闭【快捷键Ctrl W】 + +![filemenu](./image/README/filemenu.png) + +**编辑菜单**： +* 插入标题 +* 降低标题层级 +* 提升标题层级 + + + +**查看菜单**： +* 树视图 +* 思维导图 +* 气泡导图 + +![viewmenu](./image/README/viewmenu.png) + +也可以在点击下方图标切换视图： + +![changeview](./image/README/changeview.png) + +**帮助菜单**： +* 打开用户指引 ## 2 在主笔记中收集想法 ### 2.1 从 Note 在工作区窗口外选择一个 note（在 Zotero 条目视图或 PDF 阅读器中），您会在笔记编辑器工具栏顶部看到一个带有本插件图标的按钮。 -点击它，当前笔记的链接将插入主笔记的光标位置； +* 点击它，当前笔记的链接将插入主笔记的光标位置； -选择一个标题层级，笔记的链接将插入该标题的末尾。 +* 选择一个标题层级，笔记的链接将插入该标题的末尾。 ![insert-link-from-note](./image/README/from-note.png) @@ -46,22 +84,35 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 > > 打开 PDF 并打开/创建笔记（在 PDF 阅读器的右侧栏中）。用上面的方法在这条主笔记添加一个链接。 -#### 2.1.1 用来插入链接的位置 -你可以在这里插入链接。 -### 2.2 从 Annotation（批注高亮） +### 2.2 从 Annotation（高亮批注和图片） 你可以在每个批注上找到一个带有插件图标的按钮（在 PDF 阅读器的左侧栏中）。 -单击它，PDF 项目下将创建一个带有此批注的新笔记。也可以在打开的笔记编辑器中将链接添加到主笔记。 ![insert-link-from-annotation](./image/README/from-annotation.png) + +单击它，PDF 项目下将创建一个带有此批注的新笔记，且带有注释的tag标签。 + +然后可以在打开的笔记编辑器中将该笔记链接添加到主笔记。 + + +![noteunderitem](./image/README/noteunderitem.png) + +此外，也可以点击翻译，对笔记进行翻译。 + > **💡 尝试一下!** > > 打开 PDF 并打开/创建批注高亮（在 PDF 阅读器的左侧栏中）。用上面的方法在这条主笔记添加一个链接。 +### 2.3 从功能区导入笔记 + +支持从现有的多个笔记批量导入到主笔记中。 + +* 在工作区窗口的文件菜单>>导入笔记 +* 或者快捷键cmd/ctrl+I ## 3 查看工作区窗口中的链接笔记 ### 3.1 查看链接笔记 @@ -70,7 +121,7 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 返回工作区窗口。 -单击链接，链接的笔记将显示在预览区域（右侧 ➡️）。 +按住Ctrl，单击笔记链接，链接的笔记将显示在预览区域（右侧 ➡️）。 ![preview-link](./image/README/preview-note.png) @@ -82,15 +133,37 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 在上一步打开的预览笔记中，点击预览区左上角的“📄PDF”按钮。 +![openpdf](./image/README/openpdf.png) + + > **💡 尝试一下!** > > 打开一个链接笔记的 PDF。 +### 3.3 插入当前子笔记父条目文献的引用格式 + +在上一步打开的预览笔记中，点击预览区中间的“插入引用”按钮。 + +![insertCitation](./image/README/insertCitation.png) + +如果快速插入引文无效，则需要在首选项设置里面，需要将导出的格式设置为citation style，而非export format! + +![citationstyle](./image/README/citationstyle.png) + +### 3.4 插入当前子笔记到主笔记并实时更新 + +单击笔记链接，会出现四个功能。 + +![importnoteandupdate](./image/README/importnoteandupdate.png) + +插入之后： + +![insertnote](./image/README/insertnote.png) ## 4 大纲视图 点击大纲区域左下角的 ‘📊 大纲模式‘ 按钮 来切换大纲视图模式。 -![outline](./image/README/outline-mode.png) +![outline](./image/README/changeview.png) > **💡 尝试一下!** > @@ -98,7 +171,7 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 ## 5 导出 -点击主笔记区域右上角的“⬆️ 导出”按钮。选择要导出的格式，比如 MarkDown。 +点击主笔记区域右上角的“⬆️ 导出”按钮，或者文件菜单>>导出主笔记。选择要导出的格式，比如 MarkDown。 ![export](./image/README/export.png) diff --git a/image/README/changeview.png b/image/README/changeview.png new file mode 100644 index 0000000..7e96e34 Binary files /dev/null and b/image/README/changeview.png differ diff --git a/image/README/citationstyle.png b/image/README/citationstyle.png new file mode 100644 index 0000000..9d543a3 Binary files /dev/null and b/image/README/citationstyle.png differ diff --git a/image/README/editmenu.png b/image/README/editmenu.png new file mode 100644 index 0000000..2918810 Binary files /dev/null and b/image/README/editmenu.png differ diff --git a/image/README/export.png b/image/README/export.png index 90b3f94..178e5ef 100644 Binary files a/image/README/export.png and b/image/README/export.png differ diff --git a/image/README/filemenu.png b/image/README/filemenu.png new file mode 100644 index 0000000..8b68382 Binary files /dev/null and b/image/README/filemenu.png differ diff --git a/image/README/from-annotation.png b/image/README/from-annotation.png index 19c2fb9..7816f48 100644 Binary files a/image/README/from-annotation.png and b/image/README/from-annotation.png differ diff --git a/image/README/from-note.png b/image/README/from-note.png index 7792937..fcbbe56 100644 Binary files a/image/README/from-note.png and b/image/README/from-note.png differ diff --git a/image/README/importnoteandupdate.png b/image/README/importnoteandupdate.png new file mode 100644 index 0000000..c293327 Binary files /dev/null and b/image/README/importnoteandupdate.png differ diff --git a/image/README/insertCitation.png b/image/README/insertCitation.png new file mode 100644 index 0000000..676428f Binary files /dev/null and b/image/README/insertCitation.png differ diff --git a/image/README/insertnote.png b/image/README/insertnote.png new file mode 100644 index 0000000..2b9d2c0 Binary files /dev/null and b/image/README/insertnote.png differ diff --git a/image/README/mainpage.png b/image/README/mainpage.png new file mode 100644 index 0000000..9b02a72 Binary files /dev/null and b/image/README/mainpage.png differ diff --git a/image/README/noteunderitem.png b/image/README/noteunderitem.png new file mode 100644 index 0000000..7bf20e7 Binary files /dev/null and b/image/README/noteunderitem.png differ diff --git a/image/README/openpdf.png b/image/README/openpdf.png new file mode 100644 index 0000000..3e6c252 Binary files /dev/null and b/image/README/openpdf.png differ diff --git a/image/README/openworkspace.png b/image/README/openworkspace.png new file mode 100644 index 0000000..3c66857 Binary files /dev/null and b/image/README/openworkspace.png differ diff --git a/image/README/preview-note.png b/image/README/preview-note.png index cdcf6e6..8529659 100644 Binary files a/image/README/preview-note.png and b/image/README/preview-note.png differ diff --git a/image/README/viewmenu.png b/image/README/viewmenu.png new file mode 100644 index 0000000..6232c46 Binary files /dev/null and b/image/README/viewmenu.png differ diff --git a/image/README/workspace-usage.png b/image/README/workspace-usage.png index 92c0f40..37ca554 100644 Binary files a/image/README/workspace-usage.png and b/image/README/workspace-usage.png differ diff --git a/image/README/workspace.png b/image/README/workspace.png index e9f51ff..1c4f708 100644 Binary files a/image/README/workspace.png and b/image/README/workspace.png differ