Skip to content

Commit cb64da7

Browse files
EvanQuanEvanQuan
committed
symbols.vim 1.1.1
Rebrand as symbols
1 parent f900e2e commit cb64da7

File tree

4 files changed

+105
-102
lines changed

4 files changed

+105
-102
lines changed

‎README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# :sunrise_over_mountains: vim-textobj-surround
1+
# :sunrise_over_mountains: vim-textobj-symbols
22

33
This plugin adds various symbols as surrounding text-objects.
44

@@ -22,27 +22,27 @@ support:
2222
mkdir ~/.vim/pack/plugin/start/vim-textobj-user
2323
git clone https://github.com/kana/vim-textobj-user.git ~/.vim/pack/plugin/start/vim-textobj-user
2424

25-
mkdir ~/.vim/pack/plugin/start/vim-textobj-surround
26-
git clone https://github.com/EvanQuan/vim-textobj-surround.git ~/.vim/pack/plugin/start/vim-textobj-surround
25+
mkdir ~/.vim/pack/plugin/start/vim-textobj-symbols
26+
git clone https://github.com/EvanQuan/vim-textobj-symbols.git ~/.vim/pack/plugin/start/vim-textobj-symbols
2727
```
2828

2929
#### [Vim-Plug](https://github.com/junegunn/vim-plug)
3030

3131
1. Add `Plug 'kana/vim-textobj-user'` to your `vimrc` file.
32-
2. Add `Plug 'EvanQuan/vim-textobj-surround'` to your `vimrc` file.
32+
2. Add `Plug 'EvanQuan/vim-textobj-symbols'` to your `vimrc` file.
3333
3. Reload your `vimrc` or restart.
3434
4. Run `:PlugInstall`
3535

3636
#### [Vundle](https://github.com/VundleVim/Vundle.vim)
3737

3838
1. Add `Plugin 'kana/vim-textobj-user'` to your `vimrc` file.
39-
2. Add `Plugin 'EvanQuan/vim-textobj-surround'` to your `vimrc` file.
39+
2. Add `Plugin 'EvanQuan/vim-textobj-symbols'` to your `vimrc` file.
4040
3. Reload your `vimrc` or restart.
4141
4. Run `:BundleInstall`
4242

4343
#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
4444

45-
1. Add `NeoBundle 'EvanQuan/vim-textobj-surround'` to your `vimrc` file.
45+
1. Add `NeoBundle 'EvanQuan/vim-textobj-symbols'` to your `vimrc` file.
4646
2. Add `NeoBundle 'kana/vim-textobj-user'` to your `vimrc` file.
4747
3. Reload your `vimrc` or restart.
4848
4. Run `:NeoUpdate`
@@ -52,14 +52,14 @@ git clone https://github.com/EvanQuan/vim-textobj-surround.git ~/.vim/pack/plugi
5252
```bash
5353
git clone https://github.com/kana/vim-textobj-user.git ~/.vim/bundle/vim-textobj-user
5454

55-
git clone https://github.com/EvanQuan/vim-textobj-surround.git ~/.vim/bundle/vim-textobj-surround
55+
git clone https://github.com/EvanQuan/vim-textobj-symbols.git ~/.vim/bundle/vim-textobj-symbols
5656
```
5757

5858
## Usage
5959

6060
**TODO elaborate on other text objects**
6161

62-
The **textobj-surround** plugin provides two new text-objects which are triggered
62+
The **textobj-symbols** plugin provides two new text-objects which are triggered
6363
by `a|` and `i|` respectively.
6464

6565
For example, suppose you have the following markdown table:

‎doc/textobj-surround.txt

Lines changed: 0 additions & 89 deletions
This file was deleted.

‎doc/textobj-symbols.txt

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

‎plugin/textobj/surround.vim renamed to ‎plugin/textobj/symbols.vim

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
" ============================================================================
2-
" File: surround.vim
3-
" Maintainer: https://github.com/EvanQuan/vim-textobj-surround/
4-
" Version: 1.1.0
2+
" File: symbols.vim
3+
" Maintainer: https://github.com/EvanQuan/vim-textobj-symbols/
4+
" Version: 1.1.1
55
"
66
" A Vim plugin that adds various symbols as surrounding text-objects.
77
" ============================================================================
88

9-
if exists('g:loaded_textobj_surround')
9+
if exists('g:loaded_textobj_symbols')
1010
finish
1111
endif
1212

@@ -319,4 +319,4 @@ endfunction
319319

320320
" }}}
321321

322-
let g:loaded_textobj_surround = 1
322+
let g:loaded_textobj_symbols = 1

0 commit comments

Comments
 (0)