mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 21:13:04 +00:00
192 lines
10 KiB
HTML
192 lines
10 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
|
|
<title>Yet Another Snippet extension</title>
|
|
<meta name="author" content="pluskid" />
|
|
<meta name="date" content="2008-03-20" />
|
|
<link rel="stylesheet" href="styles.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div class="document" id="yet-another-snippet-extension">
|
|
<div id="header-region" class="clear-block"></div>
|
|
<div id="wrapper">
|
|
<div id="container" class="clear-block">
|
|
<div id="header">
|
|
<div id="logo-floater">
|
|
<h1 class="title">Yet Another Snippet extension</h1>
|
|
</div>
|
|
<ul class="primary-links">
|
|
<li>
|
|
<a title="" href="index.html">Home</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="define_snippet.html">Howto</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="faq.html">FAQ</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="changelog.html">ChangeLog</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="http://code.google.com/p/yasnippet/downloads/list">Download</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="center">
|
|
<div id="squeeze">
|
|
<div class="right-corner">
|
|
<div class="left-corner">
|
|
<div class="contents topic" id="contents">
|
|
<p class="topic-title first">Contents</p>
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#getting-started" id="id5">Getting Started</a><ul>
|
|
<li><a class="reference internal" href="#for-the-busy-or-impatient-people" id="id6">For the busy or impatient people</a></li>
|
|
<li><a class="reference internal" href="#for-lazy-poeple-or-beginners" id="id7">For lazy poeple or beginners</a></li>
|
|
<li><a class="reference internal" href="#for-you" id="id8">For you</a></li>
|
|
<li><a class="reference internal" href="#for-geeks" id="id9">For geeks</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#how-to-contribute" id="id10">How to contribute ?</a><ul>
|
|
<li><a class="reference internal" href="#issues" id="id11">Issues</a></li>
|
|
<li><a class="reference internal" href="#suggestion-feature-request" id="id12">Suggestion, Feature Request</a></li>
|
|
<li><a class="reference internal" href="#snippets" id="id13">Snippets</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#detailed-documentation" id="id14">Detailed Documentation</a></li>
|
|
</ul>
|
|
</div>
|
|
<p>YASnippet is a re-design and re-write of my original extension
|
|
<a class="reference external" href="http://code.google.com/p/smart-snippet/">smart-snippet</a>. It is much cleaner and more powerful than
|
|
smart-snippet.</p>
|
|
<div class="section" id="getting-started">
|
|
<h1><a class="toc-backref" href="#id5">Getting Started</a></h1>
|
|
<div class="section" id="for-the-busy-or-impatient-people">
|
|
<h2><a class="toc-backref" href="#id6">For the busy or impatient people</a></h2>
|
|
<p>Watch the <a class="reference external" href="http://www.youtube.com/watch?v=vOj7btx3ATg">screencast at YouTube</a> or download <a class="reference external" href="http://yasnippet.googlecode.com/files/yasnippet.avi">the one
|
|
with a higher resolution</a>.</p>
|
|
</div>
|
|
<div class="section" id="for-lazy-poeple-or-beginners">
|
|
<h2><a class="toc-backref" href="#id7">For lazy poeple or beginners</a></h2>
|
|
<ol class="arabic">
|
|
<li><p class="first">Download the latest bundle release <a class="footnote-reference" href="#id3" id="id1">[1]</a> from the <a class="reference external" href="http://code.google.com/p/yasnippet/downloads/list">downloads page</a>.</p>
|
|
</li>
|
|
<li><p class="first">Create a directory <tt class="docutils literal"><span class="pre">~/emacs/plugins</span></tt>.</p>
|
|
</li>
|
|
<li><p class="first">Unpack the downloaded bundle to that directory.</p>
|
|
</li>
|
|
<li><p class="first">Add the following code to your <tt class="docutils literal"><span class="pre">~/.emacs</span></tt> file:</p>
|
|
<div class="highlight"><pre>(<span style="color: #19177C">add-to-list</span> <span style="color: #19177C">'load-path</span>
|
|
<span style="color: #BA2121">"~/emacs/plugins"</span>)
|
|
(<span style="color: #008000">require</span> <span style="color: #19177C">'yasnippet-bundle</span>)
|
|
</pre></div>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
<div class="section" id="for-you">
|
|
<h2><a class="toc-backref" href="#id8">For you</a></h2>
|
|
<ol class="arabic">
|
|
<li><p class="first">Download the latest YASnippet release package <a class="footnote-reference" href="#id4" id="id2">[2]</a> from the
|
|
<a class="reference external" href="http://code.google.com/p/yasnippet/downloads/list">downloads page</a>.</p>
|
|
</li>
|
|
<li><p class="first">Unpack it to a directory and add that directory to your
|
|
<tt class="docutils literal"><span class="pre">load-path</span></tt>.</p>
|
|
</li>
|
|
<li><p class="first">Add the following code to your <tt class="docutils literal"><span class="pre">~/.emacs</span></tt> file:</p>
|
|
<div class="highlight"><pre>(<span style="color: #008000">require</span> <span style="color: #19177C">'yasnippet</span>) <span style="color: #408080; font-style: italic">;; not yasnippet-bundle</span>
|
|
(<span style="color: #19177C">yas/initialize</span>)
|
|
(<span style="color: #19177C">yas/load-directory</span> <span style="color: #BA2121">"/path/to/the/snippets/directory/"</span>)
|
|
</pre></div>
|
|
</li>
|
|
<li><p class="first">You can inspect into the <tt class="docutils literal"><span class="pre">snippets</span></tt> directory for adding your own
|
|
snippets.</p>
|
|
</li>
|
|
<li><p class="first">Detailed document can be found at the <tt class="docutils literal"><span class="pre">doc</span></tt> directory.</p>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
<div class="section" id="for-geeks">
|
|
<h2><a class="toc-backref" href="#id9">For geeks</a></h2>
|
|
<p>If you want to always follow the latest code. You can check out it
|
|
from the svn repository:</p>
|
|
<div class="highlight"><pre>svn checkout http://yasnippet.googlecode.com/svn/trunk/ yasnippet
|
|
</pre></div>
|
|
<p>However, I try to release a new version as soon as I made some changes
|
|
that will affect the normal use or added some new features. So there's
|
|
usually no need to follow the svn repository. Except that you might
|
|
find <tt class="docutils literal"><span class="pre">svn</span> <span class="pre">up</span></tt> is more convenient than downloading and unpacking the
|
|
release package. :D</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="how-to-contribute">
|
|
<h1><a class="toc-backref" href="#id10">How to contribute ?</a></h1>
|
|
<p>If you like YASnippet, you can recommendate it to your friends.</p>
|
|
<div class="section" id="issues">
|
|
<h2><a class="toc-backref" href="#id11">Issues</a></h2>
|
|
<p>If you find a bug you can create a new issue at the <a class="reference external" href="http://code.google.com/p/yasnippet/issues/list">issue list</a>. Please describe
|
|
the problem as clear as possible.</p>
|
|
</div>
|
|
<div class="section" id="suggestion-feature-request">
|
|
<h2><a class="toc-backref" href="#id12">Suggestion, Feature Request</a></h2>
|
|
<p>There's a <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion group</a> for both smart-snippet and yasnippet. If
|
|
you have any suggesion, you can post to there and discuss with other
|
|
members.</p>
|
|
<p>Especially, there's a <a class="reference external" href="http://code.google.com/p/yasnippet/wiki/WishList">wish list</a> wiki page. I'll collect ideas from
|
|
the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion group</a> to the <a class="reference external" href="http://code.google.com/p/yasnippet/wiki/WishList">wish list</a>. So you might want to look
|
|
at the <a class="reference external" href="http://code.google.com/p/yasnippet/wiki/WishList">wish list</a> before you post something.</p>
|
|
</div>
|
|
<div class="section" id="snippets">
|
|
<h2><a class="toc-backref" href="#id13">Snippets</a></h2>
|
|
<p>YASnippet comes with some default snippet definitions. However, they
|
|
are far from complete. So I'm calling users to share their
|
|
snippets. If you have some good snippet definitions, you can post them
|
|
to the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion group</a>. You can specify the <tt class="docutils literal"><span class="pre">contributor</span></tt>
|
|
property of the snippet like:</p>
|
|
<div class="highlight"><pre>#contributor : pluskid <pluskid@gmail.com>
|
|
#name : __...__
|
|
# --
|
|
__${init}__
|
|
</pre></div>
|
|
<p>I'll incorporate (some of) them in the release if suitable. However,
|
|
if you have <em>many</em> snippets (especially when they need to be
|
|
maintained and updated constantly), it is not suitable to put them in
|
|
the YASnippet release package. A better way is to make your snippets
|
|
publicly available and tell me the URL. I'll try to keep a list of
|
|
them on the wiki page.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="detailed-documentation">
|
|
<h1><a class="toc-backref" href="#id14">Detailed Documentation</a></h1>
|
|
<ul class="simple">
|
|
<li>See <a class="reference external" href="define_snippet.html">this page</a> on how to define a snippet by
|
|
yourself.</li>
|
|
<li>Here's the <a class="reference external" href="faq.html">FAQ</a> page.</li>
|
|
<li>Here's the <a class="reference external" href="changelog.html">ChangeLog</a>.</li>
|
|
</ul>
|
|
<table class="docutils footnote" frame="void" id="id3" rules="none">
|
|
<colgroup><col class="label" /><col /></colgroup>
|
|
<tbody valign="top">
|
|
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>They usually named like <tt class="docutils literal"><span class="pre">yasnippet-bundle-x.y.z.el.tgz</span></tt> where
|
|
<tt class="docutils literal"><span class="pre">x.y.z</span></tt> is the version number.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="docutils footnote" frame="void" id="id4" rules="none">
|
|
<colgroup><col class="label" /><col /></colgroup>
|
|
<tbody valign="top">
|
|
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>They usually named like <tt class="docutils literal"><span class="pre">yasnippet.x.y.z.tar.bz2</span></tt>.</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|