-
Notifications
You must be signed in to change notification settings - Fork 64
Add missing doc #524
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add missing doc #524
Changes from 3 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
*vital/Mapping.txt* Utilities for mapping. | ||
*vital/Mapping.txt* Utilities for mapping / abbreviation. | ||
|
||
Maintainer: tyru <[email protected]> | ||
|
||
|
@@ -12,14 +12,129 @@ INTERFACE |Vital.Mapping-interface| | |
============================================================================== | ||
INTRODUCTION *Vital.Mapping-introduction* | ||
|
||
*Vital.Mapping* is TODO | ||
*Vital.Mapping* is a utility functions related to |:map|, |:unmap|, | ||
|:abbreviate|, |:unabbreviate| commands. | ||
|
||
============================================================================== | ||
INTERFACE *Vital.Mapping-interface* | ||
------------------------------------------------------------------------------ | ||
FUNCTIONS *Vital.Mapping-functions* | ||
|
||
TODO | ||
*Mapping.execute_abbr_command()* | ||
execute_abbr_command({mode}, {dict}, {lhs}, {rhs}) | ||
Execute `get_abbr_command(mode, dict, lhs, rhs)` result. | ||
See |Mapping.get_abbr_command()|. | ||
|
||
*Mapping.execute_map_command()* | ||
execute_map_command({mode}, {dict}, {lhs}, {rhs}) | ||
Execute `get_map_command(mode, dict, lhs, rhs)` result. | ||
See |Mapping.get_map_command()|. | ||
|
||
*Mapping.execute_unmap_command()* | ||
execute_unmap_command({mode}, {dict}, {lhs}) | ||
Execute `get_unmap_command(mode, dict, lhs)` result. | ||
See |Mapping.get_unmap_command()|. | ||
|
||
*Mapping.get_all_modes()* | ||
get_all_modes() | ||
Returns string which represents all mode characters ("noiclxs"). | ||
NOTE: "v" is not contained. Because "x" and "s" already mean "v". | ||
|
||
*Mapping.get_all_modes_list()* | ||
get_all_modes_list() | ||
Returns |List| which represents all mode characters. | ||
Same as `split(get_all_modes(), '\zs')` . | ||
See |Mapping.get_all_modes()|. | ||
|
||
*Mapping.get_abbr_command()* | ||
get_abbr_command({mode}, {dict}, {lhs}, {rhs}) | ||
Constructs |:abbreviate| command string. | ||
{mode} is a character of mode. | ||
{dict} is a |Dictionary| of options. | ||
{lhs} and {rhs} are strings of lhs/rhs of |:map| command. | ||
The options can be created by |Mapping.options_chars2dict()| or | ||
|maparg()|'s return value when {dict} is non-zero. | ||
|
||
*Mapping.get_map_command()* | ||
get_map_command({mode}, {dict}, {lhs}, {rhs}) | ||
Constructs |:map| command string. | ||
{mode} is a character of mode. | ||
{dict} is a |Dictionary| of options. | ||
{lhs} and {rhs} are strings of lhs/rhs of |:map| command. | ||
The options can be created by |Mapping.options_chars2dict()| or | ||
|maparg()|'s return value when {dict} is non-zero. | ||
|
||
*Mapping.get_unabbr_command()* | ||
get_unabbr_command({mode}, {dict}, {lhs}) | ||
Constructs |:unabbreviate| command string. | ||
{mode} is a character of mode. | ||
{dict} is a |Dictionary| of options. | ||
{lhs} is a string of lhs of |:map| command. | ||
The options can be created by |Mapping.options_chars2dict()| or | ||
|maparg()|'s return value when {dict} is non-zero. | ||
|
||
*Mapping.get_unmap_command()* | ||
get_unmap_command({mode}, {dict}, {lhs}) | ||
Constructs |:unabbreviate| command string. | ||
{mode} is a character of mode. | ||
{dict} is a |Dictionary| of options. | ||
{lhs} is a string of lhs of |:map| command. | ||
The options can be created by |Mapping.options_chars2dict()| or | ||
|maparg()|'s return value when {dict} is non-zero. | ||
|
||
*Mapping.options_chars2dict()* | ||
options_chars2dict({chars}) | ||
{chars} is a string which represents characters of options. | ||
The return value is a |Dictionary| which is same as |maparg()|'s | ||
return value when {dict} is non-zero. | ||
|
||
chars key ~ | ||
"e" expr | ||
"b" buffer | ||
"s" silent | ||
"S" script | ||
"u" unique | ||
"r" noremap (inverse) | ||
"n" nowait | ||
|
||
Example: > | ||
options_chars2dict("bs") = { | ||
"expr": 0, | ||
"buffer": 1, | ||
"silent": 1, | ||
"script": 0, | ||
"unique": 0, | ||
"noremap": 1, | ||
"nowait": 0, | ||
} | ||
< | ||
*Mapping.options_chars2raw()* | ||
options_chars2raw({chars}) | ||
Same as `options_dict2raw(options_chars2dict(chars))` . | ||
See |Mapping.options_dict2raw()| and |Mapping.options_chars2dict()|. | ||
|
||
Example: > | ||
options_dict2chars('eb') = '<expr><buffer>' | ||
< | ||
*Mapping.options_dict2chars()* | ||
options_dict2chars({dict}) | ||
Converts {dict} to characters of options. | ||
|
||
Example: > | ||
options_dict2chars({'expr': 1, 'buffer': 1}) = 'eb' | ||
< | ||
*Mapping.options_dict2raw()* | ||
options_dict2raw({dict}) | ||
{dict} is a |Dictionary| which represents options. | ||
See |Mapping.options_chars2dict()| for the options. | ||
|
||
Example: > | ||
options_dict2raw({'expr': 1, 'buffer': 1}) = '<expr><buffer>' | ||
< | ||
*Mapping.is_mode_char()* | ||
is_mode_char({char}) | ||
Returns non-zero if {char} is a character one of | ||
"v", "n", "o", "i", "c", "l", "x", "s". | ||
|
||
============================================================================== | ||
vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
*vital/Web/URI/HTTP.txt* http scheme handler for Web.URI | ||
|
||
Maintainer: tyru <[email protected]> | ||
|
||
============================================================================== | ||
CONTENTS *Vital.Web.URI.HTTP-contents* | ||
|
||
INTRODUCTION |Vital.Web.URI.HTTP-introduction| | ||
INTERFACE |Vital.Web.URI.HTTP-interface| | ||
Functions |Vital.Web.URI.HTTP-functions| | ||
|
||
============================================================================== | ||
INTRODUCTION *Vital.Web.URI.HTTP-introduction* | ||
|
||
*Vital.Web.URI.HTTP* is a http scheme handler for |Vital.Web.URI|. | ||
|
||
============================================================================== | ||
INTERFACE *Vital.Web.URI.HTTP-interface* | ||
------------------------------------------------------------------------------ | ||
FUNCTIONS *Vital.Web.URI.HTTP-functions* | ||
|
||
canonicalize({uri}) *Vital.Web.URI.HTTP.canonicalize()* | ||
Canonicalizes {uri}. {uri} is a |Vital.Web.URI-URI| object. | ||
|
||
* Set '/' to its path if its path is empty | ||
* If its port is the same as a default port of http scheme (80), | ||
make the URI's port empty | ||
|
||
For example, the following four URIs are equivalent: | ||
* http://example.com | ||
* http://example.com/ | ||
* http://example.com:/ | ||
* http://example.com:80/ | ||
This function canonicalizes them to http://example.com/ . | ||
|
||
ref. https://tools.ietf.org/html/rfc3986#section-6.2.3 | ||
|
||
default_port() | ||
*Vital.Web.URI.HTTP.default_port()* | ||
Returns a string of a default port of http scheme ("80"). | ||
|
||
============================================================================== | ||
vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
以下全て、タグに
Vital.
がないです。There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh... 修正しました