mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-14 05:23:04 +00:00
190 lines
10 KiB
HTML
190 lines
10 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="Docutils 0.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>
|