Merge pull request #23 from katrinleinweber/improve-descriptions

Improve descriptions, fix typos

README.md

@@ -1,21 +1,21 @@
-# Citations from bibtex for Sublime Text
+# 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!
+This [Sublime Text 3](https://www.sublimetext.com/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.
+The default set up is optimized to work with [AcademicMarkdown](https://github.com/mangecoeur/AcademicMarkdown).
 
 Uses the [bibtexparser](https://github.com/sciunto/python-bibtexparser) library from sciunto.
 
 # Configuration
 
-You must specify the location of your bibtex file or files in preferences. Multiple files can be added as a list.
+You must specify the location of your BibTeX file or files in preferences. Multiple files can be added as a list.
 
 Optionally you can define 
-- `search_fields` the bibtex fields to search in when using Citer: Search
+- `search_fields` the BibTeX fields to search in when using Citer: Search
 - `citation_format` the citation format
 - `completions_scopes` 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)
 - `enable_completions` enable/disable citation completions (when you hit @)
-- `quickview_format` customise the format when listing library entries in the quickvew panel (e.g. with the Citer: Show All command). Place variables beteen `{}` braces. Available variables are `citekey`, `title`, `author`, `year`.
+- `quickview_format` customise the format when listing library entries in the quickview panel (e.g. with the Citer: Show All command). Place variables between `{}` braces. Available variables are `citekey`, `title`, `author`, `year`.
 - `auto_merge_citations` Whether to automatically merge citations that are inserted next to each other. `[@Fred2000][@Mary2001]` becomes `[@Fred2000; @Mary2001]`. Equivalent to running `Citer: Combine adjacent citations` on every insert
 
 See below for example (default) configuration
@@ -32,7 +32,7 @@ See below for example (default) configuration
     //OPTIONAL:
 
     //By default Citer Search looks for your keyword in the 
-    //author, title, year, and Citekey (id) feilds
+    //author, title, year, and Citekey (id) fields
     "search_fields": ["author", "title", "year", "id"] ,
     //Default format is @Citekey
     "citation_format": "@%s",
@@ -51,11 +51,11 @@ See below for example (default) configuration
 
 **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)
+**Citer: Show All** - show all the entries in your BibTeX in a quick view (you can then search in the title)
 
-**Citer: Insert Title** - show all the entries in your bibtex in a searchable quick view, inserts the title
+**Citer: Insert Title** - show all the entries in your BibTeX in a searchable quick view, inserts the title
 
-**Citer: Combine adjacent citations** - Combines neighboring citations i.e. `[@Fred2000][@Mary2001]` becomes `[@Fred2000; @Mary2001]`
+**Citer: Combine adjacent citations** - Combines neighbouring citations i.e. `[@Fred2000][@Mary2001]` becomes `[@Fred2000; @Mary2001]`
 
 
 # Completions
@@ -64,10 +64,12 @@ Citer provides autocompletions for your citekeys, these are enabled by default a
 
 # Compatibility
 
-Citer has (to date) only been tested with bibtex generated by Mendeley. It should work with any well-formed bibtex file.
+Citer has (to date) only been tested with BibTeX generated by [Mendeley](https://www.mendeley.com/). It should work with any well-formed BibTeX file.
 
 # TODO
-Look into providing snippets for Pandoc citation format in markdown files
+
+- [ ] Look into providing snippets for [pandoc](http://pandoc.org/index.html) citation format in markdown files.
 
 # Licence
-LGPLv3. See COPYING for details.
+
+LGPLv3. See [COPYING](https://github.com/mangecoeur/Citer/blob/master/COPYING) for details.

messages/0.6.0.txt

@@ -1,6 +1,6 @@
 Citer 0.6.0
 ===========
 
-- Supports multiple Bibtex files. the `"bibtex_file_path"` option accepts a list of paths as well as a single path.
-- Possible to customise library quickview format with `""quickview_format"` option
-- New commands: Insert Title and Merge Adjacent citations (see Readme)
+- Supports multiple BibTeX files. The `"bibtex_file_path"` option accepts a list of paths as well as a single path.
+- Possible to customise library quickview format with `"quickview_format"` option
+- New commands: Insert Title and Merge Adjacent citations (see [Readme](https://github.com/mangecoeur/Citer/blob/master/README.md))

messages/0.6.1.txt

@@ -2,4 +2,4 @@ Citer 0.6.1
 ===========
 
 - Trim whitespace from file paths
-- Code cleanup
+- Code cleanup

messages/install.txt

@@ -1,15 +1,15 @@
-# Citations from bibtex for Sublime Text
+# 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!
+This [Sublime Text 3](https://www.sublimetext.com/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.
+The default set up is optimized to work with [AcademicMarkdown](https://github.com/mangecoeur/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).
+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
 
@@ -23,7 +23,7 @@ See below for example configuration
     //OPTIONAL:
 
     //By default Citer Search looks for your keyword in the 
-    //author, title, year, and Citekey (id) feilds
+    //author, title, year, and Citekey (id) fields
     "search_fields": ["author", "title", "year", "id"] ,
     //Default format is @Citekey
     "citation_format": "@%s",
@@ -39,7 +39,7 @@ See below for example configuration
 
 **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)
+**Citer: Show All** - show all the entries in your BibTeX in a quick view (you can then search in the title)
 
 # Completions