2022-08-03 02:46:13 +02:00
|
|
|
# -*- mode: doom-docs-org -*-
|
2022-03-28 15:03:21 +02:00
|
|
|
#+title: :checkers grammar
|
|
|
|
|
#+subtitle: Tasing grammar mistake every you make
|
|
|
|
|
#+created: January 09, 2020
|
|
|
|
|
#+since: 21.12.0
|
2021-10-16 01:21:10 +02:00
|
|
|
|
|
|
|
|
* Description :unfold:
|
2020-01-09 16:43:03 -05:00
|
|
|
This module adds grammar checking to Emacs to aid your writing by combining
|
2021-10-16 01:21:10 +02:00
|
|
|
[[doom-package:][lang-tool]] and [[doom-package:][writegood-mode]].
|
2020-01-09 16:43:03 -05:00
|
|
|
|
|
|
|
|
** Maintainers
|
2021-10-16 01:21:10 +02:00
|
|
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
** Module flags
|
|
|
|
|
/This module has no flags./
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
** Packages
|
|
|
|
|
- [[doom-package:][langtool]]
|
|
|
|
|
- [[doom-package:][writegood-mode]]
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
** Hacks
|
|
|
|
|
/No hacks documented for this module./
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
** TODO Changelog
|
|
|
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
|
|
|
/This module does not have a changelog yet./
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
* Installation
|
|
|
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
This module requires [[https://languagetool.org/][LanguageTool]] (which requires =Java 1.8+=).
|
2020-01-09 16:43:03 -05:00
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
It is available from either https://languagetool.org/ or your OS's package
|
|
|
|
|
manager. E.g.
|
|
|
|
|
- macOS: ~$ brew install languagetool~
|
|
|
|
|
- Arch Linux: ~$ pacman -S languagetool~
|
|
|
|
|
|
|
|
|
|
This module tries to guess the location of =languagetool-commandline.jar=. If
|
|
|
|
|
you get a warning that Doom ~couldn't find languagetool-commandline.jar~, you
|
|
|
|
|
will need to set ~langtool-language-tool-jar~ to its location.
|
|
|
|
|
|
|
|
|
|
* TODO Usage
|
|
|
|
|
#+begin_quote
|
|
|
|
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
|
|
|
#+end_quote
|
2020-01-09 16:43:03 -05:00
|
|
|
|
|
|
|
|
** Language Tool
|
|
|
|
|
[[https://www.languagetool.org/][Language Tool]] is a polyglot proofreader service that checks for grammar and
|
|
|
|
|
stylistic issues in your writing. This requires Java 1.8+.
|
|
|
|
|
|
|
|
|
|
#+begin_quote
|
2021-10-16 01:21:10 +02:00
|
|
|
🚧 This requires Java 1.8+
|
2020-01-09 16:43:03 -05:00
|
|
|
#+end_quote
|
|
|
|
|
|
|
|
|
|
*** Commands
|
2021-10-16 01:21:10 +02:00
|
|
|
- ~M-x langtool-check~
|
|
|
|
|
- ~M-x langtool-correct-buffer~
|
2020-01-09 16:43:03 -05:00
|
|
|
|
|
|
|
|
** writegood-mode
|
|
|
|
|
This minor mode highlights weasel words, duplication and passive voice.
|
|
|
|
|
|
2021-10-16 01:21:10 +02:00
|
|
|
* TODO Configuration
|
|
|
|
|
#+begin_quote
|
|
|
|
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
|
|
|
|
#+end_quote
|
2020-01-09 16:43:03 -05:00
|
|
|
|
|
|
|
|
* Troubleshooting
|
2021-10-16 01:21:10 +02:00
|
|
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
|
|
|
|
|
|
|
|
|
* Frequently asked questions
|
|
|
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
|
|
|
|
|
|
* TODO Appendix
|
|
|
|
|
#+begin_quote
|
|
|
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
|
|
|
#+end_quote
|
