mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 05:03:04 +00:00
185 lines
9.2 KiB
HTML
185 lines
9.2 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>
|
|
<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">Intro and tutorial</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="snippet-organization.html">Howto: organize</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="snippet-expansion.html">Howto: expand</a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="snippet-development.html">Howto: write </a>
|
|
</li>
|
|
<li>
|
|
<a title="" href="snippet-menu.html">Howto: menu </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="#video-demo" id="id1">Video Demo</a></li>
|
|
<li><a class="reference internal" href="#installation" id="id2">Installation</a><ul>
|
|
<li><a class="reference internal" href="#bundle-install" id="id3">Bundle Install</a></li>
|
|
<li><a class="reference internal" href="#normal-install" id="id4">Normal Install</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#how-to-use-yasnippet" id="id5">How to use YASnippet</a></li>
|
|
<li><a class="reference internal" href="#bugs-contribution-and-support" id="id6">Bugs, Contribution and Support</a></li>
|
|
</ul>
|
|
</div>
|
|
<p>YASnippet is a template system for Emacs. It allows you to type a
|
|
abbreviation and automatically expand the abbreviation into function
|
|
templates.</p>
|
|
<p>Bundled language templates includes: C, C++, C#, Perl, Python, Ruby,
|
|
SQL, LaTeX, HTML, CSS and more.</p>
|
|
<p>YASnippet system is inspired from TextMate's template system. You can
|
|
use <a class="reference external" href="https://groups.google.com/group/smart-snippet/browse_thread/thread/691fbdd33412d86e?pli=1">a tool</a>
|
|
to import any TextMate template you have to YASnippet.</p>
|
|
<p>YASnippet is a re-write of the extension <a class="reference external" href="http://code.google.com/p/smart-snippet/">smart-snippet</a>. Both are
|
|
original creations of <a class="reference external" href="http://pluskid.lifegoo.org">pluskid</a>.</p>
|
|
<div class="section" id="video-demo">
|
|
<h1><a class="toc-backref" href="#id1">Video Demo</a></h1>
|
|
<object type="application/x-shockwave-flash"
|
|
width="425"
|
|
height="344"
|
|
align="right"
|
|
class="youtube-embed"
|
|
data="http://www.youtube.com/v/vOj7btx3ATg">
|
|
<param name="movie" value="http://www.youtube.com/v/vOj7btx3ATg"></param>
|
|
<param name="wmode" value="transparent"></param>
|
|
</object>
|
|
<p>Watch the <a class="reference external" href="http://www.youtube.com/watch?v=vOj7btx3ATg">demo at YouTube</a> (download a higher
|
|
resolution version: <a class="reference external" href="http://yasnippet.googlecode.com/files/yasnippet.avi">yasnippet.avi</a>).</p>
|
|
</div>
|
|
<div class="section" id="installation">
|
|
<h1><a class="toc-backref" href="#id2">Installation</a></h1>
|
|
<p>There are two archives of YASnippet. One is a single file compiled
|
|
“bundle”, and the other is normal. If all you need is to use the
|
|
built-in templates, download the bundle one. If you want to add your
|
|
own templates, download the normal one.</p>
|
|
<div class="section" id="bundle-install">
|
|
<h2><a class="toc-backref" href="#id3">Bundle Install</a></h2>
|
|
<ol class="arabic simple">
|
|
<li>Download the latest <tt class="docutils literal"><span class="pre">yasnippet-bundle-x.y.z.el.tgz</span></tt> and unpack it.</li>
|
|
<li>You'll get a file named <tt class="docutils literal"><span class="pre">yasnippet-bundle.el</span></tt>, put it under
|
|
<tt class="docutils literal"><span class="pre">~/.emacs.d/plugins/</span></tt> (create the directory if not exists).</li>
|
|
<li>Open the file in Emacs, and type <tt class="docutils literal"><span class="pre">Alt+x</span> <span class="pre">eval-buffer</span></tt>.</li>
|
|
</ol>
|
|
<p>That's it. Now open any one of your language file, you'll see a menu
|
|
YASnippet. you can pull the menu to insert a template. Or, you can
|
|
type the pre-defined abbrev and press <tt class="docutils literal"><span class="pre">TAB</span></tt> to expand it.</p>
|
|
<p>To have Emacs load YASnippet automatically when it starts, put the
|
|
following in your <tt class="docutils literal"><span class="pre">~/.emacs</span></tt> file:</p>
|
|
<blockquote>
|
|
<div class="highlight"><pre>(<span style="color: #19177C">add-to-list</span> <span style="color: #19177C">'load-path</span>
|
|
<span style="color: #BA2121">"~/.emacs.d/plugins"</span>)
|
|
(<span style="color: #008000">require</span> <span style="color: #19177C">'yasnippet-bundle</span>)
|
|
</pre></div>
|
|
</blockquote>
|
|
</div>
|
|
<div class="section" id="normal-install">
|
|
<h2><a class="toc-backref" href="#id4">Normal Install</a></h2>
|
|
<p>For full install of the normal archive, just download and unpack the
|
|
latest <tt class="docutils literal"><span class="pre">yasnippet-x.y.z.tar.bz2</span></tt>. You'll get a directory named
|
|
<tt class="docutils literal"><span class="pre">yasnippet</span></tt>, put it in your <tt class="docutils literal"><span class="pre">~/.emacs.d/plugins</span></tt> and add the
|
|
following in your <tt class="docutils literal"><span class="pre">.emacs</span></tt> file:</p>
|
|
<blockquote>
|
|
<div class="highlight"><pre>(<span style="color: #19177C">add-to-list</span> <span style="color: #19177C">'load-path</span>
|
|
<span style="color: #BA2121">"~/.emacs.d/plugins"</span>)
|
|
(<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">"~/.emacs.d/plugins/yasnippet/snippets"</span>)
|
|
</pre></div>
|
|
</blockquote>
|
|
<p>Please refer to the documentation for full customization, or use the
|
|
customization group.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="how-to-use-yasnippet">
|
|
<h1><a class="toc-backref" href="#id5">How to use YASnippet</a></h1>
|
|
<p>Since version 0.6, YASnippet contains more functionality. You don't
|
|
need to know all of it to use it successfully, but you it can improve
|
|
your snippeting experience.</p>
|
|
<p>Hence this section has been split into separate documents:</p>
|
|
<ol class="arabic simple">
|
|
<li><a class="reference external" href="snippet-organization.html">Organizing Snippets</a></li>
|
|
</ol>
|
|
<blockquote>
|
|
Describes ways to organize your snippets in the hard disk (or not
|
|
organize them at all and just use <tt class="docutils literal"><span class="pre">yasnippet-bundle.el</span></tt>.</blockquote>
|
|
<ol class="arabic simple" start="2">
|
|
<li><a class="reference external" href="snippet-expansion.html">Expanding Snippets</a></li>
|
|
</ol>
|
|
<blockquote>
|
|
<p>Describes how YASnippet chooses snippets for expansion at point.</p>
|
|
<p>Maybe, you'll want some snippets to be expanded in a particular
|
|
mode, or only under certain conditions, or be prompted using
|
|
<tt class="docutils literal"><span class="pre">ido</span></tt>, etc...</p>
|
|
</blockquote>
|
|
<ol class="arabic simple" start="3">
|
|
<li><a class="reference external" href="snippet-development.html">Writing Snippets</a></li>
|
|
</ol>
|
|
<blockquote>
|
|
Describes the YASnippet definition syntax, which is very close (but
|
|
not equivalent) to Textmate's. Includes a section about converting
|
|
TextMate snippets.</blockquote>
|
|
<ol class="arabic simple" start="4">
|
|
<li><a class="reference external" href="snippet-menu.html">The YASnippet menu</a></li>
|
|
</ol>
|
|
<blockquote>
|
|
Explains how to use the YASnippet menu to explore and learn new
|
|
snippets.</blockquote>
|
|
</div>
|
|
<div class="section" id="bugs-contribution-and-support">
|
|
<h1><a class="toc-backref" href="#id6">Bugs, Contribution and Support</a></h1>
|
|
<ul class="simple">
|
|
<li>If you find a bug, please report it at <a class="reference external" href="http://code.google.com/p/yasnippet/issues/list">Issue List</a>.</li>
|
|
<li>If you have problem using YASnippet, or have some new ideas,
|
|
including snippets, please post to the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion group</a>.</li>
|
|
</ul>
|
|
<p>Thank you very much for using YASnippet!</p>
|
|
<!-- LocalWords: YASnippet SQL LaTeX CSS yasnippet el eval html ido RET wiki -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|