code.delx.au - gnu-emacs-elpa/blob - README.mdown

   1 *YASnippet* is a template system for Emacs. It allows you to type an
   2 abbreviation and automatically expand it into function
   3 templates. Bundled language templates includes: C, C++, C#, Perl, Python, Ruby,
   4 SQL, LaTeX, HTML, CSS and more. The snippet syntax is inspired from [http://manual.macromates.com/en/snippets TextMate's] syntax, you can even
   5 [http://yasnippet.googlecode.com/svn/trunk/doc/snippet-development.html#importing-textmate-snippets import] most !TextMate templates to YASnippet. Watch [http://www.youtube.com/watch?v=76Ygeg9miao a demo at YouTube] or download a higher resolution version ([http://yasnippet.googlecode.com/files/yas_demo.avi yas_demo.avi])
   6
   7 ====Install with yasnippet-bundle.el====
   8
   9 To quickly tryout YASnippet, download the simpler "bundle" version.
  10 If you plan to modify the bundled templates and/or build your own,
  11 download the "normal" package.
  12
  13   # Download yasnippet-bundle on the right sidebar and unpack it.
  14   # You'll get a file named `yasnippet-bundle.el`, put it in `~/.emacs.d/plugins/` (create that directory if not exists).
  15   # Open the file in Emacs, and type `Alt+x eval-buffer`.
  16
  17 That's it. Now open any file, you'll see a menu "YASnippet".  You can
  18 pull down the menu to insert a template. Or, you can type a pre-defined
  19 abbrev and press TAB to expand it!
  20
  21 To have Emacs load YASnippet automatically when it starts, put the following in your ~/.emacs file:
  22 {{{
  23 (add-to-list 'load-path
  24              "~/.emacs.d/plugins")
  25 (require 'yasnippet-bundle)
  26 }}}
  27
  28 ==== Normal install ====
  29
  30 To install the normal archive, download and unpack the
  31 latest yasnippet-x.y.z.tar.bz2. You'll get a directory named
  32 yasnippet-x.y.z, put it in your ~/.emacs.d/plugins and add the following in
  33 your .emacs file:
  34 {{{
  35     (add-to-list 'load-path
  36                   "~/.emacs.d/plugins/yasnippet-x.y.z")
  37     (require 'yasnippet) ;; not yasnippet-bundle
  38     (yas/initialize)
  39     (yas/load-directory "~/.emacs.d/plugins/yasnippet-x.y.z/snippets")
  40 }}}
  41
  42 ====How-tos, Bugs, Contributions...====
  43
  44 Please refer to the comprehensive
  45 [http://yasnippet.googlecode.com/svn/trunk/doc/index.html documentation] for full customization and support. If you find a bug, please report it at [http://code.google.com/p/yasnippet/issues/list issues list]. If you run into problems using YASnippet, or have snippets to contribute, post to the [http://groups.google.com/group/smart-snippet yasnippet google group]. Thank you very much for using YASnippet!