Archives
/
nvim-libmodal
mirror of https://github.com/Iron-E/nvim-libmodal
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve doc consistency

Browse Source
pull/3/head release/0.3.0
Iron-E 4 years ago
parent 6622013b34
commit e285be6ff6
No known key found for this signature in database
GPG Key ID: 19B71B7B7B021D22
2 changed files with 46 additions and 21 deletions
Show Stats Download Patch File Download Diff File

51
doc/libmodal-lua.txt
Unescape Escape View File

@ -30,6 +30,7 @@ This is the base of |libmodal|. It can be imported using: >
local libmodal = require('libmodal') local libmodal = require('libmodal')
<if |libmodal| is in your 'runtimepath'. <if |libmodal| is in your 'runtimepath'.
------------------------------------------------------------------------------
MODULES *libmodal-lua-modules* MODULES *libmodal-lua-modules*
* `libmodal` * `libmodal`
@ -51,6 +52,7 @@ MODULES *libmodal-lua-modules*
These are global variables used throughout the project. They are never These are global variables used throughout the project. They are never
modified and never meant TO be modified. modified and never meant TO be modified.
------------------------------------------------------------------------------
VARIABLES *libmodal-lua-globals-variables* VARIABLES *libmodal-lua-globals-variables*
`globals`.DEFAULT_ERROR_TITLE *libmodal-lua-globals.DEFAULT_ERROR_TITLE* `globals`.DEFAULT_ERROR_TITLE *libmodal-lua-globals.DEFAULT_ERROR_TITLE*
@ -132,6 +134,7 @@ VARIABLES *libmodal-lua-globals-variables*
1 1
------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-globals-functions* FUNCTIONS *libmodal-lua-globals-functions*
`globals`.isFalse({val}) *libmodal-lua-globals.isFalse()* `globals`.isFalse({val}) *libmodal-lua-globals.isFalse()*
@ -223,6 +226,7 @@ keybinding:expression pairs.
See: |libmodal-mode| for more information. See: |libmodal-mode| for more information.
------------------------------------------------------------------------------
VARIABLES *libmodal-lua-ParseTable-variables* VARIABLES *libmodal-lua-ParseTable-variables*
`ParseTable`.CR *libmodal-lua-ParseTable.CR* `ParseTable`.CR *libmodal-lua-ParseTable.CR*
@ -235,7 +239,7 @@ VARIABLES *libmodal-lua-ParseTable-variables*
Value: ~ Value: ~
13 13
------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-ParseTable-functions* FUNCTIONS *libmodal-lua-ParseTable-functions*
`ParseTable`.new({userTable}) *libmodal-lua-ParseTable.new()* `ParseTable`.new({userTable}) *libmodal-lua-ParseTable.new()*
@ -370,13 +374,14 @@ FUNCTIONS *libmodal-lua-ParseTable-functions*
{tableToUnite}. {tableToUnite}.
============================================================================= =============================================================================
4. `libmodal.utils` *libmodal-lua-utils* 4. `libmodal.utils` *libmodal-lua-utils*
Provides extra utilities to the |libmodal| library. Provides extra utilities to the |libmodal| library.
FUNCTIONS *libmodal-lua-utils-functions* ------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-utils-functions*
`utils`.showError({pcallErr}) *libmodal-lua-utils.showError* `utils`.showError({pcallErr}) *libmodal-lua-utils.showError()*
Show an error from `pcall()`. Show an error from `pcall()`.
@ -401,15 +406,16 @@ FUNCTIONS *libmodal-lua-utils-functions*
< <
============================================================================= =============================================================================
4.1. `libmodal.utils.api` *libmodal-lua-api* 4.1. `libmodal.utils.api` *libmodal-lua-api*
Provides extensions to the `vim.api` |Lua| library. Provides extensions to the `vim.api` |Lua| library.
See: |API|. See: |API|.
FUNCTIONS *libmodal-lua-api-functions* ------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-api-functions*
`api`.nvim_bell() *libmodal-lua-api.nvim_bell()* `api`.nvim_bell() *libmodal-lua-api.nvim_bell()*
Make vim ring the visual/audio bell, if it is enabled. Make vim ring the visual/audio bell, if it is enabled.
@ -426,7 +432,7 @@ FUNCTIONS *libmodal-lua-api-functions*
'visualbell' For bell settings. 'visualbell' For bell settings.
`api`.nvim_exists({scope}, {var}) *libmodal-lua-api.nvim_exists()* `api`.nvim_exists({scope}, {var}) *libmodal-lua-api.nvim_exists()*
Check whether or not some |variable| exists. Check whether or not some |variable| exists.
@ -538,6 +544,7 @@ Allows for the creation of a default "Help" table.
By default, this "Help" is shown by pressing `?` in a |libmodal-mode| or by By default, this "Help" is shown by pressing `?` in a |libmodal-mode| or by
entering "help" into a |libmodal-prompt|. entering "help" into a |libmodal-prompt|.
------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-Help-functions* FUNCTIONS *libmodal-lua-Help-functions*
`Help`.new({commandsOrMaps}, {title}) *libmodal-lua-Help.new()* `Help`.new({commandsOrMaps}, {title}) *libmodal-lua-Help.new()*
@ -603,6 +610,7 @@ FUNCTIONS *libmodal-lua-Help-functions*
Provides creation sources for mode and prompt |echo| / |echohl| `string`s. Provides creation sources for mode and prompt |echo| / |echohl| `string`s.
------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-indicator-functions* FUNCTIONS *libmodal-lua-indicator-functions*
`Indicator`.mode({modeName}) *libmodal-lua-Indicator.mode()* `Indicator`.mode({modeName}) *libmodal-lua-Indicator.mode()*
@ -651,19 +659,20 @@ Several `vars` are created by default:
Name Use Name Use
------------------ ----------------------------------------------------- ------------------ -----------------------------------------------------
`vars.buffers` Buffers that hold |nvim_open_win()| text. `vars`.buffers Buffers that hold |nvim_open_win()| text.
`vars.combos` `ParseTable`s when |libmodal-mode|'s {instruction} is a `vars`.combos `ParseTable`s when |libmodal-mode|'s {instruction} is a
`table`. `table`.
`vars.completions` |libmodal-prompt| completions. `vars`.completions |libmodal-prompt| completions.
`vars.exit` |libmodal-mode|'s {supressExit}. `vars`.exit |libmodal-mode|'s {supressExit}.
`vars.input` Keeping user input history during |libmodal-mode|. `vars`.input Keeping user input history during |libmodal-mode|.
`vars.timeouts` Tracks if |libmodal-timeouts| are enabled for a mode. `vars`.timeouts Tracks if |libmodal-timeouts| are enabled for a mode.
`vars.timer` Tracks if there is an active |timer| for a mode. `vars`.timer Tracks if there is an active |timer| for a mode.
`vars.windows` Tracks |nvim_open_win()| handles. `vars`.windows Tracks |nvim_open_win()| handles.
------------------------------------------------------------------------------
VARIABLES *libmodal-lua-vars-variables* VARIABLES *libmodal-lua-vars-variables*
`vars`.libmodalTimeouts `vars`.libmodalTimeouts *libmodal-lua-vars.libmodalTimeouts*
The value of `g:libmodalTimeouts`. The value of `g:libmodalTimeouts`.
@ -673,7 +682,7 @@ VARIABLES *libmodal-lua-vars-variables*
Value: ~ Value: ~
`vim.api.nvim_get_var('libmodalTimeouts')` `vim.api.nvim_get_var('libmodalTimeouts')`
`self`.instances `self`.instances *libmodal-lua-vars.instances*
Instances of variables pertaining to a certain mode. Instances of variables pertaining to a certain mode.
@ -683,6 +692,7 @@ VARIABLES *libmodal-lua-vars-variables*
Value: ~ Value: ~
Starts as `{}`. Starts as `{}`.
------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-vars-functions* FUNCTIONS *libmodal-lua-vars-functions*
`self`:name({modeName}) *libmodal-lua-vars.name()* `self`:name({modeName}) *libmodal-lua-vars.name()*
@ -802,6 +812,7 @@ FUNCTIONS *libmodal-lua-vars-functions*
Tracks 'winheight' and 'winwidth' when created, so that it can be modified Tracks 'winheight' and 'winwidth' when created, so that it can be modified
freely and then restored later. freely and then restored later.
------------------------------------------------------------------------------
FUNCTIONS *libmodal-lua-WindowState-functions* FUNCTIONS *libmodal-lua-WindowState-functions*
`WindowState`.new() *libmodal-lua-WindowState.new()* `WindowState`.new() *libmodal-lua-WindowState.new()*

