aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-04 17:57:39 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-04 17:59:54 +1300
commitdae845727dbb3a7f91137d85d322ee475d604289 (patch)
tree4fe5abe81f0ce3087dc38ec69a9cad36222b840a
parent562c9ce6fbbd6fc8b9c5e470121dcc8e731de21e (diff)
downloaddotfiles-dae845727dbb3a7f91137d85d322ee475d604289.tar.gz
dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.zip
Add short documentation for new custom plugins
I'm using the plugin_name.txt syntax suggested by the Vim documentation. That may change in future as I study plugins written by experienced authors like Tim Pope. There will almost certainly be a lot more detail to add to each of these.
-rw-r--r--vim/doc/command_typos.txt12
-rw-r--r--vim/doc/copy_linebreak.txt13
-rw-r--r--vim/doc/detect_background.txt14
-rw-r--r--vim/doc/fixed_join.txt11
-rw-r--r--vim/doc/flag_toggle.txt15
-rw-r--r--vim/doc/strip_trailing_whitespace.txt12
6 files changed, 77 insertions, 0 deletions
diff --git a/vim/doc/command_typos.txt b/vim/doc/command_typos.txt
new file mode 100644
index 00000000..93f37df9
--- /dev/null
+++ b/vim/doc/command_typos.txt
@@ -0,0 +1,12 @@
+*command_typos.txt* Bind capital-letter versions of common commands
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+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
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt
new file mode 100644
index 00000000..c8463386
--- /dev/null
+++ b/vim/doc/copy_linebreak.txt
@@ -0,0 +1,13 @@
+*copy_linebreak.txt* Mapping to toggle copy-paste friendly linebreak options
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin provides a mapping target <Plug>CopyLinebreak to create a binding
+for a user to quickly toggle |'linebreak'|-related settings when |'wrap'| is
+enabled, to switch between human-readable output and a format friendly for
+copy-pasting with terminal emulators or screen/tmux.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/detect_background.txt b/vim/doc/detect_background.txt
new file mode 100644
index 00000000..ad42221c
--- /dev/null
+++ b/vim/doc/detect_background.txt
@@ -0,0 +1,14 @@
+*detect_background.txt* Figure out 'background' with a bias towards "dark"
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin inspects the $COLORFGBG environment variable to determine whether
+the user is using a terminal with a light background. It reverses Vim's
+built-in attempts to do this, which have the opposite default.
+
+It does not inspect the value of the $TERM variable or |'term'| at all.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/fixed_join.txt b/vim/doc/fixed_join.txt
new file mode 100644
index 00000000..0ee957d0
--- /dev/null
+++ b/vim/doc/fixed_join.txt
@@ -0,0 +1,11 @@
+*fixed_join.txt* Mapping to join lines in normal mode without moving cursor
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin provides a mapping target <Plug>FixedJoin to create a binding for a
+user to join lines in normal mode without the cursor jumping around.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
diff --git a/vim/doc/flag_toggle.txt b/vim/doc/flag_toggle.txt
new file mode 100644
index 00000000..5f1b504a
--- /dev/null
+++ b/vim/doc/flag_toggle.txt
@@ -0,0 +1,15 @@
+*flag_toggle.txt* Functions to toggle single-character flags in options
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+This plugin provides functions flag_toggle#Toggle(option, flag) and
+flag_toggle#ToggleLocal(option, flag) to toggle the values of options like
+|'formatoptions'| or |'complete'| that have values comprised of
+single-character flags. The author originally designed it for toggling flags in
+|'formatoptions'| quickly.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.
+
diff --git a/vim/doc/strip_trailing_whitespace.txt b/vim/doc/strip_trailing_whitespace.txt
new file mode 100644
index 00000000..670877c9
--- /dev/null
+++ b/vim/doc/strip_trailing_whitespace.txt
@@ -0,0 +1,12 @@
+*strip_trailing_whitespace.txt* Strip trailing whitespace from whole buffer
+
+Author: Tom Ryder <tom@sanctum.geek.nz>
+License: Same terms as Vim itself (see |license|)
+
+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
+and without moving the cursor from its current position.
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+off into a separate distribution as it solidifies and this documentation
+improves.