Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor changes to normalize coding style #5

Merged
merged 5 commits into from
Aug 21, 2011
Merged

Minor changes to normalize coding style #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
038d11d
Add modeline to normalize coding style.
bootleq Aug 16, 2011
e04c5c7
Format doc with 'textwidth' in 78.
bootleq Aug 16, 2011
16b5f62
Improve style of doc.
bootleq Aug 17, 2011
8b5f97f
Add doc/tags into git ignore list.
bootleq Aug 18, 2011
a112fe6
Merge branch 'style'
bootleq Aug 18, 2011
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
doc/tags
3 changes: 3 additions & 0 deletions autoload/cssswapit.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ fun! cssswapit#CssSwapComplete(direction)
endif
return 0
endfun

" modeline: {{{
" vim: expandtab softtabstop=4 shiftwidth=4 foldmethod=marker
200 changes: 114 additions & 86 deletions doc/swapit.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,30 @@
swapit.txt Extensible Keyword Swapper
*swapit.txt* Extensible Keyword Swapper

Author: Michael Brown <mjbrownie @ NOSPAMMY gmail.com>

Usage Notes
License: MIT License {{{
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
}}}


==============================================================================
Contents *swapit-contents*

1. SwapIt Introduction |swapit-intro|

Expand All @@ -24,159 +46,160 @@ Author: Michael Brown <mjbrownie @ NOSPAMMY gmail.com>

5. Omnicomplete Swapping |swapit-omnicomplete|

================================================================================
1. SwapIt Introduction *swapit-intro*

swapit.vim is a plugin designed to make it easier to perform common changes
to various filetypes. It's designed to fill a niche where onmnicomplete for
a given filetype is not providing any options. It is very easy to define your
own lists for your own projects.

It's most effective if you have a set of keywords between 2 and 10 in size.
By default it uses the increment/decrement keystrokes |ctrl-a| |ctrl-x|.
Although this can be custom mapped for screen users.
==============================================================================
1. SwapIt Introduction *swapit-intro*

A simple builtin example:
*swapit.vim* is a plugin designed to make it easier to perform common
changes to various filetypes. It's designed to fill a niche where
onmnicomplete for a given filetype is not providing any options. It is
very easy to define your own lists for your own projects.

setting=false
It's most effective if you have a set of keywords between 2 and 10 in
size. By default it uses the increment/decrement keystrokes |CTRL-A|
|CTRL-X|. Although this can be custom mapped for screen users.

moving the cursor over false in normal mode and pressing ctrl-a will result
in
A simple builtin example: >

setting=true
setting=false
<
moving the cursor over false in normal mode and pressing CTRL-A will
result in >

setting=true
<
The git repository is here http://github.com/mjbrownie/swapit/tree/master.
I'd appreciate any additions.

================================================================================
2. Setup *swapit-setup*

2.1 Requirements *swapit-requirements*
==============================================================================
2. Setup *swapit-setup*

2.1 Requirements *swapit-requirements*

Swapit has been tested on vim 7.0.

If you are looking to use the xml/html tag complete option you need to have
matchit.vim working correctly.
If you are looking to use the xml/html tag complete option you need to
have matchit.vim working correctly. |swapit-html|

2.2 Installation *swapit-installation*
2.2 Installation *swapit-installation*

Copy the swapit.tar.gz file in your ~/.vim/ directory and extract.

2.3 Bugs *swapit-bugs*
2.3 Bugs *swapit-bugs*

This is still a work in progress. There are still some bugs where the swap
gets stuck in visual mode and on some line extremities the cursor can jump
away from where you want it.

In some cases having |'selection'| set to exclusive mode can break things.
Try:

:set selection=inclusive
In some cases having |'selection'| set to exclusive mode can break
things. Try: >

2.4 Limitations/Annoyances *swapit-annoyances*
:set selection=inclusive
<

Swapping is based on naive lists so the biggest limitation is when there is
the same keyword in more than one list. If this happens then a selection
box comes up where you decide which list to use, but its not as smoothe an
operation. To combat this issue lists are filetype specific.
2.4 Limitations/Annoyances *swapit-annoyances*

For example if you have the following two lists:
Swapping is based on native lists so the biggest limitation is when there
are same keywords in more than one list. If this happens, a selection box
comes up where you can decide which list to use, but its not as smoothe an
operation. To combat this issue, lists are filetype specific.

:SwapList octave do re me fa so la ti
:SwapList self me myself I
For example if you have the following two lists: >

trying to swap the keyword 'me' will result in an option list coming up.

Swap Options: A . octave (me > fa) B . self (me > myself)
(A), (B):
:SwapList octave do re me fa so la ti
:SwapList self me myself I
<
trying to swap the keyword "me" will result in an option list coming up. >

Swap Options: A . octave (me > fa) B . self (me > myself)
(A), (B):
<
It would probably be possible to differentiate lists with some regex but
this plugin is probably overkill already.

================================================================================

==============================================================================
3 Swapping

3.1 Built in swap lists *swapit-builtin*