16
doc/libmodal.txt
Unescape Escape View File

@ -33,6 +33,7 @@ modes is also creator-defined, and is outlined in |libmodal-usage|.
See: |vim-modes| See: |vim-modes|
------------------------------------------------------------------------------
USE CASE *libmodal-use-case-example* USE CASE *libmodal-use-case-example*
As an |init.vim| configuration grows, it becomes harder to create keybindings As an |init.vim| configuration grows, it becomes harder to create keybindings
@ -108,6 +109,7 @@ Note: Examples for all topics covered here can be found in the "examples"
See: |api|, |lua-api|, https://github.com/Iron-E/nvim-tabmode See: |api|, |lua-api|, https://github.com/Iron-E/nvim-tabmode
------------------------------------------------------------------------------
FUNCTIONS *libmodal-usage-functions* FUNCTIONS *libmodal-usage-functions*
*libmodal-mode* *libmodal.mode.enter()* *libmodal-mode* *libmodal.mode.enter()*
@ -240,6 +242,7 @@ all be tested using the |luafile| |command|.
See: |libmodal-usage|, |libmodal-use-case|, |lua-require-example|. See: |libmodal-usage|, |libmodal-use-case|, |lua-require-example|.
------------------------------------------------------------------------------
MODES *libmodal-examples-mode* MODES *libmodal-examples-mode*
Using a callback `function`: > Using a callback `function`: >
@ -359,7 +362,7 @@ Using a |key-mapping| `table`: >
fooMode() fooMode()
< <
------------------------------------------------------------------------------
PROMPTS *libmodal-examples-prompt* PROMPTS *libmodal-examples-prompt*
Using a callback `function`: > Using a callback `function`: >
@ -395,6 +398,10 @@ Using a |command| `table`: >
============================================================================== ==============================================================================
4. Configuration *libmodal-configuration* 4. Configuration *libmodal-configuration*
The following specifies what settings may be used to configure
|libmodal-mode|s and |libmodal-prompt|s.
------------------------------------------------------------------------------
HIGHLIGHT GROUPS *libmodal-highlight-groups* HIGHLIGHT GROUPS *libmodal-highlight-groups*
@ -412,6 +419,7 @@ Note: `LibmodalStar`'s name — while not indicative of its use — is used for
when Neovim 0.5 launches that will introduce interoperaability between when Neovim 0.5 launches that will introduce interoperaability between
the two. the two.
------------------------------------------------------------------------------
TIMEOUTS *libmodal-timeouts* *g:libmodalTimeouts* TIMEOUTS *libmodal-timeouts* *g:libmodalTimeouts*
When `libmodal.mode.enter()`'s {instruction} argument is a `table`, mode When `libmodal.mode.enter()`'s {instruction} argument is a `table`, mode
@ -524,6 +532,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
============================================================================== ==============================================================================
7. Contributing *libmodal-contributing* 7. Contributing *libmodal-contributing*
The following describes what should be done if an individual wishes to
contribute something to the `Iron-E/nvim-libmodal` repository.
------------------------------------------------------------------------------
CODE *libmodal-contributing-code* CODE *libmodal-contributing-code*
Bugfixes ~ Bugfixes ~
@ -558,6 +570,7 @@ CODE *libmodal-contributing-code*
person who knows the most about the feature being implemented is most person who knows the most about the feature being implemented is most
likely the one implementing it. likely the one implementing it.
------------------------------------------------------------------------------
DOCUMENTATION *libmodal-contributing-documentation* DOCUMENTATION *libmodal-contributing-documentation*
If there is a problem with the documentation, or you see an area where it If there is a problem with the documentation, or you see an area where it
@ -566,6 +579,7 @@ least it will exist in history if such an issue comes up again, and likely it
will serve to help yourself and others with more clear and concise wording, or will serve to help yourself and others with more clear and concise wording, or
with more helpful and practical examples. with more helpful and practical examples.
------------------------------------------------------------------------------
ISSUES *libmodal-contributing-issues* ISSUES *libmodal-contributing-issues*
Issues are greatly welcomed on the GitHub repository, whether they are bug Issues are greatly welcomed on the GitHub repository, whether they are bug

Write Preview
Loading…
Cancel
Save