Permalink
Browse files

Merge branch '0.8-fsf-changes'

  • Loading branch information...
joaotavora committed Aug 15, 2012
2 parents f82350a + 32c65df commit 145448b81530e404e69000158d00aff689aa0a0e
View
@@ -1,13 +1,13 @@
# Intro
-**yasnippet** is a template system for Emacs. It allows you to type an
+**YASnippet** is a template system for Emacs. It allows you to type an
abbreviation and automatically expand it into function
templates. Bundled language templates includes: C, C++, C#, Perl,
Python, Ruby,
SQL, LaTeX, HTML, CSS and more. The snippet syntax is inspired from
[TextMate's][textmate-snippets] syntax, you can even
-[import][import-docs] most TextMate templates to yasnippet. Watch
+[import][import-docs] most TextMate templates to YASnippet. Watch
[a demo on YouTube][youtube-demo] or download a
[higher resolution version][high-res-demo]
@@ -30,15 +30,14 @@ Add the following in your `.emacs` file:
(add-to-list 'load-path
"~/.emacs.d/plugins/yasnippet")
(require 'yasnippet)
- (yas/global-mode 1)
-
-Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`.
+ (yas-global-mode 1)
+Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas-new-snippet`.
## Install with `package-install`
-In a recent emacs `M-x list-packages` is the recommended way to list and install packages.
-[MELPA][melpa] keeps a very recent snapshot of yasnippet, see http://melpa.milkbox.net/#installing.
+In a recent emacs `M-x list-packages` is the recommended way to list and install packages.
+[MELPA][melpa] keeps a very recent snapshot of YASnippet, see http://melpa.milkbox.net/#installing.
## Install with el-get
@@ -56,37 +55,37 @@ Consider using this "local" recipe.
:compile "yasnippet.el")
el-get-sources)
-## Use `yas/minor-mode` on a per-buffer basis
+## Use `yas-minor-mode` on a per-buffer basis
-To use yasnippet as a non-global minor mode, replace `(yas/global-mode 1)` with
-`(yas/reload-all)` to load the snippet tables. Then add a call to
-`(yas/minor-mode)` to the major-modes where you to enable yasnippet.
+To use YASnippet as a non-global minor mode, replace `(yas-global-mode 1)` with
+`(yas-reload-all)` to load the snippet tables. Then add a call to
+`(yas-minor-mode)` to the major-modes where you to enable YASnippet.
(add-hook 'prog-mode-hook
'(lambda ()
- (yas/minor-mode)))
+ (yas-minor-mode)))
# (NOT) Contributing snippets
Please **do not** open pull requests or ask me to add snippets to
-yasnippet.
+YASnippet.
The bundled collection under `/snippets` is considered frozen: **I
will not add more snippets to it**.
-You can point `yas/snippet-dirs` to good snippet collections out
+You can point `yas-snippet-dirs` to good snippet collections out
there. If you have created snippets for a mode, or multiple modes,
consider creating a repository to host them, then tell users that it
-should be added like this to `yas/snippet-dirs`:
+should be added like this to `yas-snippet-dirs`:
- (setq yas/snippet-dirs
+ (setq yas-snippet-dirs
'("~/.emacs.d/snippets" ;; personal snippets
"/path/to/some/collection/" ;; just some foo-mode snippets
"/path/to/some/othercollection/" ;; some more foo-mode and a complete baz-mode
"/path/to/yasnippet/snippets" ;; the default collection
))
- (yas/global-mode 1) ;; or M-x yas/reload-all if you've started yasnippet already.
+ (yas-global-mode 1) ;; or M-x yas-reload-all if you've started YASnippet already.
# Importing TextMate snippets
@@ -119,8 +118,8 @@ Then, in your `.emacs` file
(add-to-list 'load-path
"~/.emacs.d/plugins/yasnippet")
(require 'yasnippet)
- (setq yas/snippet-dirs '("~/.emacs.d/snippets" "~/.emacs.d/plugins/yasnippet/extras/imported"))
- (yas/global-mode 1)
+ (setq yas-snippet-dirs '("~/.emacs.d/snippets" "~/.emacs.d/plugins/yasnippet/extras/imported"))
+ (yas-global-mode 1)
Open some rails file (model, app, etc) and start using the textmate
snippets. Note that in the example above we have abandoned the
@@ -134,8 +133,8 @@ and support. If you find a bug, please report it on
[the GitHub issue tracker][issues]. (please **do not** submit new issues to the old
[googlecode tracker][googlecode tracker])
-If you run into problems using yasnippet, or have snippets to contribute, post
-to the [yasnippet google group][forum]. Thank you very much for using yasnippet!
+If you run into problems using YASnippet, or have snippets to contribute, post
+to the [YASnippet google group][forum]. Thank you very much for using YASnippet!
[docs]: http://capitaomorte.github.com/yasnippet/
[issues]: https://github.com/capitaomorte/yasnippet/issues
View
@@ -0,0 +1,102 @@
+# -*- mode: org; fill-column: 80 -*-
+#+TITLE: Yet another snippet extension
+#+OPTIONS: toc:1
+#+STARTUP: showall
+
+#+STYLE: <link rel="stylesheet" type="text/css" href="assets/stylesheet.css" />
+
+# External links
+#
+#+LINK: smart-snippet http://code.google.com/p/smart-snippet
+#+LINK: pluskid http://pluskid.lifegoo.org
+
+
+#+LINK: screencast http://www.youtube.com/watch?v=ZCGmZK4V7Sg
+#+LINK: docs http://capitaomorte.github.com/yasnippet
+#+LINK: issues https://github.com/capitaomorte/yasnippet/issues
+#+LINK: googlecode-tracker http://code.google.com/p/yasnippet/issues/list
+#+LINK: forum http://groups.google.com/group/smart-snippet
+
+*YASnippet* is a template system for Emacs. It allows you to type an
+abbreviation and automatically expand it into function templates. Bundled
+language templates includes: C, C++, C#, Perl, Python, Ruby, SQL, LaTeX, HTML,
+CSS and more. The snippet syntax is inspired from TextMate's syntax, you can
+even [[#import-textmate][import most TextMate snippets]]
+
+YASnippet is an original creation of [[pluskid]] who also wrote its predecessor
+[[smart-snippet]].
+
+* Watch a demo [[screencast]]
+
+* Install the most recent version with git
+
+Clone this repository somewhere
+
+#+BEGIN_EXAMPLE
+ $ cd ~/.emacs.d/plugins
+ $ git clone https://github.com/capitaomorte/yasnippet
+#+END_EXAMPLE
+
+Add the following in your =.emacs= file:
+
+#+BEGIN_EXAMPLE
+ (add-to-list 'load-path
+ "~/.emacs.d/plugins/yasnippet")
+ (require 'yasnippet)
+ (yas/global-mode 1)
+#+END_EXAMPLE
+
+Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`.
+
+* Install yasnippet with el-get
+
+[[https://github.com/dimitri/el-get.gti][El-get]] is a nice way to get the most recent version.
+
+* Import textmate snippets (rails example)
+:PROPERTIES:
+:CUSTOM_ID: import-textmate
+:END:
+
+Clone the yasnippet repository to `~/.emacs.d/plugins/yasnippet`
+
+#+BEGIN_EXAMPLE
+ cd ~/.emacs.d/plugins/yasnippet
+ git submodule init
+ git submodule update
+ gem install plist trollop
+ rake convert_bundles # will convert ruby, rails and html bundles from drnic
+#+END_EXAMPLE
+
+Then, in your .emacs file
+
+#+BEGIN_EXAMPLE
+ (add-to-list 'load-path
+ "~/.emacs.d/plugins/yasnippet")
+ (require 'yasnippet)
+ (setq yas/snippet-dirs '("~/.emacs.d/snippets" "~/.emacs.d/extras/imported"))
+ (yas/global-mode 1)
+#+END_EXAMPLE
+
+Open some rails file (model, app, etc) and start using the textmate snippets.
+
+* Contributing snippets
+
+Please do not ask me to add snippets to the default collection under
+=/snippets=. This is considered frozen and by customizing =yas/snippet-dirs= you
+can point yasnippet to good snippet collections out there.
+
+The =extras/textmate-import.rb= tool can import many actual Textmate
+snippets. See [[import-textmate]].
+
+I'm focusing on developping =textmate-import.rb= tool and the =yas-setup.el=
+files that guide it with more difficult importation. In the future =/snippets=
+snippets will be deprecated and replaced with =extras/imported=.
+
+* Documentation, issues, etc
+
+Please refer to the comprehensive [[docs][documentation]] for full customization and
+support. If you think you've found a bug, please report it on [[issues][the GitHub issue
+tracker]]. (please **do not** submit new issues to the old [[googlecode-tracker][googlecode tracker]])
+
+If you run into problems using YASnippet, or have snippets to contribute, post
+to the [[forum][yasnippet forum]]. Thank you very much for using YASnippet!
Oops, something went wrong.

0 comments on commit 145448b

Please sign in to comment.