first cut

LICENSE

@@ -0,0 +1,23 @@
+License:     The MIT License (MIT)
+
+Copyright (c) 2014 Reed Esau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+<!-- vim: set tw=74 :-->

README.markdown

@@ -0,0 +1,330 @@
+# vim-textobj-sentence
+
+> Improving on Vim's native sentence motion
+
+Features of this plugin:
+
+* Better sentence detection
+* Support for lightweight markup languages (markdown, e.g.)
+* Support for typographical quotes
+* Support for abbreviations
+* Buffer scoped?
+
+## Requirements
+
+May require a recent version of Vim.
+
+## Installation
+
+Install using Pathogen, Vundle, Neobundle, or your favorite Vim package
+manager.
+
+This plugin has an important (and useful) dependency that you will need to
+install.
+
+* [kana/vim-textobject-user](https://github.com/kana/vim-textobj-user) - a Vim plugin to create your own text objects without pain
+
+## Configuration
+
+### Abbreviations as false sentence endings
+
+Detecting sentences can be tricky, where sometimes this plugin needs
+a hint:
+
+```
+Mr. Maybe and Ms. Undecided watched Dr. No. I liked it.
+```
+
+To avoid false ends of sentences, this plugin detects common
+abbreviations with the default that you can change in your `.vimrc`:
+
+```
+let g:textobj#sentence#abbreviations = [
+  \ 'Mr', 'Ms', 'Mrs', 'Dr', 'Prof', 'Sr', 'Jr',
+  \ 'vs', 'etc', 'no', 'esp'
+  \ 'Mt', 'Ft',
+  \ 'Ave', 'Blvd', 'Cl', 'Ct', 'Str']
+```
+
+Many more abbreviations are possible (found [here][ab]):
+
+* People: Jr, Mr, Mrs, Ms, Dr, Prof, Sr, Sens?, Reps?,
+          Gov, Attys?, Supt,  Det, Rev
+* Military: Col, Gen, Lt, Cmdr, Adm, Capt, Sgt, Cpl, Maj
+* Organizational: dept, univ, assn, bros, inc, ltd, co, corp
+* Places: arc, al, ave, blv?d, cl, ct, cres, dr, expy?,
+        dist, Mt, Ft,
+        fw?y, hwa?y, la, pde?, pl, plz, rd, st, tce,
+        Ala , Ariz, Ark, Cal, Calif, Col, Colo, Conn,
+        Del, Fed , Fla, Ga, Ida, Id, Ill, Ind, Ia,
+        Kan, Kans, Ken, Ky , La, Me, Md, Is, Mass,
+        Mich, Minn, Miss, Mo, Mont, Neb, Nebr, Nev,
+        Mex, Okla, Ok, Ore, Penna, Penn, Pa, Dak,
+        Tenn, Tex, Ut, Vt, Va, Wash, Wis, Wisc, Wy,
+        Wyo, Alta, Man, Ont, Qué, Sask, Yuk
+* Months: jan, feb, mar, apr, may, jun, jul, aug, sept?, oct, nov, dec
+* Miscellaneous: vs, etc, no, esp
+
+[ab]: http://cpansearch.perl.org/src/SHLOMOY/Lingua-EN-Sentence-0.25/lib/Lingua/EN/Sentence.pm
+
+  ```vim
+  " standard vim command to enable loading the plugin files
+  " (and their indent support) for specific file types.
+  " It may already be in your .vimrc!
+  filetype plugin indent on
+
+  augroup quotable
+    autocmd!
+    autocmd FileType markdown call quotable#init()
+    autocmd FileType textile call quotable#init()
+    autocmd FileType python call quotable#init({ 'educate': 0 })
+  augroup END
+  ```
+
+The last statement initializes the plugin for buffers of `python` file type, but
+disables the ‘educate’ feature by default. More on that below.
+
+## Educating straight quotes
+
+This plugin will ‘educate’ quotes, meaning that it will dynamically transform
+straight quote key presses (`"` or `'`) into corresponding typographic quote
+characters.
+
+For example, entering the following sentence without this plugin using the
+straight quote keys:
+
+  ```
+  "It's Dr. Evil. I didn't spend six years in Evil Medical School to be called 'mister,'
+  thank you very much."
+  ```
+
+As expected all the quotes are straight ones. But with this plugin, the
+straight quotes are transformed into the typographic equivalent as you
+type:
+
+  ```
+  “It’s Dr. Evil. I didn’t spend six years in Evil Medical School to be called ‘mister,’
+  thank you very much.”
+  ```
+
+### Entering straight quotes
+
+In some cases, straight (ASCII) quotes are needed, such as:
+
+  ```
+  “print "Hello World!"” is a simple program you can write in Python.
+  ```
+
+To insert a straight quote while educating, enter `«Ctrl-V»` before the quote key:
+
+* `«Ctrl-V» "` - straight double quote
+* `«Ctrl-V» '` - straight single quote
+
+Note that for units of measurement you’ll want to use the prime symbol rather
+than straight quotes, as in:
+
+  ```
+  Standing at 7′3″ (2.21 m), Hasheem Thabeet of the Oklahoma City Thunder is the tallest
+  player in the NBA.
+  ```
+
+### Commands
+
+You can enable (or toggle) the educating behavior with the following
+commands:
+
+  ```vim
+  QuotableEducateOn
+  QuotableEducateOff
+  QuotableEducateToggle
+  ```
+
+`QuotableEducateOn` will map the quote keys for transformation. Or better yet,
+map to keys via your `.vimrc`:
+
+  ```vim
+  nmap <silent> <leader>q1 :QuotableEducateOn<cr>
+  nmap <silent> <leader>q0 :QuotableEducateOff<cr>
+  nmap <silent> <leader>qq :QuotableEducateToggle<cr>
+  ```
+
+## Motion commands
+
+Motion commands are a powerful feature of Vim.
+
+By default, for motion commands, `q` denotes “double” quotes and `Q` denotes
+‘single’ quotes.
+
+* `ciq` - [Change Inside “double” quotes] - excludes quote chars
+* `ciQ` - [Change Inside ‘single’ quotes] - excludes quote chars
+* `caq` - [Change Around “double” quotes] - includes quote chars
+* `caQ` - [Change Around ‘single’ quotes] - includes quote chars
+
+Apart from `c` for change, you can `v` for visual selection, `d` for deletion,
+`y` for yanking to clipboard, etc.
+
+_Quotable_’s motion command is smart too, able to distinguish between an
+apostrophe and single closing quote, even though both are represented by
+the same glyph. For example, try out `viQ` on the following sentence:
+
+```
+‘Really, I’d rather not relive the ’70s,’ said zombie Elvis.
+```
+
+If you don’t like the defaults, you can redefine these by adding the following
+to your `.vimrc`, changing the motion characters as you desire:
+
+  ```vim
+  let g:quotable#doubleMotion = 'q'
+  let g:quotable#singleMotion = 'Q'
+  ```
+
+## Matchit support
+
+Matchit enables jumping to matching quotes.
+
+* `%` - jump to the matching typographic (curly) quote character
+
+## Replace support
+
+You can replace straight quotes in existing text with curly quotes, and
+visa versa. Add key mappings of your choice to your `.vimrc`:
+
+```
+map <silent> <leader>qc <Plug>QuotableReplaceWithCurly
+map <silent> <leader>qs <Plug>QuotableReplaceWithStraight
+```
+
+Both _Normal_ and _Visual_ modes are supported by this feature.
+
+To transform all quotes in a document, use _Visual_ mode to select all the
+text in the document.
+
+## Surround support
+
+This plugin supports basic surround capabilities. Add to your `.vimrc` key
+mappings of your choice:
+
+  ```vim
+  " NOTE: be sure to remove these mappings if using the tpope/vim-surround plugin!
+  map <silent> Sq <Plug>QuotableSurroundDouble
+  map <silent> SQ <Plug>QuotableSurroundSingle
+  ```
+
+Then you can use motion commands to surround your text with quotes:
+
+(an asterisk is used to denote the cursor position)
+
+* `visSq` - My senten*ce. => “My sentence.”
+* `visSQ` - My senten*ce. => ‘My sentence.’
+
+Alternatively, if you’ve installed Tim Pope’s [vim-surround][] plugin you also
+have replace abilities on pairs of characters:
+
+* `cs'q` - 'Hello W*orld' => “Hello World”
+* `cs"q` - "Hello W*orld" => “Hello World”
+* `cs(q` - (Hello W*orld) => “Hello World”
+* `cs(Q` - (Hello W*orld) => ‘Hello World’
+
+[vim-surround]: https://github.com/tpope/vim-surround
+
+## Entering special characters
+
+Sometimes you must enter special characters (like typographic quotes)
+manually, such as in a search expression. You can do so through Vim’s digraphs
+or via your operating system’s keyboard shortcuts.
+
+| Glyph | Vim Digraph | OS X               | Description
+| ----- | ----------- | ------------------ | ----------------------------
+| `‘`   | `'6`        | `Opt-]`            | left single quotation mark
+| `’`   | `'9`        | `Shift-Opt-]`      | right single quotation mark
+| `“`   | `"6`        | `Opt-[`            | left double quotation mark
+| `”`   | `"9`        | `Shift-Opt-[`      | right double quotation mark
+| `‚`   | `.9`        |                    | single low-9 quote
+| `„`   | `:9`        | `Shift-Opt-w`      | double low-9 quote
+| `‹`   | `1<`        | `Opt-\`            | left pointing single quotation mark
+| `›`   | `1>`        | `Shift-Opt-\`      | right pointing single quotation mark
+| `«`   | `<<`        | `Opt-\`            | left pointing double quotation mark
+| `»`   | `>>`        | `Shift-Opt-\`      | right pointing double quotation mark
+| `′`   | `1'`        |                    | single prime
+| `″`   | `2'`        |                    | double prime
+| `–`   | `-N`        | `Opt-hyphen`       | en dash
+| `—`   | `-M`        | `Shift-Opt-hyphen` | em dash
+| `…`   | `..`        | `Opt-;`            | horizontal ellipsis
+| ` `   | `NS`        |                    | non-breaking space
+| `ï`   | `i:`        | `Opt-U` `i`        | lowercase i, umlaut
+| `æ`   | `ae`        | `Opt-'`            | lowercase ae
+
+For example, to enter left double quotation mark `“`, precede the digraph code
+`"6` with `Ctrl-K`, like
+
+* `«Ctrl-K» "6`
+
+Alternatively, if you’re on OS X, you can use `Opt-[` to enter this
+character.
+
+For more details, see:
+
+* `:help digraphs`
+
+## International support
+
+Many international keyboards feature keys to allow you to input
+typographic quote characters directly. In such cases, you won’t need
+to change the behavior of the straight quote keys.
+
+But if you do, a standard convention is used by default:
+
+  ```vim
+  let g:quotable#doubleDefault = '“”'     " “double”
+  let g:quotable#singleDefault = '‘’'     " ‘single’
+  ```
+
+Those users editing most of their prose in German may want to change their
+defaults to:
+
+  ```vim
+  let g:quotable#doubleDefault = '„“'     " „doppel“
+  let g:quotable#singleDefault = '‚‘'     " ‚einzel‘
+  ```
+
+International users who desire maximum control can switch between quote
+pairings within a single buffer, adding the following key mappings to
+their `.vimrc`:
+
+  ```vim
+  nnoremap <silent> <leader>qd :call quotable#init()<cr>    " forces defaults
+  nnoremap <silent> <leader>qn :call quotable#init({ 'double':'“”', 'single':'‘’' })<cr>
+  nnoremap <silent> <leader>qg :call quotable#init({ 'double':'„“', 'single':'‚‘' })<cr>
+  nnoremap <silent> <leader>qx :call quotable#init({ 'double':'„”', 'single':'‚’' })<cr>
+  nnoremap <silent> <leader>qf :call quotable#init({ 'double':'«»', 'single':'‹›' })<cr>
+  ```
+
+## See also
+
+* [quotable at vim.org](http://www.vim.org/scripts/script.php?script_id=4811)
+
+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-thematic][th] - modify Vim’s appearance to suit your task and environment
+* [vim-wordy][wo] - uncovering usage problems in writing
+
+[re]: http://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
+[th]: http://github.com/reedes/vim-thematic
+[wo]: http://github.com/reedes/vim-wordy
+
+## Future development
+
+If you’ve spotted a problem or have an idea on improving this plugin,
+please post it to the github project issue page.
+
+<!-- vim: set tw=74 :-->

autoload/textobj/sentence.vim

@@ -0,0 +1,29 @@
+" ============================================================================
+" File:        textobj_sentence.vim
+" Description: load functions for vim-textobj_sentence plugin
+" Maintainer:  Reed Esau <github.com/reedes>
+" Created:     January 25, 2013
+" License:     The MIT License (MIT)
+" ============================================================================
+
+if exists('g:autoloaded_textobj_sentence') && g:autoloaded_textobj_sentence
+  finish
+endif
+
+function! s:select(pattern)
+  call search(a:pattern, 'bc')
+  let l:start = getpos('.')
+  call search(a:pattern, 'ce')
+  let l:end = getpos('.')
+  return ['v', l:start, l:end]
+endfunction
+
+function! textobj#sentence#select_a()
+  return s:select(g:textobj#sentence#re_a)
+endfunction
+
+function! textobj#sentence#select_i()
+  return s:select(g:textobj#sentence#re_i)
+endfunction
+
+let g:autoloaded_textobj_sentence = 1