mirror of
https://github.com/preservim/vim-pencil.git
synced 2025-11-08 09:53:49 -05:00
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.
This commit is contained in:
@@ -8,9 +8,6 @@
|
||||

|
||||
- - -
|
||||
|
||||
[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
|
||||
@@ -76,13 +73,18 @@ tool in expressing yourself. For more details on vi-style editing, see...
|
||||
|
||||
# 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:
|
||||
@@ -143,7 +145,7 @@ git clone https://github.com/reedes/vim-pencil
|
||||
|
||||
## Basic initialization
|
||||
|
||||
Initializing _pencil_ by `FileType` is optional, though doing so will
|
||||
Initializing _pencil_ by `FileType` is _optional_, though doing so will
|
||||
automatically set up your buffers for editing prose.
|
||||
|
||||
Add support for your desired filetypes to your `.vimrc`:
|
||||
@@ -208,21 +210,21 @@ if auto-detect might suggest soft line wrap.
|
||||
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
|
||||
* `PencilOff` (or `NoPencil`) - removes navigation mappings and restores buffer to global settings
|
||||
* `PencilToggle` (or `TogglePencil`) - 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)
|
||||
* `SoftPencil` (or `PencilSoft`) - initialize _pencil_ with soft line wrap mode
|
||||
* `HardPencil` (or `PencilHard`) - initialize _pencil_ with hard line break mode (and Vim’s autoformat)
|
||||
|
||||
## 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
|
||||
When inserting text while in *HardPencil* mode, Vim’s autoformat feature
|
||||
will be enabled by default and can offer many of the same benefits as
|
||||
soft line wrap.
|
||||
|
||||
@@ -276,7 +278,7 @@ nnoremap <silent> Q gwip
|
||||
|
||||
## Default textwidth
|
||||
|
||||
You can configure the textwidth to be used in **PencilHard** mode when no
|
||||
You can configure the textwidth to be used in **HardPencil** 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`:
|
||||
|
||||
@@ -353,7 +355,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
|
||||
@@ -413,7 +415,7 @@ statements into a function.
|
||||
|
||||
### Autoformat blacklisting
|
||||
|
||||
_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
|
||||
@@ -442,7 +444,6 @@ let g:pencil#autoformat_blacklist = [
|
||||
\ 'mkdRule',
|
||||
\ 'mkdDelimiter',
|
||||
\ 'mkdLink',
|
||||
\ 'mkdNonListItemBlock',
|
||||
\ 'mkdIndentCode',
|
||||
\ 'htmlH[0-9]',
|
||||
\ 'markdownFencedCodeBlock',
|
||||
|
||||
@@ -79,7 +79,7 @@ if !exists('g:pencil#autoformat_blacklist')
|
||||
\ 'mkdRule',
|
||||
\ 'mkdDelimiter',
|
||||
\ 'mkdLink',
|
||||
\ 'mkdNonListItemBlock',
|
||||
\ 'mkdListItem',
|
||||
\ 'mkdIndentCode',
|
||||
\ 'htmlH[0-9]',
|
||||
\ 'markdownFencedCodeBlock',
|
||||
@@ -172,23 +172,23 @@ 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 will be disabled by default on 31-Dec-15
|
||||
if !exists('g:pencil#legacyCommands')
|
||||
let g:pencil#legacyCommands = 1
|
||||
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)
|
||||
|
||||
Reference in New Issue
Block a user