You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Download the add-on (the .xpi file) from the latest release: https://github.com/daeh/zotero-obsidian-citations/releases
27
25
- To download the .xpi file, right click it and select 'Save link as'
28
26
- Run Zotero (version 5.x)
29
27
- Go to `Tools -> Add-ons`
30
28
-`Install Add-on From File`
31
-
- Choose the file `zotero-obsidian-citations-0.0.11.xpi`
29
+
- Choose the file `zotero-obsidian-citations-0.0.12.xpi`
32
30
- Restart Zotero
33
31
34
-
35
32
## Setup
36
33
37
-
_ZoteroObsidianCitations_ presumes that a given Zotero item corresponds to single Markdown file. 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.
38
-
34
+
_ZoteroObsidianCitations_ presumes that a given Zotero item corresponds to single Markdown file. 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
35
40
36
1. Link Markdown files to Zotero items using **Better BibTex citekeys**.
41
37
42
38
- This is recommended if you created the Markdown notes with [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin).
43
39
44
40
- The Markdown file names should start with `@mycitekey` but can include extra information after it (e.g. a reading note might have the file name `@shepard1987science.md` or `@shepard1987science Toward a universal law of generalization for psychological science.md`, where `shepard1987science` is the BetterBibTex citekey).
45
41
46
-
47
42
2. Link Markdown files to Zotero items using **Zotero Item Keys**.
48
43
49
44
- This is recommended if you created the Markdown notes with the `Export Note` feature of Zotero.
@@ -53,19 +48,18 @@ _ZoteroObsidianCitations_ presumes that a given Zotero item corresponds to singl
53
48
54
49
---
55
50
56
-
57
51
### Option 1: Using BetterBibTex citekeys
58
52
59
53
_ZoteroObsidianCitations_ 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.
60
54
61
55
- In `ZoteroObsidianCitations Preferences...` (under the `Tools` menu),
62
56
63
57
- Specify the location of the folder that contains your Markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _ZoteroObsidianCitations_ add-on will recursively search this path for Markdown files beginning with `@`.
64
-
58
+
65
59
- Select the `Match notes based on BetterBibTex citekey` option.
66
60
67
61
-_ZoteroObsidianCitations_ 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 might have the file name `@shepard1987science.md` or `@shepard1987science Toward a universal law of generalization for psychological science.md`, where `shepard1987science` is the BetterBibTex citekey).
68
-
62
+
69
63
- Optionally, you can have _ZoteroObsidianCitations_ 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).
70
64
71
65
- 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).
@@ -79,36 +73,33 @@ _ZoteroObsidianCitations_ can extract the BetterBibTex citekey that specifies wh
79
73
### Option 2: Using Zotero Item Keys
80
74
81
75
_ZoteroObsidianCitations_ 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.
82
-
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`).
76
+
77
+
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`).
83
78
84
79
- In `ZoteroObsidianCitations Preferences...` (under the `Tools` menu),
85
80
86
81
- Specify the location of the folder that contains your Markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _ZoteroObsidianCitations_ add-on will recursively search this path for Markdown files beginning with `@`.
87
-
88
82
- Select the `Match notes based on Zotero-Item-Key` option.
89
-
90
83
- Specify a RegEx pattern to extract the Zotero-Item-Key from the Markdown contents.
you could extract the Zotero key (`GZ9DQ2AM`) using this RegEx pattern:
97
-
90
+
98
91
`^- local::.+\/items\/(\w+)\)`
99
92
100
93
- Run the synchronization function from `Tools -> ZoteroObsidianCitations Sync Tags`.
101
94
- This will add a tag (`ObsCite`) to every Zotero item for which there exists a reading note in the external folder you specified.
102
95
- In the `Tags` plane of Zotero, right-click on the `ObsCite` tag and assign it a color, which will mark the tagged items in the preview plane of Zotero.
Code for this extension is based on [ZotFile](https://github.com/jlegewie/zotfile) and [Zotero Citationcounts](https://github.com/eschnett/zotero-citationcounts) (which is based on [Zotero DOI Manager](https://github.com/bwiernik/zotero-shortdoi), which is based in part on [Zotero Google Scholar Citations](https://github.com/beloglazov/zotero-scholar-citations)).
0 commit comments