Update description

This commit is contained in:
Ruben van de Ven 2022-02-14 21:49:20 +01:00
parent 17374b0bf9
commit 8601678b59
2 changed files with 12 additions and 14 deletions

View file

@ -1,9 +1,15 @@
# zoterolens README
# Zoterolens
Zoterolens scans Markdown files for possible citationkeys and adds links open then with Zotero. Also a convenient option to immediately open the cited pdf-file.
Zoterolens scans Markdown files for citation-keys and adds inline links to open their attached pdf's with Zotero. An optional page number is taken into account.
I recommend using it in combination with an extension such as [Citation Picker for Zotero](https://marketplace.visualstudio.com/items?itemName=mblode.zotero), and/or [Pandoc Citer](https://marketplace.visualstudio.com/items?itemName=notZaki.pandocciter) to be able to easily add citations.
## Requirements
* Zotero (needs to be running)
* Zotero's Better-Bibtex plugin
## Features
- CodeLens to open PDF's based on citekey
@ -21,10 +27,6 @@ It should find the page number following cases:
- [@test123, pp.89-92]
- [@test123, pp.89--92]
## Requirements
* Zotero
* Zotero's Better-Bibtex plugin
## Extension Settings
@ -33,17 +35,13 @@ none.
## Known Issues / Wishlist
* It does not yet check if the citekey actually exists in Zotero, nor if it actually has any attachment.
* This should happen _before_ showing the ref.
* This should be made to happen _before_ showing the ref.
* No error if Zotero isn't running, or the Better-Bibtex plugin is not configured.
* Does not yet consider the page number of the citation when opening the pdf.
* Zotero port cannot yet be configured.
* explorer TreeView showing references.
* Possibly use CodeAction instead of Lens: https://code.visualstudio.com/api/language-extensions/programmatic-language-features#possible-actions-on-errors-or-warnings
## Release Notes
### 1.0.0
Initial release of Zoterolens
### 0.1.0
Initial pre-release of Zoterolens

View file

@ -2,7 +2,7 @@
"name": "zoterolens",
"publisher": "rubenvandeven",
"displayName": "ZoteroLens",
"description": "Lens providing quick access to Zotero information and attachments from citations.",
"description": "When using Markdown citations, Zoterolens provides quick access to Zotero pdf-attachments.",
"version": "0.1.0",
"engines": {
"vscode": "^1.63.0"