swapit has a number of obvious lists defined eg. yes/no true/false etc.
3.1 Built in swap lists *swapit-builtin*

3.2 Defining a swap list *SwapList* *swapit-define*
swapit has a number of obvious lists defined, e.g.: yes/no true/false
etc.

:SwapList <list_name> <member1> <member2> .. <membern>
3.2 Defining a swap list *:SwapList* *swapit-define*

eg. :SwapList roman I II III IV V VI VII VII IX X
:SwapList <list_name> <member1> <member2> .. <membern>

3.3 xml/html swaps *swapit-html*
Example: >

One of the most recent and useful features is you can swap xml/html
tags.
:SwapList roman I II III IV V VI VII VII IX X
<

If you vim has matchit.vim loaded you can swap. Eg:
3.3 xml/html swaps *:SwapXmlMatchit* *swapit-html*

<p> This should be an h1 </p>
One of the most recent and useful feature is you can swap xml/html
tags.

ctrl-a on the p will cycle to...
If you has matchit.vim loaded then you can swap, e.g.: >

<h1> This should be an h1 </h1>
<p> This should be an h1 </p>
<
CTRL-A on the p will cycle to... >

This behavior is defined by the command SwapXmlMatchit
<h1> This should be an h1 </h1>
<
This behavior is defined by the command :SwapXmlMatchit

which is as follows

SwapXmlMatchit <swap_list> <swap_list> ...
:SwapXmlMatchit <swap_list> <swap_list> ...

~/.vim/after/ftplugin/html_swapit.vim

SwapList formats h1 h2 h3 h4 p strong em a
SwapList layout div span script style
SwapXmlMatchit formats layout
:SwapList formats h1 h2 h3 h4 p strong em a
:SwapList layout div span script style
:SwapXmlMatchit formats layout

3.4 Multi word swaps *swapit-multiword*
3.4 Multi word swaps *swapit-multiword*

swapit can handle multiword swapping by entering into visual mode.
swapit can handle multi-word swapping with |Visual-mode|.

I wrote it and didn't find a use for it so defining multiword swaps
isn't as easy as single word swaps. you could manually define a list.
I wrote it and didn't find a use for it so defining multi-word swaps
isn't as easy as single word swaps. You could manually define a list.

~/.vim/after/ftplugin/{filetype}_swapit.vim

ClearSwapList

let g:swap_lists = [
\{'name':'hello_world', 'options':
\['Hello World!','GoodBye Cruel World!' , 'See You Next Tuesday!']},
\ {'name':'hello_world', 'options':
\ ['Hello World!','GoodBye Cruel World!' , 'See You Next Tuesday!']},
...
\]
\ ]

etc.

================================================================================

==============================================================================
4. Filetype Swaps

4.1 Defining a filetype swap list *SwapIdea* *swapit-filetype*

The command

:SwapIdea
4.1 Defining a filetype swap list *:SwapIdea* *swapit-filetype*

will open
The command :SwapIdea will open

~/.vim/after/ftplugin/{filetype}_swapit.vim

The filetype file can be used to define custom swaps for
This file can be used to define custom swaps for specific filetype.

4.2 Clearing a Swap List *ClearSwapList* *swapit-cleanup*
4.2 Clearing a Swap List *:ClearSwapList* *swapit-cleanup*

The ClearSwapList command cleans up existing swap lists. Its useful to
put this at the top of an after/ftplugin file.
The :ClearSwapList command cleans up existing swap lists. It's useful
to put this at the top of an after/ftplugin file.

ClearSwapList

5. Omnicomplete Swapping *swapit-omnicomplete*
==============================================================================
5. Omnicomplete Swapping *swapit-omnicomplete*

Rather than repeating SwapLists that are similar to omnicomplete patterns
Rather than repeating SwapLists that are similar to omnicomplete patterns,
it would be more preferable to use the omnicomplete function for the
language.

Expand All @@ -194,12 +217,17 @@ Author: Michael Brown <mjbrownie @ NOSPAMMY gmail.com>

after/ftplugin/<filetype>_swapit.vim file

Eg in after/ftplugin/css_swapit.vim

let b:swap_completefunc = 'cssswapit#CssSwapComplete'
*b:swap_completefunc*
e.g. in after/ftplugin/css_swapit.vim >

let b:swap_completefunc = 'cssswapit#CssSwapComplete'
<
then define a function in the autoload folder

autoload/cssswapit.vim. The function must take one argument specifying the
direction 'forward' or 'backward' and return 1 on a successful swap or 0
if no matches are made. Look at the cssswapit for an example.


==============================================================================
vim:tw=78:fo=tcroq2mM:et:sts=4:sw=4:ft=help:norl:fdm=marker:
4 changes: 3 additions & 1 deletion plugin/swapit.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,4 +469,6 @@ endif
"NOTE: comparison_operator doesn't work yet but there in the hope of future
"
"capability
"

" modeline: {{{
" vim: expandtab softtabstop=4 shiftwidth=4 foldmethod=marker