Skip to content

Commit

Permalink
Release version 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
PillFall committed Nov 11, 2020
2 parents e7faecf + a491e84 commit 531ab81
Show file tree
Hide file tree
Showing 6 changed files with 427 additions and 93 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/byte-compile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: build

on:
push:
branches:
- develop
pull_request:
branches:
- develop

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install emacs
run: sudo apt install emacs
- name: Install packages
run: |
emacs --batch --eval "(progn (require 'package) (add-to-list 'package-archives '(\"melpa\" . \"http://melpa.org/packages/\") t) (package-initialize) (package-refresh-contents) (package-install 'request))"
- name: Byte-compile the code
run: make
6 changes: 5 additions & 1 deletion 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.2.0, 2020-01-21
v0.3.0, 2020-01-21

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

Expand All @@ -13,6 +13,10 @@ link:https://semver.org/spec/v2.0.0.html[Semantic Versioning].

== [Unreleased]

== [0.3.0]
=== Added
* Support to LanguageTool HTTP server mode, and correction in real time.

== [0.2.0]
=== Added
* Support for different error colourful faces: misspelling, grammar and style.
Expand Down
45 changes: 37 additions & 8 deletions ReadMe.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
= languagetool.el
Joar Buitago <jebuitragoc@unal.edu.co>
v0.2.0, 2020-01-21
v0.3.0, 2020-01-21

[.text-center]
--
link:https://melpa.org/\#/languagetool[image:https://melpa.org/packages/languagetool-badge.svg[melpa]]
link:https://melpa.org/\#/languagetool[image:https://melpa.org/packages/languagetool-badge.svg[MELPA]]
link:https://stable.melpa.org/\#/languagetool[image:https://stable.melpa.org/packages/languagetool-badge.svg[MELPA Stable]]
image:https://github.com/PillFall/Emacs-LanguageTool.el/workflows/build/badge.svg[build]
--

Use LanguageTool as your Emacs grammar and spelling corrector.
Expand Down Expand Up @@ -37,11 +38,21 @@ is the `languagetool-commandline.jar` file in your `.emacs` file like:
[source,lisp]
----
(setq languagetool-language-tool-jar
"~/.languagetool/languagetool-commandline-jar")
"~/.languagetool/languagetool-commandline.jar")
----

Or via customize. It's preferred to use full path instead.

If you are going to use the LanguageTool HTML Server you instead need
to add to your `.emacs` file:

[source, lisp]
----
(setq languagetool-server-language-tool-jar
"~/.languagetool/languagetool-server.jar")
(languagetool-server-start)
----

It's recommended to add a Java flag to process the files in UTF-8, so
you should add to your `.emacs`:

Expand Down Expand Up @@ -75,15 +86,24 @@ desired.

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)`
[source, lisp]
----
(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.

Or you can use a LanguageTool HTTP Server with
``languagetool-server-mode`. In this mode the functions
`languagetool-check` and `languagetool-clear-buffer` will be
undefinded in the current buffer to prevent checking with another
tool. The other functions works as usual.



== Customizable Variables
Expand Down Expand Up @@ -119,6 +139,9 @@ e.g.
;; or
(setq languagetool-language-tool-arguments '("-flag" "argumentforflag")
----
* `languagetool-server-language-tool-jar` Sets the path of the
LanguageTool Server jar file. It's recommended to put the full
path.
* `languagetool-default-language` Sets the LanguageTool correction
language. It can be changed via command with
`languagetool-set-language`.
Expand All @@ -131,3 +154,9 @@ e.g.
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.
* `languagetool-server-url` Tells LanguageTool Server mode to send
POST request to this url. Set to `"http://localhost"` by default.
* `languagetool-server-port` Tells LanguageTool Server mode to send
Post request to this port. Set to `8081` by default.
* `languagetool-server-delayed-commands` A list of hooks for sending a
request to the server.
4 changes: 2 additions & 2 deletions languagetool-issue-faces.el
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
;; Author: Joar Buitrago <jebuitragoc@unal.edu.co>
;; Keywords: grammar text docs tools
;; URL: https://github.com/PillFall/Emacs-LanguageTool.el
;; Version: 0.2.0
;; Package-Requires: ((emacs "25.1"))
;; Version: 0.3.0
;; Package-Requires: ((emacs "25.1") (request "0.3.2"))

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Expand Down
Loading

0 comments on commit 531ab81

Please sign in to comment.