Merge pull request #74 from actionless/patch-1

markdown comment syntax
Merge pull request #78 from BlueDrink9/patch-1
2025-11-20 07:43:39 -05:00 · 2019-08-30 11:49:13 -06:00 · 2019-08-30 11:47:48 -06:00 · 2019-05-02 17:25:24 +12:00 · 2019-03-11 07:52:52 +01:00 · 2017-06-14 16:03:18 -06:00
3 changed files with 434 additions and 248 deletions
--- a/README.markdown
+++ b/README.markdown
@@ -8,9 +8,6 @@
 ![demo](http://i.imgur.com/0KYl5vU.gif)
 - - -

-[Note: demo above needs to be updated with the _recently_ renamed
-commands (see below), but the legacy ones shown still work.]
-
 # Features

 The _pencil_ plugin aspires to make Vim as powerful a tool for writers as
@@ -24,9 +21,6 @@ smooth the path to writing prose.
 * Adjusts navigation key mappings to suit the wrap mode
 * Creates undo points on common punctuation during Insert mode, including
  deletion via line `<C-U>` and word `<C-W>`
-* When using hard line breaks, _pencil_ enables Vim’s autoformat while
-  inserting text, except for tables and code blocks where you won’t want
-  it
 * Buffer-scoped configuration (with a few minor exceptions, _pencil_ preserves
  your global settings)
 * Support for Vim’s Conceal feature to hide markup defined by Syntax plugins
@@ -34,6 +28,12 @@ smooth the path to writing prose.
 * Support for display of mode indicator (`␍` and `⤸`, e.g.) in the status line
 * Pure Vimscript with no dependencies

+In addition, when using hard line break mode:
+
+* Makes use of Vim’s powerful autoformat while inserting text, except for
+  tables and code blocks where you won’t want it.
+* *NEW* Optional key mapping to suspend autoformat for the Insert.
+
 Need spell-check, distraction-free editing, and other features? Vim is about
 customization. To complete your editing environment, learn to configure Vim and
 draw upon its rich ecosystem of plugins.
@@ -48,7 +48,8 @@ Several reasons have been offered:
  to reach for mouse, track pad, or arrow keys
 * Minimal chording, with many mnemonic-friendly commands
 * Sophisticated capabilities for navigating and manipulating text
-* Highly configurable to suit your needs, with many great plugins available
+* Highly configurable, enabling you to build a workflow that suits your
+  needs, with many great plugins available
 * No proprietary format lock-in

 But while such reasons might be sound, they remain scant justification to
@@ -56,7 +57,7 @@ switch away from the familiar word processor. Instead, you need
 a compelling reason—one that can appeal to a writer’s love for language
 and the tools of writing.

-You can find that reason in Vim's mysterious command sequences. Take `cas`
+You can find that reason in Vim’s mysterious command sequences. Take `cas`
 for instance. You might see it as a mnemonic for _Change Around Sentence_
 to replace an existing sentence. But dig a bit deeper to discover that
 such commands have a grammar of their own, comprised of nouns, verbs, and
@@ -65,24 +66,31 @@ specific language_ for manipulating text, one that can become a powerful
 tool in expressing yourself. For more details on vi-style editing, see...

 * [Learn to speak vim – verbs, nouns, and modifiers!][ls] (December 2011)
-* [Your problem with Vim is that you don't grok vi][gv] (December 2011)
-* [Intro to Vim's Grammar][ig] (January 2013)
+* [Your problem with Vim is that you don’t grok vi][gv] (December 2011)
+* [Intro to Vim’s Grammar][ig] (January 2013)
 * [Why Atom Can’t Replace Vim, Learning the lesson of vi][wa] (March 2014)
+* [Language of Vim/Neovim][lovn] (January 2015)

 [ls]: http://yanpritzker.com/2011/12/16/learn-to-speak-vim-verbs-nouns-and-modifiers/
 [gv]: http://stackoverflow.com/questions/1218390/what-is-your-most-productive-shortcut-with-vim/1220118#1220118
 [ig]: http://takac.github.io/2013/01/30/vim-grammar/
 [wa]: https://medium.com/p/433852f4b4d1
+[lovn]: http://allsyed.com/language-of-vim-neovim/

 # Installation

-_pencil_ is best installed using a Vim package manager, such as Vundle,
-Plug, NeoBundle, or Pathogen.
+_pencil_ is best installed using a Vim package manager, such as
+[Vundle][vnd], [Plug][plg], [NeoBundle][nbn], or [Pathogen][pth].

 _For those new to Vim: before installing this plugin, consider getting
 comfortable with the basics of Vim by working through one of the many
 tutorials available._

+[vnd]: https://github.com/gmarik/Vundle.vim
+[plg]: https://github.com/junegunn/vim-plug
+[nbn]: https://github.com/Shougo/neobundle.vim
+[pth]: https://github.com/tpope/vim-pathogen
+
 #### Vundle

 Add to your `.vimrc` and save:
@@ -98,8 +106,6 @@ Plugin 'reedes/vim-pencil'
 :PluginInstall
 ```

-For Vundle version < 0.10.2, replace `Plugin` with `Bundle` above.
-
 #### Plug

 Add to your `.vimrc` and save:
@@ -141,12 +147,26 @@ git clone https://github.com/reedes/vim-pencil

 # Configuration

-## Basic initialization
+## Initializing by command

-Though optional, initializing _pencil_ by `FileType` will automatically
-set up your buffers for editing prose.
+You can manually enable, disable, and toggle _pencil_ as a command:

-Add support for your desired filetypes to your `.vimrc`:
+* `Pencil` - initialize _pencil_ with auto-detect for the current buffer
+* `NoPencil` (or `PencilOff`) - removes navigation mappings and restores buffer to global settings
+* `TogglePencil` (or `PencilToggle`) - if on, turns off; if off, initializes with auto-detect
+
+Because auto-detect might not work as intended, you can invoke a command
+to set the behavior for the current buffer:
+
+* `SoftPencil` (or `PencilSoft`) - initialize _pencil_ with soft line wrap mode
+* `HardPencil` (or `PencilHard`) - initialize _pencil_ with hard line break mode (and Vim’s autoformat)
+
+## Initializing by file type
+
+Initializing _pencil_ by file type is _optional_, though doing so will
+automatically set up your buffers for editing prose.
+
+Add support for your desired file types to your `.vimrc`:

 ```vim
 set nocompatible
@@ -172,16 +192,14 @@ augroup pencil
 augroup END
 ```

-For other prose-oriented plugins, consult the [See also](#see-also)
-section below.
-
-For more details, see the advanced initialization section below.
+For a list of other prose-oriented plugins, consult the [See
+also](#see-also) section below.

 ## Hard line breaks or soft line wrap?

 Coders will have the most experience with the former, and writers the
 latter. But whatever your background, chances are that you must contend
-with both conventions. This plugin doesn't force you to choose a side—you
+with both conventions. This plugin doesn’t force you to choose a side—you
 can configure each buffer independently.

 In most cases you can set a default to suit your preference and let
@@ -197,51 +215,25 @@ augroup pencil
 augroup END
 ```

-In the example above, for files of type `markdown` this plugin will
+In the example above, for buffers of type `markdown` this plugin will
 auto-detect the line wrap approach, with soft line wrap as the default.

-For files of type `text`, it will initialize with hard line breaks, even
-if auto-detect might suggest soft line wrap.
-
-## Commands
-
-You can enable, disable, and toggle _pencil_ as a command:
-
-* `Pencil` - initialize _pencil_ with auto-detect for the current buffer
-* `PencilOff` - removes navigation mappings and restores buffer to global settings
-* `PencilToggle` - if on, turns off; if off, initializes with auto-detect
-
-Because auto-detect might not work as intended, you can invoke a command
-to set the behavior for the current buffer:
-
-* `PencilSoft` - initialize _pencil_ with soft line wrap mode
-* `PencilHard` - initialize _pencil_ with hard line break mode (and Vim’s autoformat)
+For buffers of type `text`, it will initialize with hard line breaks,
+even if auto-detect might suggest soft line wrap.

 ## Automatic formatting

-_The ‘autoformat’ feature affects *PencilHard* (hard line break) mode
+_The ‘autoformat’ feature affects `HardPencil` (hard line break) mode
 only._

-When inserting text while in *PencilHard* mode, Vim’s autoformat feature
-will be enabled by default and can offer many of the same benefits as
-soft line wrap.
+When inserting text while in `HardPencil` mode, Vim’s powerful autoformat
+feature will be _enabled_ by default and can offer many of the same
+benefits as soft line wrap.

-One useful exception (aka 'blacklisting'): if used with popular 
-prose-oriented syntax plugins, _pencil_ will **not** enable autoformat when 
-you enter Insert mode from inside a code block or table. (See the 
-advanced section below for more details on the blacklisting feature.)
-
-Where you need to manually enable/disable autoformat for the current
-buffer, you can do so with a command:
-
-* `PFormat` - allows autoformat to be enabled (if not blacklisted)
-* `PFormatOff` - prevents autoformat from enabling (blacklist all)
-* `PFormatToggle` - toggle to allow if off, etc.
-
-To set the default behavior, add to your `.vimrc`:
+To set the default behavior in your `.vimrc`:

 ```vim
-let g:pencil#autoformat = 1      " 0=manual, 1=auto (def)
+let g:pencil#autoformat = 1      " 0=disable, 1=enable (def)
 ```

 You can override this default during initialization, as in:
@@ -249,36 +241,71 @@ You can override this default during initialization, as in:
 ```vim
 augroup pencil
  autocmd!
-  autocmd FileType text call pencil#init({'wrap': 'hard', 'autoformat': 0})
+  autocmd FileType markdown call pencil#init({'wrap': 'hard', 'autoformat': 1})
+  autocmd FileType text     call pencil#init({'wrap': 'hard', 'autoformat': 0})
  ...
 augroup END
 ```

-...where by default, files of type `text` will use hard line endings, but
-with autoformat disabled.
+...where buffers of type `markdown` and `text` will use hard line breaks,
+but `text` buffers will have autoformat disabled.
+
+## Suspend automatic formatting for the Insert
+
+There are two useful exceptions where autoformat (when enabled for the
+buffer) will be _temporarily disabled_ for the current Insert:
+
+**First** is _pencil’s_ ‘blacklisting’ feature: if used with popular
+prose-oriented syntax plugins, _pencil_ will suspend autoformat when you
+enter Insert mode from inside a code block or table.
+
+**Second**, where blacklisting falls short, you can optionally map
+a buffer-scoped ‘modifier’ key to suspend autoformat during the next
+Insert:
+
+```vim
+let g:pencil#map#suspend_af = 'K'   " default is no mapping
+```
+
+Using the above mapping, with `Ko` you’ll enter Insert mode with the
+cursor on a new line, but autoformat will suspend for that Insert. Using
+`o` by itself will retain autoformat.
+
+By default no modifier key is mapped.
+
+(See the advanced section below for details on how blacklisting is
+implemented and configured).

 ## Manual formatting

-Note that you need not rely on autoformat exclusively and can manually
-reformat paragraphs with standard Vim commands:
+Note that you need not rely on Vim’s autoformat exclusively and can
+manually reformat paragraphs with standard Vim commands:

-* `gqip` or `gwip` - format current paragraph
-* `vipJ` - unformat (i.e., join all lines with hard line breaks) in current paragraph
+* `gqap` - format current paragraph (see `:help gq` for details)
+* `vapJgqap` - merge two paragraphs (current and next) and format
 * `ggVGgq` or `:g/^/norm gqq` - format all paragraphs in buffer
-* `:%norm vipJ` - unformat all paragraphs in buffer

 Optionally, you can map these operations to underutilized keys in your
 `.vimrc`:

 ```vim
-nnoremap <silent> Q gwip
+nnoremap <silent> Q gqap
+xnoremap <silent> Q gq
+nnoremap <silent> <leader>Q vapJgqap
 ```

+Or you may wish to ‘unformat’, (i.e., remove hard line breaks) when using
+soft line wrap.
+
+* `vipJ` - join all lines in current paragraph
+* `:%norm vipJ` - unformat all paragraphs in buffer
+
 ## Default textwidth

-You can configure the textwidth to be used in **PencilHard** mode when no
-textwidth is set globally, locally, or available via modeline. It
-defaults to `74`, but you can change that value in your `.vimrc`:
+You can configure the textwidth to be used in `HardPencil` (hard line
+break) mode when no textwidth is set globally, locally, or available via
+modeline. It defaults to `74`, but you can change that value in your
+`.vimrc`:

 ```vim
 let g:pencil#textwidth = 74
@@ -307,13 +334,13 @@ let g:pencil#cursorwrap = 1     " 0=disable, 1=enable (def)

 ## Concealing \_\_markup\_\_

-_pencil_ enables Vim's powerful Conceal feature, although support among
+_pencil_ enables Vim’s powerful Conceal feature, although support among
 Syntax and Colorscheme plugins is currently spotty.

 You can change _pencil’s_ default settings for conceal in your `.vimrc`:

 ```vim
-let g:pencil#conceallevel = 3     " 0=disable, 1=onechar, 2=hidechar, 3=hideall (def)
+let g:pencil#conceallevel = 3     " 0=disable, 1=one char, 2=hide char, 3=hide all (def)
 let g:pencil#concealcursor = 'c'  " n=normal, v=visual, i=insert, c=command (def)
 ```

@@ -335,10 +362,10 @@ To use Vim’s Conceal feature with Markdown, you will need to install:
 1. [tpope/vim-markdown][tm] as it’s currently the only Markdown syntax
   plugin that supports conceal.

-2. a monospaced font (such as [Cousine][co]) featuring the _italic_,
+2. A monospaced font (such as [Cousine][co]) featuring the _italic_,
   **bold**, and ***bold italic*** style variant for styled text.

-3. a colorscheme (such as [reedes/vim-colors-pencil][cp]) which supports
+3. A colorscheme (such as [reedes/vim-colors-pencil][cp]) which supports
   the Markdown-specific highlight groups for styled text.

 You should then only see the `_` and `*` markup for the cursor line and in
@@ -353,7 +380,7 @@ terminal to support **bold** and _italic_ styles.
 ## Status line indicator

 Your status line can reflect the wrap mode for _pencil_ buffers. For
-example, `␍` to represent `PencilHard` (hard line break) mode.  To
+example, `␍` to represent `HardPencil` (hard line break) mode.  To
 configure your status line and ruler, add to your `.vimrc`:

 ```vim
@@ -367,12 +394,23 @@ or if using [bling/vim-airline][va]:
 let g:airline_section_x = '%{PencilMode()}'
 ```

-If you don’t like the default indicators, you can specify different ones:
+The default indicators now include ‘auto’ for when Vim’s autoformat is
+active in hard line break mode. (If autoformat is suspended for the
+Insert, it’ll show the ‘hard’ indicator.)

 ```vim
-let g:pencil#mode_indicators = {'hard': '␍', 'soft': '⤸', 'off': '',}
+let g:pencil#mode_indicators = {'hard': 'H', 'auto': 'A', 'soft': 'S', 'off': '',}
 ```

+If Unicode is detected, the default indicators are:
+
+```vim
+let g:pencil#mode_indicators = {'hard': '␍', 'auto': 'ª', 'soft': '⤸', 'off': '',}
+```
+
+If you don’t like the default indicators, you can specify your own in
+your `.vimrc`.
+
 Note that `PencilMode()` will return blank for buffers in which _pencil_
 has not been initialized.

@@ -382,106 +420,150 @@ has not been initialized.

 ### Advanced initialization

-Configurable options for `pencil#init()` include: `autoformat`,
-`concealcursor`, `conceallevel`, `cursorwrap`, `joinspaces`, `textwidth`,
-and `wrap`. These are detailed above.
+You may want to refactor initialization statements into a function in
+your `.vimrc` to set up a buffer for writing:

-You can override _pencil_ and other configuration settings when initializing:
+```vim
+function! Prose()
+  call pencil#init()
+  call lexical#init()
+  call litecorrect#init()
+  call textobj#quote#init()
+  call textobj#sentence#init()
+
+  " manual reformatting shortcuts
+  nnoremap <buffer> <silent> Q gqap
+  xnoremap <buffer> <silent> Q gq
+  nnoremap <buffer> <silent> <leader>Q vapJgqap
+
+  " force top correction on most recent misspelling
+  nnoremap <buffer> <c-s> [s1z=<c-o>
+  inoremap <buffer> <c-s> <c-g>u<Esc>[s1z=`]A<c-g>u
+
+  " replace common punctuation
+  iabbrev <buffer> -- –
+  iabbrev <buffer> --- —
+  iabbrev <buffer> << «
+  iabbrev <buffer> >> »
+
+  " open most folds
+  setlocal foldlevel=6
+
+  " replace typographical quotes (reedes/vim-textobj-quote)
+  map <silent> <buffer> <leader>qc <Plug>ReplaceWithCurly
+  map <silent> <buffer> <leader>qs <Plug>ReplaceWithStraight
+
+  " highlight words (reedes/vim-wordy)
+  noremap <silent> <buffer> <F8> :<C-u>NextWordy<cr>
+  xnoremap <silent> <buffer> <F8> :<C-u>NextWordy<cr>
+  inoremap <silent> <buffer> <F8> <C-o>:NextWordy<cr>
+
+endfunction
+
+" automatically initialize buffer by file type
+autocmd FileType markdown,mkd,text call Prose()
+
+" invoke manually by command for other file types
+command! -nargs=0 Prose call Prose()
+```
+
+For highly-granular control, you can override _pencil_ and other configuration
+settings when initializing buffers by file type:

 ```vim
 augroup pencil
  autocmd!
-  autocmd FileType markdown,mkd call pencil#init() |
-                              \ call litecorrect#init() |
-                              \ setl spell spl=en_us fdl=4 noru nonu nornu |
-                              \ setl fdo+=search
-  autocmd Filetype git,gitsendemail,*commit*,*COMMIT* |
-                              \ call pencil#init({'wrap': 'hard', 'textwidth': 72}) |
-                              \ call litecorrect#init() |
-                              \ setl spell spl=en_us et sw=2 ts=2 noai
-  autocmd Filetype mail         call pencil#init({'wrap': 'hard', 'textwidth': 60}) |
-                              \ call litecorrect#init() |
-                              \ setl spell spl=en_us et sw=2 ts=2 noai nonu nornu
-  autocmd Filetype html,xml     call pencil#init({'wrap': 'soft'}) |
-                              \ call litecorrect#init() |
-                              \ setl spell spl=en_us et sw=2 ts=2
+  autocmd FileType markdown,mkd call pencil#init()
+                            \ | call litecorrect#init()
+                            \ | setl spell spl=en_us fdl=4 noru nonu nornu
+                            \ | setl fdo+=search
+  autocmd Filetype git,gitsendemail,*commit*,*COMMIT*
+                            \   call pencil#init({'wrap': 'hard', 'textwidth': 72})
+                            \ | call litecorrect#init()
+                            \ | setl spell spl=en_us et sw=2 ts=2 noai
+  autocmd Filetype mail         call pencil#init({'wrap': 'hard', 'textwidth': 60})
+                            \ | call litecorrect#init()
+                            \ | setl spell spl=en_us et sw=2 ts=2 noai nonu nornu
+  autocmd Filetype html,xml     call pencil#init({'wrap': 'soft'})
+                            \ | call litecorrect#init()
+                            \ | setl spell spl=en_us et sw=2 ts=2
 augroup END
 ```

-Alternatives include `after/ftplugin` modules as well as refactoring initialization
-statements into a function.
+Configurable options for `pencil#init()` include: `autoformat`,
+`concealcursor`, `conceallevel`, `cursorwrap`, `joinspaces`, `textwidth`,
+and `wrap`. These are detailed above.

-### Autoformat blacklisting
+### Autoformat manual control

-_The ‘autoformat’ feature affects *PencilHard* (hard line break) mode
+_The ‘autoformat’ feature affects `HardPencil` (hard line break) mode
 only._

-When editing formatted text, such as a table or code block, autoformat
-will wreak havoc with the formatting. In these cases you will want to
-temporarily deactivate autoformat, such as with the `PFormatOff` or
-`PFormatToggle` commands described above. However, in most cases, you won’t
-need to do this.
+To suspend autoformat for the next Insert, see above.

-_pencil_ will detect the syntax highlight group at the cursor position to
-determine whether or not autoformat should be activated.
+When you need to manually enable/disable autoformat for the current
+buffer, you can do so with a command:

-If autoformat is on, it will be activated at the time you enter Insert
-mode provided that the syntax highlighting group at the cursor position is
-_not_ in the blacklist. The current blacklist is:
+* `PFormat` - enable autoformat for buffer (can still be disabled via blacklisting)
+* `PFormatOff` - disable autoformat for buffer
+* `PFormatToggle` - toggle to enable if disabled, etc.
+
+You can map a key in your `.vimrc` to toggle Vim’s autoformat:

 ```vim
-let g:pencil#autoformat_blacklist = [
-      \ 'markdownCode',
-      \ 'markdownH[0-9]',
-      \ 'markdownUrl',
-      \ 'markdownIdDeclaration',
-      \ 'markdownLink',
-      \ 'markdownRule',
-      \ 'markdownHighlight[A-Za-z0-9]+',
-      \ 'mkdCode',
-      \ 'mkdRule',
-      \ 'htmlH[0-9]',
-      \ 'mkdIndentCode',
-      \ 'markdownFencedCodeBlock',
-      \ 'markdownInlineCode',
-      \ 'mmdTable[A-Za-z0-9]*',
-      \ 'txtCode',
-      \ 'rstCodeBlock',
-      \ 'rstDirective',
-      \ 'rstLiteralBlock',
-      \ 'rstSections',
-      \ 'texBeginEndName',
-      \ 'texDelimiter',
-      \ 'texDocType',
-      \ 'texInputFile',
-      \ 'texMath',
-      \ 'texRefZone',
-      \ 'texSection$',
-      \ 'texTitle',
-      \ 'asciidocAttribute',
-      \ 'asciidocList',
-      \ 'asciidocLiteral',
-      \ 'asciidoc[A-Za-z]*Block',
-      \ 'asciidoc[A-Za-z]*Macro',
-      \ 'asciidoc[A-Za-z]*Title',
-      \ ]
+noremap <silent> <F7> :<C-u>PFormatToggle<cr>
+inoremap <silent> <F7> <C-o>:PFormatToggle<cr>
 ```

-_WARNING: the implementation of this blacklist may be changing in the
-future._
+### Autoformat blacklisting (and whitelisting)

-There’s also a whitelist to override the blacklist. See code for details.
+_The ‘autoformat’ feature affects `HardPencil` (hard line break) mode
+only._

-You can override this in your `.vimrc`. Additions to defaults with good
-use cases are welcome.
+When editing formatted text, such as a table or code block, Vim’s
+autoformat will wreak havoc with the formatting. In these cases you will
+want autoformat suspended for the duration of the Insert.
+
+When entering Insert mode, _pencil_ will determine the highlight group at
+the cursor position. If that group has been blacklisted, _pencil_ will
+suspend autoformat for the Insert. For example, if editing a buffer of
+type ‘markdown’, autoformat will be suspended if you invoke Insert mode
+from inside a `markdownFencedCodeBlock` highlight group.
+
+Blacklists are now declared by file type. The default blacklists (and
+whitelists) are declared in the `plugin/pencil.vim` module. Here’s an
+excerpt showing the configuration for the ‘markdown’ file type:
+
+```vim
+  let g:pencil#autoformat_config = {
+        \   'markdown': {
+        \     'black': [
+        \       'htmlH[0-9]',
+        \       'markdown(Code|H[0-9]|Url|IdDeclaration|Link|Rule|Highlight[A-Za-z0-9]+)',
+        \       'markdown(FencedCodeBlock|InlineCode)',
+        \       'mkd(Code|Rule|Delimiter|Link|ListItem|IndentCode)',
+        \       'mmdTable[A-Za-z0-9]*',
+        \     ],
+        \     'white': [
+        \      'markdown(Code|Link)',
+        \     ],
+        \   },
+        [snip]
+        \ }
+```
+
+The whitelist will override the blacklist and enable Vim’s autoformat if
+text that would normally be blacklisted doesn’t dominate the entire line.
+This allows autoformat to work with `inline` code and links.

 ### Auto-detecting wrap mode

-If you didn't explicitly specify a wrap mode during initialization,
+If you didn’t explicitly specify a wrap mode during initialization,
 _pencil_ will attempt to detect it.

 It will first look for a `textwidth` (or `tw`) specified in a modeline.
-Failing that, _pencil_ will then sample lines from the start of the file.
+Failing that, _pencil_ will then sample lines from the start of the
+buffer.

 #### Detect via modeline

@@ -502,7 +584,8 @@ command upon loading the file into a buffer:
 ```

 It tells _pencil_ to assume hard line breaks, regardless of whether or
-not soft line wrap is the default editing mode for files of type ‘markdown’.
+not soft line wrap is the default editing mode for buffers of type
+‘markdown’.

 You explicitly specify soft wrap mode by specifying a textwidth of `0`:

@@ -515,12 +598,12 @@ reasons) the textwidth will still be set by this plugin.

 #### Detect via sampling

-If no modeline with a textwidth is found, _pencil_ will sample the initial
-lines from the file, looking for those excessively-long.
+If no modeline with a textwidth is found, _pencil_ will sample the
+initial lines from the buffer, looking for those excessively-long.

 There are two settings you can add to your `.vimrc` to tweak this behavior.

-The maximum number of lines to sample from the start of the file:
+The maximum number of lines to sample from the start of the buffer:

 ```vim
 let g:pencil#softDetectSample = 20
@@ -543,13 +626,30 @@ If no such lines found, _pencil_ falls back to the default wrap mode.
 * [Vim Training Class - Basic motions and commands][tc] - video tutorial by Shawn Biddle
 * [Vim for Writers][vw] - guide to the basics geared to writers

+Bloggers and developers discuss _pencil_ and its brethern:
+
+* [Reed Esau’s growing list of Vim plugins for writers][regl] (2014) - by @pengwynn
+* [Distraction Free Writing in Vim][dfwiv] (2014) - by @tlattimore
+* [Safari Blog: Turning vim into an IDE through vim plugins][tviai] (2014) - by @jameydeorio
+* [Quick tops for writing prose with Vim][qtfwp] (2014) - by @benoliver999
+* [UseVim: Reed Esau’s Writing Plugins][rewp] (2015) - by @alexyoung
+* [Tomasino Labs: Vim in Context][vic] (2015) - by @jamestomasino
+
 Other plugins of specific interest to writers:

+* [danielbmarques/vim-ditto][vd] - highlight repeated words
 * [tpope/vim-abolish][ab] - search for, substitute, and abbr. multiple variants of a word
 * [tommcdo/vim-exchange][ex] - easy text exchange operator for Vim
 * [junegunn/limelight.vim][jl] - focus mode that brightens current paragraph
 * [junegunn/goyo.vim][jg] - distraction-free editing mode

+[vd]: https://github.com/danielbmarques/vim-ditto
+[qtfwp]: http://benoliver999.com/technology/2014/12/06/vimforprose/
+[vic]: https://labs.tomasino.org/vim-in-context/
+[rewp]: https://medium.com/usevim/reed-esaus-writing-plugins-5b6c65bc808f
+[tviai]: https://www.safaribooksonline.com/blog/2014/11/23/way-vim-ide/
+[regl]: http://wynnnetherland.com/journal/reed-esau-s-growing-list-of-vim-plugins-for-writers/
+[dfwiv]: http://tlattimore.com/blog/distraction-free-writing-in-vim/
 [ab]: http://github.com/tpope/vim-abolish
 [ex]: http://github.com/tommcdo/vim-exchange
 [jl]: http://github.com/junegunn/limelight.vim
@@ -557,10 +657,24 @@ Other plugins of specific interest to writers:

 Markdown syntax plugins

-* [tpope/vim-markdown][tvm] - the latest version of the syntax plugin that ships with Vim
+Markdown users typically won’t need to install a syntax plugin unless
+they want the latest version of Pope’s syntax highlighting:
+
+* [tpope/vim-markdown][tvm] - (recommended) the latest version of Pope’s
+  syntax plugin which ships with Vim
+
+Those using tables and footnotes should consider installing this plugin:
+
+* [mattly/vim-markdown-enhancements][mvme]
+
+Alternatives to Tim Pope’s syntax highlighting include:
+
 * [plasticboy/vim-markdown][pvm]
 * [gabrielelana/vim-markdown][gvm]
-* [mattly/vim-markdown-enhancements][mvme] - highlighting for tables and footnotes
+
+Note that the plasticboy and gabrielelana plugins may incorrectly
+reformat bulleted lists when Vim’s autoformat is active in _pencil_’s
+HardPencil mode.

 [tvm]: http://github.com/tpope/vim-markdown
 [pvm]: http://github.com/plasticboy/vim-markdown
@@ -574,7 +688,7 @@ If you find the _pencil_ plugin useful, check out these others by [@reedes][re]:
 * [vim-litecorrect][lc] - lightweight auto-correction for Vim
 * [vim-one][vo] - make use of Vim’s _+clientserver_ capabilities
 * [vim-textobj-quote][qu] - extends Vim to support typographic (‘curly’) quotes
-* [vim-textobj-sentence][ts] - improving on Vim's native sentence motion command
+* [vim-textobj-sentence][ts] - improving on Vim’s native sentence motion command
 * [vim-thematic][th] - modify Vim’s appearance to suit your task and environment
 * [vim-wheel][wh] - screen-anchored cursor movement for Vim
 * [vim-wordy][wo] - uncovering usage problems in writing
@@ -599,9 +713,7 @@ with its own Markdown variant.

 # 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 or submit a pull request.
+If you’ve spotted a problem or have an idea on improving _pencil_, please
+report it as an issue, or better yet submit a pull request.

-```
 <!-- vim: set tw=73 :-->
-```
--- a/autoload/pencil.vim
+++ b/autoload/pencil.vim
@@ -44,7 +44,7 @@ fun! s:detect_wrap_mode() abort
  return s:WRAP_MODE_DEFAULT
 endf

-fun! s:imap(preserve_completion, key, icmd)
+fun! s:imap(preserve_completion, key, icmd) abort
  if a:preserve_completion
    exe ":ino <buffer> <silent> <expr> " . a:key . " pumvisible() ? \"" . a:key . "\" : \"" . a:icmd . "\""
  el
@@ -52,8 +52,26 @@ fun! s:imap(preserve_completion, key, icmd)
  en
 endf

-fun! s:maybe_enable_autoformat()
-  " don't enable autoformat if in a code block or table
+fun! s:maybe_enable_autoformat() abort
+  " don't enable autoformat if in a blacklisted code block or table,
+  " allowing for reprieve via whitelist in certain cases
+
+  " a flag to suspend autoformat for the Insert
+  if b:pencil_suspend_af
+    let b:pencil_suspend_af = 0   " clear the flag
+    return
+  en
+
+  let l:ft = get(g:pencil#autoformat_aliases, &ft, &ft)
+  let l:af_cfg = get(g:pencil#autoformat_config, l:ft, {})
+  let l:black = get(l:af_cfg, 'black', [])
+  let l:white = get(l:af_cfg, 'white', [])
+  let l:has_black_re = len(l:black) > 0
+  let l:has_white_re = len(l:white) > 0
+  let l:black_re = l:has_black_re ? '\v(' . join( l:black, '|') . ')' : ''
+  let l:white_re = l:has_white_re ? '\v(' . join( l:white, '|') . ')' : ''
+  let l:enforce_previous_line = get(l:af_cfg, 'enforce-previous-line', 0)
+
  let l:okay_to_enable = 1
  let l:line = line('.')
  let l:col = col('.')
@@ -88,17 +106,21 @@ fun! s:maybe_enable_autoformat()
    endw
  en
  " enforce blacklist by scanning for syntax matches
-  for l:sid in l:stack
-    if match(synIDattr(l:sid, 'name'),
-            \ g:pencil#autoformat_blacklist_re) >= 0
-      let l:okay_to_enable = 0
-      break
-    en
-  endfo
-  " enforce whitelist by detecting inline `markup` for
-  " which we DO want autoformat to be enabled (e.g.,
-  " tpope's markdownCode)
-  if !l:okay_to_enable
+  if l:has_black_re
+    for l:sid in l:stack
+      if match(synIDattr(l:sid, 'name'), l:black_re) >= 0
+        let l:okay_to_enable = 0
+        "echohl WarningMsg
+        "echo 'hit blacklist line=' . l:line . ' col=' . l:col .
+        "      \ ' name=' . synIDattr(l:sid, 'name')
+        "echohl NONE
+        break
+      en
+    endfo
+  en
+  " enforce whitelist by detecting inline `markup` for which we DO want
+  " autoformat to be enabled (e.g., tpope's markdownCode)
+  if l:has_white_re && !l:okay_to_enable
    " one final check for an empty stack at the start and end of line,
    " either of which greenlights a whitelist check
    if !l:found_empty
@@ -109,21 +131,31 @@ fun! s:maybe_enable_autoformat()
    en
    if l:found_empty
      for l:sid in l:stack
-        if match(synIDattr(l:sid, 'name'),
-                \ g:pencil#autoformat_inline_whitelist_re) >= 0
+        if match(synIDattr(l:sid, 'name'), l:white_re) >= 0
          let l:okay_to_enable = 1
          break
        en
      endfo
    en
  en
+  " disallow enable if start of previous line is in blacklist,
+  if l:has_black_re && l:enforce_previous_line && l:okay_to_enable && l:line > 1
+    let l:prev_stack = synstack(l:line - 1, 1)
+    for l:sid in l:prev_stack
+      if len(l:sid) > 0 &&
+              \ match(synIDattr(l:sid, 'name'), l:black_re) >= 0
+        let l:okay_to_enable = 0
+        break
+      en
+    endfo
+  en
  if l:okay_to_enable
    set formatoptions+=a
  en
 endf

-fun! pencil#setAutoFormat(af)
-  " 1=auto, 0=manual, -1=toggle
+fun! pencil#setAutoFormat(af) abort
+  " 1=enable, 0=disable, -1=toggle
  if !exists('b:last_autoformat')
    let b:last_autoformat = 0
  en
@@ -136,7 +168,6 @@ fun! pencil#setAutoFormat(af)
      au InsertEnter <buffer> call s:maybe_enable_autoformat()
      au InsertLeave <buffer> set formatoptions-=a
    aug END
-    let b:last_autoformat = l:nu_af
  el
    sil! au! pencil_autoformat * <buffer>
    if l:nu_af && !l:is_hard
@@ -146,6 +177,7 @@ fun! pencil#setAutoFormat(af)
      return
    en
  en
+  let b:last_autoformat = l:nu_af
 endf

 " Create mappings for word processing
@@ -154,6 +186,9 @@ endf
 fun! pencil#init(...) abort
  let l:args = a:0 ? a:1 : {}

+  " flag to suspend autoformat for the next Insert
+  let b:pencil_suspend_af = 0
+
  if !exists('b:pencil_wrap_mode')
    let b:pencil_wrap_mode = s:WRAP_MODE_OFF
  en
@@ -206,6 +241,14 @@ fun! pencil#init(...) abort
      setl textwidth<
    en
    setl nowrap
+
+    " flag to suspend autoformat for next Insert
+    " optional user-defined mapping
+    if exists('g:pencil#map#suspend_af') &&
+     \ g:pencil#map#suspend_af != ''
+      exe 'no <buffer> <silent> ' . g:pencil#map#suspend_af . ' :let b:pencil_suspend_af=1<CR>'
+    en
+
  elsei b:pencil_wrap_mode ==# s:WRAP_MODE_SOFT
    setl textwidth=0
    setl wrap
@@ -217,7 +260,7 @@ fun! pencil#init(...) abort
      setl breakat-=@         " avoid breaking at email addresses
    en

-    if has('syntax')
+    if exists('&colorcolumn')
      setl colorcolumn=0      " doesn't align as expected
    en
  el
@@ -229,7 +272,7 @@ fun! pencil#init(...) abort
      setl breakat<
    en

-    if has('syntax')
+    if exists('&colorcolumn')
      setl colorcolumn<
    en
  en
@@ -368,6 +411,10 @@ fun! pencil#init(...) abort
    vn <buffer> <silent> k gk
    no <buffer> <silent> <Up>   gk
    no <buffer> <silent> <Down> gj
+    nn <buffer> <silent> gj j
+    nn <buffer> <silent> gk k
+    vn <buffer> <silent> gj j
+    vn <buffer> <silent> gk k

    " preserve behavior of up/down keys in popups
    call s:imap(1, '<Up>'  , '<C-o>g<Up>'  )
@@ -379,6 +426,10 @@ fun! pencil#init(...) abort
    sil! vu  <buffer> k
    sil! unm <buffer> <Up>
    sil! unm <buffer> <Down>
+    sil! nun <buffer> gj j
+    sil! nun <buffer> gk k
+    sil! vu <buffer> gj j
+    sil! vu <buffer> gk k

    sil! iu <buffer> <Up>
    sil! iu <buffer> <Down>
@@ -395,7 +446,14 @@ fun! pencil#init(...) abort
    ino <buffer> : :<c-g>u
    ino <buffer> <c-u> <c-g>u<c-u>
    ino <buffer> <c-w> <c-g>u<c-w>
-    ino <buffer> <cr> <c-g>u<cr>
+
+    " map <cr> only if not already mapped
+    if empty(maparg('<cr>', 'i'))
+      ino <buffer> <cr> <c-g>u<cr>
+      let b:pencil_cr_mapped = 1
+    el
+      let b:pencil_cr_mapped = 0
+    en
  el
    sil! iu <buffer> .
    sil! iu <buffer> !
@@ -405,7 +463,11 @@ fun! pencil#init(...) abort
    sil! iu <buffer> :
    sil! iu <buffer> <c-u>
    sil! iu <buffer> <c-w>
-    sil! iu <buffer> <cr>
+
+    " unmap <cr> only if we mapped it ourselves
+    if exists('b:pencil_cr_mapped') && b:pencil_cr_mapped
+      sil! iu <buffer> <cr>
+    en
  en
 endf

--- a/plugin/pencil.vim
+++ b/plugin/pencil.vim
@@ -31,7 +31,11 @@ fun! PencilMode()
    if b:pencil_wrap_mode ==# s:WRAP_MODE_SOFT
      return get(g:pencil#mode_indicators, 'soft', 'S')
    elsei b:pencil_wrap_mode ==# s:WRAP_MODE_HARD
-      return get(g:pencil#mode_indicators, 'hard', 'H')
+      if &fo =~ 'a'
+        return get(g:pencil#mode_indicators, 'auto', 'A')
+      el
+        return get(g:pencil#mode_indicators, 'hard', 'H')
+      en
    el
      return get(g:pencil#mode_indicators, 'off', '')
    en
@@ -57,9 +61,9 @@ if !exists('g:pencil#autoformat')
  let g:pencil#autoformat = 1
 en

-if !exists('g:pencil#autoformat_blacklist')
-  " by default, pencil does NOT start autoformat if inside any of
-  " the following syntax groups
+if !exists('g:pencil#autoformat_config')
+  " Do not activate autoformat if entering Insert mode when
+  " the cursor is inside any of the following syntax groups.
  "
  " markdown* (tpope/vim-markdown)
  " mkd*, htmlH[0-9] (plasticboy/vim-markdown)
@@ -67,59 +71,66 @@ if !exists('g:pencil#autoformat_blacklist')
  " mmdTable[A-Za-z0-9]* (mattly/vim-markdown-enhancements)
  " txtCode (timcharper/textile.vim)
  " rst*,tex*,asciidoc* (syntax file shipped with vim)
-  let g:pencil#autoformat_blacklist = [
-        \ 'markdownCode',
-        \ 'markdownH[0-9]',
-        \ 'markdownUrl',
-        \ 'markdownIdDeclaration',
-        \ 'markdownLink',
-        \ 'markdownRule',
-        \ 'markdownHighlight[A-Za-z0-9]+',
-        \ 'mkdCode',
-        \ 'mkdRule',
-        \ 'htmlH[0-9]',
-        \ 'mkdIndentCode',
-        \ 'markdownFencedCodeBlock',
-        \ 'markdownInlineCode',
-        \ 'mmdTable[A-Za-z0-9]*',
-        \ 'txtCode',
-        \ 'rstCodeBlock',
-        \ 'rstDirective',
-        \ 'rstLiteralBlock',
-        \ 'rstSections',
-        \ 'texBeginEndName',
-        \ 'texDelimiter',
-        \ 'texDocType',
-        \ 'texInputFile',
-        \ 'texMath',
-        \ 'texRefZone',
-        \ 'texSection$',
-        \ 'texTitle',
-        \ 'asciidocAttribute',
-        \ 'asciidocList',
-        \ 'asciidocLiteral',
-        \ 'asciidoc[A-Za-z]*Block',
-        \ 'asciidoc[A-Za-z]*Macro',
-        \ 'asciidoc[A-Za-z]*Title',
-        \ ]
+  let g:pencil#autoformat_config = {
+        \   'markdown': {
+        \     'black': [
+        \       'htmlH[0-9]',
+        \       'markdown(Code|H[0-9]|Url|IdDeclaration|Link|Rule|Highlight[A-Za-z0-9]+)',
+        \       'markdown(FencedCodeBlock|InlineCode)',
+        \       'mkd(Code|Rule|Delimiter|Link|ListItem|IndentCode|Snippet)',
+        \       'mmdTable[A-Za-z0-9]*',
+        \     ],
+        \     'white': [
+        \      'markdown(Code|Link)',
+        \     ],
+        \   },
+        \   'asciidoc': {
+        \     'black': [
+        \       'asciidoc(AttributeList|AttributeEntry|ListLabel|Literal|SideBar|Source|Sect[0-9])',
+        \       'asciidoc[A-Za-z]*(Block|Macro|Title)',
+        \     ],
+        \     'white': [
+        \      'asciidoc(AttributeRef|Macro)',
+        \     ],
+        \     'enforce-previous-line': 1,
+        \   },
+        \   'rst': {
+        \     'black': [
+        \       'rst(CodeBlock|Directive|LiteralBlock|Sections)',
+        \     ],
+        \   },
+        \   'tex': {
+        \     'black': [
+        \       'tex(BeginEndName|Delimiter|DocType|InputFile|Math|RefZone|Statement|Title)',
+        \       'texSection$',
+        \     ],
+        \     'enforce-previous-line': 1,
+        \   },
+        \   'textile': {
+        \     'black': [
+        \       'txtCode',
+        \     ],
+        \   },
+        \   'pandoc': {
+        \     'black': [
+        \       '^pandoc.*Code.*',
+        \       'pandocHTML',
+        \       'pandocLaTeXMathBlock',
+        \       '^pandoc.*List.*',
+        \       '^pandoc.*Table.*',
+        \       'pandocYAMLHeader',
+        \     ],
+        \   }
+        \ }
 en
-let g:pencil#autoformat_blacklist_re =
-  \ '\v(' . join(g:pencil#autoformat_blacklist, '|') . ')'
-
-if !exists('g:pencil#autoformat_inline_whitelist')
-  " grant autoformat a reprieve (allow enabling) if any of
-  " following syntax groups doesn't dominate the whole line
-  "
-  "'markdownCode' (tpope/vim-markdown)
-  let g:pencil#autoformat_inline_whitelist = [
-        \ 'markdownCode',
-        \ 'markdownLink',
-        \ 'asciidocMacro',
-        \ 'asciidocQuotedMonospaced',
-        \ ]
+if !exists('g:pencil#autoformat_aliases')
+  " Aliases used exclusively for autoformat config.
+  " Pencil will NOT modify the filetype setting.
+  let g:pencil#autoformat_aliases = {
+        \    'md': 'markdown',
+        \    'mkd': 'markdown',
+        \  }
 en
-let g:pencil#autoformat_inline_whitelist_re =
-  \ '\v(' . join(g:pencil#autoformat_inline_whitelist, '|') . ')'

 if !exists('g:pencil#joinspaces')
  " by default, only one space after full stop (.)
@@ -159,9 +170,9 @@ en
 if !exists('g:pencil#mode_indicators')
  " used to set PencilMode() for statusline
  if s:unicode_enabled()
-    let g:pencil#mode_indicators = {'hard': '␍', 'soft': '⤸', 'off': '',}
+    let g:pencil#mode_indicators = {'hard': '␍', 'auto': 'ª', 'soft': '⤸', 'off': '',}
  el
-    let g:pencil#mode_indicators = {'hard': 'H', 'soft': 'S', 'off': '',}
+    let g:pencil#mode_indicators = {'hard': 'H', 'auto': 'A', 'soft': 'S', 'off': '',}
  en
 en

@@ -169,23 +180,24 @@ en

 com -nargs=0 Pencil         call pencil#init({'wrap': 'on' })
 com -nargs=0 PencilOff      call pencil#init({'wrap': 'off' })
+com -nargs=0 NoPencil       call pencil#init({'wrap': 'off' })
+com -nargs=0 HardPencil     call pencil#init({'wrap': 'hard'})
 com -nargs=0 PencilHard     call pencil#init({'wrap': 'hard'})
+com -nargs=0 SoftPencil     call pencil#init({'wrap': 'soft'})
 com -nargs=0 PencilSoft     call pencil#init({'wrap': 'soft'})
 com -nargs=0 PencilToggle   call pencil#init({'wrap': 'toggle'})
+com -nargs=0 TogglePencil   call pencil#init({'wrap': 'toggle'})
 com -nargs=0 PFormat        call pencil#setAutoFormat(1)
 com -nargs=0 PFormatOff     call pencil#setAutoFormat(0)
 com -nargs=0 PFormatToggle  call pencil#setAutoFormat(-1)

-" NOTE: legacy commands will be disabled by default at some point
+" NOTE: legacy commands have been disabled by default as of 31-Dec-15
+"       These will be removed entirely on 31-Dec-16
 if !exists('g:pencil#legacyCommands')
-  let g:pencil#legacyCommands = 1
+  let g:pencil#legacyCommands = 0
 en
 if g:pencil#legacyCommands
-  com -nargs=0 HardPencil    call pencil#init({'wrap': 'hard'})
-  com -nargs=0 SoftPencil    call pencil#init({'wrap': 'soft'})
  com -nargs=0 DropPencil    call pencil#init({'wrap': 'off' })
-  com -nargs=0 NoPencil      call pencil#init({'wrap': 'off' })
-  com -nargs=0 TogglePencil  call pencil#init({'wrap': 'toggle'})
  com -nargs=0 AutoPencil    call pencil#setAutoFormat(1)
  com -nargs=0 ManualPencil  call pencil#setAutoFormat(0)
  com -nargs=0 ShiftPencil   call pencil#setAutoFormat(-1)
Author	SHA1	Message	Date
Reed Es	4e0f08de17	Merge pull request #74 from actionless/patch-1 markdown comment syntax	2019-08-30 11:49:13 -06:00
Reed Es	0205f78aac	Merge pull request #78 from BlueDrink9/patch-1 fix #77 Map gk in soft mode	2019-08-30 11:47:48 -06:00
BlueDrink9	013587c347	fix #77 Map gk in soft mode	2019-05-02 17:25:24 +12:00
Yauhen Kirylau	68a8d0f3e4	markdown comment syntax	2019-03-11 07:52:52 +01:00
Reed Esau	2dcd974b72	Merge pull request #58 from zorab47/patch-1 Fix broken blog links in readme	2017-06-14 16:03:18 -06:00
Charles Maresh	aeba287111	Fix broken links due to remote site changes Updates links to remote blogs due to their owners changing the URLs. I was unable to find a working site for "Writing with Vim (2015) - by Pat Ambrosio". It was removed.	2017-06-13 10:15:03 -05:00
Reed Esau	6d01570f94	Merge branch 'master' of https://github.com/reedes/vim-pencil	2017-01-11 18:23:26 -07:00
Reed Esau	443187995a	misc formatting and notes on markdownsyntax behavior	2017-01-11 18:22:07 -07:00
Reed Esau	a5dbd88f30	Merge pull request #53 from ExMember/pandoc-support Add vim-pandoc support	2017-01-11 18:03:34 -07:00
Damien Burke	9ad784bc23	Add vim-pandoc support Do not autoformat code, HTML, LaTeX math blocks, lists, tables or YAML in pandoc documents.	2017-01-02 22:37:32 -08:00
Reed Esau	fd75347422	mkdNonListItemBlock shouldn't be blacklisted	2016-10-05 23:29:52 -06:00
Reed Esau	f113c8c929	Blacklist updates for plasticboy markdown syntax	2016-10-02 23:40:51 -06:00
Reed Esau	3e8b6f3417	Various minor fixes to documentation	2016-09-02 11:10:08 -06:00
Reed Esau	670c62c39e	Various improvements to initialization Added example of initializing by function.	2016-09-01 10:56:48 -06:00
Reed Esau	99e2499500	Improve wording and formatting.	2016-08-18 14:10:42 -06:00
Reed Esau	f5f456ccdc	New optional key mapping to suspend autoformat #48 When using hard line break mode, autoformat is enabled by default. Blacklisting is the existing mechanism to suspend autoformat for code blocks. You can now optionally map a buffer-scoped 'modifier' key to suspend autoformat for the Insert. Also simplified README by moving things to the advanced section.	2016-08-17 11:32:38 -06:00
Reed Esau	cc63b20e03	Added mention of new danielbmarques/vim-ditto plugin	2016-07-30 19:05:18 -06:00
Reed Esau	f1df0f3030	Merge branch 'master' of https://github.com/reedes/vim-pencil	2016-07-30 18:57:12 -06:00
Reed Esau	735cc3b24e	Additional tips on formatting paragraphs	2016-07-30 18:56:58 -06:00
Reed Esau	a4ad656d68	Removed <buffer> from manual autoformat mapping examples	2016-07-11 18:42:41 -06:00
Reed Esau	ad18a74cf0	Blacklisting texStatement, per #43	2016-06-29 20:09:26 -06:00
Reed Esau	470f9ca44c	ongoing	2016-06-13 17:08:16 -06:00
Reed Esau	f9cbfca887	ongoing	2016-06-11 15:13:24 -06:00
Reed Esau	01a3a95c72	Merge branch 'master' of https://github.com/reedes/vim-pencil	2016-06-10 21:26:31 -06:00
Reed Esau	08ee355694	map <cr> only if not already mapped	2016-06-10 21:26:23 -06:00
Reed Esau	2f62713ed9	Merge pull request #44 from noqqe/master Compatibility changes for vim 7.2 in colorcolumn	2016-06-10 21:22:14 -06:00
Florian Baumann	5e6ba37a94	Compatibility changes for vim 7.2 in colorcolumn	2016-06-09 12:17:46 +02:00
Reed Esau	ebbfc350b8	Disable legacy commands by default, as per schedule	2016-01-03 13:27:13 -07:00
Reed Esau	b36e21556d	More improvements to blogger/developer mentions	2015-09-17 13:24:04 -06:00
Reed Esau	4e82b996e4	Added another blogger mention of pencil	2015-09-16 12:46:12 -06:00
Reed Esau	6b6c2f08bf	Added blogger mentions of pencil	2015-09-14 13:59:01 -06:00
Reed Esau	dd8321a2d5	Additional changes for #33 , file type specific autoformat config	2015-09-07 12:18:19 -06:00
Reed Esau	f89a3ac998	Blacklist (and whitelist) config by file type	2015-09-07 00:26:37 -06:00
Reed Esau	290b0872d0	Added 'auto' mode indicator to fix #18 An indicator to show that Vim's autoformat is activated while in HardPencil mode.	2015-09-07 00:19:42 -06:00
Reed Esau	632ae63c2c	Removed MarkdownOrderedListMarker from default blacklist Numbered whole paragraphs makes for a strong use case to keep Vim's autoformat enabled.	2015-09-05 12:46:25 -06:00
Reed Esau	5f819bfec0	Sentence rewording	2015-05-06 02:01:56 -06:00
Reed Esau	45f4c46cfe	Better behavior for #31 , autoformat lists in Markdown For tpope's markdown syntax, restored standard autoformat behavior for unordered lists, which is generally pretty good. Ordered lists had annoying behavior for autoformat, so simply disabling autoformat if detected when insert is entered. This isn't ideal, but it's not clear what else can be done now. Fixed bug for PFormatToggle, where it wasn't properly disabling Vim's autoformat. Provided help in README for mapping key to toggle autoformat.	2015-05-06 00:56:49 -06:00
Reed Esau	536311e98c	Blacklist markdownListMarker #31 To make it easier to add new items to a list in HardPencil mode	2015-04-24 00:17:48 -06:00
Reed Esau	c465e30c19	Improve autoformat support for asciidoc #28 For all document types, autoformat blacklisting now sneaks a look a the start of the previous line, to allow for non-heading text to immediately follow, without autoformat being engaged in a way that will cause the heading to be captured in the auto formatted text.	2015-03-15 16:04:30 -06:00
Reed Esau	320c7fc284	Reprieve for original HardPencil and SoftPencil commands PencilHard and PencilSoft benefited from autocomplete when you didn't know the commands, but they are awkward when you do know the commands. So, there's PencilHard and HardPencil. PencilSoft and SoftPencil PencilToggle and TogglePencil PencilOff and NoPencil Additional blacklist adjustment for the plasticboy plugin, though I'll be doing more work in the coming weeks to get things tuned better.	2015-01-30 13:57:35 -07:00
Reed Esau	02283c81e6	Addl blacklist to better support plasticboy/markdown	2015-01-29 00:36:44 -07:00
Reed Esau	96546d4b17	minor rewording and formatting	2015-01-28 23:36:58 -07:00