24

GitHub - bnbeckwith/writegood-mode: Minor mode for Emacs to improve English writ...

 6 years ago
source link: https://github.com/bnbeckwith/writegood-mode
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

README.org

Writegood Mode

This is a minor mode to aid in finding common writing problems. Matt Might’s weaselwords scripts inspired this mode.

It highlights text based on a set of weasel-words, passive-voice and duplicate words.

Basic Usage

First, load in the mode.

(add-to-list 'load-path "path/to/writegood-mode")
(require 'writegood-mode)
(global-set-key "\C-cg" 'writegood-mode)

I use the command key above to start the mode when I wish to check my writing.

Alternatively, this package is also available on MELPA. If installed through the package manager, then only the global key customization would be necessary.

Readability tests

There are now two functions to perform Flesch-Kincaid scoring and grade-level estimation. These follow the known algorithms, but may differ from other implementations due to the syllable estimation.

I use these global keys to get to the readability tests:

(global-set-key "\C-c\C-gg" 'writegood-grade-level)
(global-set-key "\C-c\C-ge" 'writegood-reading-ease)

Customization

The user is free to customize three main portions of the mode.

Faces

The three faces used pull from the default warning face and add subtle backgrounds. There is a separate face for each check performed.

  • Weasel words (writegood-weasels-face)
  • Passive voice (writegood-passive-voice-face)
  • Duplicate words (writegood-duplicates-face)

Weasel Words

There is a large list of included weasel words, but you may have your own. See the write-good-weasel-words variable to modify this list.

Passive Voice Irregulars

There is also a list of irregular passive voice verbs. These are the verbs that do not end in ‘ed’ to signify past tense. This variable allow the user to modify the list as needed.

Alternatives

Artbollocks looks to be an alternative mode to this one.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK