m-vim_plugins/vim-easy-align
1
0
Fork 0
mirror of https://github.com/junegunn/vim-easy-align.git synced 2025-11-10 10:53:49 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Junegunn Choi
2014-05-31 02:59:14 +09:00
parent da281d78d3
commit cc8966c0a5
2 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -85,7 +85,7 @@ Usage
### Concept of _alignment rule_ ### Concept of _alignment rule_
easy-align can align lines of text around any delimiter, but it provides Though easy-align can align lines of text around any delimiter, it provides
shortcuts for the most common use cases with the concept of "_alignment rule_". shortcuts for the most common use cases with the concept of "_alignment rule_".
An *alignment rule* is a predefined set of options for common alignment tasks, An *alignment rule* is a predefined set of options for common alignment tasks,
@@ -95,11 +95,11 @@ which is identified by a single character, *DELIMITER KEY*, such as `<Space>`,
Think of it as a shortcut. Instead of writing regular expression and setting Think of it as a shortcut. Instead of writing regular expression and setting
several options, you can just type in a single character. several options, you can just type in a single character.
### Starting easy-align ### Execution models
There are two ways to start easy-align. There are two ways to use easy-align.
#### 1. With `<Plug>` mappings #### 1. Using `<Plug>` mappings
The recommended method is to use `<Plug>` mappings as described earlier. The recommended method is to use `<Plug>` mappings as described earlier.
@@ -115,17 +115,17 @@ The recommended method is to use `<Plug>` mappings as described earlier.
If you prefer command-line or do not want to start interactive mode, you can use If you prefer command-line or do not want to start interactive mode, you can use
`:EasyAlign` command instead. `:EasyAlign` command instead.
| Mode | Command | | Mode | Command |
| ------------------------------------- | ------------------------------------------------ | | ------------------------------------------ | ------------------------------------------------ |
| Interactive mode | `:EasyAlign[!] [OPTIONS]` | | Interactive mode | `:EasyAlign[!] [OPTIONS]` |
| Live interactive mode | `:LiveEasyAlign[!] [...]` | | Live interactive mode | `:LiveEasyAlign[!] [...]` |
| Non-interactive (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` | | Non-interactive mode (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` |
| Non-interactive (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` | | Non-interactive mode (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` |
### Interactive mode ### Interactive mode
The following sections will assume that you have the following mappings in your The following sections will assume that you have `<Plug>(EasyAlign)` mappings in
.vimrc: your .vimrc as below:
```vim ```vim
" Start interactive EasyAlign in visual mode (e.g. vip<Enter>) " Start interactive EasyAlign in visual mode (e.g. vip<Enter>)
@@ -370,7 +370,7 @@ There are 4 ways to set alignment options (from lowest precedence to highest):
With `filter` option, you can align lines that only match or do not match a With `filter` option, you can align lines that only match or do not match a
given pattern. There are several ways to set the pattern. given pattern. There are several ways to set the pattern.
1. Press `CTRL-F` in interactive mode and input `g/pat/` or `v/pat/` 1. Press `CTRL-F` in interactive mode and type in `g/pat/` or `v/pat/`
2. In command-line, it can be written in dictionary format: `{'filter': 'g/pat/'}` 2. In command-line, it can be written in dictionary format: `{'filter': 'g/pat/'}`
3. Or in shorthand notation: `g/pat/` or `v/pat/` 3. Or in shorthand notation: `g/pat/` or `v/pat/`

34
doc/easy_align.txt
View File

@@ -10,8 +10,8 @@ VIM-EASY-ALIGN - TABLE OF CONTENTS *easyalign* *easy-align* *easy-align-
TLDR - One-minute guide |easy-align-4| TLDR - One-minute guide |easy-align-4|
Usage |easy-align-5| Usage |easy-align-5|
Concept of alignment rule |easy-align-5-1| Concept of alignment rule |easy-align-5-1|
Starting easy-align |easy-align-5-2| Execution models |easy-align-5-2|
1. With <Plug> mappings |easy-align-5-2-1| 1. Using <Plug> mappings |easy-align-5-2-1|
2. Using :EasyAlign command |easy-align-5-2-2| 2. Using :EasyAlign command |easy-align-5-2-2|
Interactive mode |easy-align-5-3| Interactive mode |easy-align-5-3|
Predefined alignment rules |easy-align-5-3-1| Predefined alignment rules |easy-align-5-3-1|
@@ -153,7 +153,7 @@ USAGE *easy-align-usage*
*easy-align-concept-of-alignment-rule* *easy-align-concept-of-alignment-rule*
*easy-align-5-1* *easy-align-5-1*
easy-align can align lines of text around any delimiter, but it provides Though easy-align can align lines of text around any delimiter, it provides
shortcuts for the most common use cases with the concept of "alignment rule". shortcuts for the most common use cases with the concept of "alignment rule".
An alignment rule is a predefined set of options for common alignment tasks, An alignment rule is a predefined set of options for common alignment tasks,
@@ -164,15 +164,15 @@ Think of it as a shortcut. Instead of writing regular expression and setting
several options, you can just type in a single character. several options, you can just type in a single character.
< Starting easy-align >_______________________________________________________~ < Execution models >__________________________________________________________~
*starting-easy-align* *easy-align-execution-models*
*easy-align-5-2* *easy-align-5-2*
There are two ways to start easy-align. There are two ways to use easy-align.
1. With <Plug> mappings~ 1. Using <Plug> mappings~
*easy-align-1-with-plug-mappings* *easy-align-1-using-plug-mappings*
*easy-align-5-2-1* *easy-align-5-2-1*
The recommended method is to use <Plug> mappings as described earlier. The recommended method is to use <Plug> mappings as described earlier.
@@ -196,20 +196,20 @@ The recommended method is to use <Plug> mappings as described earlier.
If you prefer command-line or do not want to start interactive mode, you can If you prefer command-line or do not want to start interactive mode, you can
use `:EasyAlign` command instead. use `:EasyAlign` command instead.
Mode | Command~ Mode | Command~
------------------------------------- | ------------------------------------------------ ------------------------------------------ | ------------------------------------------------
Interactive mode | `:EasyAlign[!] [OPTIONS]` Interactive mode | `:EasyAlign[!] [OPTIONS]`
Live interactive mode | `:LiveEasyAlign[!] [...]` Live interactive mode | `:LiveEasyAlign[!] [...]`
Non-interactive (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` Non-interactive mode (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]`
Non-interactive (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` Non-interactive mode (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]`
< Interactive mode >__________________________________________________________~ < Interactive mode >__________________________________________________________~
*easy-align-interactive-mode* *easy-align-interactive-mode*
*easy-align-5-3* *easy-align-5-3*
The following sections will assume that you have the following mappings in your The following sections will assume that you have <Plug>(EasyAlign) mappings in
.vimrc: your .vimrc as below:
> >
" Start interactive EasyAlign in visual mode (e.g. vip<Enter>) " Start interactive EasyAlign in visual mode (e.g. vip<Enter>)
vmap <Enter> <Plug>(EasyAlign) vmap <Enter> <Plug>(EasyAlign)
@@ -480,7 +480,7 @@ There are 4 ways to set alignment options (from lowest precedence to highest):
With `filter` option, you can align lines that only match or do not match a With `filter` option, you can align lines that only match or do not match a
given pattern. There are several ways to set the pattern. given pattern. There are several ways to set the pattern.
1. Press CTRL-F in interactive mode and input `g/pat/` or `v/pat/` 1. Press CTRL-F in interactive mode and type in `g/pat/` or `v/pat/`
2. In command-line, it can be written in dictionary format: `{'filter': 'g/pat/'}` 2. In command-line, it can be written in dictionary format: `{'filter': 'g/pat/'}`
3. Or in shorthand notation: `g/pat/` or `v/pat/` 3. Or in shorthand notation: `g/pat/` or `v/pat/`