mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 21:13:04 +00:00
377 lines
10 KiB
HTML
377 lines
10 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!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>Organizing snippets</title>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
|
|
<meta name="title" content="Organizing snippets"/>
|
|
<meta name="generator" content="Org-mode"/>
|
|
<meta name="generated" content="2013-12-02T23:44-0500"/>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
<meta name="keywords" content=""/>
|
|
<style type="text/css">
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
html { font-family: Times, serif; font-size: 12pt; }
|
|
.title { text-align: center; }
|
|
.todo { color: red; }
|
|
.done { color: green; }
|
|
.tag { background-color: #add8e6; font-weight:normal }
|
|
.target { }
|
|
.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;}
|
|
p.verse { margin-left: 3% }
|
|
pre {
|
|
border: 1pt solid #AEBDCC;
|
|
background-color: #F3F5F7;
|
|
padding: 5pt;
|
|
font-family: courier, monospace;
|
|
font-size: 90%;
|
|
overflow:auto;
|
|
}
|
|
table { border-collapse: collapse; }
|
|
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; }
|
|
div.figure { padding: 0.5em; }
|
|
div.figure p { text-align: center; }
|
|
div.inlinetask {
|
|
padding:10px;
|
|
border:2px solid gray;
|
|
margin:10px;
|
|
background: #ffffcc;
|
|
}
|
|
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>
|
|
<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="org-div-home-and-up" style="text-align:right;font-size:70%;white-space:nowrap;">
|
|
<a accesskey="h" href="./index.html"> UP </a>
|
|
|
|
|
<a accesskey="H" href="./index.html"> HOME </a>
|
|
</div>
|
|
|
|
<div id="preamble">
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
<h1 class="title">Organizing snippets</h1>
|
|
|
|
|
|
|
|
<div id="table-of-contents">
|
|
<h2>Table of Contents</h2>
|
|
<div id="text-table-of-contents">
|
|
<ul>
|
|
<li><a href="#sec-1">Basic structure</a></li>
|
|
<li><a href="#sec-2">Setting up <code>yas-snippet-dirs</code></a></li>
|
|
<li><a href="#sec-3">The <code>.yas-parents</code> file</a></li>
|
|
<li><a href="#sec-4">The <code>.yas-make-groups</code> file</a></li>
|
|
<li><a href="#sec-5">The <code>.yas-setup.el</code> file</a>
|
|
<ul>
|
|
<li><a href="#sec-5-1"></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-6">The <code>.yas-compiled-snippet.el</code> file</a>
|
|
<ul>
|
|
<li><a href="#sec-6-1"></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#sec-7">The <code>.yas-skip</code> file</a>
|
|
<ul>
|
|
<li><a href="#sec-7-1"></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-1" class="outline-2">
|
|
<h2 id="sec-1">Basic structure</h2>
|
|
<div class="outline-text-2" id="text-1">
|
|
|
|
|
|
<p>
|
|
Snippet collections can be stored in plain text files. They are arranged by
|
|
sub-directories naming <b>snippet tables</b>. These mostly name Emacs major names.
|
|
</p>
|
|
|
|
|
|
|
|
<pre class="example">.
|
|
|-- c-mode
|
|
| `-- printf
|
|
|-- java-mode
|
|
| `-- println
|
|
`-- text-mode
|
|
|-- email
|
|
`-- time
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
The collections are loaded into <b>snippet tables</b> which the
|
|
triggering mechanism (see <a href="snippet-expansion.html">Expanding Snippets</a>) looks up and
|
|
(hopefully) causes the right snippet to be expanded for you.
|
|
</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-2" class="outline-2">
|
|
<h2 id="sec-2">Setting up <code>yas-snippet-dirs</code></h2>
|
|
<div class="outline-text-2" id="text-2">
|
|
|
|
|
|
<p>
|
|
The emacs variable <a href="snippet-reference.html#yas-snippet-dirs"><code>yas-snippet-dirs</code></a> tells YASnippet
|
|
which collections to consider. It's used when you activate
|
|
<a href="snippet-reference.html#yas-global-mode"><code>yas-global-mode</code></a> or call
|
|
<a href="snippet-reference.html#yas-reload-all"><code>yas-reload-all</code></a> interactively.
|
|
</p>
|
|
<p>
|
|
The default considers:
|
|
</p>
|
|
<ul>
|
|
<li>a personal collection that lives in <code>~/.emacs.d/snippets</code>
|
|
</li>
|
|
<li>the bundled collection, taken as a relative path to <code>yasnippet.el</code> localtion
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<p>
|
|
When you come across other snippet collections, do the following to try them
|
|
out:
|
|
</p>
|
|
|
|
|
|
|
|
<pre class="example">;; Develop in ~/emacs.d/mysnippets, but also
|
|
;; try out snippets in ~/Downloads/interesting-snippets
|
|
(setq yas-snippet-dirs '("~/emacs.d/mysnippets"
|
|
"~/Downloads/interesting-snippets"))
|
|
|
|
;; OR, keeping YASnippet defaults try out ~/Downloads/interesting-snippets
|
|
(setq yas-snippet-dirs (append yas-snippet-dirs
|
|
'("~/Downloads/interesting-snippets")))
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
Collections appearing earlier in the list shadow snippets with same names
|
|
appearing in collections later in the list. <a href="snippet-reference.html#yas-new-snippet"><code>yas-new-snippet</code></a> always stores
|
|
snippets in the first collection.
|
|
</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-3" class="outline-2">
|
|
<h2 id="sec-3">The <code>.yas-parents</code> file</h2>
|
|
<div class="outline-text-2" id="text-3">
|
|
|
|
|
|
<p>
|
|
It's very useful to have certain modes share snippets between
|
|
themselves. To do this, choose a mode subdirectory and place a
|
|
<code>.yas-parents</code> containing a whitespace-separated list of other mode
|
|
names. When you reload those modes become parents of the original
|
|
mode.
|
|
</p>
|
|
|
|
|
|
|
|
<pre class="example">.
|
|
|-- 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 id="outline-container-4" class="outline-2">
|
|
<h2 id="sec-4"><span class="todo TODO">TODO</span> The <code>.yas-make-groups</code> file</h2>
|
|
<div class="outline-text-2" id="text-4">
|
|
|
|
|
|
<p>
|
|
If you place an empty plain text file <code>.yas-make-groups</code> inside one
|
|
of the mode directories, the names of these sub-directories are
|
|
considered groups of snippets and <a href="#snippet-menu.org">the menu</a> is organized much more
|
|
cleanly:
|
|
</p>
|
|
<p>
|
|
<img src="./images/menu-groups.png" alt="./images/menu-groups.png" />
|
|
</p>
|
|
<p>
|
|
Another way to achieve this is to place a <code># group:</code> directive
|
|
inside the snippet definition. See <a href="./snippet-development.html">Writing Snippets</a>.
|
|
</p>
|
|
|
|
|
|
|
|
<pre class="example">$ tree ruby-mode/
|
|
ruby-mode/
|
|
|-- .yas-make-groups
|
|
|-- collections
|
|
| |-- each
|
|
| `-- ...
|
|
|-- control structure
|
|
| |-- forin
|
|
| `-- ...
|
|
|-- definitions
|
|
| `-- ...
|
|
`-- general
|
|
`-- ...
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
Yet another way to create a nice snippet menu is to write into
|
|
<code>.yas-make-groups</code> a menu definition. TODO
|
|
</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-5" class="outline-2">
|
|
<h2 id="sec-5"><span class="todo TODO">TODO</span> The <code>.yas-setup.el</code> file</h2>
|
|
<div class="outline-text-2" id="text-5">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-5-1" class="outline-3">
|
|
<h3 id="sec-5-1"><span class="todo TODO">TODO</span></h3>
|
|
<div class="outline-text-3" id="text-5-1">
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-6" class="outline-2">
|
|
<h2 id="sec-6"><span class="todo TODO">TODO</span> The <code>.yas-compiled-snippet.el</code> file</h2>
|
|
<div class="outline-text-2" id="text-6">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-6-1" class="outline-3">
|
|
<h3 id="sec-6-1"><span class="todo TODO">TODO</span></h3>
|
|
<div class="outline-text-3" id="text-6-1">
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-7" class="outline-2">
|
|
<h2 id="sec-7"><span class="todo TODO">TODO</span> The <code>.yas-skip</code> file</h2>
|
|
<div class="outline-text-2" id="text-7">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="outline-container-7-1" class="outline-3">
|
|
<h3 id="sec-7-1"><span class="todo TODO">TODO</span></h3>
|
|
<div class="outline-text-3" id="text-7-1">
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="postamble">
|
|
<hr><p class='creator'>Generated by <a href="http://orgmode.org">Org</a> version 7.9.3f with <a href="http://www.gnu.org/software/emacs/">Emacs</a> version 24 on 2013-12-02T23:44-0500 from 0a9885eb627303b2841fbd364176ea4811646303
|
|
</p>
|
|
<p class='xhtml-validation'><a href="http://validator.w3.org/check?uri=referer">Validate XHTML 1.0</a></p>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|