mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 21:13:04 +00:00
Manual documentation update
This commit is contained in:
Joao Tavora
parent
15f3e4febf
commit
a95ffccdc8
388
changelog.html
Normal file
388
changelog.html
Normal file
@ -0,0 +1,388 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>ChangeLog</title>
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="changelog">
|
||||
<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">ChangeLog</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<div class="section" id="b">
|
||||
<h1>0.7.0b / ????-??-??</h1>
|
||||
<ul class="simple">
|
||||
<li>Filenames can no longer be snippet triggers. Please upgrade your snippet
|
||||
collections.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="c-2009-08-13">
|
||||
<h1>0.6.1c / 2009-08-13</h1>
|
||||
<ul class="simple">
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues">issues</a> 99, 98, 93,
|
||||
90, 91, 88, 87. Thanks everybody.</li>
|
||||
<li>More compliant customization group <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=94">Issue94</a>, (thanks
|
||||
wyuenho).</li>
|
||||
<li>Added workaround for issue 97 in the FAQ</li>
|
||||
<li>Small updates to documentation.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="b-2009-08-29">
|
||||
<h1>0.6.1b / 2009-08-29</h1>
|
||||
<ul class="simple">
|
||||
<li>Much more powerful menu. See <a class="reference external" href="snippet-menu.html">The YASnippet menu</a>.</li>
|
||||
<li>New ways to organize snippets. See <a class="reference external" href="snippet-organization.html">Organizing snippets</a>.</li>
|
||||
<li>Added <tt class="docutils literal"><span class="pre">yas/also-auto-indent-first-line</span></tt> customization variable.</li>
|
||||
<li>Renamed directive <tt class="docutils literal"># env:</tt> to <tt class="docutils literal"># <span class="pre">expand-env:</span></tt></li>
|
||||
<li>Rewrote much of the documentation.</li>
|
||||
<li>Added TextMate import tool <tt class="docutils literal"><span class="pre">textmate-import.rb</span></tt> to to svn
|
||||
repository (see "extras/")</li>
|
||||
<li>Added <em>experimental</em> bundle of textmate snippets
|
||||
<tt class="docutils literal"><span class="pre">yasnippet-textmate-bundle.el</span></tt></li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=74">Issue 74</a> (thanks
|
||||
rmartin.k...@gmail.com)</li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=80">Issues 80 through 84</a> (thanks
|
||||
Moritz Bunkus)</li>
|
||||
<li>Fixed many more issues...</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="c-2009-07-27">
|
||||
<h1>0.6.0c / 2009-07-27</h1>
|
||||
<ul class="simple">
|
||||
<li>Now byte compiles correctly with no warnings.</li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=68">Issue 68</a> with
|
||||
mouse-clicking alternatives in <tt class="docutils literal"><span class="pre">ido-mode</span></tt>.</li>
|
||||
<li>Added <tt class="docutils literal"><span class="pre">yas/also-auto-indent-first-line</span></tt> customization variable.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="b-2009-07-25">
|
||||
<h1>0.6.0b / 2009-07-25</h1>
|
||||
<ul class="simple">
|
||||
<li>Nested placeholders of the type <tt class="docutils literal"><span class="pre"><div${1:</span> <span class="pre">id="${2:someid}"}></span> $0</tt>.</li>
|
||||
<li>More robust undo/redo support.</li>
|
||||
<li>Stacked snippet expansion (<em>snippet in snippet</em>).</li>
|
||||
<li>Transformation on a primary field with syntax <tt class="docutils literal"><span class="pre">${1:default$(transform)}</span></tt></li>
|
||||
<li>Validations on field exit through the <tt class="docutils literal"><span class="pre">yas/verify-value</span></tt>
|
||||
primary field transformation.</li>
|
||||
<li>Wrapping the region in the exit marker <tt class="docutils literal">$0</tt> of the snippet. Use
|
||||
<tt class="docutils literal"><span class="pre">yas/wrap-around-region</span></tt>.</li>
|
||||
<li>Auto-indentation. Use <tt class="docutils literal"><span class="pre">yas/indent-line</span></tt> set to <tt class="docutils literal">'auto</tt></li>
|
||||
<li>Easier definition of snippets. Use <tt class="docutils literal"><span class="pre">yas/find-snippets</span></tt> or
|
||||
<tt class="docutils literal"><span class="pre">yas/visit-snippet-file</span></tt>. In the new <tt class="docutils literal"><span class="pre">snippet-mode</span></tt> use
|
||||
<tt class="docutils literal"><span class="pre">yas/load-snippet-buffer</span></tt> and <tt class="docutils literal"><span class="pre">yas/tryout-snippet</span></tt>.</li>
|
||||
<li>Customization group <tt class="docutils literal">yasnippet</tt>.</li>
|
||||
<li>Overriding customization variables in snippets. Use the <tt class="docutils literal">env:
|
||||
<span class="pre">let-form</span></tt> template keyword.</li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=60">Issue 60</a></li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=65">Issue 65</a></li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=56">Issue 56</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h1>0.5.10 / 2009-02-11</h1>
|
||||
<ul class="simple">
|
||||
<li>Added <em>grouping</em> support so that the snippets in the menu can be
|
||||
groupped together.</li>
|
||||
<li>Make the bundle <a class="reference external" href="http://tromey.com/elpa/index.html">ELPA</a>
|
||||
compatible.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h1>0.5.9 / 2009-01-21</h1>
|
||||
<ul class="simple">
|
||||
<li>Fixed the bug of disabling the auto-indenting of <tt class="docutils literal"><span class="pre">cc-mode</span></tt>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h1>0.5.8 / 2009-01-15</h1>
|
||||
<ul class="simple">
|
||||
<li>Added a <tt class="docutils literal">key</tt> property in snippet definition for snippet names
|
||||
that are not valid path name.</li>
|
||||
<li>Fixed some bugs of indenting (<a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=44">Issue 44</a>, <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=46">Issue
|
||||
46</a>).</li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=45">Issue 45</a> by
|
||||
providing a proper default value for <tt class="docutils literal"><span class="pre">yas/buffer-local-condition</span></tt>.</li>
|
||||
<li>Added helper function <tt class="docutils literal">yas/substr</tt> for convenient mirror
|
||||
transformation.</li>
|
||||
<li>Make variable <tt class="docutils literal"><span class="pre">yas/registered-snippet</span></tt> properly initialized.</li>
|
||||
<li>Fixed the overlay error when overlay becomes empty (<a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=49">Issue 49</a> and
|
||||
<a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=48">Issue 48</a>). This
|
||||
bug has occurred and been fixed earlier, and should not have
|
||||
happened if we have proper regression test.</li>
|
||||
<li>Added a workaround for <tt class="docutils literal"><span class="pre">c-electric-</span></tt> serial commands (<a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=27">Issue 27</a>).</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h1>0.5.7 / 2008-12-03</h1>
|
||||
<ul class="simple">
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=28">Issue 28</a> of
|
||||
properly clean up snippet (by joaotavora).</li>
|
||||
<li>Added a new section "Field-level undo functionality" to correct
|
||||
<a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=33">Issue 33</a>
|
||||
(by joaotavora).</li>
|
||||
<li>Added some snippets from users for sql, erlang, scala, html, xml, latex, etc.</li>
|
||||
<li>Fixed <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=16">Issue 16</a> by adding
|
||||
<tt class="docutils literal">$></tt> support. Here's the <a class="reference external" href="http://pluskid.lifegoo.com/upload/project/yasnippet/doc/define_snippet.html#indenting">doc for $> indenting</a>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id5">
|
||||
<h1>0.5.6 / 2008-08-07</h1>
|
||||
<ul class="simple">
|
||||
<li>Added a buffer local variable <tt class="docutils literal"><span class="pre">yas/dont-activate</span></tt> to turn off
|
||||
<tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> in some major modes. See <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=29">Issue 29</a>.</li>
|
||||
<li>Make the environment of elisp evaluation more friendly to
|
||||
<tt class="docutils literal"><span class="pre">(current-column)</span></tt>.</li>
|
||||
<li>Fixed the regular expression bug in python-mode snippets.</li>
|
||||
<li>Use filename or full key extension for snippet name if no <tt class="docutils literal">name</tt>
|
||||
property is defined.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h1>0.5.5 / 2008-05-29</h1>
|
||||
<ul class="simple">
|
||||
<li>Tweak <tt class="docutils literal"><span class="pre">yas/extra-mode-hooks</span></tt> so that it can be more easily
|
||||
customized.</li>
|
||||
<li>Add an entry in FAQ about why <tt class="docutils literal">TAB</tt> key doesn't work in some
|
||||
modes.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h1>0.5.4 / 2008-05-15</h1>
|
||||
<ul class="simple">
|
||||
<li>Added <tt class="docutils literal"><span class="pre">ox-mode-hook</span></tt> and <tt class="docutils literal"><span class="pre">python-mode-hook</span></tt> to
|
||||
<tt class="docutils literal"><span class="pre">yas/extra-mode-hooks</span></tt> to fix the problem YASnippet is not enabled
|
||||
in those modes.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h1>0.5.3 / 2008-05-07</h1>
|
||||
<ul class="simple">
|
||||
<li>Fix indent of python-mode snippets.</li>
|
||||
<li>Fix a bug of dropdown-list: conflicts with color-theme (<a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=23">Issue 23</a>). Thanks
|
||||
Mike.</li>
|
||||
<li>Fix a bug of condition system.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h1>0.5.2 / 2008-04-20</h1>
|
||||
<ul class="simple">
|
||||
<li>Fix a bug for comparing string to symbol using <tt class="docutils literal">string=</tt> (which
|
||||
will fire an error).</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id10">
|
||||
<h1>0.5.1 / 2008-04-14</h1>
|
||||
<ul class="simple">
|
||||
<li>Use a beautiful css style in the document.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id11">
|
||||
<h1>0.5.0 / 2008-04-10</h1>
|
||||
<ul class="simple">
|
||||
<li>Integrate with hippie-expand. Just add <tt class="docutils literal"><span class="pre">yas/hippie-try-expand</span></tt> to
|
||||
<tt class="docutils literal"><span class="pre">hippie-expand-try-functions-list</span></tt>.</li>
|
||||
<li>If you set <tt class="docutils literal"><span class="pre">yas/fall-back-behavior</span></tt> to <tt class="docutils literal"><span class="pre">'return-nil</span></tt>, YASnippet
|
||||
will return nil when it can't find a snippet to expand.</li>
|
||||
<li>Defect fix: the condition of a snippet was evaluated twice in
|
||||
earlier version.</li>
|
||||
<li>Deleting snippet (using <tt class="docutils literal"><span class="pre">C-w</span></tt> or <tt class="docutils literal"><span class="pre">C-k</span></tt>) won't cause serious
|
||||
problem now.</li>
|
||||
<li>Several complex snippet for python-mode from Yasser included in the
|
||||
distribution.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id12">
|
||||
<h1>0.4.5 / 2008-04-07</h1>
|
||||
<ul class="simple">
|
||||
<li>Merge the latest dropdown-list.el.</li>
|
||||
<li>Add snippets for f90-mode from Li Zhu.</li>
|
||||
<li>Bug fix: l-safe-expr-p: Lisp nesting exceeds <tt class="docutils literal"><span class="pre">max-lisp-eval-depth</span></tt>
|
||||
error when several (more than two) snippets overlaps. Thanks
|
||||
<a class="reference external" href="mailto:sunwaybupt@newsmth">sunwaybupt@newsmth</a> for reporting this bug.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id13">
|
||||
<h1>0.4.4 / 2008-03-24</h1>
|
||||
<ul class="simple">
|
||||
<li>Bug fix: dropdown-list.el doesn't recognize [return] properly.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id14">
|
||||
<h1>0.4.3 / 2008-03-23</h1>
|
||||
<ul class="simple">
|
||||
<li>Bug fix: failed to recognize user customized yas/trigger-key.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id15">
|
||||
<h1>0.4.2 / 2008-03-22</h1>
|
||||
<ul class="simple">
|
||||
<li>Make a separate document package for release. Also make document
|
||||
available online.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id16">
|
||||
<h1>0.4.1 / 2008-03-21</h1>
|
||||
<ul class="simple">
|
||||
<li>Make sure <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt>'s key bindings always take priority to
|
||||
other minor modes.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id17">
|
||||
<h1>0.4.0 / 2008-03-20</h1>
|
||||
<ul class="simple">
|
||||
<li>Document refinement and released with YASnippet. Most of the Online
|
||||
wiki document will be deprecated soon.</li>
|
||||
<li>Powerful condition system added to yasnippet!</li>
|
||||
<li>Incorporate <tt class="docutils literal"><span class="pre">dropdown-list.el</span></tt> and make it default way for
|
||||
selecting multiple candidates. Thanks to <a class="reference external" href="http://groups.google.com/group/smart-snippet/browse_thread/thread/c869158b76addeb3/e7c6372ba457189e">Jaeyoun Chung</a>.</li>
|
||||
<li>yas/before-expand-snippet-hook</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id18">
|
||||
<h1>0.3.2 / 2008-03-19</h1>
|
||||
<ul class="simple">
|
||||
<li>Enhancement: A better way to define minor-mode. Thanks to Kentaro
|
||||
Kuribayashi. See <a class="reference external" href="https://groups.google.com/group/smart-snippet/browse_thread/thread/65cb3b5583eda887?hl=en">this thread</a>
|
||||
for more details.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id19">
|
||||
<h1>0.3.1 / 2008-03-17</h1>
|
||||
<ul class="simple">
|
||||
<li>Bug fix: Emacs get confused when a field is deleted. See <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=10">issue 10</a>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id20">
|
||||
<h1>0.3.0 / 2008-03-16</h1>
|
||||
<ul class="simple">
|
||||
<li>Add a <tt class="docutils literal"><span class="pre">yas/after-exit-snippet-hook</span></tt> so that you can do something like
|
||||
<tt class="docutils literal"><span class="pre">indent-region</span></tt> or <tt class="docutils literal"><span class="pre">fill-region</span></tt> after finish the snippet.</li>
|
||||
<li>Use minor-mode instead of <tt class="docutils literal"><span class="pre">global-set-key</span></tt> to bind the trigger
|
||||
key. Now the trigger key and fall-back behavior can be more
|
||||
flexible. Not constrained to <tt class="docutils literal"><tab></tt>. Thanks to Trey Jackson. See
|
||||
this <a class="reference external" href="https://groups.google.com/group/smart-snippet/browse_thread/thread/937f32a2a6dea4f2?hl=en">thread</a>
|
||||
for more details.</li>
|
||||
<li>Now user can customize the popup function for selecting multiple
|
||||
candidate for the same snippet key.</li>
|
||||
<li>Support <tt class="docutils literal"><span class="pre">dropdown-list.el</span></tt> to be a better way to select multiple
|
||||
candidate when in text mode.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id21">
|
||||
<h1>0.2.3 / 2008-03-15</h1>
|
||||
<ul class="simple">
|
||||
<li>Bug in non-window (-nw) mode when there's multiple candidate to
|
||||
expand. See <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=7">issue 7</a>.</li>
|
||||
<li>Allow expanding another snippet as long as not currently inside a
|
||||
field.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id22">
|
||||
<h1>0.2.2 / 2008-03-13</h1>
|
||||
<ul class="simple">
|
||||
<li>Added customized face for fields and mirrors. Better in dark
|
||||
background. And users can customize it.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id23">
|
||||
<h1>0.2.1 / 2008-03-10</h1>
|
||||
<ul class="simple">
|
||||
<li>Fix the insert-behind problem under both Emacs 22 and Emacs 23.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id24">
|
||||
<h1>0.2.0 / 2008-03-10</h1>
|
||||
<ul class="simple">
|
||||
<li>Use big keymap overlay to detect <tt class="docutils literal"><span class="pre">insert-behind</span></tt> event manually to
|
||||
avoid sometimes missed hook calls. See <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=3">issue 3</a> for more
|
||||
details.</li>
|
||||
<li>Support parent snippet table. Now you can set (for example)
|
||||
<tt class="docutils literal"><span class="pre">cc-mode</span></tt> as common mode for <tt class="docutils literal"><span class="pre">c++-mode</span></tt>, <tt class="docutils literal"><span class="pre">c-mode</span></tt> and
|
||||
<tt class="docutils literal"><span class="pre">java-mode</span></tt>. They'll share snippets defined for <tt class="docutils literal"><span class="pre">cc-mode</span></tt>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id25">
|
||||
<h1>0.1.1 / 2008-03-08</h1>
|
||||
<ul class="simple">
|
||||
<li>Add a rake task to upload to google code.</li>
|
||||
<li>Use elisp compile-bundle function instead of python scrip</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id26">
|
||||
<h1>0.1.0 / 2008-03-07</h1>
|
||||
<ul class="simple">
|
||||
<li>Embedded elisp support.</li>
|
||||
<li>Fields navigation support.</li>
|
||||
<li>Mirror of fields support.</li>
|
||||
<li>Menu-bar support.</li>
|
||||
<li>Multiple snippets with same name support.</li>
|
||||
<li>Popup menu for multiple snippet with same name support.</li>
|
||||
<li>Transformation of fields support.</li>
|
||||
<li>Load directory support.</li>
|
||||
<li>Compile bundle support.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
78
define_snippet.html
Normal file
78
define_snippet.html
Normal file
@ -0,0 +1,78 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>Moved</title>
|
||||
<meta content="3; URL=index.html" http-equiv="Refresh" />
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="moved">
|
||||
<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">Moved</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<p>This page has been moved. Click <a class="reference external" href="index.html">here</a> if your browser
|
||||
does not automatically redirect you</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
189
faq.html
Normal file
189
faq.html
Normal file
@ -0,0 +1,189 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>Frequently Asked Questions</title>
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="frequently-asked-questions">
|
||||
<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">Frequently Asked Questions</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<div class="section" id="why-is-there-an-extra-newline">
|
||||
<h1>Why is there an extra newline?</h1>
|
||||
<p>If you have a newline at the end of the snippet definition file, then
|
||||
YASnippet will add a newline when you expanding a snippet. Please
|
||||
don't add a newline at the end if you don't want it when you saving
|
||||
the snippet file.</p>
|
||||
<p>Note some editors will automatically add a newline for you. In Emacs,
|
||||
if you set <tt class="docutils literal"><span class="pre">require-final-newline</span></tt> to <tt class="docutils literal">t</tt>, it will add the final
|
||||
newline for you automatically.</p>
|
||||
</div>
|
||||
<div class="section" id="why-doesn-t-tab-expand-a-snippet">
|
||||
<h1>Why doesn't TAB expand a snippet?</h1>
|
||||
<p>First check the mode line to see if there's <tt class="docutils literal">yas</tt>. If not, then try
|
||||
<tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/minor-mode</span></tt> to manually turn on the minor mode and try to
|
||||
expand the snippet again. If it works, then, you can add the following
|
||||
code to your <tt class="docutils literal">.emacs</tt> <em>before</em> loading YASnippet:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(add-hook 'the-major-mode-hook 'yas/minor-mode-on)
|
||||
</pre></div>
|
||||
<p>where <tt class="docutils literal"><span class="pre">the-major-mode</span></tt> is the major mode in which <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt>
|
||||
isn't enabled by default.</p>
|
||||
<p>From YASnippet 0.6 you can also use the command <tt class="docutils literal"><span class="pre">M-x</span>
|
||||
<span class="pre">yas/global-mode</span></tt> to turn on YASnippet automatically for <em>all</em> major
|
||||
modes.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> is on but the snippet still not expanded. Then
|
||||
try to see what command is bound to the <tt class="docutils literal">TAB</tt> key: press <tt class="docutils literal"><span class="pre">C-h</span> k</tt>
|
||||
and then press <tt class="docutils literal">TAB</tt>. Emacs will show you the result.</p>
|
||||
<p>You'll see a buffer prompted by Emacs saying that <tt class="docutils literal">TAB runs the
|
||||
command ...</tt>. Alternatively, you might see <tt class="docutils literal"><tab> runs the command
|
||||
...</tt>, note the difference between <tt class="docutils literal">TAB</tt> and <tt class="docutils literal"><tab></tt> where the
|
||||
latter has priority. If you see <tt class="docutils literal"><tab></tt> bound to a command other
|
||||
than <tt class="docutils literal">yas/expand</tt>, (e.g. in <tt class="docutils literal"><span class="pre">org-mode</span></tt>) you can try the following
|
||||
code to work around:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(add-hook 'org-mode-hook
|
||||
(let ((original-command (lookup-key org-mode-map [tab])))
|
||||
`(lambda ()
|
||||
(setq yas/fallback-behavior
|
||||
'(apply ,original-command))
|
||||
(local-set-key [tab] 'yas/expand))))
|
||||
</pre></div>
|
||||
<p>replace <tt class="docutils literal"><span class="pre">org-mode-hook</span></tt> and <tt class="docutils literal"><span class="pre">org-mode-map</span></tt> with the major mode
|
||||
hook you are dealing with (Use <tt class="docutils literal"><span class="pre">C-h</span> m</tt> to see what major mode you
|
||||
are in).</p>
|
||||
<p>As an alternative, you can also try</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(defun yas/advise-indent-function (function-symbol)
|
||||
(eval `(defadvice ,function-symbol (around yas/try-expand-first activate)
|
||||
,(format
|
||||
"Try to expand a snippet before point, then call `%s' as usual"
|
||||
function-symbol)
|
||||
(let ((yas/fallback-behavior nil))
|
||||
(unless (and (interactive-p)
|
||||
(yas/expand))
|
||||
ad-do-it)))))
|
||||
|
||||
(yas/advise-indent-function 'ruby-indent-line)
|
||||
</pre></div>
|
||||
<p>To <em>advise</em> the modes indentation function bound to TAB, (in this case
|
||||
<tt class="docutils literal"><span class="pre">ruby-indent-line</span></tt>) to first try to run <tt class="docutils literal">yas/expand</tt>.</p>
|
||||
<p>If the output of <tt class="docutils literal"><span class="pre">C-h</span> k RET <tab></tt> tells you that <tt class="docutils literal"><tab></tt> is
|
||||
indeed bound to <tt class="docutils literal">yas/expand</tt> but YASnippet still doesn't work, check
|
||||
your configuration and you may also ask for help on the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion
|
||||
group</a>. See this
|
||||
particular <a class="reference external" href="http://code.google.com/p/yasnippet/issues/detail?id=93&can=1">thread</a> for
|
||||
quite some solutions and alternatives.</p>
|
||||
<p>Don't forget to attach the information on what command is bound to TAB
|
||||
as well as the mode information (Can be obtained by <tt class="docutils literal"><span class="pre">C-h</span> m</tt>).</p>
|
||||
</div>
|
||||
<div class="section" id="why-doesn-t-tab-navigation-work-with-flyspell">
|
||||
<h1>Why doesn't TAB navigation work with flyspell</h1>
|
||||
<p>A workaround is to inhibit flyspell overlays while the snippet is active:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(add-hook 'flyspell-incorrect-hook
|
||||
#'(lambda (dummy1 dummy2 dymmy3)
|
||||
(and yas/active-field-overlay
|
||||
(overlay-buffer yas/active-field-overlay))))
|
||||
</pre></div>
|
||||
<p>This is apparently related to overlay priorities. For some reason, the
|
||||
<tt class="docutils literal">keymap</tt> property of flyspell's overlays always takes priority over
|
||||
the same property in yasnippet's overlays, even if one sets the
|
||||
latter's <tt class="docutils literal">priority</tt> property to something big. If you know
|
||||
emacs-lisp and can solve this problem, drop a line in the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion
|
||||
group</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="how-do-i-turn-off-the-minor-mode-where-in-some-buffers">
|
||||
<h1>How do I turn off the minor mode where in some buffers</h1>
|
||||
<p>The best way, since version 0.6.1c, is to set the default value of the
|
||||
variable <tt class="docutils literal"><span class="pre">yas/dont-activate</span></tt> to a lambda function like so:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(set-default 'yas/dont-activate
|
||||
#'(lambda ()
|
||||
(and yas/root-directory
|
||||
(null (yas/get-snippet-tables)))))
|
||||
</pre></div>
|
||||
<p>This is also the default value starting for that version. It skips the
|
||||
minor mode in buffers where it is not applicable (no snippet tables),
|
||||
but only once you have setup your yas/root-directory.</p>
|
||||
</div>
|
||||
<div class="section" id="how-do-i-define-an-abbrev-key-containing-characters-not-supported-by-the-filesystem">
|
||||
<h1>How do I define an abbrev key containing characters not supported by the filesystem?</h1>
|
||||
<dl class="docutils">
|
||||
<dt><strong>Note</strong>: This question applies if you're still defining snippets</dt>
|
||||
<dd>whose key <em>is</em> the filename. This is behavior stil provided by
|
||||
version 0.6 for backward compatibilty, but is somewhat deprecated...</dd>
|
||||
</dl>
|
||||
<p>For example, you want to define a snippet by the key <tt class="docutils literal"><</tt> which is
|
||||
not a valid character for filename on Windows. This means you can't
|
||||
use the filename as a trigger key in this case.</p>
|
||||
<p>You should rather use the <tt class="docutils literal"># key:</tt> directive to specify the key of
|
||||
the defined snippet explicitly and name your snippet with an arbitrary
|
||||
valid filename, <tt class="docutils literal">lt.yasnippet</tt> for example, using <tt class="docutils literal"><</tt> for the
|
||||
<tt class="docutils literal"># key:</tt> directive:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">#key: <
|
||||
#name: <...></...>
|
||||
# --
|
||||
<${1:div}>$0</$1>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
BIN
images/bg-content-left.png
Normal file
BIN
images/bg-content-left.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
BIN
images/bg-content-right.png
Normal file
BIN
images/bg-content-right.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.1 KiB |
BIN
images/bg-content.png
Normal file
BIN
images/bg-content.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 485 B |
BIN
images/bg-navigation-item-hover.png
Normal file
BIN
images/bg-navigation-item-hover.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 441 B |
BIN
images/bg-navigation-item.png
Normal file
BIN
images/bg-navigation-item.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 502 B |
BIN
images/bg-navigation.png
Normal file
BIN
images/bg-navigation.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 104 B |
BIN
images/body.png
Normal file
BIN
images/body.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 712 B |
BIN
images/customization-group.png
Normal file
BIN
images/customization-group.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
BIN
images/dropdown-menu.png
Normal file
BIN
images/dropdown-menu.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
BIN
images/external.png
Normal file
BIN
images/external.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 B |
BIN
images/ido-menu.png
Normal file
BIN
images/ido-menu.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
BIN
images/menu-1.png
Normal file
BIN
images/menu-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
BIN
images/menu-2.png
Normal file
BIN
images/menu-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
BIN
images/menu-groups.png
Normal file
BIN
images/menu-groups.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
BIN
images/menu-parent.png
Normal file
BIN
images/menu-parent.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
BIN
images/minor-mode-indicator.png
Normal file
BIN
images/minor-mode-indicator.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.8 KiB |
BIN
images/x-menu.png
Normal file
BIN
images/x-menu.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
601
snippet-development.html
Normal file
601
snippet-development.html
Normal file
@ -0,0 +1,601 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>Writing snippets</title>
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="writing-snippets">
|
||||
<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">Writing snippets</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<div class="contents topic" id="contents">
|
||||
<p class="topic-title first">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#snippet-development" id="id3">Snippet development</a><ul>
|
||||
<li><a class="reference internal" href="#quickly-finding-snippets" id="id4">Quickly finding snippets</a></li>
|
||||
<li><a class="reference internal" href="#using-the-snippet-mode-major-mode" id="id5">Using the <tt class="docutils literal"><span class="pre">snippet-mode</span></tt> major mode</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#file-content" id="id6">File content</a><ul>
|
||||
<li><a class="reference internal" href="#key-snippet-abbrev" id="id7"><tt class="docutils literal"># key:</tt> snippet abbrev</a></li>
|
||||
<li><a class="reference internal" href="#name-snippet-name" id="id8"><tt class="docutils literal"># name:</tt> snippet name</a></li>
|
||||
<li><a class="reference internal" href="#condition-snippet-condition" id="id9"><tt class="docutils literal"># condition:</tt> snippet condition</a></li>
|
||||
<li><a class="reference internal" href="#group-snippet-menu-grouping" id="id10"><tt class="docutils literal"># group:</tt> snippet menu grouping</a></li>
|
||||
<li><a class="reference internal" href="#expand-env-expand-environment" id="id11"><tt class="docutils literal"># <span class="pre">expand-env:</span></tt> expand environment</a></li>
|
||||
<li><a class="reference internal" href="#binding-direct-keybinding" id="id12"><tt class="docutils literal"># binding:</tt> direct keybinding</a></li>
|
||||
<li><a class="reference internal" href="#contributor-snippet-author" id="id13"><tt class="docutils literal"># contributor:</tt> snippet author</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#template-syntax" id="id14">Template syntax</a><ul>
|
||||
<li><a class="reference internal" href="#plain-text" id="id15">Plain Text</a></li>
|
||||
<li><a class="reference internal" href="#embedded-emacs-lisp-code" id="id16">Embedded Emacs-lisp code</a></li>
|
||||
<li><a class="reference internal" href="#tab-stop-fields" id="id17">Tab stop fields</a></li>
|
||||
<li><a class="reference internal" href="#placeholder-fields" id="id18">Placeholder fields</a></li>
|
||||
<li><a class="reference internal" href="#id2" id="id19">Mirrors</a></li>
|
||||
<li><a class="reference internal" href="#mirrors-with-transformations" id="id20">Mirrors with transformations</a></li>
|
||||
<li><a class="reference internal" href="#fields-with-transformations" id="id21">Fields with transformations</a></li>
|
||||
<li><a class="reference internal" href="#choosing-fields-value-from-a-list-and-other-tricks" id="id22">Choosing fields value from a list and other tricks</a></li>
|
||||
<li><a class="reference internal" href="#nested-placeholder-fields" id="id23">Nested placeholder fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#customizable-variables" id="id24">Customizable variables</a><ul>
|
||||
<li><a class="reference internal" href="#yas-trigger-key" id="id25"><tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-next-field-key" id="id26"><tt class="docutils literal"><span class="pre">yas/next-field-key</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-prev-field-key" id="id27"><tt class="docutils literal"><span class="pre">yas/prev-field-key</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-skip-and-clear-key" id="id28"><tt class="docutils literal"><span class="pre">yas/skip-and-clear-key</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-good-grace" id="id29"><tt class="docutils literal"><span class="pre">yas/good-grace</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-indent-line" id="id30"><tt class="docutils literal"><span class="pre">yas/indent-line</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-wrap-around-region" id="id31"><tt class="docutils literal"><span class="pre">yas/wrap-around-region</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-triggers-in-field" id="id32"><tt class="docutils literal"><span class="pre">yas/triggers-in-field</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-snippet-revival" id="id33"><tt class="docutils literal"><span class="pre">yas/snippet-revival</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-after-exit-snippet-hook-and-yas-before-expand-snippet-hook" id="id34"><tt class="docutils literal"><span class="pre">yas/after-exit-snippet-hook</span></tt> and <tt class="docutils literal"><span class="pre">yas/before-expand-snippet-hook</span></tt></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#importing-textmate-snippets" id="id35">Importing TextMate snippets</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="snippet-development">
|
||||
<h1><a class="toc-backref" href="#id3">Snippet development</a></h1>
|
||||
<div class="section" id="quickly-finding-snippets">
|
||||
<h2><a class="toc-backref" href="#id4">Quickly finding snippets</a></h2>
|
||||
<p>There are some ways you can quickly find a snippet file:</p>
|
||||
<ul>
|
||||
<li><p class="first"><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/new-snippet</span></tt></p>
|
||||
<p>Prompts you for a snippet name, then tries to guess a suitable
|
||||
directory to store it, prompting you for creation if it does not
|
||||
exist. Finally, places you in a new buffer set to <tt class="docutils literal"><span class="pre">snippet-mode</span></tt>
|
||||
so you can write your snippet.</p>
|
||||
</li>
|
||||
<li><p class="first"><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/find-snippets</span></tt></p>
|
||||
<p>Lets you find the snippet file in the directory the snippet was
|
||||
loaded from (if it exists) like <tt class="docutils literal"><span class="pre">find-file-other-window</span></tt>. The
|
||||
directory searching logic is similar to <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/new-snippet</span></tt>.</p>
|
||||
</li>
|
||||
<li><p class="first"><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/visit-snippet-file</span></tt></p>
|
||||
<p>Prompts you for possible snippet expansions like
|
||||
<tt class="docutils literal"><span class="pre">yas/insert-snippet</span></tt>, but instead of expanding it, takes you
|
||||
directly to the snippet definition's file, if it exists.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Once you find this file it will be set to <tt class="docutils literal"><span class="pre">snippet-mode</span></tt> (see ahead)
|
||||
and you can start editing your snippet.</p>
|
||||
</div>
|
||||
<div class="section" id="using-the-snippet-mode-major-mode">
|
||||
<h2><a class="toc-backref" href="#id5">Using the <tt class="docutils literal"><span class="pre">snippet-mode</span></tt> major mode</a></h2>
|
||||
<p>There is a major mode <tt class="docutils literal"><span class="pre">snippet-mode</span></tt> to edit snippets. You can set
|
||||
the buffer to this mode with <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">snippet-mode</span></tt>. It provides
|
||||
reasonably useful syntax highlighting.</p>
|
||||
<p>Two commands are defined in this mode:</p>
|
||||
<ul>
|
||||
<li><p class="first"><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/load-snippet-buffer</span></tt></p>
|
||||
<blockquote>
|
||||
<p>When editing a snippet, this loads the snippet into the correct
|
||||
mode and menu. Bound to <tt class="docutils literal"><span class="pre">C-c</span> <span class="pre">C-c</span></tt> by default while in
|
||||
<tt class="docutils literal"><span class="pre">snippet-mode</span></tt>.</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
<li><p class="first"><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/tryout-snippet</span></tt></p>
|
||||
<blockquote>
|
||||
<p>When editing a snippet, this opens a new empty buffer, sets it to
|
||||
the appropriate major mode and inserts the snippet there, so you
|
||||
can see what it looks like. This is bound to <tt class="docutils literal"><span class="pre">C-c</span> <span class="pre">C-t</span></tt> while in
|
||||
<tt class="docutils literal"><span class="pre">snippet-mode</span></tt>.</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
</ul>
|
||||
<p>There are also <em>snippets for writing snippets</em>: <tt class="docutils literal">vars</tt>, <tt class="docutils literal">$f</tt> and
|
||||
<tt class="docutils literal">$m</tt> :-).</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="file-content">
|
||||
<h1><a class="toc-backref" href="#id6">File content</a></h1>
|
||||
<p>A file defining a snippet generally contains the template to be
|
||||
expanded.</p>
|
||||
<p>Optionally, if the file contains a line of <tt class="docutils literal"># <span class="pre">--</span></tt>, the lines above
|
||||
it count as comments, some of which can be <em>directives</em> (or meta
|
||||
data). Snippet directives look like <tt class="docutils literal"># property: value</tt> and tweak
|
||||
certain snippets properties described below. If no <tt class="docutils literal"># <span class="pre">--</span></tt> is found,
|
||||
the whole file is considered the snippet template.</p>
|
||||
<p>Here's a typical example:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">#contributor : pluskid <pluskid@gmail.com>
|
||||
#name : __...__
|
||||
# --
|
||||
__${init}__
|
||||
</pre></div>
|
||||
<p>Here's a list of currently supported directives:</p>
|
||||
<div class="section" id="key-snippet-abbrev">
|
||||
<h2><a class="toc-backref" href="#id7"><tt class="docutils literal"># key:</tt> snippet abbrev</a></h2>
|
||||
<p>This is the probably the most important directive, it's the abbreviation you
|
||||
type to expand a snippet just before hitting <tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt>. If you don't
|
||||
specify this the snippet will not be expandable through the key mechanism.</p>
|
||||
</div>
|
||||
<div class="section" id="name-snippet-name">
|
||||
<h2><a class="toc-backref" href="#id8"><tt class="docutils literal"># name:</tt> snippet name</a></h2>
|
||||
<p>This is a one-line description of the snippet. It will be displayed in
|
||||
the menu. It's a good idea to select a descriptive name for a
|
||||
snippet -- especially distinguishable among similar snippets.</p>
|
||||
<p>If you omit this name it will default to the file name the snippet was
|
||||
loaded from.</p>
|
||||
</div>
|
||||
<div class="section" id="condition-snippet-condition">
|
||||
<h2><a class="toc-backref" href="#id9"><tt class="docutils literal"># condition:</tt> snippet condition</a></h2>
|
||||
<p>This is a piece of Emacs-lisp code. If a snippet has a condition, then it
|
||||
will only be expanded when the condition code evaluate to some non-nil
|
||||
value.</p>
|
||||
<p>See also <tt class="docutils literal"><span class="pre">yas/buffer-local-condition</span></tt> in <a class="reference external" href="snippet-expansion.html">Expanding snippets</a></p>
|
||||
</div>
|
||||
<div class="section" id="group-snippet-menu-grouping">
|
||||
<h2><a class="toc-backref" href="#id10"><tt class="docutils literal"># group:</tt> snippet menu grouping</a></h2>
|
||||
<p>When expanding/visiting snippets from the menu-bar menu, snippets for a
|
||||
given mode can be grouped into sub-menus . This is useful if one has
|
||||
too many snippets for a mode which will make the menu too
|
||||
long.</p>
|
||||
<p>The <tt class="docutils literal"># group:</tt> property only affect menu construction (See <a class="reference external" href="snippet-menu.html">the
|
||||
YASnippet menu</a>) and the same effect can be achieved by grouping
|
||||
snippets into sub-directories and using the <tt class="docutils literal"><span class="pre">.yas-make-groups</span></tt>
|
||||
special file (for this see <a class="reference external" href="snippet-organization.html">Organizing Snippets</a></p>
|
||||
<p>Refer to the bundled snippets for <tt class="docutils literal"><span class="pre">ruby-mode</span></tt> for examples on the
|
||||
<tt class="docutils literal"># group:</tt> directive. Group can also be nested, e.g. <tt class="docutils literal">control
|
||||
structure.loops</tt> tells that the snippet is under the <tt class="docutils literal">loops</tt> group
|
||||
which is under the <tt class="docutils literal">control structure</tt> group.</p>
|
||||
</div>
|
||||
<div class="section" id="expand-env-expand-environment">
|
||||
<h2><a class="toc-backref" href="#id11"><tt class="docutils literal"># <span class="pre">expand-env:</span></tt> expand environment</a></h2>
|
||||
<p>This is another piece of Emacs-lisp code in the form of a <tt class="docutils literal">let</tt>
|
||||
<em>varlist form</em>, i.e. a list of lists assigning values to variables. It
|
||||
can be used to override variable values while the snippet is being
|
||||
expanded.</p>
|
||||
<p>Interesting variables to override are <tt class="docutils literal"><span class="pre">yas/wrap-around-region</span></tt> and
|
||||
<tt class="docutils literal"><span class="pre">yas/indent-line</span></tt> (see <a class="reference external" href="snippet-expansion.html">Expanding Snippets</a>).</p>
|
||||
<p>As an example, you might normally have <tt class="docutils literal"><span class="pre">yas/indent-line</span></tt> set to
|
||||
<tt class="docutils literal">'auto</tt> and <tt class="docutils literal"><span class="pre">yas/wrap-around-region</span></tt> set to <tt class="docutils literal">t</tt>, but for this
|
||||
particularly brilliant piece of ASCII art these values would mess up
|
||||
your hard work. You can then use:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"># name : ASCII home
|
||||
# expand-env: ((yas/indent-line 'fixed) (yas/wrap-around-region 'nil))
|
||||
# --
|
||||
welcome to my
|
||||
X humble
|
||||
/ \ home,
|
||||
/ \ $0
|
||||
/ \
|
||||
/-------\
|
||||
| |
|
||||
| +-+ |
|
||||
| | | |
|
||||
+--+-+--+
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="binding-direct-keybinding">
|
||||
<h2><a class="toc-backref" href="#id12"><tt class="docutils literal"># binding:</tt> direct keybinding</a></h2>
|
||||
<p>You can use this directive to expand a snippet directly from a normal
|
||||
Emacs keybinding. The keybinding will be registered in the Emacs
|
||||
keymap named after the major mode the snippet is active
|
||||
for.</p>
|
||||
<p>Additionally a variable <tt class="docutils literal">yas/prefix</tt> is set to to the prefix
|
||||
argument you normally use for a command. This allows for small
|
||||
variations on the same snippet, for example in this "html-mode"
|
||||
snippet.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">#name : <p>...</p>
|
||||
#binding: C-c C-c C-m
|
||||
# --
|
||||
<p>`(when yas/prefix "\n")`$0`(when yas/prefix "\n")`</p>
|
||||
</pre></div>
|
||||
<p>This binding will be recorded in the keymap
|
||||
<tt class="docutils literal"><span class="pre">html-mode-map</span></tt>. To expand a paragraph tag newlines, just
|
||||
press <tt class="docutils literal"><span class="pre">C-u</span> <span class="pre">C-c</span> <span class="pre">C-c</span> <span class="pre">C-m</span></tt>. Omitting the <tt class="docutils literal"><span class="pre">C-u</span></tt> will expand the
|
||||
paragraph tag without newlines.</p>
|
||||
</div>
|
||||
<div class="section" id="contributor-snippet-author">
|
||||
<h2><a class="toc-backref" href="#id13"><tt class="docutils literal"># contributor:</tt> snippet author</a></h2>
|
||||
<p>This is optional and has no effect whatsoever on snippet
|
||||
functionality, but it looks nice.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="template-syntax">
|
||||
<h1><a class="toc-backref" href="#id14">Template syntax</a></h1>
|
||||
<p>The syntax of the snippet template is simple but powerful, very
|
||||
similar to TextMate's.</p>
|
||||
<div class="section" id="plain-text">
|
||||
<h2><a class="toc-backref" href="#id15">Plain Text</a></h2>
|
||||
<p>Arbitrary text can be included as the content of a template. They are
|
||||
usually interpreted as plain text, except <tt class="docutils literal">$</tt> and <tt class="docutils literal">`</tt>. You need to
|
||||
use <tt class="docutils literal">\</tt> to escape them: <tt class="docutils literal">\$</tt> and <tt class="docutils literal">\`</tt>. The <tt class="docutils literal">\</tt> itself may also
|
||||
needed to be escaped as <tt class="docutils literal">\\</tt> sometimes.</p>
|
||||
</div>
|
||||
<div class="section" id="embedded-emacs-lisp-code">
|
||||
<h2><a class="toc-backref" href="#id16">Embedded Emacs-lisp code</a></h2>
|
||||
<p>Emacs-Lisp code can be embedded inside the template, written inside
|
||||
back-quotes (<tt class="docutils literal">`</tt>). The lisp forms are evaluated when the snippet is
|
||||
being expanded. The evaluation is done in the same buffer as the
|
||||
snippet being expanded.</p>
|
||||
<p>Here's an example for <tt class="docutils literal"><span class="pre">c-mode</span></tt> to calculate the header file guard
|
||||
dynamically:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">#ifndef ${1:_`(upcase (file-name-nondirectory (file-name-sans-extension (buffer-file-name))))`_H_}
|
||||
#define $1
|
||||
|
||||
$0
|
||||
|
||||
#endif /* $1 */
|
||||
</pre></div>
|
||||
<p>From version 0.6, snippets expansions are run with some special
|
||||
Emacs-lisp variables bound. One of this is <tt class="docutils literal"><span class="pre">yas/selected-text</span></tt>. You
|
||||
can therefore define a snippet like:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">for ($1;$2;$3) {
|
||||
`yas/selected-text`$0
|
||||
}
|
||||
</pre></div>
|
||||
<p>to "wrap" the selected region inside your recently inserted
|
||||
snippet. Alternatively, you can also customize the variable
|
||||
<tt class="docutils literal"><span class="pre">yas/wrap-around-region</span></tt> to <tt class="docutils literal">t</tt> which will do this automatically.</p>
|
||||
</div>
|
||||
<div class="section" id="tab-stop-fields">
|
||||
<h2><a class="toc-backref" href="#id17">Tab stop fields</a></h2>
|
||||
<p>Tab stops are fields that you can navigate back and forth by <tt class="docutils literal">TAB</tt>
|
||||
and <tt class="docutils literal"><span class="pre">S-TAB</span></tt>. They are written by <tt class="docutils literal">$</tt> followed with a
|
||||
number. <tt class="docutils literal">$0</tt> has the special meaning of the <em>exit point</em> of a
|
||||
snippet. That is the last place to go when you've traveled all the
|
||||
fields. Here's a typical example:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"><div$1>
|
||||
$0
|
||||
</div>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="placeholder-fields">
|
||||
<h2><a class="toc-backref" href="#id18">Placeholder fields</a></h2>
|
||||
<p>Tab stops can have default values -- a.k.a placeholders. The syntax is
|
||||
like this:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">${N:default value}
|
||||
</pre></div>
|
||||
<p>They acts as the default value for a tab stop. But when you firstly
|
||||
type at a tab stop, the default value will be replaced by your
|
||||
typing. The number can be omitted if you don't want to create
|
||||
<a class="reference internal" href="#mirrors">mirrors</a> or <a class="reference internal" href="#transformations">transformations</a> for this field.</p>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<span id="mirrors"></span><h2><a class="toc-backref" href="#id19">Mirrors</a></h2>
|
||||
<p>We refer the tab stops with placeholders as a <em>field</em>. A field can have
|
||||
mirrors. Its mirrors will get updated when you change the text of a
|
||||
field. Here's an example:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">\begin{${1:enumerate}}
|
||||
$0
|
||||
\end{$1}
|
||||
</pre></div>
|
||||
<p>When you type <tt class="docutils literal">"document"</tt> at <tt class="docutils literal">${1:enumerate}</tt>, the word
|
||||
<tt class="docutils literal">"document"</tt> will also be inserted at <tt class="docutils literal"><span class="pre">\end{$1}</span></tt>. The best
|
||||
explanation is to see the screencast(<a class="reference external" href="http://www.youtube.com/watch?v=vOj7btx3ATg">YouTube</a> or <a class="reference external" href="http://yasnippet.googlecode.com/files/yasnippet.avi">avi video</a>).</p>
|
||||
<p>The tab stops with the same number to the field act as its mirrors. If
|
||||
none of the tab stops has an initial value, the first one is selected
|
||||
as the field and others mirrors.</p>
|
||||
</div>
|
||||
<div class="section" id="mirrors-with-transformations">
|
||||
<span id="transformations"></span><h2><a class="toc-backref" href="#id20">Mirrors with transformations</a></h2>
|
||||
<p>If the value of an <tt class="docutils literal">${n:</tt>-construct starts with and contains <tt class="docutils literal">$(</tt>,
|
||||
then it is interpreted as a mirror for field <tt class="docutils literal">n</tt> with a
|
||||
transformation. The mirror's text content is calculated according to
|
||||
this transformation, which is Emacs-lisp code that gets evaluated in
|
||||
an environment where the variable <tt class="docutils literal">text</tt> (or <tt class="docutils literal">yas/text</tt>) is bound
|
||||
to the text content (string) contained in the field <tt class="docutils literal">n</tt>.Here's an
|
||||
example for Objective-C:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">- (${1:id})${2:foo}
|
||||
{
|
||||
return $2;
|
||||
}
|
||||
|
||||
- (void)set${2:$(capitalize text)}:($1)aValue
|
||||
{
|
||||
[$2 autorelease];
|
||||
$2 = [aValue retain];
|
||||
}
|
||||
$0
|
||||
</pre></div>
|
||||
<p>Look at <tt class="docutils literal"><span class="pre">${2:$(capitalize</span> text)}</tt>, it is a mirror with
|
||||
transformation instead of a field. The actual field is at the first
|
||||
line: <tt class="docutils literal">${2:foo}</tt>. When you type text in <tt class="docutils literal">${2:foo}</tt>, the
|
||||
transformation will be evaluated and the result will be placed there
|
||||
as the transformed text. So in this example, if you type "baz" in the
|
||||
field, the transformed text will be "Baz". This example is also
|
||||
available in the screencast.</p>
|
||||
<p>Another example is for <tt class="docutils literal"><span class="pre">rst-mode</span></tt>. In reStructuredText, the document
|
||||
title can be some text surrounded by "===" below and above. The "==="
|
||||
should be at least as long as the text. So</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">=====
|
||||
Title
|
||||
=====
|
||||
</pre></div>
|
||||
<p>is a valid title but</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">===
|
||||
Title
|
||||
===
|
||||
</pre></div>
|
||||
<p>is not. Here's an snippet for rst title:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">${1:$(make-string (string-width text) ?\=)}
|
||||
${1:Title}
|
||||
${1:$(make-string (string-width text) ?\=)}
|
||||
|
||||
$0
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="fields-with-transformations">
|
||||
<h2><a class="toc-backref" href="#id21">Fields with transformations</a></h2>
|
||||
<p>From version 0.6 on, you can also have lisp transformation inside
|
||||
fields. These work mostly mirror transformations but are evaluated
|
||||
when you first enter the field, after each change you make to the
|
||||
field and also just before you exit the field.</p>
|
||||
<p>The syntax is also a tiny bit different, so that the parser can
|
||||
distinguish between fields and mirrors. In the following example</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">#define "${1:mydefine$(upcase yas/text)}"
|
||||
</pre></div>
|
||||
<p><tt class="docutils literal">mydefine</tt> gets automatically upcased to <tt class="docutils literal">MYDEFINE</tt> once you enter
|
||||
the field. As you type text, it gets filtered through the
|
||||
transformation every time.</p>
|
||||
<p>Note that to tell this kind of expression from a mirror with a
|
||||
transformation, YASnippet needs extra text between the <tt class="docutils literal">:</tt> and the
|
||||
transformation's <tt class="docutils literal">$</tt>. If you don't want this extra-text, you can use
|
||||
two <tt class="docutils literal">$</tt>'s instead.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">#define "${1:$$(upcase yas/text)}"
|
||||
</pre></div>
|
||||
<p>Please note that as soon as a transformation takes place, it changes
|
||||
the value of the field and sets it its internal modification state to
|
||||
<tt class="docutils literal">true</tt>. As a consequence, the auto-deletion behaviour of normal
|
||||
fields does not take place. This is by design.</p>
|
||||
</div>
|
||||
<div class="section" id="choosing-fields-value-from-a-list-and-other-tricks">
|
||||
<h2><a class="toc-backref" href="#id22">Choosing fields value from a list and other tricks</a></h2>
|
||||
<p>As mentioned, the field transformation is invoked just after you enter
|
||||
the field, and with some useful variables bound, notably
|
||||
<tt class="docutils literal"><span class="pre">yas/field-modified-p</span></tt> and <tt class="docutils literal"><span class="pre">yas/moving-away-p</span></tt>. Because of this
|
||||
feature you can place a transformation in the primary field that lets
|
||||
you select default values for it.</p>
|
||||
<p>The <tt class="docutils literal"><span class="pre">yas/choose-value</span></tt> does this work for you. For example:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"><div align="${2:$$(yas/choose-value '("right" "center" "left"))}">
|
||||
$0
|
||||
</div>
|
||||
</pre></div>
|
||||
<p>See the definition of <tt class="docutils literal"><span class="pre">yas/choose-value</span></tt> to see how it was written
|
||||
using the two variables.</p>
|
||||
<p>Here's another use, for LaTeX-mode, which calls reftex-label just as
|
||||
you enter snippet field 2. This one makes use of <tt class="docutils literal"><span class="pre">yas/modified-p</span></tt>
|
||||
directly.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">\section{${1:"Titel der Tour"}}%
|
||||
\index{$1}%
|
||||
\label{{2:"waiting for reftex-label call..."$(unless yas/modified-p (reftex-label nil 'dont-
|
||||
insert))}}%
|
||||
</pre></div>
|
||||
<p>The function <tt class="docutils literal"><span class="pre">yas/verify-value</span></tt> has another neat trick, and makes
|
||||
use of <tt class="docutils literal"><span class="pre">yas/moving-away-p</span></tt>. Try it and see! Also, check out this
|
||||
<a class="reference external" href="http://groups.google.com/group/smart-snippet/browse_thread/thread/282a90a118e1b662">thread</a></p>
|
||||
</div>
|
||||
<div class="section" id="nested-placeholder-fields">
|
||||
<h2><a class="toc-backref" href="#id23">Nested placeholder fields</a></h2>
|
||||
<p>From version 0.6 on, you can also have nested placeholders of the type:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"><div${1: id="${2:some_id}"}>$0</div>
|
||||
</pre></div>
|
||||
<p>This allows you to choose if you want to give this <tt class="docutils literal">div</tt> an <tt class="docutils literal">id</tt>
|
||||
attribute. If you tab forward after expanding it will let you change
|
||||
"some_id" to whatever you like. Alternatively, you can just press
|
||||
<tt class="docutils literal"><span class="pre">C-d</span></tt> (which executes <tt class="docutils literal"><span class="pre">yas/skip-and-clear-or-delete-char</span></tt>) and go
|
||||
straight to the exit marker.</p>
|
||||
<p>By the way, <tt class="docutils literal"><span class="pre">C-d</span></tt> will only clear the field if you cursor is at the
|
||||
beginning of the field <em>and</em> it hasn't been changed yet. Otherwise, it
|
||||
performs the normal Emacs <tt class="docutils literal"><span class="pre">delete-char</span></tt> command.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="customizable-variables">
|
||||
<h1><a class="toc-backref" href="#id24">Customizable variables</a></h1>
|
||||
<div class="section" id="yas-trigger-key">
|
||||
<h2><a class="toc-backref" href="#id25"><tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt></a></h2>
|
||||
<p>The key bound to <tt class="docutils literal">yas/expand</tt> when function <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> is
|
||||
active.</p>
|
||||
<p>Value is a string that is converted to the internal Emacs key
|
||||
representation using <tt class="docutils literal"><span class="pre">read-kbd-macro</span></tt>.</p>
|
||||
<p>Default value is <tt class="docutils literal">"TAB"</tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-next-field-key">
|
||||
<h2><a class="toc-backref" href="#id26"><tt class="docutils literal"><span class="pre">yas/next-field-key</span></tt></a></h2>
|
||||
<p>The key to navigate to next field when a snippet is active.</p>
|
||||
<p>Value is a string that is converted to the internal Emacs key
|
||||
representation using <tt class="docutils literal"><span class="pre">read-kbd-macro</span></tt>.</p>
|
||||
<p>Can also be a list of keys.</p>
|
||||
<p>Default value is <tt class="docutils literal">"TAB"</tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-prev-field-key">
|
||||
<h2><a class="toc-backref" href="#id27"><tt class="docutils literal"><span class="pre">yas/prev-field-key</span></tt></a></h2>
|
||||
<p>The key to navigate to previous field when a snippet is active.</p>
|
||||
<p>Value is a string that is converted to the internal Emacs key
|
||||
representation using <tt class="docutils literal"><span class="pre">read-kbd-macro</span></tt>.</p>
|
||||
<p>Can also be a list of keys.</p>
|
||||
<p>Default value is <tt class="docutils literal"><span class="pre">("<backtab>"</span> <span class="pre">"<S-tab>)"</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-skip-and-clear-key">
|
||||
<h2><a class="toc-backref" href="#id28"><tt class="docutils literal"><span class="pre">yas/skip-and-clear-key</span></tt></a></h2>
|
||||
<p>The key to clear the currently active field.</p>
|
||||
<p>Value is a string that is converted to the internal Emacs key
|
||||
representation using <tt class="docutils literal"><span class="pre">read-kbd-macro</span></tt>.</p>
|
||||
<p>Can also be a list of keys.</p>
|
||||
<p>Default value is <tt class="docutils literal"><span class="pre">"C-d"</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-good-grace">
|
||||
<h2><a class="toc-backref" href="#id29"><tt class="docutils literal"><span class="pre">yas/good-grace</span></tt></a></h2>
|
||||
<p>If non-nil, don't raise errors in inline Emacs-lisp evaluation inside
|
||||
snippet definitions. An error string "[yas] error" is returned instead.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-indent-line">
|
||||
<h2><a class="toc-backref" href="#id30"><tt class="docutils literal"><span class="pre">yas/indent-line</span></tt></a></h2>
|
||||
<p>The variable <tt class="docutils literal"><span class="pre">yas/indent-line</span></tt> controls the indenting. It is bound
|
||||
to <tt class="docutils literal">'auto</tt> by default, which causes your snippet to be indented
|
||||
according to the mode of the buffer it was inserted in.</p>
|
||||
<p>Another variable <tt class="docutils literal"><span class="pre">yas/also-auto-indent-first-line</span></tt>, when non-nil
|
||||
does exactly that :-).</p>
|
||||
<p>To use the hard-coded indentation in your snippet template, set this
|
||||
variable to <tt class="docutils literal">fixed</tt>.</p>
|
||||
<p>To control indentation on a per-snippet basis, see also the directive
|
||||
<tt class="docutils literal"># <span class="pre">expand-env:</span></tt> in <a class="reference external" href="snippet-development.html">Writing Snippets</a>.</p>
|
||||
<p>For backward compatibility with earlier versions of YASnippet, you can
|
||||
also place a <tt class="docutils literal">$></tt> in your snippet, an <tt class="docutils literal"><span class="pre">(indent-according-to-mode)</span></tt>
|
||||
will be executed there to indent the line. This only takes effect when
|
||||
<tt class="docutils literal"><span class="pre">yas/indent-line</span></tt> is set to something other than <tt class="docutils literal">'auto</tt>.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">for (${int i = 0}; ${i < 10}; ${++i})
|
||||
{$>
|
||||
$0$>
|
||||
}$>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="yas-wrap-around-region">
|
||||
<h2><a class="toc-backref" href="#id31"><tt class="docutils literal"><span class="pre">yas/wrap-around-region</span></tt></a></h2>
|
||||
<p>If non-nil, YASnippet will try to expand the snippet's exit marker
|
||||
around the currently selected region. When this variable is set to t,
|
||||
this has the same effect has using the <tt class="docutils literal"><span class="pre">`yas/selected-text`</span></tt> inline
|
||||
evaluation.</p>
|
||||
<p>Because on most systems starting to type deletes the currently
|
||||
selected region, this works mostly for snippets with direct
|
||||
keybindings or with the <tt class="docutils literal"><span class="pre">yas/insert-snippet</span></tt> command.</p>
|
||||
<p>However, when the value is of this variable is <tt class="docutils literal">cua</tt> YASnippet will
|
||||
additionally look-up any recently selected that you deleted by starting
|
||||
typing. This allows you select a region, type a snippet key (deleting
|
||||
the region), then press <tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt> to see the deleted region
|
||||
spring back to life inside your new snippet.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-triggers-in-field">
|
||||
<h2><a class="toc-backref" href="#id32"><tt class="docutils literal"><span class="pre">yas/triggers-in-field</span></tt></a></h2>
|
||||
<p>If non-nil, <tt class="docutils literal"><span class="pre">yas/next-field-key</span></tt> can trigger stacked expansions,
|
||||
that is a snippet expansion inside another snippet
|
||||
expansion. Otherwise, <tt class="docutils literal"><span class="pre">yas/next-field-key</span></tt> just tries to move on to
|
||||
the next field.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-snippet-revival">
|
||||
<h2><a class="toc-backref" href="#id33"><tt class="docutils literal"><span class="pre">yas/snippet-revival</span></tt></a></h2>
|
||||
<p>Non-nil means re-activate snippet fields after undo/redo.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-after-exit-snippet-hook-and-yas-before-expand-snippet-hook">
|
||||
<h2><a class="toc-backref" href="#id34"><tt class="docutils literal"><span class="pre">yas/after-exit-snippet-hook</span></tt> and <tt class="docutils literal"><span class="pre">yas/before-expand-snippet-hook</span></tt></a></h2>
|
||||
<p>These hooks are called, respectively, before the insertion of a
|
||||
snippet and after exiting the snippet. If you find any strange but
|
||||
functional use for them, that's probably a design flaw in YASnippet,
|
||||
so let us know.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="importing-textmate-snippets">
|
||||
<h1><a class="toc-backref" href="#id35">Importing TextMate snippets</a></h1>
|
||||
<p>There are a couple of tools that take TextMate's ".tmSnippet" xml
|
||||
files and create YASnippet definitions:</p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="http://code.nokrev.com/?p=snippet-copier.git;a=blob_plain;f=snippet_copier.py">a python script by Jeff Wheeler</a></li>
|
||||
<li>a <a class="reference external" href="http://yasnippet.googlecode.com/svn/trunk/extras/textmate_import.rb">ruby tool</a>
|
||||
, <tt class="docutils literal">textmate_import.rb</tt> adapted from <a class="reference external" href="http://www.neutronflux.net/2009/07/28/shoulda-snippets-for-emacs/">Rob Christie's</a>,
|
||||
which I have uploaded to the repository.</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p>In this section, i'll shortly cover the <strong>second</strong> option.</p>
|
||||
<p>Download the <tt class="docutils literal">textmate_import.rb</tt> tool and the TextMate
|
||||
bundle you're interested in.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">$ curl -O http://yasnippet.googlecode.com/svn/trunk/extras/textmate_import.rb
|
||||
$ svn export http://svn.textmate.org/trunk/Bundles/HTML.tmbundle/
|
||||
</pre></div>
|
||||
<p>Then invoke <tt class="docutils literal">textmate_import.rb</tt> like this:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">$ ./textmate_import.rb -d HTML.tmbundle/Snippets/ -o html-mode -g HTML.tmbundle/info.plist
|
||||
</pre></div>
|
||||
<p>You should end up with a <tt class="docutils literal"><span class="pre">html-mode</span></tt> subdir containing snippets
|
||||
exported from textmate.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">$ tree html-mode # to view dir contents, if you have 'tree' installed
|
||||
</pre></div>
|
||||
<p>The <tt class="docutils literal"><span class="pre">-g</span></tt> is optional but helps the tool figure out the grouping.
|
||||
According to <a class="reference external" href="snippet-organization.html">Organizing Snippets</a>, don't forget to touch
|
||||
<tt class="docutils literal"><span class="pre">.yas-make-groups</span></tt> and <tt class="docutils literal"><span class="pre">.yas-ignore-filename-triggers</span></tt> inside the
|
||||
<tt class="docutils literal"><span class="pre">html-mode</span></tt> dir.</p>
|
||||
<p>Also try <tt class="docutils literal">textmate_import.rb <span class="pre">--help</span></tt> for a list of options.</p>
|
||||
<p>Please note that snippet importation is not yet perfect. You'll
|
||||
probably have some adjustments to some/many snippets. Please
|
||||
contribute these adjustments to the google group or, better yet, patch
|
||||
the <tt class="docutils literal">textmate_import.rb</tt> to automatically perform them and submit
|
||||
that.</p>
|
||||
<!-- LocalWords: html YASnippet yas sourcecode pluskid init filenames filename -->
|
||||
<!-- LocalWords: env varlist keybinding keymap rinari ifndef upcase endif -->
|
||||
<!-- LocalWords: nondirectory autorelease aValue inline -->
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
432
snippet-expansion.html
Normal file
432
snippet-expansion.html
Normal file
@ -0,0 +1,432 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>Expanding snippets</title>
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="expanding-snippets">
|
||||
<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">Expanding snippets</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<div class="contents topic" id="contents">
|
||||
<p class="topic-title first">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#triggering-expansion" id="id2">Triggering expansion</a><ul>
|
||||
<li><a class="reference internal" href="#trigger-key" id="id3">Trigger key</a><ul>
|
||||
<li><a class="reference internal" href="#fallback-bahaviour" id="id4">Fallback bahaviour</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#insert-at-point" id="id5">Insert at point</a></li>
|
||||
<li><a class="reference internal" href="#snippet-keybinding" id="id6">Snippet keybinding</a></li>
|
||||
<li><a class="reference internal" href="#expanding-from-the-menu" id="id7">Expanding from the menu</a></li>
|
||||
<li><a class="reference internal" href="#expanding-with-hippie-expand" id="id8">Expanding with <tt class="docutils literal"><span class="pre">hippie-expand</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#expanding-from-emacs-lisp-code" id="id9">Expanding from emacs-lisp code</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#controlling-expansion" id="id10">Controlling expansion</a><ul>
|
||||
<li><a class="reference internal" href="#eligible-snippets" id="id11">Eligible snippets</a></li>
|
||||
<li><a class="reference internal" href="#the-condition-system" id="id12">The condition system</a></li>
|
||||
<li><a class="reference internal" href="#multiples-snippet-with-the-same-key" id="id13">Multiples snippet with the same key</a><ul>
|
||||
<li><a class="reference internal" href="#use-the-x-window-system" id="id14">Use the X window system</a></li>
|
||||
<li><a class="reference internal" href="#minibuffer-prompting" id="id15">Minibuffer prompting</a></li>
|
||||
<li><a class="reference internal" href="#use-dropdown-menu-el" id="id16">Use <tt class="docutils literal"><span class="pre">dropdown-menu.el</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#roll-your-own" id="id17">Roll your own</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#customizable-variables" id="id18">Customizable Variables</a><ul>
|
||||
<li><a class="reference internal" href="#yas-prompt-functions" id="id19"><tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-fallback-behavior" id="id20"><tt class="docutils literal"><span class="pre">yas/fallback-behavior</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-choose-keys-first" id="id21"><tt class="docutils literal"><span class="pre">yas/choose-keys-first</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-choose-tables-first" id="id22"><tt class="docutils literal"><span class="pre">yas/choose-tables-first</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-key-syntaxes" id="id23"><tt class="docutils literal"><span class="pre">yas/key-syntaxes</span></tt></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="triggering-expansion">
|
||||
<h1><a class="toc-backref" href="#id2">Triggering expansion</a></h1>
|
||||
<p>You can use YASnippet to expand snippets in different ways:</p>
|
||||
<ul class="simple">
|
||||
<li>By typing an abbrev, the snippet <em>trigger key</em>, and then pressing
|
||||
the key defined in <tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt> (which defaults to
|
||||
"TAB"). This works in buffers where the minor mode
|
||||
<tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> is active;</li>
|
||||
<li>By invoking the command <tt class="docutils literal"><span class="pre">yas/insert-snippet</span></tt> (either by typing
|
||||
<tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/insert-snippet</span></tt> or its keybinding). This does <em>not</em>
|
||||
require <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> to be active.</li>
|
||||
<li>By using the keybinding associated with an active snippet. This also
|
||||
requires <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> to be active;</li>
|
||||
<li>By expanding directly from the "YASnippet" menu in the menu-bar</li>
|
||||
<li>By using hippie-expand</li>
|
||||
<li>Expanding from emacs-lisp code</li>
|
||||
</ul>
|
||||
<div class="section" id="trigger-key">
|
||||
<h2><a class="toc-backref" href="#id3">Trigger key</a></h2>
|
||||
<p>When <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> is enabled, the keybinding taken from
|
||||
<tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt> will take effect.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt> invokes <tt class="docutils literal">yas/expand</tt>, which tries to expand a
|
||||
<em>snippet abbrev</em> (also known as <em>snippet key</em>) before point.</p>
|
||||
<p>The default key is <tt class="docutils literal">"TAB"</tt>, however, you can freely set it to some
|
||||
other key.</p>
|
||||
<img alt="images/minor-mode-indicator.png" class="align-left" src="images/minor-mode-indicator.png" />
|
||||
<p>To enable the YASnippet minor mode in all buffers globally use the
|
||||
command <tt class="docutils literal"><span class="pre">yas/global-mode</span></tt>.</p>
|
||||
<p>When you use <tt class="docutils literal"><span class="pre">yas/global-mode</span></tt> you can also selectively disable
|
||||
YASnippet in some buffers by setting the buffer-local variable
|
||||
<tt class="docutils literal"><span class="pre">yas/dont-active</span></tt> in the buffer's mode hook.</p>
|
||||
<p>Trouble when using or understanding the <tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt> is easily
|
||||
the most controversial issue in YASsnippet. See the <a class="reference external" href="faq.html">FAQ</a>.</p>
|
||||
<div class="section" id="fallback-bahaviour">
|
||||
<h3><a class="toc-backref" href="#id4">Fallback bahaviour</a></h3>
|
||||
<p><tt class="docutils literal"><span class="pre">yas/fallback-behaviour</span></tt> is a customization variable bound to
|
||||
<tt class="docutils literal"><span class="pre">'call-other-command</span></tt> by default. If <tt class="docutils literal">yas/expand</tt> failed to find
|
||||
any suitable snippet to expand, it will disable the minor mode
|
||||
temporarily and find if there's any other command bound the
|
||||
<tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt>.</p>
|
||||
<p>If found, the command will be called. Usually this works very well --
|
||||
when there's a snippet, expand it, otherwise, call whatever command
|
||||
originally bind to the trigger key.</p>
|
||||
<p>However, you can change this behavior by customizing the
|
||||
<tt class="docutils literal"><span class="pre">yas/fallback-behavior</span></tt> variable. If you set this variable to
|
||||
<tt class="docutils literal"><span class="pre">'return-nil</span></tt>, it will return <tt class="docutils literal">nil</tt> instead of trying to call the
|
||||
<em>original</em> command when no snippet is found.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="insert-at-point">
|
||||
<h2><a class="toc-backref" href="#id5">Insert at point</a></h2>
|
||||
<p>The command <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/insert-snippet</span></tt> lets you insert snippets at
|
||||
point <em>for you current major mode</em>. It prompts you for the snippet
|
||||
key first, and then for a snippet template if more than one template
|
||||
exists for the same key.</p>
|
||||
<p>The list presented contains the snippets that can be inserted at
|
||||
point, according to the condition system. If you want to see all
|
||||
applicable snippets for the major mode, prefix this command with
|
||||
<tt class="docutils literal"><span class="pre">C-u</span></tt>.</p>
|
||||
<p>The prompting methods used are again controlled by
|
||||
<tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="snippet-keybinding">
|
||||
<h2><a class="toc-backref" href="#id6">Snippet keybinding</a></h2>
|
||||
<p>See the section of the <tt class="docutils literal"># binding:</tt> directive in <a class="reference external" href="snippet-development.html">Writing
|
||||
Snippets</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="expanding-from-the-menu">
|
||||
<h2><a class="toc-backref" href="#id7">Expanding from the menu</a></h2>
|
||||
<p>See <a class="reference external" href="snippet-menu.html">the YASnippet Menu</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="expanding-with-hippie-expand">
|
||||
<h2><a class="toc-backref" href="#id8">Expanding with <tt class="docutils literal"><span class="pre">hippie-expand</span></tt></a></h2>
|
||||
<p>To integrate with <tt class="docutils literal"><span class="pre">hippie-expand</span></tt>, just put
|
||||
<tt class="docutils literal"><span class="pre">yas/hippie-try-expand</span></tt> in
|
||||
<tt class="docutils literal"><span class="pre">hippie-expand-try-functions-list</span></tt>. This probably makes more sense
|
||||
when placed at the top of the list, but it can be put anywhere you
|
||||
prefer.</p>
|
||||
</div>
|
||||
<div class="section" id="expanding-from-emacs-lisp-code">
|
||||
<h2><a class="toc-backref" href="#id9">Expanding from emacs-lisp code</a></h2>
|
||||
<p>Sometimes you might want to expand a snippet directly from you own
|
||||
elisp code. You should call <tt class="docutils literal"><span class="pre">yas/expand-snippet</span></tt> instead of
|
||||
<tt class="docutils literal">yas/expand</tt> in this case.</p>
|
||||
<p>As with expanding from the menubar, the condition system and multiple
|
||||
candidates doesn't affect expansion. In fact, expanding from the
|
||||
YASnippet menu has the same effect of evaluating the follow code:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(<span style="color: #19177C">yas/expand-snippet</span> <span style="color: #19177C">template</span>)
|
||||
</pre></div>
|
||||
<p>See the internal documentation on <tt class="docutils literal"><span class="pre">yas/expand-snippet</span></tt> for more
|
||||
information.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="controlling-expansion">
|
||||
<h1><a class="toc-backref" href="#id10">Controlling expansion</a></h1>
|
||||
<div class="section" id="eligible-snippets">
|
||||
<h2><a class="toc-backref" href="#id11">Eligible snippets</a></h2>
|
||||
<p>YASnippet does quite a bit of filtering to find out which snippets are
|
||||
eligible for expanding at the current cursor position.</p>
|
||||
<p>In particular, the following things matter:</p>
|
||||
<ul>
|
||||
<li><p class="first">Currently loaded snippets tables</p>
|
||||
<p>These are loaded from a directory hierarchy in your file system. See
|
||||
<a class="reference external" href="snippet-organization.html">Organizing Snippets</a>. They are named after major modes like
|
||||
<tt class="docutils literal"><span class="pre">html-mode</span></tt>, <tt class="docutils literal"><span class="pre">ruby-mode</span></tt>, etc...</p>
|
||||
</li>
|
||||
<li><p class="first">Major mode of the current buffer</p>
|
||||
<p>If the currrent major mode matches one of the loaded snippet tables,
|
||||
then all that table's snippets are considered for expansion. Use
|
||||
<tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">describe-variable</span> RET <span class="pre">major-mode</span> RET</tt> to find out which major
|
||||
mode you are in currently.</p>
|
||||
</li>
|
||||
<li><p class="first">Parent tables</p>
|
||||
<p>Snippet tables defined as the parent of some other eligible table
|
||||
are also considered. This works recursively, i.e. parents of parents
|
||||
of eligible tables are also considered.</p>
|
||||
</li>
|
||||
<li><p class="first">Buffer-local <tt class="docutils literal"><span class="pre">yas/mode-symbol</span></tt> variable</p>
|
||||
<p>This can be used to consider snippet tables whose name does not
|
||||
correspond to a major mode. If you set this variable to a name ,
|
||||
like <tt class="docutils literal"><span class="pre">rinari-minor-mode</span></tt>, you can have some snippets expand only
|
||||
in that minor mode. Naturally, you want to set this conditionally,
|
||||
i.e. only when entering that minor mode, so using a hook is a good
|
||||
idea.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"><span style="color: #408080; font-style: italic">;; When entering rinari-minor-mode, consider also the snippets in the</span>
|
||||
<span style="color: #408080; font-style: italic">;; snippet table "rails-mode"</span>
|
||||
(<span style="color: #19177C">add-hook</span> <span style="color: #19177C">'rinari-minor-mode-hook</span>
|
||||
<span style="color: #0000FF">#'</span>(<span style="color: #008000; font-weight: bold">lambda</span> ()
|
||||
(<span style="color: #008000; font-weight: bold">setq</span> <span style="color: #19177C">yas/mode-symbol</span> <span style="color: #19177C">'rails-mode</span>)))
|
||||
</pre></div>
|
||||
<ul>
|
||||
<li><p class="first">Buffer-local <tt class="docutils literal"><span class="pre">yas/buffer-local-condition</span></tt> variable</p>
|
||||
<p>This variable provides finer grained control over what snippets can
|
||||
be expanded in the current buffer. The default value won't let you
|
||||
expand snippets inside comments or string literals for example. See
|
||||
<a class="reference internal" href="#the-condition-system">The condition system</a> for more info.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="the-condition-system">
|
||||
<h2><a class="toc-backref" href="#id12">The condition system</a></h2>
|
||||
<p>Consider this scenario: you are an old Emacs hacker. You like the
|
||||
abbrev-way and set <tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt> to <tt class="docutils literal">"SPC"</tt>. However,
|
||||
you don't want <tt class="docutils literal">if</tt> to be expanded as a snippet when you are typing
|
||||
in a comment block or a string (e.g. in <tt class="docutils literal"><span class="pre">python-mode</span></tt>).</p>
|
||||
<p>If you use the <tt class="docutils literal"># condition :</tt> directive (see <a class="reference external" href="snippet-development.html">Writing Snippets</a>)
|
||||
you could just specify the condition for <tt class="docutils literal">if</tt> to be <tt class="docutils literal">(not
|
||||
<span class="pre">(python-in-string/comment))</span></tt>. But how about <tt class="docutils literal">while</tt>, <tt class="docutils literal">for</tt>,
|
||||
etc. ? Writing the same condition for all the snippets is just
|
||||
boring. So has a buffer local variable
|
||||
<tt class="docutils literal"><span class="pre">yas/buffer-local-condition</span></tt>. You can set this variable to <tt class="docutils literal">(not
|
||||
<span class="pre">(python-in-string/comment))</span></tt> in <tt class="docutils literal"><span class="pre">python-mode-hook</span></tt>.</p>
|
||||
<p>Then, what if you really want some particular snippet to expand even
|
||||
inside a comment? This is also possible! But let's stop telling the
|
||||
story and look at the rules:</p>
|
||||
<ul class="simple">
|
||||
<li>If <tt class="docutils literal"><span class="pre">yas/buffer-local-condition</span></tt> evaluate to nil, no snippets will
|
||||
be considered for expansion.</li>
|
||||
<li>If it evaluates to the a <em>cons cell</em> where the <tt class="docutils literal">car</tt> is the symbol
|
||||
<tt class="docutils literal"><span class="pre">require-snippet-condition</span></tt> and the <tt class="docutils literal">cdr</tt> is a symbol (let's
|
||||
call it <tt class="docutils literal">requirement</tt>), then:<ul>
|
||||
<li>Snippets having no <tt class="docutils literal"># condition:</tt> directive won't be considered;</li>
|
||||
<li>Snippets with conditions that evaluate to nil (or produce an
|
||||
error) won't be considered;</li>
|
||||
<li>If the snippet has a condition that evaluates to non-nil (let's
|
||||
call it <tt class="docutils literal">result</tt>):<ul>
|
||||
<li>If <tt class="docutils literal">requirement</tt> is <tt class="docutils literal">t</tt>, the snippet is ready to be
|
||||
expanded;</li>
|
||||
<li>If <tt class="docutils literal">requirement</tt> is <tt class="docutils literal">eq</tt> to <tt class="docutils literal">result</tt>, the snippet is ready
|
||||
to be expanded;</li>
|
||||
<li>Otherwise the snippet won't be considered.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>If it evaluates to the symbol <tt class="docutils literal">always</tt>, all snippets are
|
||||
considered for expansion, regardless of any conditions.</li>
|
||||
<li>If it evaluate to <tt class="docutils literal">t</tt> or some other non-nil value:<ul>
|
||||
<li>If the snippet has no condition, or has a condition that evaluate
|
||||
to non-nil, it is ready to be expanded.</li>
|
||||
<li>Otherwise, it won't be considered.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p>In the mentioned scenario, set <tt class="docutils literal"><span class="pre">yas/buffer-local-condition</span></tt> like
|
||||
this</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(<span style="color: #19177C">add-hook</span> <span style="color: #19177C">'python-mode-hook</span>
|
||||
<span style="color: #666666">'</span>(<span style="color: #008000; font-weight: bold">lambda</span> ()
|
||||
(<span style="color: #008000; font-weight: bold">setq</span> <span style="color: #19177C">yas/buffer-local-condition</span>
|
||||
<span style="color: #666666">'</span>(<span style="color: #008000; font-weight: bold">if</span> (<span style="color: #19177C">python-in-string/comment</span>)
|
||||
<span style="color: #666666">'</span>(<span style="color: #19177C">require-snippet-condition</span> <span style="color: #666666">.</span> <span style="color: #19177C">force-in-comment</span>)
|
||||
<span style="color: #880000">t</span>))))
|
||||
</pre></div>
|
||||
<p>... and specify the condition for a snippet that you're going to
|
||||
expand in comment to be evaluated to the symbol
|
||||
<tt class="docutils literal"><span class="pre">force-in-comment</span></tt>. Then it can be expanded as you expected, while
|
||||
other snippets like <tt class="docutils literal">if</tt> still can't expanded in comment.</p>
|
||||
</div>
|
||||
<div class="section" id="multiples-snippet-with-the-same-key">
|
||||
<h2><a class="toc-backref" href="#id13">Multiples snippet with the same key</a></h2>
|
||||
<p>The rules outlined <a class="reference external" href="Eligiblesnippets">above</a> can return more than
|
||||
one snippet to be expanded at point.</p>
|
||||
<p>When there are multiple candidates, YASnippet will let you select
|
||||
one. The UI for selecting multiple candidate can be customized through
|
||||
<tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt> , which defines your preferred methods of
|
||||
being prompted for snippets.</p>
|
||||
<p>You can customize it with <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">customize-variable</span> RET
|
||||
<span class="pre">yas/prompt-functions</span> RET</tt>. Alternatively you can put in your
|
||||
emacs-file:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">(<span style="color: #008000; font-weight: bold">setq</span> <span style="color: #19177C">yas/prompt-functions</span> <span style="color: #666666">'</span>(<span style="color: #19177C">yas/x-prompt</span> <span style="color: #19177C">yas/dropdown-prompt</span>))
|
||||
</pre></div>
|
||||
<p>Currently there are some alternatives solution with YASnippet.</p>
|
||||
<img alt="images/x-menu.png" class="align-right" src="images/x-menu.png" />
|
||||
<div class="section" id="use-the-x-window-system">
|
||||
<h3><a class="toc-backref" href="#id14">Use the X window system</a></h3>
|
||||
<p>The function <tt class="docutils literal"><span class="pre">yas/x-prompt</span></tt> can be used to show a popup menu for you
|
||||
to select. This menu will be part of you native window system widget,
|
||||
which means:</p>
|
||||
<ul class="simple">
|
||||
<li>It usually looks beautiful. E.g. when you compile Emacs with gtk
|
||||
support, this menu will be rendered with your gtk theme.</li>
|
||||
<li>Your window system may or may not allow to you use <tt class="docutils literal"><span class="pre">C-n</span></tt>, <tt class="docutils literal"><span class="pre">C-p</span></tt>
|
||||
to navigate this menu.</li>
|
||||
<li>This function can't be used when in a terminal.</li>
|
||||
</ul>
|
||||
<img alt="images/ido-menu.png" class="align-right" src="images/ido-menu.png" />
|
||||
</div>
|
||||
<div class="section" id="minibuffer-prompting">
|
||||
<h3><a class="toc-backref" href="#id15">Minibuffer prompting</a></h3>
|
||||
<p>You can use functions <tt class="docutils literal"><span class="pre">yas/completing-prompt</span></tt> for the classic emacs
|
||||
completion method or <tt class="docutils literal"><span class="pre">yas/ido-prompt</span></tt> for a much nicer looking
|
||||
method. The best way is to try it. This works in a terminal.</p>
|
||||
<img alt="images/dropdown-menu.png" class="align-right" src="images/dropdown-menu.png" />
|
||||
</div>
|
||||
<div class="section" id="use-dropdown-menu-el">
|
||||
<h3><a class="toc-backref" href="#id16">Use <tt class="docutils literal"><span class="pre">dropdown-menu.el</span></tt></a></h3>
|
||||
<p>The function <tt class="docutils literal"><span class="pre">yas/dropdown-prompt</span></tt> can also be placed in the
|
||||
<tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt> list.</p>
|
||||
<p>This works in both window system and terminal and is customizable, you
|
||||
can use <tt class="docutils literal"><span class="pre">C-n</span></tt>, <tt class="docutils literal"><span class="pre">C-p</span></tt> to navigate, <tt class="docutils literal">q</tt> to quit and even press
|
||||
<tt class="docutils literal">6</tt> as a shortcut to select the 6th candidate.</p>
|
||||
</div>
|
||||
<div class="section" id="roll-your-own">
|
||||
<h3><a class="toc-backref" href="#id17">Roll your own</a></h3>
|
||||
<p>See below for the documentation on variable <tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="customizable-variables">
|
||||
<h1><a class="toc-backref" href="#id18">Customizable Variables</a></h1>
|
||||
<div class="section" id="yas-prompt-functions">
|
||||
<h2><a class="toc-backref" href="#id19"><tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt></a></h2>
|
||||
<p>You can write a function and add it to the <tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt>
|
||||
list. These functions are called with the following arguments:</p>
|
||||
<ul class="simple">
|
||||
<li>PROMPT: A string to prompt the user;</li>
|
||||
<li>CHOICES: A list of strings or objects;</li>
|
||||
<li>optional DISPLAY-FN : A function. When applied to each of the
|
||||
objects in CHOICES it will return a string;</li>
|
||||
</ul>
|
||||
<p>The return value of any function you put here should be one of
|
||||
the objects in CHOICES, properly formatted with DISPLAY-FN (if
|
||||
that is passed).</p>
|
||||
<ul class="simple">
|
||||
<li>To signal that your particular style of prompting is unavailable at
|
||||
the moment, you can also have the function return nil.</li>
|
||||
<li>To signal that the user quit the prompting process, you can signal
|
||||
<tt class="docutils literal">quit</tt> with <tt class="docutils literal">(signal 'quit "user <span class="pre">quit!")</span></tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="yas-fallback-behavior">
|
||||
<h2><a class="toc-backref" href="#id20"><tt class="docutils literal"><span class="pre">yas/fallback-behavior</span></tt></a></h2>
|
||||
<p>How to act when <tt class="docutils literal">yas/expand</tt> does <em>not</em> expand a snippet.</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">call-other-command</span></tt> means try to temporarily disable YASnippet and</dt>
|
||||
<dd>call the next command bound to <tt class="docutils literal"><span class="pre">yas/trigger-key</span></tt>.</dd>
|
||||
</dl>
|
||||
<p><tt class="docutils literal"><span class="pre">return-nil</span></tt> means return nil. (i.e. do nothing)</p>
|
||||
<p>An entry (apply COMMAND . ARGS) means interactively call COMMAND, if
|
||||
ARGS is non-nil, call COMMAND non-interactively with ARGS as
|
||||
arguments.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-choose-keys-first">
|
||||
<h2><a class="toc-backref" href="#id21"><tt class="docutils literal"><span class="pre">yas/choose-keys-first</span></tt></a></h2>
|
||||
<p>If non-nil, prompt for snippet key first, then for template.</p>
|
||||
<p>Otherwise prompts for all possible snippet names.</p>
|
||||
<p>This affects <tt class="docutils literal"><span class="pre">yas/insert-snippet</span></tt> and <tt class="docutils literal"><span class="pre">yas/visit-snippet-file</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="yas-choose-tables-first">
|
||||
<h2><a class="toc-backref" href="#id22"><tt class="docutils literal"><span class="pre">yas/choose-tables-first</span></tt></a></h2>
|
||||
<p>If non-nil, and multiple eligible snippet tables, prompts user for
|
||||
tables first.</p>
|
||||
<p>Otherwise, user chooses between the merging together of all
|
||||
eligible tables.</p>
|
||||
<p>This affects <tt class="docutils literal"><span class="pre">yas/insert-snippet</span></tt>, <tt class="docutils literal"><span class="pre">yas/visit-snippet-file</span></tt></p>
|
||||
</div>
|
||||
<div class="section" id="yas-key-syntaxes">
|
||||
<h2><a class="toc-backref" href="#id23"><tt class="docutils literal"><span class="pre">yas/key-syntaxes</span></tt></a></h2>
|
||||
<p>The default searching strategy is quite powerful. For example, in
|
||||
<tt class="docutils literal"><span class="pre">c-mode</span></tt>, <tt class="docutils literal">bar</tt>, <tt class="docutils literal">foo_bar</tt>, <tt class="docutils literal">"#foo_bar"</tt> can all be recognized
|
||||
as a snippet key. Furthermore, the searching is in that order. In
|
||||
other words, if <tt class="docutils literal">bar</tt> is found to be a key to some <em>valid</em> snippet,
|
||||
then that snippet is expanded and replaces the <tt class="docutils literal">bar</tt>. Snippets
|
||||
pointed to by <tt class="docutils literal">foo_bar</tt> and <tt class="docutils literal">"#foobar</tt> won't be considered.</p>
|
||||
<p>However, this strategy can also be customized easily from the
|
||||
<tt class="docutils literal"><span class="pre">yas/key-syntaxes</span></tt> variable. It is a list of syntax rules, the
|
||||
default value is <tt class="docutils literal">("w" "w_" "w_." "^ ")</tt>. Which means search the
|
||||
following thing until found one:</p>
|
||||
<ul class="simple">
|
||||
<li>a word.</li>
|
||||
<li>a symbol. In lisp, <tt class="docutils literal">-</tt> and <tt class="docutils literal">?</tt> can all be part of a symbol.</li>
|
||||
<li>a sequence of characters of either word, symbol or punctuation.</li>
|
||||
<li>a sequence of characters of non-whitespace characters.</li>
|
||||
</ul>
|
||||
<p>But you'd better keep the default value unless you want to understand
|
||||
how Emacs's syntax rules work...</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
141
snippet-menu.html
Normal file
141
snippet-menu.html
Normal file
@ -0,0 +1,141 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>YASnippet menu</title>
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="yasnippet-menu">
|
||||
<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">YASnippet menu</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<div class="contents topic" id="contents">
|
||||
<p class="topic-title first">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#loading-snippets-from-menu" id="id1">Loading snippets from menu</a></li>
|
||||
<li><a class="reference internal" href="#snippet-menu-behavior" id="id2">Snippet menu behavior</a></li>
|
||||
<li><a class="reference internal" href="#controlling-indenting" id="id3">Controlling indenting</a></li>
|
||||
<li><a class="reference internal" href="#prompting-method" id="id4">Prompting method</a></li>
|
||||
<li><a class="reference internal" href="#misc" id="id5">Misc</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>When <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> is active, YASnippet will setup a menu just
|
||||
after the "Buffers" menu in the menubar.</p>
|
||||
<p>In this menu, you can find</p>
|
||||
<ul class="simple">
|
||||
<li>The currently loaded snippet definitions, organized by major mode,
|
||||
and optional grouping.</li>
|
||||
<li>A rundown of the most common commands, (followed by their
|
||||
keybindings) including commands to load directories and reload all
|
||||
snippet definitions.</li>
|
||||
<li>A series of submenus for customizing and exploring YASnippet
|
||||
behavior.</li>
|
||||
</ul>
|
||||
<img alt="images/menu-1.png" class="align-right" src="images/menu-1.png" />
|
||||
<div class="section" id="loading-snippets-from-menu">
|
||||
<h1><a class="toc-backref" href="#id1">Loading snippets from menu</a></h1>
|
||||
<p>Invoking "Load snippets..." from the menu invokes
|
||||
<tt class="docutils literal"><span class="pre">yas/load-directory</span></tt> and prompts you for a snippet directory
|
||||
hierarchy to load.</p>
|
||||
<p>Also useful is the "Reload all" options which uncondionally reloads
|
||||
all the snippets directories defined in <tt class="docutils literal"><span class="pre">yas/root-directory</span></tt> and
|
||||
rebuilds the menus.</p>
|
||||
</div>
|
||||
<div class="section" id="snippet-menu-behavior">
|
||||
<h1><a class="toc-backref" href="#id2">Snippet menu behavior</a></h1>
|
||||
<p>YASnippet will list in this section all the loaded snippet definitions
|
||||
organized by snippet table name.</p>
|
||||
<p>You can use this section to explore currently loaded snippets. If you
|
||||
click on one of them, the default behavior is to expand it,
|
||||
unconditionally, inside the current buffer.</p>
|
||||
<p>You can however, customize variable <tt class="docutils literal"><span class="pre">yas/visit-from-menu</span></tt> to be
|
||||
<tt class="docutils literal">t</tt> which will take you to the snippet definition file when you
|
||||
select it from the menu.</p>
|
||||
<p>If you want the menu show only snippet tables whose name corresponds
|
||||
to a "real" major mode. You do this by setting <tt class="docutils literal"><span class="pre">yas/use-menu</span></tt> to
|
||||
<tt class="docutils literal"><span class="pre">'real-modes</span></tt>.</p>
|
||||
<p>Finally, to have the menu show only the tables for the currently
|
||||
active mode, set <tt class="docutils literal"><span class="pre">yas/use-menu</span></tt> to <tt class="docutils literal">abbreviate</tt>.</p>
|
||||
<p>These customizations can also be found in the menu itself, under the
|
||||
"Snippet menu behavior" submenu.</p>
|
||||
</div>
|
||||
<div class="section" id="controlling-indenting">
|
||||
<h1><a class="toc-backref" href="#id3">Controlling indenting</a></h1>
|
||||
<p>The "Indenting" submenu contains options to control the values of
|
||||
<tt class="docutils literal"><span class="pre">yas/indent-line</span></tt> and <tt class="docutils literal"><span class="pre">yas/also-auto-indent-first-line</span></tt>. See
|
||||
<a class="reference external" href="snippet-development.html">Writing snippets</a> .</p>
|
||||
</div>
|
||||
<div class="section" id="prompting-method">
|
||||
<h1><a class="toc-backref" href="#id4">Prompting method</a></h1>
|
||||
<p>The "Prompting method" submenu contains options to control the value
|
||||
of <tt class="docutils literal"><span class="pre">yas/prompt-functions</span></tt>. See <a class="reference external" href="snippet-expansion.html">Expanding snippets</a> .</p>
|
||||
</div>
|
||||
<div class="section" id="misc">
|
||||
<h1><a class="toc-backref" href="#id5">Misc</a></h1>
|
||||
<p>The "Misc" submenu contains options to control the values of more
|
||||
variables.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
232
snippet-organization.html
Normal file
232
snippet-organization.html
Normal file
@ -0,0 +1,232 @@
|
||||
<?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.8.1: http://docutils.sourceforge.net/" />
|
||||
<title>Organizing snippets</title>
|
||||
<link rel="stylesheet" href="styles.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="organizing-snippets">
|
||||
<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">Organizing snippets</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">
|
||||
<p>
|
||||
<b>Important:</b> This documentation applies to
|
||||
the <b>SVN trunk</b> of YASnippet, which you
|
||||
get <a href="http://code.google.com/p/yasnippet/source/checkout">here</a>. Documentation
|
||||
for other versions can be found <a title=""
|
||||
href="http://code.google.com/p/yasnippet/downloads/list">here</a>.
|
||||
</p>
|
||||
<div class="contents topic" id="contents">
|
||||
<p class="topic-title first">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#loading-snippets" id="id3">Loading snippets</a></li>
|
||||
<li><a class="reference internal" href="#id2" id="id4">Organizing snippets</a><ul>
|
||||
<li><a class="reference internal" href="#the-yas-parents-file" id="id5">The <tt class="docutils literal">.yas.parents</tt> file</a></li>
|
||||
<li><a class="reference internal" href="#the-yas-make-groups-file" id="id6">The <tt class="docutils literal"><span class="pre">.yas-make-groups</span></tt> file</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#yasnippet-bundle" id="id7">YASnippet bundle</a></li>
|
||||
<li><a class="reference internal" href="#customizable-variables" id="id8">Customizable variables</a><ul>
|
||||
<li><a class="reference internal" href="#yas-root-directory" id="id9"><tt class="docutils literal"><span class="pre">yas/root-directory</span></tt></a></li>
|
||||
<li><a class="reference internal" href="#yas-ignore-filenames-as-triggers" id="id10"><tt class="docutils literal"><span class="pre">yas/ignore-filenames-as-triggers</span></tt></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="loading-snippets">
|
||||
<h1><a class="toc-backref" href="#id3">Loading snippets</a></h1>
|
||||
<p>Snippet definitions are stored in files in the filesystem. Unless you
|
||||
use the simpler <a class="reference external" href="mailto:index.html@installation">bundle version</a>), these
|
||||
are arranged so that YASnippet can load them into <em>snippet
|
||||
tables</em>. The triggering mechanisms (see <a class="reference external" href="snippet-expansion.html">Expanding snippets</a>) will
|
||||
look up these snippet tables and (hopefully) expand the snippet you
|
||||
intended.</p>
|
||||
<p>The non-bundle version of YASnippet, once unpacked, comes with a full
|
||||
directory of snippets, which you can copy somewhere and use. You can
|
||||
also create or download more directories.</p>
|
||||
<p>Once these directories are in place reference them in the variable
|
||||
<tt class="docutils literal"><span class="pre">yas/root-directory</span></tt> and load them with <tt class="docutils literal"><span class="pre">yas/load-directory</span></tt>:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"><span style="color: #408080; font-style: italic">;; Develop and keep personal snippets under ~/emacs.d/mysnippets</span>
|
||||
(<span style="color: #008000; font-weight: bold">setq</span> <span style="color: #19177C">yas/root-directory</span> <span style="color: #BA2121">"~/emacs.d/mysnippets"</span>)
|
||||
|
||||
<span style="color: #408080; font-style: italic">;; Load the snippets</span>
|
||||
(<span style="color: #19177C">yas/load-directory</span> <span style="color: #19177C">yas/root-directory</span>)
|
||||
</pre></div>
|
||||
<p>The point in using <tt class="docutils literal"><span class="pre">yas/root-directory</span></tt> (as opposed to calling
|
||||
<tt class="docutils literal"><span class="pre">yas/load-directory</span></tt> directly) is considering "~/emacs.d/mysnippets"
|
||||
for snippet development, so you can use commands like
|
||||
<tt class="docutils literal"><span class="pre">yas/new-snippet</span></tt> and others described in section <a class="reference external" href="snippet-development.html">Writing
|
||||
Snippets</a>.</p>
|
||||
<p>You can make this variable a list and store more items into it:</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%"><span style="color: #408080; font-style: italic">;; Develop in ~/emacs.d/mysnippets, but also</span>
|
||||
<span style="color: #408080; font-style: italic">;; try out snippets in ~/Downloads/interesting-snippets</span>
|
||||
(<span style="color: #008000; font-weight: bold">setq</span> <span style="color: #19177C">yas/root-directory</span> <span style="color: #666666">'</span>(<span style="color: #BA2121">"~/emacs.d/mysnippets"</span>
|
||||
<span style="color: #BA2121">"~/Downloads/interesting-snippets"</span>))
|
||||
|
||||
<span style="color: #408080; font-style: italic">;; Map `yas/load-directory' to every element</span>
|
||||
(<span style="color: #008000">mapc</span> <span style="color: #19177C">'yas/load-directory</span> <span style="color: #19177C">yas/root-directory</span>)
|
||||
</pre></div>
|
||||
<p>In this last example, the all the directories are loaded and their
|
||||
snippets considered for expansion. However development still happens
|
||||
in the first element, "~/emacs.d/mysnippets".</p>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h1><a class="toc-backref" href="#id4">Organizing snippets</a></h1>
|
||||
<p>Once you've setup <tt class="docutils literal"><span class="pre">yas/root-directory</span></tt> , you can store snippets
|
||||
inside sub-directories of these directories.</p>
|
||||
<p>Snippet definitions are put in plain text files. They are arranged
|
||||
by sub-directories, and the snippet tables are named after these
|
||||
directories.</p>
|
||||
<p>The name corresponds to the Emacs mode where you want expansion to
|
||||
take place. For example, snippets for <tt class="docutils literal"><span class="pre">c-mode</span></tt> are put in the
|
||||
<tt class="docutils literal"><span class="pre">c-mode</span></tt> sub-directory.</p>
|
||||
<div class="section" id="the-yas-parents-file">
|
||||
<h2><a class="toc-backref" href="#id5">The <tt class="docutils literal">.yas.parents</tt> file</a></h2>
|
||||
<p>It's very useful to have certain modes share snippets between
|
||||
themselves. To do this, choose a mode subdirectory and place a
|
||||
<tt class="docutils literal"><span class="pre">.yas-parents</span></tt> containing a whitespace-separated list of other
|
||||
mode names. When you reload those modes become parents of the
|
||||
original mode.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">$ tree
|
||||
.
|
||||
|-- c-mode
|
||||
| |-- .yas-parents # contains "cc-mode text-mode"
|
||||
| `-- printf
|
||||
|-- cc-mode
|
||||
| |-- for
|
||||
| `-- while
|
||||
|-- java-mode
|
||||
| |-- .yas-parents # contains "cc-mode text-mode"
|
||||
| `-- println
|
||||
`-- text-mode
|
||||
|-- email
|
||||
`-- time
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="the-yas-make-groups-file">
|
||||
<h2><a class="toc-backref" href="#id6">The <tt class="docutils literal"><span class="pre">.yas-make-groups</span></tt> file</a></h2>
|
||||
<img alt="images/menu-groups.png" class="align-right" src="images/menu-groups.png" />
|
||||
<p>If you place an empty plain text file <tt class="docutils literal"><span class="pre">.yas-make-groups</span></tt> inside one
|
||||
of the mode directories, the names of these sub-directories are
|
||||
considered groups of snippets and <a class="reference external" href="snippet-menu.html">The YASnippet Menu</a> is organized
|
||||
much more cleanly, as you can see in the image.</p>
|
||||
<p>Another alternative way to achieve this is to place a <tt class="docutils literal"># group:</tt>
|
||||
directive inside the snippet definition. See <a class="reference external" href="snippet-development.html">Writing Snippets</a>.</p>
|
||||
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%">$ tree ruby-mode/
|
||||
ruby-mode/
|
||||
|-- .yas-make-groups
|
||||
|-- collections
|
||||
| |-- each
|
||||
| `-- ...
|
||||
|-- control structure
|
||||
| |-- forin
|
||||
| `-- ...
|
||||
|-- definitions
|
||||
| `-- ...
|
||||
`-- general
|
||||
`-- ...
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="yasnippet-bundle">
|
||||
<h1><a class="toc-backref" href="#id7">YASnippet bundle</a></h1>
|
||||
<p>The most convenient way to define snippets for YASnippet is to put
|
||||
them in a directory arranged by the mode and use
|
||||
<tt class="docutils literal"><span class="pre">yas/load-directory</span></tt> to load them.</p>
|
||||
<p>However, this might slow down the Emacs start-up speed if you have many
|
||||
snippets. You can use <tt class="docutils literal"><span class="pre">yas/define-snippets</span></tt> to define a bunch of
|
||||
snippets for a particular mode in an Emacs-lisp file.</p>
|
||||
<p>Since this is hard to maintain, there's a better way: define your
|
||||
snippets in directory and then call <tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/compile-bundle</span></tt> to
|
||||
compile it into a bundle file when you modified your snippets.</p>
|
||||
<p>The release bundle of YASnippet is produced by
|
||||
<tt class="docutils literal"><span class="pre">yas/compile-bundle</span></tt>. The bundle uses <tt class="docutils literal"><span class="pre">yas/define-snippets</span></tt> to
|
||||
define snippets. This avoids the IO and parsing overhead when loading
|
||||
snippets.</p>
|
||||
<p>Further more, the generated bundle is a stand-alone file not depending
|
||||
on <tt class="docutils literal">yasnippet.el</tt>. The released bundles of YASnippet are all
|
||||
generated this way.</p>
|
||||
<p>See the internal documentation for these functions</p>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">describe-function</span> RET <span class="pre">yas/define-snippets</span> RET</tt></li>
|
||||
<li><tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">describe-function</span> RET <span class="pre">yas/compile-bundle</span> RET</tt>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="customizable-variables">
|
||||
<h1><a class="toc-backref" href="#id8">Customizable variables</a></h1>
|
||||
<div class="section" id="yas-root-directory">
|
||||
<h2><a class="toc-backref" href="#id9"><tt class="docutils literal"><span class="pre">yas/root-directory</span></tt></a></h2>
|
||||
<p>Root directory that stores the snippets for each major mode.</p>
|
||||
<p>If you set this from your .emacs, can also be a list of strings,
|
||||
for multiple root directories. If you make this a list, the first
|
||||
element is always the user-created snippets directory. Other
|
||||
directories are used for bulk reloading of all snippets using
|
||||
<tt class="docutils literal"><span class="pre">yas/reload-all</span></tt></p>
|
||||
</div>
|
||||
<div class="section" id="yas-ignore-filenames-as-triggers">
|
||||
<h2><a class="toc-backref" href="#id10"><tt class="docutils literal"><span class="pre">yas/ignore-filenames-as-triggers</span></tt></a></h2>
|
||||
<p>If non-nil, don't derive tab triggers from filenames.</p>
|
||||
<p>This means a snippet without a <tt class="docutils literal"># key:</tt> directive wont have a tab
|
||||
trigger.</p>
|
||||
<!-- LocalWords: html YASnippet filesystem yas sourcecode setq mapc printf perl -->
|
||||
<!-- LocalWords: println cperl forin filenames filename ERb's yasnippet Avar el -->
|
||||
<!-- LocalWords: rjs RET -->
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("UA-10536822-1");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user