diff --git a/README.md b/README.md index 486427e..2c40d60 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ Everything about note management. All in Zotero. -Better Notes Handbook (outdated, for version<=0.8.9): [δΈ­ζ–‡ (provide translation)](https://zotero.yuque.com/staff-gkhviy/better-notes/biigg4?) - Join the community on Telegram: [@bnzotero](https://t.me/boost/bnzotero) ## 🧩 Outline @@ -110,61 +108,50 @@ BN offers a range of features that can be combined like Lego blocks to build you Start taking notes in Zotero with BN in **5 minutes**! -### Getting Started with the _Workspace_ +### Getting Started by Opening a Note Tab -> πŸ’‘ 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. +> πŸ’‘ In the latest version, the workspace is no longer a thing. You can open an unlimited number of note tabs/windows, which is what we called `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 a note in a tab, double-click/press `Enter` on the item in the library, as you would do to open an attachment. Holding `shift` opens the note in a new window. -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_!** +> **Explore the Note Tab!** > πŸ’‘ 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 +> - Context pane (tags, related, relation graph, in/outbound links) ### 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? +> πŸ’‘ Where can I find the 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 +> - In the note tab/window +> - In the library: click to open a note editor in the item pane +> - In the PDF reader: right-side context pane > > πŸ’‘ How to create a new note? -> Click the note icon in the library tools bar (the row under the tabs bar). +> Click the note icon in the library tools bar (the row under the tabs bar), or from the menu - File -
+
### 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. +To create a _note link_ between the note you are editing and another note, click the button in the title bar of the note editor. -
+
+ +> πŸ’‘ What's the difference between `Mention in` and `Link to`? +> +> `Mention in` will insert a link of the current note (from which you open the link creator) to another note (which you pick in the link creator), i.e. inbound link. +> `Link to` will insert links of picked notes to the current note, i.e. outbound link. + +You can also manually copy the note link from the note editor menu. ### Note Template -Still spending a lot of time writing summaries or doing copy-pasting while taking notes? Say hello to _Note Template_! +Are you spending a lot of time writing summaries and copy-pasting while taking notes? Say hello to _Note Template_! _Note Template_ is designed for tasks like: @@ -174,13 +161,13 @@ _Note Template_ is designed for tasks like: > πŸ’‘ Need help or looking for community templates? [See here β†’](https://github.com/windingwind/zotero-better-notes/discussions/categories/note-templates) > -> πŸ’‘ Want to write/share your own templates? +> πŸ’‘ Want to write/share your templates? > > [How to write β†’](docs/about-note-template.md#write-note-template) > > [How to share β†’](docs/about-note-template.md#share-your-template) -
+
### Syncing: Note πŸ”„οΈ Markdown @@ -208,15 +195,9 @@ You can export your note to the following formats: Simply click on the corresponding export button in the toolbar and follow the prompts. -### GPT Integration +### LLM Integration -The [Zotero-GPT](https://github.com/MuiseDestiny/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. +The [Zotero-GPT](https://github.com/MuiseDestiny/zotero-gpt) plugin provides GPT Integration. If you also have Better Notes installed, you can wake up its chatting pane in the note editor and insert/modify content in the note. ### Action Workflow @@ -229,7 +210,7 @@ The [Actions & Tags](https://github.com/windingwind/zotero-actions-tags) plugin ### Other Features - Quick Note: convert annotation to note with one click. -- Resize images with right-click menu. +- Resize images with a right-click menu. - Preview images with double-click/ctrl-click. ## 🧲 API @@ -242,13 +223,13 @@ BN provides APIs for other plugin developers in `Zotero.BetterNotes.api.${API_MO - `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. +- `editor`: Note editor APIs. Give your script full control of contents in the note editor. ## πŸ”§ Development This plugin is built based on the [Zotero Plugin Template](https://github.com/windingwind/zotero-plugin-template). See the setup and debug details there. -To startup, run +To start, run ```bash git clone https://github.com/windingwind/zotero-better-notes.git