Skip to content

Commit

Permalink
Document the new augends
Browse files Browse the repository at this point in the history
  • Loading branch information
@f1rstlady
f1rstlady committed Jun 3, 2022
1 parent 25c855c commit 8b4efc3
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 26 deletions.
56 changes: 31 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,31 +263,37 @@ require("dial.config").augends:register_group{
}
```

|Alias Name |Explanation |Examples |
|------------------------------------------|-------------------------------------------------|-----------------------------------|
|`augend.integer.alias.decimal` |decimal natural number |`0`, `1`, ..., `9`, `10`, `11`, ...|
|`augend.integer.alias.decimal_int` |decimal integer (including negative number) |`0`, `314`, `-1592`, ... |
|`augend.integer.alias.hex` |hex natural number |`0x00`, `0x3f3f`, ... |
|`augend.integer.alias.octal` |octal natural number |`0o00`, `0o11`, `0o24`, ... |
|`augend.integer.alias.binary` |binary natural number |`0b0101`, `0b11001111`, ... |
|`augend.date.alias["%Y/%m/%d"]` |Date in the format `%Y/%m/%d` (`0` padding) |`2021/01/23`, ... |
|`augend.date.alias["%m/%d/%Y"]` |Date in the format `%m/%d/%Y` (`0` padding) |`23/01/2021`, ... |
|`augend.date.alias["%d/%m/%Y"]` |Date in the format `%d/%m/%Y` (`0` padding) |`01/23/2021`, ... |
|`augend.date.alias["%m/%d/%y"]` |Date in the format `%m/%d/%y` (`0` padding) |`01/23/21`, ... |
|`augend.date.alias["%d/%m/%y"]` |Date in the format `%d/%m/%y` (`0` padding) |`23/01/21`, ... |
|`augend.date.alias["%m/%d"]` |Date in the format `%m/%d` (`0` padding) |`01/04`, `02/28`, `12/25`, ... |
|`augend.date.alias["%-m/%-d"]` |Date in the format `%-m/%-d` (no paddings) |`1/4`, `2/28`, `12/25`, ... |
|`augend.date.alias["%Y-%m-%d"]` |Date in the format `%Y-%m-%d` (`0` padding) |`2021-01-04`, ... |
|`augend.date.alias["%Y年%-m月%-d日"]` |Date in the format `%Y年%-m月%-d日` (no paddings)|`2021年1月4日`, ... |
|`augend.date.alias["%Y年%-m月%-d日(%ja)"]`|Date in the format `%Y年%-m月%-d日(%ja)` |`2021年1月4日(月)`, ... |
|`augend.date.alias["%H:%M:%S"]` |Time in the format `%H:%M:%S` |`14:30:00`, ... |
|`augend.date.alias["%H:%M"]` |Time in the format `%H:%M` |`14:30`, ... |
|`augend.constant.alias.ja_weekday` |Japanese weekday |`月`, `火`, ..., `土`, `日` |
|`augend.constant.alias.ja_weekday_full` |Japanese full weekday |`月曜日`, `火曜日`, ..., `日曜日` |
|`augend.constant.alias.bool` |elements in boolean algebra (`true` and `false`) |`true`, `false` |
|`augend.constant.alias.alpha` |Lowercase alphabet letter (word) |`a`, `b`, `c`, ..., `z` |
|`augend.constant.alias.Alpha` |Uppercase alphabet letter (word) |`A`, `B`, `C`, ..., `Z` |
|`augend.semver.alias.semver` |Semantic version |`0.3.0`, `1.22.1`, `3.9.1`, ... |
|Alias Name |Explanation |Examples |
|------------------------------------------|-------------------------------------------------|------------------------------------|
|`augend.integer.alias.decimal` |decimal natural number |`0`, `1`, ..., `9`, `10`, `11`, ... |
|`augend.integer.alias.decimal_int` |decimal integer (including negative number) |`0`, `314`, `-1592`, ... |
|`augend.integer.alias.hex` |hex natural number |`0x00`, `0x3f3f`, ... |
|`augend.integer.alias.octal` |octal natural number |`0o00`, `0o11`, `0o24`, ... |
|`augend.integer.alias.binary` |binary natural number |`0b0101`, `0b11001111`, ... |
|`augend.date.alias["%Y/%m/%d"]` |Date in the format `%Y/%m/%d` (`0` padding) |`2021/01/23`, ... |
|`augend.date.alias["%m/%d/%Y"]` |Date in the format `%m/%d/%Y` (`0` padding) |`23/01/2021`, ... |
|`augend.date.alias["%d/%m/%Y"]` |Date in the format `%d/%m/%Y` (`0` padding) |`01/23/2021`, ... |
|`augend.date.alias["%m/%d/%y"]` |Date in the format `%m/%d/%y` (`0` padding) |`01/23/21`, ... |
|`augend.date.alias["%d/%m/%y"]` |Date in the format `%d/%m/%y` (`0` padding) |`23/01/21`, ... |
|`augend.date.alias["%m/%d"]` |Date in the format `%m/%d` (`0` padding) |`01/04`, `02/28`, `12/25`, ... |
|`augend.date.alias["%-m/%-d"]` |Date in the format `%-m/%-d` (no paddings) |`1/4`, `2/28`, `12/25`, ... |
|`augend.date.alias["%Y-%m-%d"]` |Date in the format `%Y-%m-%d` (`0` padding) |`2021-01-04`, ... |
|`augend.date.alias["%d.%m.%Y"]` |Date in the format `%d.%m.%Y` (`0` padding) |`01/23/2021`, ... |
|`augend.date.alias["%d.%m.%y"]` |Date in the format `%d.%m.%y` (`0` padding) |`23/01/21`, ... |
|`augend.date.alias["%d.%m."]` |Date in the format `%d.%m.` (`0` padding) |`01/04`, `02/28`, `12/25`, ... |
|`augend.date.alias["%-d/%-m."]` |Date in the format `%-d/%-m.` (no paddings) |`1/4`, `2/28`, `12/25`, ... |
|`augend.date.alias["%Y年%-m月%-d日"]` |Date in the format `%Y年%-m月%-d日` (no paddings)|`2021年1月4日`, ... |
|`augend.date.alias["%Y年%-m月%-d日(%ja)"]`|Date in the format `%Y年%-m月%-d日(%ja)` |`2021年1月4日(月)`, ... |
|`augend.date.alias["%H:%M:%S"]` |Time in the format `%H:%M:%S` |`14:30:00`, ... |
|`augend.date.alias["%H:%M"]` |Time in the format `%H:%M` |`14:30`, ... |
|`augend.constant.alias.de_weekday` |German weekday |`Mo`, `Di`, ..., `Sa`, `So` |
|`augend.constant.alias.de_weekday_full` |German full weekday |`Montag`, `Dienstag`, ..., `Sonntag`|
|`augend.constant.alias.ja_weekday` |Japanese weekday |`月`, `火`, ..., `土`, `日` |
|`augend.constant.alias.ja_weekday_full` |Japanese full weekday |`月曜日`, `火曜日`, ..., `日曜日` |
|`augend.constant.alias.bool` |elements in boolean algebra (`true` and `false`) |`true`, `false` |
|`augend.constant.alias.alpha` |Lowercase alphabet letter (word) |`a`, `b`, `c`, ..., `z` |
|`augend.constant.alias.Alpha` |Uppercase alphabet letter (word) |`A`, `B`, `C`, ..., `Z` |
|`augend.semver.alias.semver` |Semantic version |`0.3.0`, `1.22.1`, `3.9.1`, ... |


If you don't specify any settings, the following augends is set as the value of the `default` group.
Expand Down
42 changes: 41 additions & 1 deletion doc/dial.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,46 @@ Matches dates with the following format:
<
It matches non-existent dates and corrects them to the existent ones.

augend.date.alias["%d.%m.%Y"]~

Matches dates with the following format:
>
31.12.1970
01.01.2021
13.02.2021
<
It matches non-existent dates and corrects them to the existent ones.

augend.date.alias["%d.%m.%y"]~

Matches dates with the following format:
>
31.12.70
01.01.21
13.02.21
<
It matches non-existent dates and corrects them to the existent ones.

augend.date.alias["%d.%m."]~

Matches dates with the following format:
>
31.12.
01.01.
13.02.
<
It matches non-existent dates and corrects them to the existent ones.

augend.date.alias["%-d.%-m."]~

Matches dates with the following format:
>
31.12.
1.1.
13.2.
<
It matches non-existent dates and corrects them to the existent ones.

augend.date.alias["%Y年%-m月%-d日"]~

Matches dates with the following format:
Expand Down Expand Up @@ -955,7 +995,7 @@ MAPPING *dial-mapping*
left-hand.

In linweise VISUAL mode (|V|), this command works similarly in linewise
VISUAL mode, but the target is narrowed down to the selection.
VISUAL mode, but the target is narrowed down to the selection.

["x]<Plug>(dial-decrement) *<Plug>(dial-decrement)*
An alternative to the existing CTRL-X command in NORMAL mode.
Expand Down

0 comments on commit 8b4efc3

Please sign in to comment.