Skip to content

Commit 3c1a9da

Browse files
authored
Update README.md
1 parent 5486b7d commit 3c1a9da

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# Research Helper
22

3-
This is a front-end only web tool which retrieves library from your [Zotero](https://www.zotero.org/) personal account and organizes your references according to the collection in it. The outputs can be used to generate `tags` in [diagrams.net](http://diagrams.net/), which allow one to make citations with unique hash key.
3+
This is a plugin for [diagrams.net(drawio)](http://diagrams.net/) which retrieves library from your [Zotero](https://www.zotero.org/) personal account and organizes your references according to the collection in it. With this plugin, you can add tags for blocks with standard citation format.
44

55
# The Website
6-
- [Our customized drawio](https://sciyen.github.io/drawio/src/main/webapp/index.html?p=zotero.js)
7-
- [The researcher helper](https://sciyen.github.io/ResearchHelper/publics/index.html)
6+
- Please use [our customized drawio](https://sciyen.github.io/drawio/src/main/webapp/index.html?p=zotero.js). Third-party plugin is not allowed in the offical drawio webapp.
87

98
## Quick start
109
1. Register a private API key from [here](https://www.zotero.org/settings/keys/new).
1110
2. Lookup for your userID from [here](https://www.zotero.org/settings/keys).
1211
3. Follow the steps in [this](https://github.com/sciyen/ResearchHelper/tree/main/plugins) to permanently add a plugin to your diagrams.
13-
4. Obtain the citation list with [our tool](https://sciyen.github.io/ResearchHelper/publics/index.html) and copy to clipboard.
14-
+ Note, you can click `Manage your passwords` at the right end of the url bar after entering the `UID` and `API key` to save the keys to your account.
15-
5. Paste the citation list to the `Tags` dialog in diagrams.net.
16-
+ You can open the dialog by clicking `View > Tags`, where you can see all the tags that you already have.
17-
+ Click `add` button and paste the citation list.
18-
+ Click `add` button and all the citations will be imported.
19-
6. Select a block, and add a tag from `Tags` dialog in your diagram.
12+
4. Enter the personal account information to diagrams.net.
13+
+ Click `Extras > Configurations` to configure the API key and UID.
14+
```
15+
{
16+
"zotero_uid": "YOUR_UID",
17+
"zotero_api_key": "SOMEAPIKEY"
18+
}
19+
```
20+
5. Click `Extras > Reload Zotero` to load the library to the list of tags.
21+
6. Select a block, and add a tag from `Tags` dialog (you can open it from `View > Tags`) in your diagram.
2022
7. And you should see the attached yellow block with standard citation.
2123
![](https://i.imgur.com/Plw7U0k.png)
2224

0 commit comments

Comments
 (0)