diff --git a/README.md b/README.md index c34bbf4..0893fe7 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ Usage ### 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_". 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 ``, Think of it as a shortcut. Instead of writing regular expression and setting 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 `` mappings +#### 1. Using `` mappings The recommended method is to use `` mappings as described earlier. @@ -115,17 +115,17 @@ The recommended method is to use `` mappings as described earlier. If you prefer command-line or do not want to start interactive mode, you can use `:EasyAlign` command instead. -| Mode | Command | -| ------------------------------------- | ------------------------------------------------ | -| Interactive mode | `:EasyAlign[!] [OPTIONS]` | -| Live interactive mode | `:LiveEasyAlign[!] [...]` | -| Non-interactive (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` | -| Non-interactive (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` | +| Mode | Command | +| ------------------------------------------ | ------------------------------------------------ | +| Interactive mode | `:EasyAlign[!] [OPTIONS]` | +| Live interactive mode | `:LiveEasyAlign[!] [...]` | +| Non-interactive mode (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` | +| Non-interactive mode (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` | ### Interactive mode -The following sections will assume that you have the following mappings in your -.vimrc: +The following sections will assume that you have `(EasyAlign)` mappings in +your .vimrc as below: ```vim " Start interactive EasyAlign in visual mode (e.g. vip) @@ -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 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/'}` 3. Or in shorthand notation: `g/pat/` or `v/pat/` diff --git a/doc/easy_align.txt b/doc/easy_align.txt index 878f11f..69cc48d 100644 --- a/doc/easy_align.txt +++ b/doc/easy_align.txt @@ -10,8 +10,8 @@ VIM-EASY-ALIGN - TABLE OF CONTENTS *easyalign* *easy-align* *easy-align- TLDR - One-minute guide |easy-align-4| Usage |easy-align-5| Concept of alignment rule |easy-align-5-1| - Starting easy-align |easy-align-5-2| - 1. With mappings |easy-align-5-2-1| + Execution models |easy-align-5-2| + 1. Using mappings |easy-align-5-2-1| 2. Using :EasyAlign command |easy-align-5-2-2| Interactive mode |easy-align-5-3| Predefined alignment rules |easy-align-5-3-1| @@ -153,7 +153,7 @@ USAGE *easy-align-usage* *easy-align-concept-of-alignment-rule* *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". 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. -< Starting easy-align >_______________________________________________________~ - *starting-easy-align* +< Execution models >__________________________________________________________~ + *easy-align-execution-models* *easy-align-5-2* -There are two ways to start easy-align. +There are two ways to use easy-align. -1. With mappings~ - *easy-align-1-with-plug-mappings* +1. Using mappings~ + *easy-align-1-using-plug-mappings* *easy-align-5-2-1* The recommended method is to use mappings as described earlier. @@ -196,20 +196,20 @@ The recommended method is to use mappings as described earlier. If you prefer command-line or do not want to start interactive mode, you can use `:EasyAlign` command instead. - Mode | Command~ - ------------------------------------- | ------------------------------------------------ - Interactive mode | `:EasyAlign[!] [OPTIONS]` - Live interactive mode | `:LiveEasyAlign[!] [...]` - Non-interactive (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` - Non-interactive (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` + Mode | Command~ + ------------------------------------------ | ------------------------------------------------ + Interactive mode | `:EasyAlign[!] [OPTIONS]` + Live interactive mode | `:LiveEasyAlign[!] [...]` + Non-interactive mode (predefined rules) | `:EasyAlign[!] [N-th] DELIMITER_KEY [OPTIONS]` + Non-interactive mode (regular expressions) | `:EasyAlign[!] [N-th] /REGEXP/ [OPTIONS]` < Interactive mode >__________________________________________________________~ *easy-align-interactive-mode* *easy-align-5-3* -The following sections will assume that you have the following mappings in your -.vimrc: +The following sections will assume that you have (EasyAlign) mappings in +your .vimrc as below: > " Start interactive EasyAlign in visual mode (e.g. vip) vmap (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 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/'}` 3. Or in shorthand notation: `g/pat/` or `v/pat/`