vim-wordy/README.markdown

# vim-wordy

> Uncovering usage problems in writing

## Features of this plugin

* Pure Vimscript; no external services or libraries needed
* Uses Vim’s 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
_wordy_’s bare-bones approach, it’s 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

You’ll typically use this plugin on-demand. It does not require any
special configuration.

Important note: on the first use of each of the plugin’s 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

You’ll 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][1] for more detail on those issues
targeted by _ProblemWordy_.

[1]: http://www.dailywritingtips.com/50-problem-words-and-phrases/

### 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 can’t be trusted”

Assuming that you’re 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 you’re writing to be neutral, you will want to avoid editorializing
(_OpineWordy_) and loaded use of ‘said’ (_SaidWordy_).

If you’re writing formally, you’ll want to identify unintentional
contractions with _AintWordy_. A warning that it’s not yet capturing most
instances of “’s”, such as “Joe’s 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][wa] - a brief guide to usage by
writer Cary Morton

[wa]: http://darlingmionette.deviantart.com/art/Words-To-Avoid-152886782

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

* [vim-colors-pencil][cp] - color scheme for Vim inspired by IA Writer
* [vim-lexical][lx] - building on Vim’s spell-check and thesaurus/dictionary completion
* [vim-litecorrect][lc] - lightweight auto-correction for Vim
* [vim-pencil][pn] - rethinking Vim as a tool for writers
* [vim-quotable][qu] - extends Vim to support typographic (‘curly’) quotes
* [vim-thematic][th] — modify Vim’s appearance to suit your task and environment 

[re]: https://github.com/reedes
[cp]: http://github.com/reedes/vim-colors-pencil
[lx]: http://github.com/reedes/vim-lexical
[lc]: http://github.com/reedes/vim-litecorrect
[pn]: http://github.com/reedes/vim-pencil
[qu]: http://github.com/reedes/vim-quotable
[th]: http://github.com/reedes/vim-thematic

## Future development

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

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

<!-- vim: set tw=74 :-->