Would be nice if vim plugins which provided help files said so in an einfo. Best way to handle this is probably to update pkg_postinst in the vim-plugin eclass to check for a VIM_PLUGIN_HELPFILE and display a "This plugin provides a help file. Please use :help $VIM_PLUGIN_HELPFILE for more information." or somesuch...
Created attachment 38712 [details, diff] vim-plugin-eclass-helpfiles.patch Lets vim plugins specify VIM_PLUGIN_HELPFILES. For example: VIM_PLUGIN_HELPFILES="align-manual align-maps" gives an einfo like: * * This plugin provides documentation via vim's help system. To * view it, use: * :help align-manual * :help align-maps *
Created attachment 38717 [details, diff] updated vim-plugin-eclass-helpfiles.patch For plugins which don't provide a help file, we could use VIM_PLUGIN_HELPTEXT to display a short usage message. So: VIM_PLUGIN_HELPTEXT=( \ "To use this plugin, press the tab key whilst in insert mode. Words" \ "will be autocompleted as per ctrl+n. Completion mode can be changed" \ "using ctrl+x. To insert an actual tab character, either use ctrl+v" \ "tab or enter a space followed by a tab." \ ) when no VIM_PLUGIN_HELPFILES is available will give: * * To use this plugin, press the tab key whilst in insert mode. Words * will be autocompleted as per ctrl+n. Completion mode can be changed * using ctrl+x. To insert an actual tab character, either use ctrl+v * tab or enter a space followed by a tab. *
Created attachment 38758 [details, diff] updated vim-plugin-eclass-helpfiles.patch As per Aron's suggestions, switch to using [[ ]] over [ ] and kill the array syntax. Multiline strings can be used instead now.
Eclass updated. Variables for most things in app-vim set.
