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/copy_linebreak.txt | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) (limited to 'vim/doc/copy_linebreak.txt') 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: -- cgit v1.2.3 From 3d5021d659d2864e484fe03f35d52adf2cb0c98b Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sun, 12 Nov 2017 23:19:33 +1300 Subject: Flesh out copy_linebreak.vim interface docs --- vim/doc/copy_linebreak.txt | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) (limited to 'vim/doc/copy_linebreak.txt') diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt index f9aacfb4..7efbad4b 100644 --- a/vim/doc/copy_linebreak.txt +++ b/vim/doc/copy_linebreak.txt @@ -7,22 +7,37 @@ This plugin provides mapping targets for a user to set, unset, or toggle human-readable output and a format friendly for copy-pasting with terminal emulators or screen/tmux. -Mappings: -> - CopyLinebreakEnable - CopyLinebreakDisable - CopyLinebreakToggle -< -Commands: -> - :CopyLinebreakEnable - :CopyLinebreakDisable - :CopyLinebreakToggle - REQUIREMENTS *copy_linebreak-requirements* This plugin is only available if 'compatible' is not set. +MAPPINGS *copy_linebreak-mappings* + +Mapping targets provided are: + +|CopyLinebreakEnable|: *CopyLinebreakEnable* + Enable copy-paste friendly line break options. +|CopyLinebreakDisable|: *CopyLinebreakDisable* + Revert to human-readable line break options. +|CopyLinebreakToggle|: *CopyLinebreakToggle* + Toggle between the above two states. + +There are no default key mappings to any of these targers; you should define +them yourself in your |vimrc|. For example: +> + :nmap b CopyLinebreakToggle + +COMMANDS *copy_linebreak-commands* + +If the |+user_commands| feature is available, commands provided are: +> +`:CopyLinebreakEnable`: *:CopyLinebreakEnable* + Enable copy-paste friendly line break options. +`:CopyLinebreakDisable`: *:CopyLinebreakDisable* + Revert to human-readable line break options. +`:CopyLinebreakToggle`: *:CopyLinebreakToggle* + Toggle between the above two states. + AUTHOR *copy_linebreak-author* Written and maintained by Tom Ryder . -- cgit v1.2.3