Skip to content

Commit 939c70d

Browse files
committed
update readme
1 parent cdb76a2 commit 939c70d

File tree

2 files changed

+37
-35
lines changed

2 files changed

+37
-35
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
.project
22
*.xpi
33
.vscode
4+
*_gitignore
5+
*-gitignore
46
*_gitignore.*
57
*-gitignore.*
68
node_modules

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
# MarkDB-Connect (Zotero Markdown DataBase Connect)
44

5-
- **_Adds colored tags to Zotero items that have associated Markdown notes stored in an external folder._**
6-
- **_Opens Markdown notes from the contextual menu of Zotero items._**
5+
- **_Scans your Markdown database and adds a colored tag to associated Zotero items._**
6+
- **_Jump to Markdown notes from the contextual menu of Zotero items._**
77
- **_Supports various Markdown databases, including [Obsidian](https://obsidian.md), [logseq](https://logseq.com), and [Zettlr](https://www.zettlr.com)_**
88

99
![MarkDBConnectScreenshot](MarkDBConnectScreenshot.png)
1010

11-
This is a plugin for [Zotero](https://www.zotero.org), a research source management tool. The _MarkDB-Connect_ plugin searches a user-defined folder for Markdown files that include a [Better BibTeX](https://retorque.re/zotero-better-bibtex/) citekey or Zotero Item Key, and adds a colored tag to the corresponding Zotero items.
11+
This is a plugin for [Zotero](https://www.zotero.org), a research source management tool. The _MarkDB-Connect_ plugin searches a user-defined folder for markdown files that include a [Better BibTeX](https://retorque.re/zotero-better-bibtex/) citekey or Zotero-Item-Key, and adds a colored tag to the corresponding Zotero items.
1212

13-
This plugin was initially designed with the [Obsidian](https://obsidian.md) Markdown editor in mind, and was inspired by the [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin) workflow. It offers preliminary support for [logseq](https://logseq.com) and [Zettlr](https://www.zettlr.com). It can be adapted to other databases that store Markdown files outside of Zotero, and to other workflows that generate Markdown reading notes linked to Zotero items (such as Zotero's `Export Note` feature).
13+
This plugin was initially designed with the [Obsidian](https://obsidian.md) markdown editor in mind, and was inspired by the [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin) workflow. It offers preliminary support for [logseq](https://logseq.com) and [Zettlr](https://www.zettlr.com). It can be adapted to other databases that store markdown files outside of Zotero, and to other workflows that generate markdown reading notes linked to Zotero items (such as Zotero's `Export Note` feature).
1414

1515
Please post any bugs, questions, or feature requests in the Github repository.
1616

1717
## Plugin Functions
1818

1919
Adds a colored tag to Zotero items for which there are associated reading notes in an external folder.
2020

21-
Supports multiple Markdown files for a single Zotero item.
21+
Supports multiple markdown files for a single Zotero item.
2222

23-
Opens an existing Markdown note in [Obsidian](https://obsidian.md), [logseq](https://logseq.com), or the system's default Markdown note editor (e.g. [Zettlr](https://www.zettlr.com), [Typora](https://typora.io)) from the contextual menu of a Zotero item.
23+
Opens an existing markdown note in [Obsidian](https://obsidian.md), [logseq](https://logseq.com), or the system's default markdown note editor (e.g. [Zettlr](https://www.zettlr.com), [Typora](https://typora.io)) from the contextual menu of a Zotero item.
2424

2525
![MarkDBConnectMenu](MarkDBConnectMenu.png)
2626

@@ -36,39 +36,39 @@ Opens an existing Markdown note in [Obsidian](https://obsidian.md), [logseq](htt
3636

3737
## Setup
3838

39-
A Markdown file can specify which Zotero item it's linked to using either a [Better BibTeX](https://retorque.re/zotero-better-bibtex/) citekey or a Zotero-Item-Key.
39+
A markdown file can specify which Zotero item it's linked to using either a [Better BibTeX](https://retorque.re/zotero-better-bibtex/) citekey or a Zotero-Item-Key.
4040

41-
1. Link Markdown files to Zotero items using **Better BibTeX citekeys**.
41+
1. Using **Better BibTeX citekeys** to link markdown files to Zotero items.
4242

43-
- This is recommended if you created the Markdown notes with [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin).
43+
- This is recommended if you created the markdown notes with [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin).
4444

45-
- The BetterBibTeX citekey needs to appear in the filename or the metadata of the Markdown note.
45+
- The BetterBibTeX citekey needs to appear in the filename or the metadata of the markdown note.
4646

47-
2. Link Markdown files to Zotero items using **Zotero Item Keys**.
47+
2. Using **Zotero Item Keys** to link markdown files to Zotero items.
4848

49-
- This is recommended if you created the Markdown notes with the `Export Note` feature of Zotero.
50-
- The Markdown note contents should include the Zotero-Item-Key in a consistent format.
49+
- This is recommended if you created the markdown notes with the `Export Note` feature of Zotero.
50+
- The markdown note contents should include the Zotero-Item-Key in a consistent format.
5151

52-
NOTE: Multiple Markdown files can point to the same Zotero item. However, _MarkDB-Connect_ assumes that a given Markdown file corresponds to a single Zotero item. (A Markdown reading note can reference multiple Zotero items throughout the file, but _MarkDB-Connect_ will only link the Markdown note to one BetterBibTeX-citekey / Zotero-Item-Key.)
52+
NOTE: multiple markdown files can point to the same Zotero item. However, _MarkDB-Connect_ assumes that a given markdown file corresponds to a single Zotero item. (A markdown reading note can reference multiple Zotero items throughout the file, but _MarkDB-Connect_ will only link the markdown note to one BetterBibTeX-citekey / Zotero-Item-Key.)
5353

5454
---
5555

5656
### Option 1: Using BetterBibTeX citekeys
5757

58-
_MarkDB-Connect_ can extract the BetterBibTeX citekey that specifies which Zotero Item a Markdown note corresponds to. The BetterBibTeX citekey can be taken from the Markdown filename or yaml metadata.
58+
_MarkDB-Connect_ can extract the BetterBibTeX citekey that specifies which Zotero Item a markdown note corresponds to. The BetterBibTeX citekey can be taken from the markdown filename or yaml metadata.
5959

6060
- In `MarkDBConnect Preferences...` (under the `Tools` menu),
6161

62-
- Specify the location of the folder that contains your Markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for Markdown files.
62+
- Specify the location of the folder that contains your markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for markdown files.
6363

6464
- The default behavior is to search for markdown files beginning with `@`.
6565
- Alternatively, you can specify a RegEx pattern to match your reading note files.
6666

6767
- Select the `Match notes based on BetterBibTeX citekey` option.
6868

69-
- By default, _MarkDB-Connect_ expects that the filenames of your Markdown reading note files begin with `@mycitekey` but can include extra information after it (e.g. a reading note with the BetterBibTeX citekey `shepard1987science` could have the file name `@shepard1987science.md` or `@shepard1987science Toward a universal law of generalization for psychological science.md`).
69+
- By default, _MarkDB-Connect_ expects that the filenames of your markdown reading note files begin with `@mycitekey` but can include extra information after it (e.g. a reading note with the BetterBibTeX citekey `shepard1987science` could have the file name `@shepard1987science.md` or `@shepard1987science Toward a universal law of generalization for psychological science.md`).
7070

71-
- Optionally, you can have _MarkDB-Connect_ read the metadata of your Markdown notes and extract the citekey from one of the fields. To enable this, specify the metadata ID (`citekey` is a common value).
71+
- Optionally, you can have _MarkDB-Connect_ read the metadata of your markdown notes and extract the citekey from one of the fields. To enable this, specify the metadata ID (`citekey` is a common value).
7272

7373
- This is necessary if the file names do not begin with the correct citekey, which may happen if the citekeys include special characters (e.g. if a citekey contains `:`, it will probably need to be taken from the yaml metadata rather than the filename).
7474

@@ -80,20 +80,20 @@ _MarkDB-Connect_ can extract the BetterBibTeX citekey that specifies which Zoter
8080

8181
### Option 2: Using Zotero Item Keys
8282

83-
_MarkDB-Connect_ can extract the Zotero-Item-Key that specifies which Zotero Item a Markdown note corresponds to. The Zotero-Item-Key is taken from the Markdown file contents using a custom RegEx pattern.
83+
_MarkDB-Connect_ can extract the Zotero-Item-Key that specifies which Zotero Item a markdown note corresponds to. The Zotero-Item-Key is taken from the markdown file contents using a custom RegEx pattern.
8484

8585
Zotero automatically generates Item Keys, they take the form of `ABCD1234`, as in `zotero://select/library/items/ABCD1234`. NB this is not the same as the BetterBibTeX citekey you assigned an item (e.g. `mycitekey` in `zotero://select/items/@mycitekey`).
8686

8787
- In `MarkDBConnect Preferences...` (under the `Tools` menu),
8888

89-
- Specify the location of the folder that contains your Markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for Markdown files.
89+
- Specify the location of the folder that contains your markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for markdown files.
9090

9191
- The default behavior is to search for markdown files beginning with `@`.
9292
- Alternatively, you can specify a RegEx pattern to match your reading note files.
9393

9494
- Select the `Match notes based on Zotero-Item-Key` option.
9595

96-
- Specify a RegEx pattern to extract the Zotero-Item-Key from the Markdown contents.
96+
- Specify a RegEx pattern to extract the Zotero-Item-Key from the markdown contents.
9797

9898
E.g. if your note has the line
9999

@@ -111,39 +111,39 @@ Zotero automatically generates Item Keys, they take the form of `ABCD1234`, as i
111111

112112
## Example Markdown Note
113113

114-
In this example Markdown note (`@saxe2017emobtom.md`), the _MarkDB-Connect_ will use the yaml metadata keyword `citekey` to find the BetterBibTeX citekey (`saxe2017emobtom`) to determine which Zotero item to associate with the Markdown file. Notice that the Markdown file can include other BetterBibTeX citekeys and Zotero-Item-Keys, which are ignored by the plugin.
114+
In this example markdown note (`@saxe2017emobtom.md`), the _MarkDB-Connect_ will use the yaml metadata keyword `citekey` to find the BetterBibTeX citekey (`saxe2017emobtom`) to determine which Zotero item to associate with the markdown file. Notice that the markdown file can include other BetterBibTeX citekeys and Zotero-Item-Keys, which are ignored by the plugin.
115115

116116
```markdown
117117
---
118118
citekey: saxe2017emobtom
119-
doi: 10.1016/j.copsyc.2017.04.019
120119
zoterouri: zotero://select/library/items/IACZMXU4
121120
bbturi: zotero://select/items/@saxe2017emobtom
121+
doi: 10.1016/j.copsyc.2017.04.019
122122
---
123123

124124
# Formalizing emotion concepts within a Bayesian model of theory of mind
125125

126-
[A reference using a Zotero URI](zotero://select/library/items/4RJ97IFL)
126+
[A reference to another paper using a Zotero URI](zotero://select/library/items/4RJ97IFL)
127127

128-
[A reference using a BetterBibTeX URI](zotero://select/items/@anzellotti2021opaque)
128+
[A reference to another paper using a BetterBibTeX URI](zotero://select/items/@anzellotti2021opaque)
129129

130-
A reference using an Obsidian wiki link: [[@cusimano2018cogsci]]
130+
A reference to another paper using an Obsidian wiki link: [[@cusimano2018cogsci]]
131131
```
132132

133133
## Related Projects
134134

135-
- [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin)
135+
- [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin) by hans
136136
Obsidian plugin that integrates your Zotero database with Obsidian.
137-
- [BibNotes Formatter](https://github.com/stefanopagliari/bibnotes)
137+
- [BibNotes Formatter](https://github.com/stefanopagliari/bibnotes) by stefanopagliari
138138
Obsidian plugin to facilitate exporting annotations from Zotero into Obsidian.
139-
- [Obsidian Zotero Desktop Connector](https://github.com/mgmeyers/obsidian-zotero-desktop-connector)
139+
- [Obsidian Zotero Integration](https://github.com/mgmeyers/obsidian-zotero-integration) by mgmeyers
140140
Obsidian plugin to facilitate exporting annotations from Zotero into Obsidian.
141-
- [Zotero 6 'Export Notes' feature](https://forums.zotero.org/discussion/93521/available-for-beta-testing-markdown-export-of-notes/p1)
142-
Zotero 6 beta feature to export notes and annotations from Zotero items as Markdown files.
143-
- [Zotero-mdnotes](https://argentinaos.com/zotero-mdnotes/)
144-
Zotero plugin to export metadata and notes from Zotero items as Markdown files.
145-
- [Zotero to Markdown](https://github.com/e-alizadeh/Zotero2md)
146-
Python library to export annotations and notes from Zotero items as Markdown files.
141+
- [Zotero 6 'Export Notes' feature](https://forums.zotero.org/discussion/93521/available-for-beta-testing-markdown-export-of-notes/p1) by Zotero
142+
Zotero 6 beta feature to export notes and annotations from Zotero items as markdown files.
143+
- [Zotero-mdnotes](https://argentinaos.com/zotero-mdnotes/) by argenos
144+
Zotero plugin to export metadata and notes from Zotero items as markdown files.
145+
- [Zotero to Markdown](https://github.com/e-alizadeh/Zotero2md) by e-alizadeh
146+
Python library to export annotations and notes from Zotero items as markdown files.
147147

148148
## Notes
149149

0 commit comments

Comments
 (0)