diff --git a/UserGuide.md b/UserGuide.md index 6361584..af7a0e9 100644 --- a/UserGuide.md +++ b/UserGuide.md @@ -18,66 +18,46 @@ 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. +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. -Set current note as the main note: +Set a note as the main note in the right-click popup menu. -* 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 +### 1.3 Workspace 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] - +- Create new main note(Ctrl/Cmd+N) +- Open main note(Ctrl/Cmd+O) +- Import notes(Ctrl/Cmd+I) +- Export notes(Ctrl/Cmd+E) +- Close workspace window(Ctrl/Cmd+W) **Edit menu**: -* Insert the title - -* Reduce the title level - -* Improve the title level +- Insert heading +- Decrease selected heading level(Tab) +- Increase selected heading level(Shift+Tab) **View menu**: -* Tree view - -* mind Mapping - -* Bubble map - - -You can also click the icon below to switch view : - -![changeview](./image/README/changeview.png) +- Outline Views **Help menu**: -* Open the user guidance +- Open user guide + ## 2 Gather Ideas to Main Note ### 2.1 From Note @@ -86,7 +66,7 @@ Select a note outside the workspace window(in Zotero items view or PDF viewer), 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. +Select a heading, and the note's link will be inserted into the end of this heading. ![insert-link-from-note](./image/README/from-note.png) @@ -94,29 +74,28 @@ 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.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). - ![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) - +Click it, and a new note containing this annotation will be created under the PDF item. Annotation tags are copied to the new note. +You can then add its link to the main note in the note editor. > **💡 Try it now!** > -> Open a PDF and open/create an annotation(in the left sidebar of PDF viewer). +> Open a PDF and open/create an annotation(in the left sidebar of PDF viewer). -### 2.3 Import notes from the menu area +### 2.3 Import Existing Notes -Support to import the notes into the main notes in batches from the existing notes. +You can import notes into the main note. + +- In workspace window, File -> Import Notes; +- Select notes and confirm. + +Notes' links will be appended to the end of the main note. -* File menu >> Import notes -* or shortcut key cmd/ctrl+I ## 3 Check Linked Notes in Workspace Window ### 3.1 View Linked Notes @@ -125,7 +104,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 with Ctrl, the linked note will show up in the preview area(right side➡️). +Open a note link, the linked note will show up in the preview area(right side➡️). ![preview-link](./image/README/preview-note.png) @@ -143,25 +122,36 @@ Click the '📄PDF' button on the top-left of the preview area. > > Open a linked note's PDF. -### 3.3 Inserts a reference format for the parent entry of the current note +### 3.3 Insert Citation 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! +Currently, the quick copy format must be a citation format, otherwise, this function will not work. See Edit->Preferences->Export in Zotero main window. -![citationstyle](./image/README/citationstyle.png) +### 3.4 Import Linked Note -### 3.4 Insert the current note to the main note and update in real time - -Click the note link, there will be four functions. +Import the selected linked note's context to the main note by clicking the 'import note' button in the link popup. ![importnoteandupdate](./image/README/importnoteandupdate.png) -After insertion: +Example: ![insertnote](./image/README/insertnote.png) + +> **💡 Try it now!** +> +> Import one linked note. + +### 3.5 Update Note Link Text + +Update the link text in main note by clicking the 'update link text' button in the link popup. + +> **💡 Try it now!** +> +> Modify the first line of a linked note in the preview area. Then update its link text in the main note. + ## 4 Outline Mode Switch the outline mode with the '📊mode' button on the bottom of the outline area. @@ -174,7 +164,7 @@ Switch the outline mode with the '📊mode' button on the bottom of the outline ## 5 Export -Click the '⬆️export' button on the top-right of the main note area. Choose a format to export, e.g. MarkDown. +Click the '⬆️export' button on the top-right of the main note area. Choose a format to export, i.e. MarkDown. ![export](./image/README/export.png) @@ -190,7 +180,7 @@ 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 by **Open the main note** under the file menu or **Ctrl O**. +Open different main note in workspace window->File->Open Main Note. > **✨ Hint** > diff --git a/UserGuideCN.md b/UserGuideCN.md index f3b320b..01a6e2d 100644 --- a/UserGuideCN.md +++ b/UserGuideCN.md @@ -32,49 +32,41 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 所有链接都将添加到主笔记中。 -设置当前笔记为主笔记： -* 选中当前笔记 -* 鼠标右键设置为主笔记 +从右键菜单中设置当前一个笔记为主笔记： -![workspace-usage](./image/README/workspace-usage.png) -### 1.3 功能区 +### 1.3 工作区菜单栏 **文件菜单**： - * 创建新的主笔记【快捷键Ctrl N】 - * 打开主笔记【快捷键Ctrl O】 - * 导入笔记【快捷键Ctrl I】 - * 导出笔记【快捷键Ctrl E】 - * 关闭【快捷键Ctrl W】 +- 创建新的主笔记(Ctrl/Cmd+N) +- 打开主笔记(Ctrl/Cmd+O) +- 导入笔记(Ctrl/Cmd+I) +- 导出笔记(Ctrl/Cmd+E) +- 关闭(Ctrl/Cmd+W) **编辑菜单**： -* 插入标题 -* 降低标题层级 -* 提升标题层级 - +- 插入标题 +- 降低标题层级 +- 提升标题层级 **查看菜单**： -* 树视图 -* 思维导图 -* 气泡导图 - -也可以在点击左下方图标切换视图： - -![changeview](./image/README/changeview.png) +- 大纲视图 **帮助菜单**： -* 打开用户指引 + +- 打开用户指引 + ## 2 在主笔记中收集想法 ### 2.1 从 Note 在工作区窗口外选择一个 note（在 Zotero 条目视图或 PDF 阅读器中），您会在笔记编辑器工具栏顶部看到一个带有本插件图标的按钮。 -* 点击它，当前笔记的链接将插入主笔记的光标位置； +点击它，当前笔记的链接将插入主笔记的光标位置； -* 选择一个标题层级，笔记的链接将插入该标题的末尾。 +选择一个标题层级，笔记的链接将插入该标题的末尾。 ![insert-link-from-note](./image/README/from-note.png) @@ -82,25 +74,16 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 > > 打开 PDF 并打开/创建笔记（在 PDF 阅读器的右侧栏中）。用上面的方法在这条主笔记添加一个链接。 - - ### 2.2 从 Annotation（高亮批注和图片） 你可以在每个批注上找到一个带有插件图标的按钮（在 PDF 阅读器的左侧栏中）。 - ![insert-link-from-annotation](./image/README/from-annotation.png) - -单击它，PDF 项目下将创建一个带有此批注的新笔记，且带有注释的tag标签。 +单击它，PDF条目下将创建一个带有此批注的新笔记。批注的标签将会复制到新的笔记。 然后可以在打开的笔记编辑器中将该笔记链接添加到主笔记。 - -![noteunderitem](./image/README/noteunderitem.png) - - - > **💡 尝试一下!** > > 打开 PDF 并打开/创建批注高亮（在 PDF 阅读器的左侧栏中）。用上面的方法在这条主笔记添加一个链接。 @@ -109,8 +92,9 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 支持从现有的多个笔记批量导入到主笔记中。 -* 在工作区窗口的文件菜单>>导入笔记 -* 或者快捷键cmd/ctrl+I +- 在工作区窗口菜单栏文件->导入笔记； +- 选择多个笔记并确认。 + ## 3 查看工作区窗口中的链接笔记 ### 3.1 查看链接笔记 @@ -119,7 +103,7 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 返回工作区窗口。 -按住Ctrl，单击笔记链接，链接的笔记将显示在预览区域（右侧 ➡️）。 +打开笔记链接，链接的笔记将显示在预览区域（右侧 ➡️）。 ![preview-link](./image/README/preview-note.png) @@ -133,7 +117,6 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 ![openpdf](./image/README/openpdf.png) - > **💡 尝试一下!** > > 打开一个链接笔记的 PDF。 @@ -144,19 +127,30 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 ![insertCitation](./image/README/insertCitation.png) -如果快速插入引文无效，则需要在首选项设置里面，需要将导出的格式设置为citation style，而非export format! +目前，快速复制格式需要设置为citation format，否则该功能无法正常工作。可在Zotero主窗口的编辑->首选项->导出中设置。 -![citationstyle](./image/README/citationstyle.png) +### 3.4 插入链接的子笔记 -### 3.4 插入当前子笔记到主笔记并实时更新 - -单击笔记链接，会出现四个功能。 +点击链接弹窗中的'import note'来插入选择的笔记内容。 ![importnoteandupdate](./image/README/importnoteandupdate.png) 插入之后： ![insertnote](./image/README/insertnote.png) + +> **💡 尝试一下!** +> +> 插入一个链接的笔记 + +### 3.5 更新链接文本 + +点击链接弹窗中的'update link text'来更新选择的笔记链接文本。 + +> **💡 尝试一下!** +> +> 在预览区域中编辑某个链接笔记的第一行文本，然后在主笔记区域更新它的链接文本。 + ## 4 大纲视图 点击大纲区域左下角的 ‘📊 大纲模式‘ 按钮 来切换大纲视图模式。 @@ -169,7 +163,7 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 ## 5 导出 -点击主笔记区域右上角的“⬆️ 导出”按钮，或者文件菜单>>导出主笔记。选择要导出的格式，比如 MarkDown。 +点击主笔记区域右上角的“⬆️ 导出”按钮，或者工作区窗口菜单的文件->导出主笔记。选择要导出的格式，比如 MarkDown。 ![export](./image/README/export.png) @@ -183,9 +177,9 @@ Zotero 的 note 很像一个标记/富文本编辑器。您可以使用上方工 导出后，您可能希望使用新的空主笔记开始新任务。 -创建一个 note 笔记，然后右键单击将其设置为主笔记；或者直接创建一个新的主笔记。 +创建一个笔记，然后在右键菜单中将其设置为主笔记；或者直接创建一个新的主笔记。 -使用文件菜单下的打开主笔记以切换不同的主笔记。 +使用工作区窗口菜单的文件->打开主笔记以切换不同的主笔记。 > **✨ 提示** > diff --git a/image/README/changeview.png b/image/README/changeview.png deleted file mode 100644 index 7e96e34..0000000 Binary files a/image/README/changeview.png and /dev/null differ diff --git a/image/README/citationstyle.png b/image/README/citationstyle.png deleted file mode 100644 index 190611d..0000000 Binary files a/image/README/citationstyle.png and /dev/null differ diff --git a/image/README/noteunderitem.png b/image/README/noteunderitem.png deleted file mode 100644 index 7bf20e7..0000000 Binary files a/image/README/noteunderitem.png and /dev/null differ diff --git a/image/README/workspace-usage.png b/image/README/workspace-usage.png deleted file mode 100644 index 6a62c94..0000000 Binary files a/image/README/workspace-usage.png and /dev/null differ