|
| 1 | +*textobj-surround.txt* For Vim version 8.1 Last change: 2018 December 24 |
| 2 | + |
| 3 | + _____ _ _____ _ _ ~ |
| 4 | + |_ _| | | | _ | | (_) ~ |
| 5 | + | | _____ _| |_| | | | |__ _ ~ |
| 6 | + | |/ _ \ \/ / __| | | | '_ \| | ~ |
| 7 | + | | __/> <| |_\ \_/ / |_) | | ~ |
| 8 | + \_/\___/_/\_\\__|\___/|_.__/| | ~ |
| 9 | + _____ _/ | _ ~ |
| 10 | + / ___| |__/ | | ~ |
| 11 | + \ `--. _ _ _ __ _ __ ___ _ _ _ __ __| | ~ |
| 12 | + `--. \ | | | '__| '__/ _ \| | | | '_ \ / _` | ~ |
| 13 | + /\__/ / |_| | | | | | (_) | |_| | | | | (_| | ~ |
| 14 | + \____/ \__,_|_| |_| \___/ \__,_|_| |_|\__,_| ~ |
| 15 | + |
| 16 | + |
| 17 | + A Vim plugin that adds various symbols as ~ |
| 18 | + surrounding text objects. ~ |
| 19 | + |
| 20 | + |
| 21 | + Reference Manual ~ |
| 22 | + |
| 23 | + |
| 24 | +============================================================================== |
| 25 | +CONTENTS *textobj-surround-contents* |
| 26 | + |
| 27 | + 1. Intro....................................|textobj-surround-intro| |
| 28 | + 2. Symbols..................................|textobj-surround-symbols| |
| 29 | + 3. Usage....................................|textobj-surround-usage| |
| 30 | + 4. About....................................|textobj-surround-about| |
| 31 | + |
| 32 | +============================================================================== |
| 33 | +1. Intro *textobj-surround-intro* |
| 34 | + |
| 35 | +TODO |
| 36 | +============================================================================== |
| 37 | +2. Symbols *textobj-surround-symbols* |
| 38 | + |
| 39 | +$ |
| 40 | +% |
| 41 | +* |
| 42 | +| |
| 43 | ++ |
| 44 | +- |
| 45 | +_ |
| 46 | + |
| 47 | +TODO description |
| 48 | + |
| 49 | + |
| 50 | +============================================================================== |
| 51 | +3. Usage *textobj-surround-usage* |
| 52 | + |
| 53 | +TODO elaborate on others |
| 54 | + |
| 55 | +The textobj-surround plugin provides two new |text-objects| which are triggered |
| 56 | +by `a|` and `i|` respectively. You can use them when writing Vim help |
| 57 | +documentation (Wow, how meta), or markdown tables. |
| 58 | + |
| 59 | +For example, suppose you have the following markdown table: > |
| 60 | +
|
| 61 | + | Cats | Dogs | |
| 62 | + |:------------:|:--------:| |
| 63 | + | Mr. Whiskers | Snuffles | |
| 64 | + | Oscar | Bella | |
| 65 | +< |
| 66 | +If you want to change 'Mr. Whiskers' to 'Tigger', you can do the following |
| 67 | +(cursor position marked by *): |
| 68 | + |
| 69 | +`| Mr. Wh*iskers |` and type `ci|` to get `|*|`, where you can make your |
| 70 | +replacement `| Tigger |` . |
| 71 | + |
| 72 | +Another example is if you are writing Vim help documentation and have |
| 73 | +a hot-link, which is a word surrounded with pipes as such: > |
| 74 | +
|
| 75 | + |bad tag| |
| 76 | +< |
| 77 | +If you want to delete the hot-link, you can do the following (cursor position |
| 78 | +marked by *): |
| 79 | + |
| 80 | +`|bad*tag|` and type `da|`, which will delete the hot-link. |
| 81 | + |
| 82 | +============================================================================== |
| 83 | +4. About *textobj-surround-about* |
| 84 | + |
| 85 | +You can find the most updated version of the plugin from: |
| 86 | + |
| 87 | + http://github.com/EvanQuan/vim-textobj-surround |
| 88 | + |
| 89 | +vim:tw=78:ts=8:ft=help:norl: |
0 commit comments