2014-01-20 00:04:49 -07:00
2014-01-16 23:27:54 -07:00
2014-01-19 22:11:24 -07:00
2014-01-19 22:11:24 -07:00
2014-01-16 03:49:44 -07:00
2014-01-16 23:31:48 -07:00

vim-wordy

Uncovering usage problems in writing

Features of this plugin

  • Pure Vimscript; no external services or libraries needed
  • Uses Vims native spell-check engine
  • Includes 13 dictionaries covering different types of word usage
  • Buffer-scoped configuration (leaves your global settings alone)
  • Unicode-friendly, including support for typographic quotes

What is wordy?

wordy is not a grammar checker. Nor is it a guide to proper word usage. Rather, wordy is a lightweight tool to assist writers in identifying those words and phrases known for their history of misuse, abuse, and overuse, at least according to usage experts.

For example, if wordy highlights moreover in your document, a word for which no good usage exists, you should consider a rewrite to eliminate it. But if it highlights therefore in a sentence where you can demonstrate the usage is sound, you can elect to keep it —wordy be damned.

Why wordy?

Off-the-shelf proofreading software can scan your text for potential problems and provide comprehensive feedback. However, it may require a complex software installation or transmission of your work to a remote server for checking.

wordy stands ready as a simple alternative to these comprehensive tools, focusing narrowly on identifying potential problems. To compensate for wordys bare-bones approach, its best used in concert with the literature on usage (Strunk and White, e.g.).

Requirements

wordy may require a recent version of Vim.

Installation

Best installed using Pathogen, Vundle, Neobundle, or your favorite Vim package manager.

Configuration

Youll typically use this plugin on-demand. It does not require any special configuration.

Important note: on the first use of each of the plugins dictionaries, a spell file will be built. This produces a message that resembles:

Reading word file /Users/reede/.vim/bundle/vim-wordy/data/en/weasel.dic ...
Compressing word tree...
Compressed 618 of 1738 nodes; 1120 (64%) remaining
Writing spell file /Users/reede/.vim/bundle/vim-wordy/spell/weasel.en.utf-8.spl ...
Done!
Estimated runtime memory use: 5600 bytes
Press ENTER or type command to continue

As instructed, press the enter key and it will disturb you no longer, at least until it needs to build again.

Commands

Youll use the commands that follow to enable wordy. To disable it and restore your previous spell environment, enter the command:

:NoWordy

Weak and lazy usage

:LazyWordy

Weak and lazy words are common in first drafts.

We sabotage our writing though weak language, kicking the legs out from beneath our verbs and tearing at the foundations of our nouns, watering down the very points that we are trying to drive home.

  • “I got up and went to work.” (weak)
  • “I awoke and drove to work.” (better)

We diminish the weight of our ideas by adding modifiers and fillers.

  • “The regiment that took the hill was perhaps a hundred strong.” (weak)
  • “Despite heavy losses, the regiment took the hill.” (better)

Words can also be weakened through overuse.

  • “He actually drove to work in the blizzard.” (weak)
  • “He drove to work in spite of the blizzard.” (better)

When using this dictionary, scrutinize each highlighted word or phrase, asking whether it detracts from the point you are trying to make.

Redundant and problematic usage

:WordyWordy
:ProblemWordy

Did you ever receive an advance warning when a mere warning would do? Why plan when you can plan ahead? Why need a thought to occur to me when the thought can merely occur?

But redundancies may not actually be redundant: invited guests may not if some of the guests have crashed your event. Or dialect differences can erase redundancies, as the British will protest against where Americans may simply protest.

See 50 Problem Words and Phrases for more detail on those issues targeted by ProblemWordy.

Puffery and Jargonese

“The man embodies authenticity; his disruptive ideas on self-actualization reflect his dynamic and transformative personality.” (puffery and jargonese)

:PuffWordy
:JargWordy

Instead of puffery, demonstrate through details.

  • “The Empire State Building is breathtakingly tall.” (puffery)
  • “My ears popped several times during the rapid elevator ride to the 80th floor.” (better)

Manipulative language

:WeaselWordy

Words can be used to hide or obscure a weak position, or to cast doubt on a strong one. They can be used to mislead, to evade blame, or to claim credit where none has been earned.

  • “mistakes were made”
  • “discounted up to 50% off”
  • “most voters feel that my opponent cant be trusted”

Assuming that youre not consciously trying to manipulate others, you will seek to purge such loaded language from your writing.

Forms of to be

:BeingWordy

You may find this dictionary useful in avoiding overuse of the many forms of the verb to be, often found in overly-passive sentences.

Colloquialisms, Idioms, and Similies

:TriteWordy

Dictionaries for uncovering the tired cliché, including colloquial and idiomatic phrases scraped from Wiktionary and Wikipedia.

Miscellaneous

:SaidWordy
:OpineWordy
:AintWordy
:TimeWordy

A few dictionaries to serve specific needs.

If youre writing to be neutral, you will want to avoid editorializing (OpineWordy) and loaded use of said (SaidWordy).

If youre writing formally, youll want to identify unintentional contractions with AintWordy. A warning that its not yet capturing most instances of “s”, such as “Joes not here.”

And finally, TimeWordy finds where you are using general descriptions of time where you could be more specific.

See also

Words To Avoid in Creative Writing - a brief guide to usage by writer Cary Morton

If you find this plugin useful, you may want to check out these others by @reedes:

  • vim-colors-pencil - color scheme for Vim inspired by IA Writer
  • vim-lexical - building on Vims spell-check and thesaurus/dictionary completion
  • vim-litecorrect - lightweight auto-correction for Vim
  • vim-pencil - rethinking Vim as a tool for writers
  • vim-quotable - extends Vim to support typographic (curly) quotes
  • vim-thematic — modify Vims appearance to suit your task and environment

Future development

This early version targets English usage issues and utf-8 encoding. Support for other languages will be added if theres interest. (Hint: pull requests!)

wordy is a work in progress. If youve spotted a problem or have an idea on improving this plugin, please post it to the github project issue page. Contributions are welcome.

Description
Uncover usage problems in your writing
Readme MIT 639 KiB
Languages
Vim Script 100%