From 1facfe407ff501917457c83ce1b5b47dc6d640a9 Mon Sep 17 00:00:00 2001 From: Ted Pavlic Date: Fri, 2 Jan 2009 11:37:07 -0500 Subject: [PATCH] Several edits to help docs to clarify when plugins are loaded and what can cause them to not be loaded. --- vimperator/locale/en-US/options.txt | 5 +++- vimperator/locale/en-US/repeat.txt | 8 +++--- vimperator/locale/en-US/starting.txt | 38 +++++++++++++++------------- 3 files changed, 29 insertions(+), 22 deletions(-) diff --git a/vimperator/locale/en-US/options.txt b/vimperator/locale/en-US/options.txt index 961a013d..cc77492c 100644 --- a/vimperator/locale/en-US/options.txt +++ b/vimperator/locale/en-US/options.txt @@ -470,7 +470,10 @@ ____ |\'nolpl'| |\'lpl'| |\'noloadplugins'| |\'loadplugins'| ||'loadplugins' 'lpl'|| boolean (default on) ____ -Load plugin scripts when starting up. +Load plugin scripts when starting up. When on, yet unloaded plugins are +automatically loaded after the vimperatorrc file has been sourced. To +load plugins earlier, use the [c]:loadplugins[c] command within the +vimperatorrc. ____ diff --git a/vimperator/locale/en-US/repeat.txt b/vimperator/locale/en-US/repeat.txt index 9c3c72d4..afdda5e6 100644 --- a/vimperator/locale/en-US/repeat.txt +++ b/vimperator/locale/en-US/repeat.txt @@ -95,9 +95,11 @@ ________________________________________________________________________________ |:lpl| |:loadplugins| ||:loadplugins|| + ________________________________________________________________________________ -Load all unloaded plugins immediately. This is useful both for sourcing new -plugins without restarting vimperator, and making sure that a plugin is loaded -so that you can use its commands from your vimperatorrc. +Load all unloaded plugins immediately. Because plugins are automatically +loaded after vimperatorrc is sourced, this command must be placed early +in the vimperatorrc file if vimperatorrc also includes commands that are +implemented by plugins. Additionally, this command allows for sourcing +new plugins without restarting vimperator. ________________________________________________________________________________ diff --git a/vimperator/locale/en-US/starting.txt b/vimperator/locale/en-US/starting.txt index e25d2306..b971a2f4 100644 --- a/vimperator/locale/en-US/starting.txt +++ b/vimperator/locale/en-US/starting.txt @@ -5,33 +5,35 @@ be documented here. section:Initialization[initialization,startup] -At startup Vimperator can perform user initialization commands. When one of -the following is successfully located, it is executed, and no further -locations are tried. +At startup, Vimperator completes the following tasks in order. +1. Vimperator can perform user initialization commands. When +one of the following is successfully located, it is executed, and no +further locations are tried. |$VIMPERATOR_INIT| -1. _$VIMPERATOR_INIT_ -- May contain a single ex command, usually - [c]:source {file}[c]. -2. [a]\~/_vimperatorrc[a] -- Windows only. If this file exists, its contents + a. _$VIMPERATOR_INIT_ -- May contain a single ex command (e.g., + "[c]:source {file}[c]"). + b. [a]\~/_vimperatorrc[a] -- Windows only. If this file exists, its contents are executed. -3. [a]\~/.vimperatorrc[a] -- If this file exists, its contents are executed. + c. [a]\~/.vimperatorrc[a] -- If this file exists, its contents are executed. -If 'exrc' is set then any RC file in the current directory is also sourced. +2. If 'exrc' is set, then any RC file in the current directory is also sourced. -The plugin directory can be in any of the directories in 'runtimepath'. - -All directories in 'runtimepath' are searched for a "plugin" subdirectory and -all are loaded. For each plugin directory all *.\{js,vimp} files (including -those in further subdirectories) are sourced alphabetically. - -Plugins will not be sourced if 'noloadplugins' is set. +3. All directories in 'runtimepath' are searched for a "plugin" +subdirectory and all yet unloaded plugins are loaded. For each plugin +directory, all *.\{js,vimp} files (including those in further +subdirectories) are sourced alphabetically. No plugins will be sourced +if 'noloadplugins' is set. Any particular plugin will not be loaded if +it has already been loaded (e.g., by an earlier [c]:loadplugins[c] +command). The user's ~ (i.e., "home") directory is determined as follows: -* Unix and Mac -- _$HOME_ is used. -* Windows -- if _%HOME%_ is set then this is used, otherwise _%USERPROFILE%_ or finally -_%HOMEDRIVE%%HOMEPATH%_. +* On Unix and Mac, the environment variable _$HOME_ is used. +* On Windows, Vimperator checks for the existence of _%HOME%_, then +_%USERPROFILE%_, and then _%HOMEDRIVE%%HOMEPATH%_. It uses the first one +it finds. section:Saving{nbsp}settings[save-settings]