|
1 |
| -This is a template. For "how to make a linter", please check [the HOWTO](HOWTO.md). |
| 1 | +SublimeLinter-csl |
| 2 | +================= |
2 | 3 |
|
3 |
| ------------------------------------------------------------------ |
| 4 | +[](https://travis-ci.org/SublimeLinter/SublimeLinter-csl) |
4 | 5 |
|
5 |
| -SublimeLinter-contrib-__linter__ |
6 |
| -================================ |
7 |
| - |
8 |
| -[](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-__linter__) |
9 |
| - |
10 |
| -This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [__linter__](__linter_homepage__). It will be used with files that have the “__syntax__” syntax. |
| 6 | +This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to the [csl-validator.sh](https://github.com/citation-style-language/utilities) script. It will be used with files that have the Citation Style Language (CSL) syntax. |
11 | 7 |
|
12 | 8 | ## Installation
|
13 |
| -SublimeLinter must be installed in order to use this plugin. |
| 9 | +SublimeLinter must be installed in order to use this plugin. |
14 | 10 |
|
15 | 11 | Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
|
16 | 12 |
|
17 |
| -Before installing this plugin, you must ensure that `__linter__` is installed on your system. |
| 13 | +Before installing this plugin, you must ensure that the `csl-validator.sh` script from https://github.com/citation-style-language/utilities is available on your system. This further requires the `curl` and `jq` utilities. |
18 | 14 |
|
19 |
| -In order for `__linter__` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover [troubleshooting PATH configuration](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable). |
| 15 | +In order for `csl-validator.sh` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover [troubleshooting PATH configuration](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable). |
20 | 16 |
|
21 | 17 | ## Settings
|
22 | 18 | - SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html
|
23 | 19 | - Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
|
24 | 20 |
|
25 |
| -Additional SublimeLinter-__linter__ settings: |
26 |
| - |
27 |
| -|Setting|Description | |
28 |
| -|:------|:--------------| |
29 |
| -|foo |Something. | |
30 |
| -|bar |Something else.| |
| 21 | +There are no specific settings for `csl-validator.sh` nor this plugin. |
0 commit comments