Skip to content

Commit

Permalink
Update docs to v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
PillFall committed May 7, 2020
1 parent 8ebcda3 commit 0a1be9b
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 32 deletions.
20 changes: 11 additions & 9 deletions ChangeLog.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Change Log
Joar Buitago <jebuitragoc@unal.edu.co>
v0.1.2, 2020-01-21
v0.2.0, 2020-01-21

All notable changes to this project will be documented in this file.

Expand All @@ -12,23 +12,25 @@ link:https://semver.org/spec/v2.0.0.html[Semantic Versioning].


== [Unreleased]

== [0.2.0]
=== Added
- Support for different error faces.
* Support for different error colourful faces: misspelling, grammar and style.

=== Fixed
- Jagged minibuffer message
* Jagged minibuffer message

== [0.1.2]
=== Fixed
- Correction fails if language is set.
* Correction fails if language is set.

== [0.1.1]
=== Fixed
- Redundant code for obtaining the java arguments.
* Redundant code for obtaining the java arguments.

== [0.1.0]
=== Added
- Comunication with LanguageTool.
- Functions for the user to use.
- Visual overlay to mark corrections.
- Correction throught minibuffer.
* Communication with LanguageTool.
* Functions for the user to use.
* Visual overlay to mark corrections.
* Correction through minibuffer.
48 changes: 27 additions & 21 deletions ReadMe.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= languagetool.el
Joar Buitago <jebuitragoc@unal.edu.co>
v0.1.2, 2020-01-21
v0.2.0, 2020-01-21

[.text-center]
--
Expand All @@ -17,6 +17,9 @@ parse JSON output, making it incompatible with the original version,
that's why this package is not a forked version and it's made from
scratch.

LanguageTool is an open source proof-reading tool built in Java which
supports more than 30 languages.



== Getting Started
Expand Down Expand Up @@ -55,25 +58,28 @@ your `.emacs` file like:
(setq languagetool-default-language "en-GB")
----

You can change this latter using `languagetool-set-language` function.



== Usage

There are 5 commands to use, and if you want you can bind they to a key.
There are 5 commands than can be used directly and bound to a key if
desired.

- `languagetool-check` To check the active region or the buffer.
- `languagetool-clear-buffer` To delete all the buffer highlights.
- `languagetool-correct-at-point` To correct the warning at point.
- `languagetool-correct-buffer` To correct the whole buffer.
- `languagetool-set-language` To change correction language.
* `languagetool-check` To check the active region or the buffer.
* `languagetool-clear-buffer` To delete all the buffer highlights.
* `languagetool-correct-at-point` To correct the warning at point.
* `languagetool-correct-buffer` To correct the whole buffer.
* `languagetool-set-language` To change correction language.

For this package the suggested keybinding is:

- `(global-set-key "\C-clc" 'languagetool-check)`
- `(global-set-key "\C-cld" 'languagetool-clear-buffer)`
- `(global-set-key "\C-clp" 'languagetool-correct-at-point)`
- `(global-set-key "\C-clb" 'languagetool-correct-buffer)`
- `(global-set-key "\C-cll" 'languagetool-set-language)`
* `(global-set-key "\C-clc" 'languagetool-check)`
* `(global-set-key "\C-cld" 'languagetool-clear-buffer)`
* `(global-set-key "\C-clp" 'languagetool-correct-at-point)`
* `(global-set-key "\C-clb" 'languagetool-correct-buffer)`
* `(global-set-key "\C-cll" 'languagetool-set-language)`

Once you are correcting with build in functions it will pop-up a
correction buffer at the minibuffer, you only need to choose.
Expand All @@ -85,9 +91,9 @@ correction buffer at the minibuffer, you only need to choose.
For this package there are a few customizable variables that should be
set in order to take control of LanguageTool suggestions.

- `languagetool-java-bin` Sets the path to the JAVA executable, if it
is in `PATH` only it's name is needed.
- `languagetool-java-arguments` If you need to pass arguments to JAVA
* `languagetool-java-bin` Sets the path to the JAVA executable, if it
is in `PATH` only it's name is needed. Set to `"java"` by default.
* `languagetool-java-arguments` If you need to pass arguments to JAVA
set this variable. It must be a list of strings, one string for
each argument without spaces.
+
Expand All @@ -99,9 +105,9 @@ e.g.
;; or
(setq languagetool-java-arguments '("-flag" "argumentforflag")
----
- `languagetool-language-tool-jar` Sets the path of the LanguageTool
* `languagetool-language-tool-jar` Sets the path of the LanguageTool
command line jar file. It's recommended to put the full path.
- `languagetool-language-tool-arguments` Sets arguments to pass to
* `languagetool-language-tool-arguments` Sets arguments to pass to
LanguageTool. It must be a list of strings, one string for each
argument without spaces.
+
Expand All @@ -113,15 +119,15 @@ e.g.
;; or
(setq languagetool-language-tool-arguments '("-flag" "argumentforflag")
----
- `languagetool-default-language` Sets the LanguageTool correction
* `languagetool-default-language` Sets the LanguageTool correction
language. It can be changed via command with
`languagetool-set-language`.
- `languagetool-mother-tongue` If set LanguageTool behaviour change to
* `languagetool-mother-tongue` If set LanguageTool behaviour change to
correct using `languagetool-default-language` but being aware of
false friends.
- `languagetool-disabled-rules` Tells LanguageTool to ignore these
* `languagetool-disabled-rules` Tells LanguageTool to ignore these
rules when checking text.
- `languagetool-local-disabled-rules` As `languagetool-disabled-rules`
* `languagetool-local-disabled-rules` As `languagetool-disabled-rules`
tells LanguageTool to ignore these rules when checking text but it's
buffer local, so if you want you can set it in your local variables
comment.
2 changes: 1 addition & 1 deletion languagetool-issue-faces.el
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
;; Author: Joar Buitrago <jebuitragoc@unal.edu.co>
;; Keywords: grammar text docs tools
;; URL: https://github.com/PillFall/Emacs-LanguageTool.el
;; Version: 0.1.2
;; Version: 0.2.0
;; Package-Requires: ((emacs "25.1"))

;; This program is free software; you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion languagetool.el
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
;; Author: Joar Buitrago <jebuitragoc@unal.edu.co>
;; Keywords: grammar text docs tools
;; URL: https://github.com/PillFall/Emacs-LanguageTool.el
;; Version: 0.1.2
;; Version: 0.2.0
;; Package-Requires: ((emacs "25.1"))

;; This program is free software; you can redistribute it and/or modify
Expand Down

0 comments on commit 0a1be9b

Please sign in to comment.