mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 13:13:03 +00:00
408 lines
14 KiB
HTML
408 lines
14 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
<head>
|
|
<title>Frequently Asked Questions</title>
|
|
<!-- 2015-09-24 Thu 21:15 -->
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="generator" content="Org-mode" />
|
|
<style type="text/css">
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
.title { text-align: center; }
|
|
.todo { font-family: monospace; color: red; }
|
|
.done { color: green; }
|
|
.tag { background-color: #eee; font-family: monospace;
|
|
padding: 2px; font-size: 80%; font-weight: normal; }
|
|
.timestamp { color: #bebebe; }
|
|
.timestamp-kwd { color: #5f9ea0; }
|
|
.right { margin-left: auto; margin-right: 0px; text-align: right; }
|
|
.left { margin-left: 0px; margin-right: auto; text-align: left; }
|
|
.center { margin-left: auto; margin-right: auto; text-align: center; }
|
|
.underline { text-decoration: underline; }
|
|
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
|
p.verse { margin-left: 3%; }
|
|
pre {
|
|
border: 1px solid #ccc;
|
|
box-shadow: 3px 3px 3px #eee;
|
|
padding: 8pt;
|
|
font-family: monospace;
|
|
overflow: auto;
|
|
margin: 1.2em;
|
|
}
|
|
pre.src {
|
|
position: relative;
|
|
overflow: visible;
|
|
padding-top: 1.2em;
|
|
}
|
|
pre.src:before {
|
|
display: none;
|
|
position: absolute;
|
|
background-color: white;
|
|
top: -10px;
|
|
right: 10px;
|
|
padding: 3px;
|
|
border: 1px solid black;
|
|
}
|
|
pre.src:hover:before { display: inline;}
|
|
pre.src-sh:before { content: 'sh'; }
|
|
pre.src-bash:before { content: 'sh'; }
|
|
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
|
pre.src-R:before { content: 'R'; }
|
|
pre.src-perl:before { content: 'Perl'; }
|
|
pre.src-java:before { content: 'Java'; }
|
|
pre.src-sql:before { content: 'SQL'; }
|
|
|
|
table { border-collapse:collapse; }
|
|
caption.t-above { caption-side: top; }
|
|
caption.t-bottom { caption-side: bottom; }
|
|
td, th { vertical-align:top; }
|
|
th.right { text-align: center; }
|
|
th.left { text-align: center; }
|
|
th.center { text-align: center; }
|
|
td.right { text-align: right; }
|
|
td.left { text-align: left; }
|
|
td.center { text-align: center; }
|
|
dt { font-weight: bold; }
|
|
.footpara:nth-child(2) { display: inline; }
|
|
.footpara { display: block; }
|
|
.footdef { margin-bottom: 1em; }
|
|
.figure { padding: 1em; }
|
|
.figure p { text-align: center; }
|
|
.inlinetask {
|
|
padding: 10px;
|
|
border: 2px solid gray;
|
|
margin: 10px;
|
|
background: #ffffcc;
|
|
}
|
|
#org-div-home-and-up
|
|
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
|
textarea { overflow-x: auto; }
|
|
.linenr { font-size: smaller }
|
|
.code-highlighted { background-color: #ffff00; }
|
|
.org-info-js_info-navigation { border-style: none; }
|
|
#org-info-js_console-label
|
|
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
|
.org-info-js_search-highlight
|
|
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
|
/*]]>*/-->
|
|
</style>
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/manual.css" />
|
|
<script type="text/javascript">
|
|
/*
|
|
@licstart The following is the entire license notice for the
|
|
JavaScript code in this tag.
|
|
|
|
Copyright (C) 2012-2013 Free Software Foundation, Inc.
|
|
|
|
The JavaScript code in this tag is free software: you can
|
|
redistribute it and/or modify it under the terms of the GNU
|
|
General Public License (GNU GPL) as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option)
|
|
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
|
|
As additional permission under GNU GPL version 3 section 7, you
|
|
may distribute non-source (e.g., minimized or compacted) forms of
|
|
that code without the copy of the GNU GPL normally required by
|
|
section 4, provided you include this license notice and a URL
|
|
through which recipients can access the Corresponding Source.
|
|
|
|
|
|
@licend The above is the entire license notice
|
|
for the JavaScript code in this tag.
|
|
*/
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
function CodeHighlightOn(elem, id)
|
|
{
|
|
var target = document.getElementById(id);
|
|
if(null != target) {
|
|
elem.cacheClassElem = elem.className;
|
|
elem.cacheClassTarget = target.className;
|
|
target.className = "code-highlighted";
|
|
elem.className = "code-highlighted";
|
|
}
|
|
}
|
|
function CodeHighlightOff(elem, id)
|
|
{
|
|
var target = document.getElementById(id);
|
|
if(elem.cacheClassElem)
|
|
elem.className = elem.cacheClassElem;
|
|
if(elem.cacheClassTarget)
|
|
target.className = elem.cacheClassTarget;
|
|
}
|
|
/*]]>*///-->
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="preamble" class="status">
|
|
<nav>
|
|
<ul class="center">
|
|
<li> <a href="index.html">Overview</a>
|
|
<li> <a href="https://github.com/capitaomorte/yasnippet/blob/master/README.mdown">
|
|
Intro and Tutorial</a>
|
|
<li class="center">Snippet
|
|
<ul>
|
|
<li> <a href="snippet-organization.html">Organization</a>
|
|
<li> <a href="snippet-expansion.html">Expansion</a>
|
|
<li> <a href="snippet-development.html">Development</a>
|
|
<li> <a href="snippet-menu.html">Menu</a>
|
|
</ul>
|
|
<li> <a href="faq.html">FAQ</a>
|
|
<li> <a href="snippet-reference.html">Reference</a>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div id="content">
|
|
<h1 class="title">Frequently Asked Questions</h1>
|
|
<div id="table-of-contents">
|
|
<h2>Table of Contents</h2>
|
|
<div id="text-table-of-contents">
|
|
<ul>
|
|
<li><a href="#sec-1">Why is there an extra newline?</a></li>
|
|
<li><a href="#sec-2">Why doesn't TAB expand a snippet?</a></li>
|
|
<li><a href="#sec-3">Why doesn't TAB navigation work with flyspell</a></li>
|
|
<li><a href="#sec-4">How to I use alternative keys, i.e. not TAB?</a></li>
|
|
<li><a href="#sec-5">How do I turn off the minor mode where in some buffers?</a></li>
|
|
<li><a href="#sec-6">How do I define an abbrev key containing characters not supported by the filesystem?</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-sec-1" class="outline-2">
|
|
<h2 id="sec-1">Why is there an extra newline?</h2>
|
|
<div class="outline-text-2" id="text-1">
|
|
<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 <code>require-final-newline</code> to <code>t</code>, it will add the final newline
|
|
for you automatically.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-sec-2" class="outline-2">
|
|
<h2 id="sec-2">Why doesn't TAB expand a snippet?</h2>
|
|
<div class="outline-text-2" id="text-2">
|
|
<p>
|
|
First check the mode line to see if there's <code>yas</code>. If not, then try
|
|
<code>M-x yas-minor-mode</code> 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 <code>.emacs</code> <i>before</i> loading YASnippet:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-emacs-lisp">(add-hook 'the-major-mode-hook 'yas-minor-mode-on)
|
|
</pre>
|
|
</div>
|
|
|
|
<p>
|
|
where <code>the-major-mode</code> is the major mode in which <a href="snippet-reference.html#yas-minor-mode"><code>yas-minor-mode</code></a> isn't
|
|
enabled by default.
|
|
</p>
|
|
|
|
<p>
|
|
From YASnippet 0.6 you can also use the command <code>M-x yas-global-mode</code> to
|
|
turn on YASnippet automatically for <i>all</i> major modes.
|
|
</p>
|
|
|
|
<p>
|
|
If <a href="snippet-reference.html#yas-minor-mode"><code>yas-minor-mode</code></a> is on but the snippet still not expanded. Then try
|
|
to see what command is bound to the <code>TAB</code> key: press <code>C-h k</code> and then
|
|
press <code>TAB</code>. Emacs will show you the result.
|
|
</p>
|
|
|
|
<p>
|
|
You'll see a buffer prompted by Emacs saying that
|
|
<code>TAB runs the command ...</code>. Alternatively, you might see
|
|
<code><tab> runs the command ...</code>, note the difference between <code>TAB</code> and
|
|
<code><tab></code> where the latter has priority. If you see <code><tab></code> bound to a
|
|
command other than <a href="snippet-reference.html#yas-expand"><code>yas-expand</code></a>, (e.g. in <code>org-mode</code>) you can try the
|
|
following code to work around:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-emacs-lisp">(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 <code>org-mode-hook</code> and <code>org-mode-map</code> with the major mode hook you
|
|
are dealing with (Use <code>C-h m</code> to see what major mode you are in).
|
|
</p>
|
|
|
|
<p>
|
|
As an alternative, you can also try
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-emacs-lisp">(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 <i>advise</i> the modes indentation function bound to TAB, (in this case
|
|
<code>ruby-indent-line</code>) to first try to run <a href="snippet-reference.html#yas-expand"><code>yas-expand</code></a>.
|
|
</p>
|
|
|
|
<p>
|
|
If the output of <code>C-h k RET <tab></code> tells you that <code><tab></code> is indeed
|
|
bound to <a href="snippet-reference.html#yas-expand"><code>yas-expand</code></a> but YASnippet still doesn't work, check your
|
|
configuration and you may also ask for help on the <a href="http://groups.google.com/group/smart-snippet">discussion group</a>.
|
|
See this particular <a 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 <code>C-h m</code>).
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-sec-3" class="outline-2">
|
|
<h2 id="sec-3">Why doesn't TAB navigation work with flyspell</h2>
|
|
<div class="outline-text-2" id="text-3">
|
|
<p>
|
|
A workaround is to inhibit flyspell overlays while the snippet is
|
|
active:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-emacs-lisp">(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
|
|
<code>keymap</code> property of flyspell's overlays always takes priority over the
|
|
same property in YASnippet's overlays, even if one sets the latter's
|
|
<code>priority</code> property to something big. If you know emacs-lisp and can
|
|
solve this problem, drop a line in the
|
|
<a href="http://groups.google.com/group/smart-snippet">discussion group</a>.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-sec-4" class="outline-2">
|
|
<h2 id="sec-4">How to I use alternative keys, i.e. not TAB?</h2>
|
|
<div class="outline-text-2" id="text-4">
|
|
<p>
|
|
Edit the keymaps <a href="snippet-reference.html#yas-minor-mode-map"><code>yas-minor-mode-map</code></a> and
|
|
<a href="snippet-reference.html#yas-keymap"><code>yas-keymap</code></a> as you would any other keymap:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-emacs-lisp">(define-key yas-minor-mode-map (kbd "<tab>") nil)
|
|
(define-key yas-minor-mode-map (kbd "TAB") nil)
|
|
(define-key yas-minor-mode-map (kbd "<the new key>") 'yas-expand)
|
|
|
|
;;keys for navigation
|
|
(define-key yas-keymap [(tab)] nil)
|
|
(define-key yas-keymap (kbd "TAB") nil)
|
|
(define-key yas-keymap [(shift tab)] nil)
|
|
(define-key yas-keymap [backtab] nil)
|
|
(define-key yas-keymap (kbd "<new-next-field-key>") 'yas-next-field-or-maybe-expand)
|
|
(define-key yas-keymap (kbd "<new-prev-field-key>") 'yas-prev)
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-sec-5" class="outline-2">
|
|
<h2 id="sec-5">How do I turn off the minor mode where in some buffers?</h2>
|
|
<div class="outline-text-2" id="text-5">
|
|
<p>
|
|
The best way, since version 0.6.1c, is to set the default value of the
|
|
variable <a href="snippet-reference.html#yas-dont-activate"><code>yas-dont-activate</code></a> to a lambda function like so:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-emacs-lisp">(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>
|
|
|
|
<div id="outline-container-sec-6" class="outline-2">
|
|
<h2 id="sec-6">How do I define an abbrev key containing characters not supported by the filesystem?</h2>
|
|
<div class="outline-text-2" id="text-6">
|
|
<ul class="org-ul">
|
|
<li><b>Note</b>: This question applies if you're still defining snippets
|
|
whose key <i>is</i> the filename. This is behavior still provided by
|
|
version 0.6 for backward compatibilty, but is somewhat
|
|
deprecated…
|
|
</li>
|
|
</ul>
|
|
|
|
<p>
|
|
For example, you want to define a snippet by the key <code><</code> 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 <code># key:</code> directive to specify the key of the
|
|
defined snippet explicitly and name your snippet with an arbitrary valid
|
|
filename, <code>lt.YASnippet</code> for example, using <code><</code> for the <code># key:</code>
|
|
directive:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
|
|
<pre class="src src-snippet"># key: <
|
|
# name: <...></...>
|
|
# --
|
|
<${1:div}>$0</$1>
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="postamble" class="status">
|
|
<hr><p class='creator'>Generated by <a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.4.91.1 (<a href="http://orgmode.org">Org</a> mode 8.2.10) on from 7703a55ac416a131dec45fa6a1e0ec1e31adf760
|
|
</p>
|
|
<p class='xhtml-validation'><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
|
</div>
|
|
</body>
|
|
</html>
|