From b2773467137be4f76a1efa25203fb05411fa9d95 Mon Sep 17 00:00:00 2001 From: Tom Date: Fri, 17 Jan 2014 13:10:12 +0100 Subject: [PATCH] docs --- doc/tplugin.txt | 156 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 132 insertions(+), 24 deletions(-) diff --git a/doc/tplugin.txt b/doc/tplugin.txt index 185f768..270dadf 100755 --- a/doc/tplugin.txt +++ b/doc/tplugin.txt @@ -173,30 +173,35 @@ Also available via git: http://github.com/tomtom/tplugin_vim/ ======================================================================== Contents~ - g:tplugin_autoload ................. |g:tplugin_autoload| - g:tplugin_menu_prefix .............. |g:tplugin_menu_prefix| - g:tplugin_file ..................... |g:tplugin_file| - g:tplugin_load_plugin .............. |g:tplugin_load_plugin| - :TPlugin ........................... |:TPlugin| - :TPluginRoot ....................... |:TPluginRoot| - :TPluginScan ....................... |:TPluginScan| - :TPluginBefore ..................... |:TPluginBefore| - :TPluginAfter ...................... |:TPluginAfter| - :TPluginUpdate ..................... |:TPluginUpdate| - TPluginMap ......................... |TPluginMap()| - TPluginFunction .................... |TPluginFunction()| - TPluginCommand ..................... |TPluginCommand()| - TPluginAddRoots .................... |TPluginAddRoots()| - TPluginDependencies ................ |TPluginDependencies()| - TPluginVimEnter .................... |TPluginVimEnter()| - g:tplugin#autoload_exclude ......... |g:tplugin#autoload_exclude| - g:tplugin#scan ..................... |g:tplugin#scan| - g:tplugin#shallow_scan ............. |g:tplugin#shallow_scan| - g:tplugin#show_helptags_errors ..... |g:tplugin#show_helptags_errors| - tplugin#ScanRoots .................. |tplugin#ScanRoots()| - g:tplugin#vcsdo#script ............. |g:tplugin#vcsdo#script| - g:tplugin#vcsdo#log_buffer ......... |g:tplugin#vcsdo#log_buffer| - g:tplugin#vcsdo#exclude_roots_rx ... |g:tplugin#vcsdo#exclude_roots_rx| + g:tplugin_autoload .......................... |g:tplugin_autoload| + g:tplugin_menu_prefix ....................... |g:tplugin_menu_prefix| + g:tplugin_file .............................. |g:tplugin_file| + g:tplugin_load_plugin ....................... |g:tplugin_load_plugin| + :TPlugin .................................... |:TPlugin| + :TPluginRoot ................................ |:TPluginRoot| + :TPluginScan ................................ |:TPluginScan| + :TPluginBefore .............................. |:TPluginBefore| + :TPluginAfter ............................... |:TPluginAfter| + :TPluginUpdate .............................. |:TPluginUpdate| + TPluginMap .................................. |TPluginMap()| + TPluginFunction ............................. |TPluginFunction()| + TPluginCommand .............................. |TPluginCommand()| + TPluginAddRoots ............................. |TPluginAddRoots()| + TPluginDependencies ......................... |TPluginDependencies()| + TPluginVimEnter ............................. |TPluginVimEnter()| + g:tplugin#autoload_exclude .................. |g:tplugin#autoload_exclude| + g:tplugin#scan .............................. |g:tplugin#scan| + g:tplugin#shallow_scan ...................... |g:tplugin#shallow_scan| + g:tplugin#show_helptags_errors .............. |g:tplugin#show_helptags_errors| + tplugin#ScanRoots ........................... |tplugin#ScanRoots()| + g:tplugin#vcsdo#script ...................... |g:tplugin#vcsdo#script| + g:tplugin#vcsdo#log_buffer .................. |g:tplugin#vcsdo#log_buffer| + g:tplugin#vcsdo#exclude_roots_rx ............ |g:tplugin#vcsdo#exclude_roots_rx| + g:tplugin#autoload_exclude .................. |g:tplugin#autoload_exclude| + g:tplugin#scan .............................. |g:tplugin#scan| + g:tplugin#shallow_scan ...................... |g:tplugin#shallow_scan| + g:tplugin#show_helptags_errors .............. |g:tplugin#show_helptags_errors| + tplugin#ScanRoots ........................... |tplugin#ScanRoots()| ======================================================================== @@ -427,6 +432,39 @@ tplugin#ScanRoots(immediate, roots, shallow_roots, args) Search in autoload/tplugin/autoload/*.vim for prefabricated autoload definitions. The file's basenames are repo names. + *g:tplugin#autoload_exclude* +g:tplugin#autoload_exclude (default: ['tplugin']) + A list of repositories for which autoload is disabled when running + |:TPluginScan|. + + *g:tplugin#scan* +g:tplugin#scan (default: 'cfptham_') + The default value for |:TPluginScan|. A set of identifiers + determining the information being collected: + c ... commands + f ... functions + p ... maps + t ... filetypes + h ... helptags if not available + a ... autoload + m ... parse vim-addon-manager metadata + _ ... include _tplugin.vim files + all ... all of the above + + *g:tplugin#shallow_scan* +g:tplugin#shallow_scan (default: 'hm') + + *g:tplugin#show_helptags_errors* +g:tplugin#show_helptags_errors (default: 1) + If true, show errors when running :helptags. + + *tplugin#ScanRoots()* +tplugin#ScanRoots(immediate, roots, shallow_roots, args) + Write autoload information for each root directory to + "ROOT/_tplugin.vim". + Search in autoload/tplugin/autoload/*.vim for prefabricated autoload + definitions. The file's basenames are repo names. + ======================================================================== autoload/tplugin/vcsdo.vim~ @@ -445,5 +483,75 @@ g:tplugin#vcsdo#exclude_roots_rx (default: '') Don't update root directories matching this |regexp|. +======================================================================== +autoload/tplugin.vim~ + + *g:tplugin#autoload_exclude* +g:tplugin#autoload_exclude (default: ['tplugin']) + A list of repositories for which autoload is disabled when running + |:TPluginScan|. + + *g:tplugin#scan* +g:tplugin#scan (default: 'cfptham_') + The default value for |:TPluginScan|. A set of identifiers + determining the information being collected: + c ... commands + f ... functions + p ... maps + t ... filetypes + h ... helptags if not available + a ... autoload + m ... parse vim-addon-manager metadata + _ ... include _tplugin.vim files + all ... all of the above + + *g:tplugin#shallow_scan* +g:tplugin#shallow_scan (default: 'hm') + + *g:tplugin#show_helptags_errors* +g:tplugin#show_helptags_errors (default: 1) + If true, show errors when running :helptags. + + *tplugin#ScanRoots()* +tplugin#ScanRoots(immediate, roots, shallow_roots, args) + Write autoload information for each root directory to + "ROOT/_tplugin.vim". + Search in autoload/tplugin/autoload/*.vim for prefabricated autoload + definitions. The file's basenames are repo names. + + *g:tplugin#autoload_exclude* +g:tplugin#autoload_exclude (default: ['tplugin']) + A list of repositories for which autoload is disabled when running + |:TPluginScan|. + + *g:tplugin#scan* +g:tplugin#scan (default: 'cfptham_') + The default value for |:TPluginScan|. A set of identifiers + determining the information being collected: + c ... commands + f ... functions + p ... maps + t ... filetypes + h ... helptags if not available + a ... autoload + m ... parse vim-addon-manager metadata + _ ... include _tplugin.vim files + all ... all of the above + + *g:tplugin#shallow_scan* +g:tplugin#shallow_scan (default: 'hm') + + *g:tplugin#show_helptags_errors* +g:tplugin#show_helptags_errors (default: 1) + If true, show errors when running :helptags. + + *tplugin#ScanRoots()* +tplugin#ScanRoots(immediate, roots, shallow_roots, args) + Write autoload information for each root directory to + "ROOT/_tplugin.vim". + Search in autoload/tplugin/autoload/*.vim for prefabricated autoload + definitions. The file's basenames are repo names. + + vim:tw=78:fo=tcq2:isk=!-~,^*,^|,^":ts=8:ft=help:norl: