From fe4bb70a18516d20d60672e9adf086f297ff66e0 Mon Sep 17 00:00:00 2001 From: Foivos Zakkak Date: Thu, 10 Oct 2019 01:20:35 +0300 Subject: [PATCH] Reformat app/write/README.org to match __doom-readme template --- modules/app/write/README.org | 112 ++++++++++++++++++++--------------- 1 file changed, 65 insertions(+), 47 deletions(-) diff --git a/modules/app/write/README.org b/modules/app/write/README.org index a61493ab6..54eed548d 100644 --- a/modules/app/write/README.org +++ b/modules/app/write/README.org @@ -1,29 +1,77 @@ -#+TITLE: :app write +#+TITLE: app/write +#+DATE: October 10, 2019 +#+SINCE: v2.0.9 +#+STARTUP: inlineimages +* Table of Contents :TOC_3:noexport: +- [[#description][Description]] + - [[#module-flags][Module Flags]] + - [[#plugins][Plugins]] +- [[#prerequisites][Prerequisites]] + - [[#language-tool][Language Tool]] + - [[#wordnut][Wordnut]] +- [[#features][Features]] + - [[#m-x-write-mode][~M-x +write-mode~]] + - [[#language-tool-langtool][Language Tool ~+langtool~]] + - [[#commands][Commands]] + - [[#wordnut-wordnut][Wordnut ~+wordnut~]] + - [[#commands-1][Commands]] + - [[#synosaurus][Synosaurus]] + - [[#commands-2][Commands]] +- [[#configuration][Configuration]] + - [[#mixed-pitch-mode][mixed-pitch-mode]] +- [[#appendix][Appendix]] + - [[#minor-modes][Minor modes]] + - [[#commands-3][Commands]] + +* Description Adds word processing tools and the ~+write-mode~ minor mode, which converts Emacs into a more comfortable writing environment. -* Table of Contents :TOC: -- [[Features][Features]] - - [[~M-x +write-mode~][~M-x +write-mode~]] - - [[Language Tool ~+langtool~][Language Tool ~+langtool~]] - - [[Wordnut ~+wordnut~][Wordnut ~+wordnut~]] - - [[Synosaurus][Synosaurus]] -- [[Prerequisites][Prerequisites]] - - [[Language Tool][Language Tool]] - - [[Wordnut][Wordnut]] -- [[Configuration][Configuration]] - - [[mixed-pitch-mode][mixed-pitch-mode]] -- [[Appendix][Appendix]] - - [[Minor modes][Minor modes]] - - [[Commands][Commands]] - -* Features +** Module Flags This module provides two module flags: - ~+langtool~ Enables language tool integration. - ~+wordnut~ Enables wordnet integration. +** Plugins ++ synosaurus ++ mixed-pitch ++ langtool ++ wordnut ++ visual-fill-column + +* Prerequisites +** Language Tool +Either download and deploy it from https://languagetool.org/ or install it +through your OS package manager: + +#+BEGIN_SRC sh +# MacOS/Homebrew users: +brew install languagetool + +# Arch Linux users: +sudo pacman -S languagetool +#+END_SRC + +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 find langaugetool-commandline.jar and set ~langtool-language-tool-jar~ +to its path. + +** Wordnut +This requires =wordnet= to be installed, which should be available through your +OS package manager: + +#+BEGIN_SRC sh +# MacOS/Homebrew users: +brew install wordnet + +# Arch Linux users: +sudo pacaur -S wordnet # on the AUR +#+END_SRC + +* Features ** ~M-x +write-mode~ Write mode makes Emacs a more comfortable writing environment by: @@ -65,36 +113,6 @@ connection. - ~synosaurus-lookup~ - ~synosaurus-choose-and-replace~ -* Prerequisites -** Language Tool -Either download and deploy it from https://languagetool.org/ or install it -through your OS package manager: - -#+BEGIN_SRC sh -# MacOS/Homebrew users: -brew install languagetool - -# Arch Linux users: -sudo pacman -S languagetool -#+END_SRC - -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 find langaugetool-commandline.jar and set ~langtool-language-tool-jar~ -to its path. - -** Wordnut -This requires =wordnet= to be installed, which should be available through your -OS package manager: - -#+BEGIN_SRC sh -# MacOS/Homebrew users: -brew install wordnet - -# Arch Linux users: -sudo pacaur -S wordnet # on the AUR -#+END_SRC - * Configuration ** mixed-pitch-mode To configure which faces are displayed with fixed-pitch fonts in