Commits

Alexander Q committed bf0fb6c

added markdown readme

  • Participants
  • Parent commits d0dda57

Comments (0)

Files changed (1)

File README.markdown

-surround.vim
-============
+# Installation
+Clone it as $HOME/.vim/ folder, symlink $HOME/.vim/vimrc to $HOME/.vimrc. Done.
 
-Surround.vim is all about "surroundings": parentheses, brackets, quotes,
-XML tags, and more.  The plugin provides mappings to easily delete,
-change and add such surroundings in pairs.
+# Features
+* Rotating read/write file encoding with hotkey
+* modeline `filenecoding=…` works
 
-It's easiest to explain with examples.  Press `cs"'` inside
+# Plugins
+* [NERDtree](http://www.vim.org/scripts/script.php?script_id=1658) v4.2.0, 2011-12-28
+* [perl-support](http://www.vim.org/scripts/script.php?script_id=556) v5.1, 2012-06-01
+* [vcscommand.vim](http://www.vim.org/scripts/script.php?script_id=90) v1.99.46 2011-12-06
+* [xslate-vim](https://github.com/motemen/xslate-vim) 2011-06-17
+* [tt2 syntax](https://github.com/petdance/vim-perl/tree/master/syntax) 2010-10-08
+* [mojo templates syntax](http://www.vim.org/scripts/script.php?script_id=3168) v0.04 2011-08-09
+* [bufexplorer](http://www.vim.org/scripts/script.php?script_id=42) v7.2.8 2010-11-08
+* [surround](https://github.com/tpope/vim-surround) 2011-03-14
+* [haskell indentation](http://www.vim.org/scripts/script.php?script_id=1968) v0.1 2007-07-24
+* [taglist.vim](http://www.vim.org/scripts/script.php?script_id=273) v4.5 2007-09-21
+* [haskell unicode awesomeness](https://github.com/Twinside/vim-haskellConceal) 2011-09-08, modified to handle ∈, ∉ and ∀. Turned off by default, enable with `:set conceallevel=1`
+* [haskellmode](http://projects.haskell.org/haskellmode-vim/vimfiles/) 2010-11-18
+* [Javascript indenter](http://www.vim.org/scripts/script.php?script_id=3081) v1.0 2011-05-15
+* [Align](http://www.vim.org/scripts/script.php?script_id=294)  v36/42 2012-06-18
 
-    "Hello world!"
 
-to change it to
+# Hotkeys
+## Any mode
+* **\** *mapleader*, *maplocalleader*
+* **F8** rotate file read encoding (koi8-r, cp1251, cp866, utf-8)
+* **Ctrl-F8** rotate file write encoding (koi8-r, cp1251, cp866, utf-8)
+* **Alt-arrows** move between buffers
+* **Ctrl-k** **Ctrl-j** move to upper/lower buffer, maximize it
+* **F11** Show taglist.vim window
+* **Ctrl-n** toggle line numbers
+* **Ctrl-s** toggle case-[in]sensitive search
+* **Ctrl-p** toggles list (showing listchars, in this case tabs and trailing spaces)
+* **<Leader>vd** executes `:VCSDiff` in normal mode
+* **<Leader>vD** executes `:VCSVimDiff` in normal mode
 
-    'Hello world!'
+## Insert mode
+### `*htm*` files
+* **>>** closes tag and sets cursor inside. I.e., to get "<p>a</p>", you press buttons `<p>>a`
+### embedded perl (.ep) templates
+* **<%[space]**, **<%=[space]** and **<%==[space]** are automatically translated into **<% | %>**, **<%= | %>** and **<%== | %>**, where **|** denotes cursor position
 
-Now press `cs'<q>` to change it to
-
-    <q>Hello world!</q>
-
-To go full circle, press `cst"` to get
-
-    "Hello world!"
-
-To remove the delimiters entirely, press `ds"`.
-
-    Hello world!
-
-Now with the cursor on "Hello", press `ysiw]` (`iw` is a text object).
-
-    [Hello] world!
-
-Let's make that braces and add some space (use `}` instead of `{` for no
-space): `cs]{`
-
-    { Hello } world!
-
-Now wrap the entire line in parentheses with `yssb` or `yss)`.
-
-    ({ Hello } world!)
-
-Revert to the original text: `ds{ds)`
-
-    Hello world!
-
-Emphasize hello: `ysiw<em>`
-
-    <em>Hello</em> world!
-
-Finally, let's try out visual mode. Press a capital V (for linewise
-visual mode) followed by `S<p class="important">`.
-
-    <p class="important">
-      <em>Hello</em> world!
-    </p>
-
-This plugin is very powerful for HTML and XML editing, a niche which
-currently seems underfilled in Vim land.  (As opposed to HTML/XML
-*inserting*, for which many plugins are available).  Adding, changing,
-and removing pairs of tags simultaneously is a breeze.
-
-The `.` command will work with `ds`, `cs`, and `yss` if you install
-[repeat.vim](https://github.com/tpope/vim-repeat).
-
-Installation
-------------
-
-If you don't have a preferred installation method, I recommend
-installing [pathogen.vim](https://github.com/tpope/vim-pathogen), and
-then simply copy and paste:
-
-    cd ~/.vim/bundle
-    git clone git://github.com/tpope/vim-surround.git
-
-Once help tags have been generated, you can view the manual with
-`:help surround`.
-
-Contributing
-------------
-
-See the contribution guidelines for
-[pathogen.vim](https://github.com/tpope/vim-pathogen#readme).
-
-Self-Promotion
---------------
-
-Like surround.vim? Follow the repository on
-[GitHub](https://github.com/tpope/vim-surround) and vote for it on
-[vim.org](http://www.vim.org/scripts/script.php?script_id=1697).  And if
-you're feeling especially charitable, follow [tpope](http://tpo.pe/) on
-[Twitter](http://twitter.com/tpope) and
-[GitHub](https://github.com/tpope).
-
-License
--------
-
-Copyright (c) Tim Pope.  Distributed under the same terms as Vim itself.
-See `:help license`.
+### X (gvim) mode
+* **F2** toggle menubar and toolbar