Built in Documentation

Every plugin implemented in vy is self documented. A good way to get help is through the help python function and dir function.

List installed plugins

Set an output target on an AreaVi instance then execute the python code below:

print dir(vyapp.plugins)

Print plugin help

In order to get builtin help for the main_jumps plugin one would set the output target on an AreaVi instance then run the python code below:

help(vyapp.plugins.main_jumps) 

Then it will output the docs for the plugin.

Help on module vyapp.plugins.main_jumps in vyapp.plugins:

NAME
    vyapp.plugins.main_jumps

FILE
    /usr/local/lib/python2.7/dist-packages/vyapp/plugins/main_jumps.py

DESCRIPTION
    Overview
    ========
    
    This plugin implements the basic cursor movements.
    
    Usage
    =====
    
    The way to move the cursor up is by pressing <Key-k>, to move the cursor down <Key-j>,
    to move the cursor left <Key-h>, to move the cursor right <Key-l>. These events
    work in NORMAL mode.
    
    keycommands
    ============
    
    Mode: NORMAL
    Event: <Key-j> 
    Description: Move the cursor one line down.
    
    
    Mode: NORMAL
    Event: <Key-k> 
    Description: Move the cursor one line up.
    
    
    Mode: NORMAL
    Event: <Key-h> 
    Description: Move the cursor one character left.
    
    
    Mode: NORMAL
    Event: <Key-l> 
    Description: Move the cursor one character right.

FUNCTIONS
    install(area)

---