-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Some fixes after PR. Testing, documentation, added version message
- Loading branch information
1 parent
b5f2a1f
commit 5b41524
Showing
5 changed files
with
73 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"install": "messages/install.txt", | ||
"0.6.0": "messages/0.6.0.txt" | ||
} |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Citations from bibtex for Sublime Text | ||
|
||
This Sublime Text 3 plugin provides citation search and Tab-completion for citations stored in a bibtex file. Configure the file path and you are good to go! | ||
|
||
The default set up is optimized to work with AcademicMarkdown. | ||
|
||
Uses the [bibtexparser](https://github.com/sciunto/python-bibtexparser) library from sciunto. | ||
|
||
# Configuration | ||
|
||
You must specify the location of your bibtex file in preferences. | ||
Optionally you can define the bibtex fields to search in when using Citer: Search, the default citation format, and the list of scopes to limit the operation of the plugin (by default, Citer will only suggest citations within plain text scopes and is disabled in source code). | ||
|
||
See below for example configuration | ||
|
||
|
||
```js | ||
{ | ||
//REQUIRED: | ||
|
||
"bibtex_file_path": "example/path/to/file.bib", | ||
|
||
//OPTIONAL: | ||
|
||
//By default Citer Search looks for your keyword in the | ||
//author, title, year, and Citekey (id) feilds | ||
"search_fields": ["author", "title", "year", "id"] , | ||
//Default format is @Citekey | ||
"citation_format": "@%s", | ||
//list of scopes. Could be top level "text" or "source", or limit to | ||
// e.g "text.html.markdown" | ||
"completions_scopes": ["text"], | ||
"enable_completions": true | ||
} | ||
``` | ||
|
||
|
||
# Commands | ||
|
||
**Citer: Search** - enter a search term. All results where the term is found in the author, title, citekey, or year fields will be shown (the searched fields are configurable) | ||
|
||
**Citer: Show All** - show all the entries in your bibtex in a quick view (you can then search in the title) | ||
|
||
# Completions | ||
|
||
Citer provides autocompletions for your citekeys, these are enabled by default and can be disabled in the config. |