From 9e31143b66cc44a93f3e369b671ace64e38bb8a5 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 12 Nov 2017 22:41:23 +1300 Subject: Apply boilerplate to Vim plugin docs The DESCRIPTION heading for each of these is filled out now, but some of them probably need a bit more explanation. The mail_mutt.txt plugin is good, though. --- vim/doc/auto_backupdir.txt | 26 ++++++++++++++++++----- vim/doc/auto_swapdir.txt | 30 ++++++++++++++++++++------ vim/doc/auto_undodir.txt | 32 +++++++++++++++++++++------- vim/doc/big_file_options.txt | 26 ++++++++++++++++++----- vim/doc/command_typos.txt | 28 ++++++++++++++++++------ vim/doc/copy_linebreak.txt | 32 +++++++++++++++++++++------- vim/doc/detect_background.txt | 28 ++++++++++++++++++------ vim/doc/fixed_join.txt | 30 ++++++++++++++++++++------ vim/doc/strip_trailing_whitespace.txt | 26 ++++++++++++++++++----- vim/doc/toggle_option_flag.txt | 40 +++++++++++++++++++++++++---------- 10 files changed, 230 insertions(+), 68 deletions(-) (limited to 'vim') diff --git a/vim/doc/auto_backupdir.txt b/vim/doc/auto_backupdir.txt index c5b6ebad..2990332e 100644 --- a/vim/doc/auto_backupdir.txt +++ b/vim/doc/auto_backupdir.txt @@ -1,12 +1,28 @@ -*auto_backupdir.txt* Automatically create 'backupdir' in 'realtimepath' +*auto_backupdir.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *auto_backupdir* This plugin attempts to create a directory "backup" in the directory named by the first element of 'realtimepath', and enables 'backup' with that as the 'backupdir' if it succeeds or if the directory already exists. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *auto_backupdir-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *auto_backupdir-author* + +Written and maintained by Tom Ryder . + +LICENSE *auto_backupdir-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *auto_backupdir-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/auto_swapdir.txt b/vim/doc/auto_swapdir.txt index f88cfcf3..a5b8f274 100644 --- a/vim/doc/auto_swapdir.txt +++ b/vim/doc/auto_swapdir.txt @@ -1,12 +1,28 @@ -*auto_swapdir.txt* Automatically create 'swapdir' in 'realtimepath' +*auto_swapdir.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *auto_swapdir* -This plugin attempts to create a directory "swap" in the directory named by the -first element of 'realtimepath', and enables 'swapfile' with that as the +This plugin attempts to create a directory "swap" in the directory named by +the first element of 'runtimepath', and enables 'swapfile' with that as the 'directory' if it succeeds or if the directory already exists. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *auto_swapdir-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *auto_swapdir-author* + +Written and maintained by Tom Ryder . + +LICENSE *auto_swapdir-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *auto_swapdir-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/auto_undodir.txt b/vim/doc/auto_undodir.txt index c782a70e..451bea66 100644 --- a/vim/doc/auto_undodir.txt +++ b/vim/doc/auto_undodir.txt @@ -1,14 +1,30 @@ -*auto_undodir.txt* Automatically create 'undodir' in 'realtimepath' +*auto_undodir.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *auto_undodir* -This plugin attempts to create a directory "undo" in the directory named by the -first element of 'realtimepath', and enables 'undofile' with that as the +This plugin attempts to create a directory "undo" in the directory named by +the first element of 'runtimepath', and enables 'undofile' with that as the 'undodir' if it succeeds or if the directory already exists. -It requires the +persistent_undo feature. +It requires the |+persistent_undo| feature. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *auto_undodir-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *auto_undodir-author* + +Written and maintained by Tom Ryder . + +LICENSE *auto_undodir-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *auto_undodir-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/big_file_options.txt b/vim/doc/big_file_options.txt index 706ba5a7..cab0664e 100644 --- a/vim/doc/big_file_options.txt +++ b/vim/doc/big_file_options.txt @@ -1,12 +1,28 @@ -*big_file_options.txt* Disable slow options for big files for faster load +*big_file_options.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *big_file_options* This plugin adds an |autocmd| hook to check the file size of an incoming buffer, and if it's over a certain threshold, disables certain options in order to make the file a bit easier to edit. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *big_file_options-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *big_file_options-author* + +Written and maintained by Tom Ryder . + +LICENSE *big_file_options-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *big_file_options-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/command_typos.txt b/vim/doc/command_typos.txt index 93f37df9..0bd7c336 100644 --- a/vim/doc/command_typos.txt +++ b/vim/doc/command_typos.txt @@ -1,12 +1,28 @@ -*command_typos.txt* Bind capital-letter versions of common commands +*command_typos.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *command_typos* -This plugin defines custom commands like :W, :Qa, and :Wq to match their +This plugin defines custom commands like `:W`, `:Qa`, and `:Wq` to match their lowercase analogues, to forgive me when my pinky finger doesn't roll off the Shift key quite soon enough after pressing the colon key. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *command_typos-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *command_typos-author* + +Written and maintained by Tom Ryder . + +LICENSE *command_typos-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *command_typos-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt index 15e4b1b0..f9aacfb4 100644 --- a/vim/doc/copy_linebreak.txt +++ b/vim/doc/copy_linebreak.txt @@ -1,7 +1,6 @@ -*copy_linebreak.txt* Mapping to toggle copy-paste friendly linebreak options +*copy_linebreak.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *copy_linebreak* This plugin provides mapping targets for a user to set, unset, or toggle |'linebreak'|-related settings when |'wrap'| is enabled, to switch between @@ -9,17 +8,34 @@ human-readable output and a format friendly for copy-pasting with terminal emulators or screen/tmux. Mappings: - +> CopyLinebreakEnable CopyLinebreakDisable CopyLinebreakToggle - +< Commands: - +> :CopyLinebreakEnable :CopyLinebreakDisable :CopyLinebreakToggle -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *copy_linebreak-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *copy_linebreak-author* + +Written and maintained by Tom Ryder . + +LICENSE *copy_linebreak-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *copy_linebreak-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/detect_background.txt b/vim/doc/detect_background.txt index ed122aee..55992288 100644 --- a/vim/doc/detect_background.txt +++ b/vim/doc/detect_background.txt @@ -1,9 +1,8 @@ -*detect_background.txt* Figure out 'background' with a bias towards "dark" +*detect_background.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *detect_background* -The detect_background#DetectBackground() function provided by this plugin +The |detect_background#DetectBackground()| function provided by this plugin inspects the $COLORFGBG environment variable to determine whether the user is using a terminal with a light background, and returns the word "dark" or "light" accordingly, for use in setting 'background'. @@ -15,6 +14,23 @@ hints otherwise. Note that this plugin does not inspect the value of the $TERM environment variable or the |'term'| option at all, nor the |'t_RB'| option. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *detect_background-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *detect_background-author* + +Written and maintained by Tom Ryder . + +LICENSE *detect_background-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *detect_background-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/fixed_join.txt b/vim/doc/fixed_join.txt index 834a3569..7bfb6c8b 100644 --- a/vim/doc/fixed_join.txt +++ b/vim/doc/fixed_join.txt @@ -1,17 +1,33 @@ -*fixed_join.txt* Join lines in normal mode without moving cursor +*fixed_join.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *fixed_join* This plugin provides a mapping target FixedJoin to create a binding for a -user to join lines in normal mode without the cursor jumping around. If the +user to `:join` lines in normal mode without the cursor jumping around. If the user's configuration does not specify a mapping to this target by the time this plugin is loaded, it will attempt to map 'J' in normal mode to simply replace the default functionality. -The plugin also provides a :FixedJoin command if you have +user_commands, but +The plugin also provides a `:FixedJoin` command if you have |+user_commands|, but this is not required. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *fixed_join-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *fixed_join-author* + +Written and maintained by Tom Ryder . + +LICENSE *fixed_join-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *fixed_join-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/strip_trailing_whitespace.txt b/vim/doc/strip_trailing_whitespace.txt index d50fbfb7..f7ea1a95 100644 --- a/vim/doc/strip_trailing_whitespace.txt +++ b/vim/doc/strip_trailing_whitespace.txt @@ -1,7 +1,6 @@ -*strip_trailing_whitespace.txt* Strip trailing whitespace from whole buffer +*strip_trailing_whitespace.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *strip_trailing_whitespace* This plugin is the author's approach to stripping trailing whitespace from an entire buffer, including empty lines at the end, without making command noise @@ -10,6 +9,23 @@ and without moving the cursor from its current position. If also provides a :StripTrailingWhitespace command if you have +user_commands, but this is not required. -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +REQUIREMENTS *strip_trailing_whitespace-requirements* + +This plugin is only available if 'compatible' is not set. + +AUTHOR *strip_trailing_whitespace-author* + +Written and maintained by Tom Ryder . + +LICENSE *strip_trailing_whitespace-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *strip_trailing_whitespace-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: diff --git a/vim/doc/toggle_option_flag.txt b/vim/doc/toggle_option_flag.txt index 9415ae6b..928a233b 100644 --- a/vim/doc/toggle_option_flag.txt +++ b/vim/doc/toggle_option_flag.txt @@ -1,17 +1,35 @@ -*toggle_option_flag.txt* Commands to toggle option flags +*toggle_option_flag.txt* For Vim version 7.0 Last change: 2017 November 12 -Author: Tom Ryder -License: Same terms as Vim itself (see |license|) +DESCRIPTION *toggle_option_flag* -This plugin provides commands :ToggleOptionFlag and :ToggleOptionFlagLocal to -toggle the values of options like |'formatoptions'| or |'complete'| that have -values comprised of single-character or comma-separated flags. The author +This plugin provides commands `:ToggleOptionFlag` and `:ToggleOptionFlagLocal` +to toggle the values of options like |'formatoptions'| or |'complete'| that +have values comprised of single-character or comma-separated flags. The author originally designed it for toggling flags in |'formatoptions'| quickly. - :ToggleOptionFlag formatoptions a - :ToggleOptionFlag switchbuf useopen - :ToggleOptionFlagLocal shortmess I +EXAMPLES *toggle_option_flag-examples* +> + :ToggleOptionFlag formatoptions a + :ToggleOptionFlag switchbuf useopen + :ToggleOptionFlagLocal shortmess I +< +REQUIREMENTS *toggle_option_flag-requirements* -This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +This plugin is only available if 'compatible' is not set. + +AUTHOR *toggle_option_flag-author* + +Written and maintained by Tom Ryder . + +LICENSE *toggle_option_flag-license* + +Licensed for distribution under the same terms as Vim itself (see |license|). + +DISTRIBUTION *toggle_option_flag-distribution* + +This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun off into a separate distribution as it solidifies and this documentation -improves. +improves. See for more +information. + + vim:tw=78:ts=8:ft=help:norl: -- cgit v1.2.3