ultimate-vim/sources_non_forked/vim-snipmate/README.rst

============
snipmate.vim
============

IMPORTANT: comment on: [What about merging whith Ultisnip using its engine](https://github.com/garbas/vim-snipmate/issues/114)
status: snipmate-snippet files are read by Ultisnip flawlessly. See
snipmate-snippets readme about how to configure and use Ultisnips as alternative
That branch also supports completion menu now
Thus there is only one reason left to keep using snipmate from my point of
view: not having python support.
In other words: upstream of snipmate is almost dead. (Better to say Marc Weber is not going to fix any bugs anymore)


:Author: `Michael Sanders`_
:Maintainer: `Adnan Zafar`_ & `Rok Garbas`_ & `Marc Weber`_
:Homepage: http://www.vim.org/scripts/script.php?script_id=2540
:Contributors: `MarcWeber`_, `lilydjwg`_, `henrik`_, `steveno`_, `asymmetric`_, `jherdman`_, `ironcamel`_, `honza`_, `jb55`_, `robhudson`_, `kozo2`_, `MicahElliott`_, `darkwise`_, `redpill`_, `thisgeek`_, `sickill`_, `pose`_, `marutanm`_, `r00k`_, `jbernard`_, `holizz`_, `muffinresearch`_, `statik`_, `taq`_, `alderz`_, `radicalbit`_, `pielgrzym`_, `hpesoj`_


.. contents::


ChangeLog
=========


0.85 [2013-04-03]
-----------------

* Allow trigger key customization
* Enable undoing of snippet expansion
* Support backslash escaping in snippets
* Add support for {VISUAL}
* Expand filetype extension with scope_aliases
* Add expansion guards
* Enable per-buffer expansion of snippets
* Fix 'cpo' compatibility
* Update supertab compatibility
* Enable customization of various things through g:snipMate

* Disable spelling in snippet files
* Highlight trigger names in .snippets files

* Update many snippets
* Separate sample snippets into separate repository

0.84
----

* Unreleased version by `Michael Sanders`_. Available on `GitHub`_.

0.83 [2009-07-13]
-----------------

* Last release done by `Michael Sanders`_. Available on `vim.org`_.


How to install
==============

Unfortunately there are many ways to install vim plugins. If you don't
see your preferred way of installation, please consider updating
this section. Basically, installation consists of 2 simple steps:

1. Install vim-snipmate
2. Install snippets


snipmate dependencies
==============
Important to note is that since version 0.85 we depend on 2 vim plugins:
    * `vim-addon-mw-utils`_ providing the implementation for caching parsed
      .snippets files.

    * `tlib`_ for tlib#input#List which provides the excellent filterable
      list selection view (and more).

    * the default set of snippets (optional but recommended).
      See 'Snippets repository' below.


Using `VAM`_ (recommended)
------------

- Add `snipmate-snippets` to the names to be installed. Or use
  "github:name/repo" if you want to use a non standard upstream.

The default snippets depend on "snipmate" so VAM will fetch the core along
with its dependencies automatically.

Using `pathogen`_
--------------------------------------

::

    % cd ~/.vim
    % mkdir bundle
    % cd bundle
    % git clone git://github.com/garbas/vim-snipmate.git

    # Install dependencies:
    % git clone https://github.com/tomtom/tlib_vim.git
    % git clone https://github.com/MarcWeber/vim-addon-mw-utils.git
    % git clone https://github.com/honza/vim-snippets.git

Using `Vundle`_
---------------

::

    Install dependencies:
    Bundle "MarcWeber/vim-addon-mw-utils"
    Bundle "tomtom/tlib_vim"
    Bundle "honza/vim-snippets"

    Install:
    Bundle "garbas/vim-snipmate"

    And :BundleInstall



Manually (not recommended!)
---------------------------

::

    % git clone git://github.com/honza/vim-snippets.git
    % git clone git://github.com/garbas/vim-snipmate.git
    % cd snipmate.vim
    % cp -R * ~/.vim

Then in vim::

    :helptags ~/.vim/doc/

Then install any dependencies (see above).

Snippets repository
===================
There is now one snippet repo containing almost all snippets. You are
encouraged to submit any fixes and new snippets there.

https://github.com/honza/vim-snippets

More snippet repositories are listed at that repository's README file.

Why forking snipMate?
=====================

    After several unsuccessful attempts of contacting Michael Sanders, no
    commits in last half year and long pull request line on github (none of
    pull requests were commented/replied/rejected) I decided to take action,
    step up and bring some love to this widely used plugin.

    But nothing to worry about. We all get busy, accupied with our daily work
    or just lose interest in doing boring maintainance.

    While reviewing pull requests on github.com/msanders I found lots of great
    improvements and I decided to **friendly** fork it, review and apply patches
    that were sent, notify all the patch submitters and decided to maintain
    snipmate.vim from now on. Of course if somebody wants to
    help, please do not hesitate to write me, I am open to any suggestions.

    Maybe I will only maintain it for a while until Michael Sanders takes things
    back into his hand or until some other super-hero shows up.

    Tnx and happy snipmating, Rok Garbas & Marc Weber, 2011-02-02



related work
=============
See doc/snipMate.txt

Known Bugs
=============

    * Set one value default as input of another value.
      https://github.com/garbas/vim-snipmate/issues/59
      [2011-10-18, `bogdan`_]


TODO / Future
=============

    * Notify all "forkers" about new home and ask them nicely to review already
      merged changes and possibly send their changes.
      [2011-02-07, `garbas`_]

    * I'd like to investigate whether xptemplate or snipmate has the better
      engine. So maybe my vision of the future could be making xptemplate read
      snippet files. It is not important enough for me to work on it right now as
      snipmate works reasonable well for me.
      [2011-02-02, `MarcWeber`_]

    * comment without verifying it:
      < Silex> MarcWeber: btw, check out ultisnips. Much better than snipmate imho

      And before this discussion xptemplate vs snipmate vs ultisnips .. continues
      we should create a wiki page comparing them and keep that up to date.
      If you volunteer tell me so that I can reference the link.
      [2011-02-02, `MarcWeber`_]

    * tcomment claims to know which language mode you're editing in even if its
      JS in PHP or HTML within PHP. It would be great if that functionality could be
      moved into its own plugirn (vim-detect-language-at-cursor) or such.
      Then a lot of the scoped_aliases (which causes collisions easily) could
      be enhanced.


.. _`Michael Sanders`: http://www.vim.org/account/profile.php?user_id=16544
.. _`Adnan Zafar`: https://github.com/ajzafar
.. _`Rok Garbas`: rok@garbas.si
.. _`Marc Weber`: marco-oweber@gmx.de
.. _`VAM`: https://github.com/MarcWeber/vim-addon-manager
.. _`pathogen`: http://www.vim.org/scripts/script.php?script_id=2332
.. _`vim-addon-mw-utils`: https://github.com/MarcWeber/vim-addon-mw-utils
.. _`tlib`: https://github.com/tomtom/tlib_vim

.. _`garbas`: https://github.com/garbas
.. _`MarcWeber`: https://github.com/MarcWeber
.. _`lilydjwg`: https://github.com/lilydjwg
.. _`henrik`: https://github.com/henrik
.. _`steveno`: https://github.com/steveno
.. _`asymmetric`: https://github.com/asymmetric
.. _`jherdman`: https://github.com/jherdman
.. _`ironcamel`: https://github.com/ironcamel
.. _`honza`: https://github.com/honza
.. _`jb55`: https://github.com/jb55
.. _`robhudson`: https://github.com/robhudson
.. _`kozo2`: https://github.com/kozo2
.. _`MicahElliott`: https://github.com/MicahElliott
.. _`darkwise`: https://github.com/darkwise
.. _`redpill`: https://github.com/redpill
.. _`thisgeek`: https://github.com/thisgeek
.. _`sickill`: https://github.com/sickill
.. _`pose`: https://github.com/pose
.. _`marutanm`: https://github.com/marutanm
.. _`r00k`: https://github.com/r00k
.. _`jbernard`: https://github.com/jbernard
.. _`holizz`: https://github.com/holizz
.. _`muffinresearch`: https://github.com/muffinresearch
.. _`statik`: https://github.com/statik
.. _`Vundle`: https://github.com/gmarik/vundle
.. _`alderz`: https://github.com/alderz
.. _`johnbintz`: https://github.com/johnbintz
.. _`thenoseman`: https://github.com/thenoseman
.. _`ervandew`: https://github.com/ervandew
.. _`blueyed`: https://github.com/blueyed
.. _`tisho`: https://github.com/tisho
.. _`pielgrzym`: https://github.com/pielgrzym
.. _`jgosmann`: https://github.com/jgosmann
.. _`taq`: https://github.com/taq
.. _`vim.org`: http://www.vim.org/scripts/script.php?script_id=2540
.. _`GitHub`: http://github.com/msanders/snipmate.vim
.. _`radicalbit`: https://github.com/radicalbit
.. _`hpesoj`: https://github.com/hpesoj