mirror of
https://github.com/joaotavora/yasnippet.git
synced 2026-02-04 06:32:24 +00:00
Automatic documentation update.
From 0.13.0
This commit is contained in:
Noam Postavsky
@@ -3,21 +3,28 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Organizing snippets</title>
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="generator" content="Org-mode" />
|
||||
<meta name="generator" content="Org mode" />
|
||||
<style type="text/css">
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
.title { text-align: center; }
|
||||
.title { text-align: center;
|
||||
margin-bottom: .2em; }
|
||||
.subtitle { text-align: center;
|
||||
font-size: medium;
|
||||
font-weight: bold;
|
||||
margin-top:0; }
|
||||
.todo { font-family: monospace; color: red; }
|
||||
.done { color: green; }
|
||||
.done { font-family: monospace; color: green; }
|
||||
.priority { font-family: monospace; color: orange; }
|
||||
.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; }
|
||||
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
||||
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
||||
.org-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%; }
|
||||
@@ -44,27 +51,111 @@
|
||||
border: 1px solid black;
|
||||
}
|
||||
pre.src:hover:before { display: inline;}
|
||||
pre.src-sh:before { content: 'sh'; }
|
||||
pre.src-bash:before { content: 'sh'; }
|
||||
/* Languages per Org manual */
|
||||
pre.src-asymptote:before { content: 'Asymptote'; }
|
||||
pre.src-awk:before { content: 'Awk'; }
|
||||
pre.src-C:before { content: 'C'; }
|
||||
/* pre.src-C++ doesn't work in CSS */
|
||||
pre.src-clojure:before { content: 'Clojure'; }
|
||||
pre.src-css:before { content: 'CSS'; }
|
||||
pre.src-D:before { content: 'D'; }
|
||||
pre.src-ditaa:before { content: 'ditaa'; }
|
||||
pre.src-dot:before { content: 'Graphviz'; }
|
||||
pre.src-calc:before { content: 'Emacs Calc'; }
|
||||
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'; }
|
||||
pre.src-fortran:before { content: 'Fortran'; }
|
||||
pre.src-gnuplot:before { content: 'gnuplot'; }
|
||||
pre.src-haskell:before { content: 'Haskell'; }
|
||||
pre.src-hledger:before { content: 'hledger'; }
|
||||
pre.src-java:before { content: 'Java'; }
|
||||
pre.src-js:before { content: 'Javascript'; }
|
||||
pre.src-latex:before { content: 'LaTeX'; }
|
||||
pre.src-ledger:before { content: 'Ledger'; }
|
||||
pre.src-lisp:before { content: 'Lisp'; }
|
||||
pre.src-lilypond:before { content: 'Lilypond'; }
|
||||
pre.src-lua:before { content: 'Lua'; }
|
||||
pre.src-matlab:before { content: 'MATLAB'; }
|
||||
pre.src-mscgen:before { content: 'Mscgen'; }
|
||||
pre.src-ocaml:before { content: 'Objective Caml'; }
|
||||
pre.src-octave:before { content: 'Octave'; }
|
||||
pre.src-org:before { content: 'Org mode'; }
|
||||
pre.src-oz:before { content: 'OZ'; }
|
||||
pre.src-plantuml:before { content: 'Plantuml'; }
|
||||
pre.src-processing:before { content: 'Processing.js'; }
|
||||
pre.src-python:before { content: 'Python'; }
|
||||
pre.src-R:before { content: 'R'; }
|
||||
pre.src-ruby:before { content: 'Ruby'; }
|
||||
pre.src-sass:before { content: 'Sass'; }
|
||||
pre.src-scheme:before { content: 'Scheme'; }
|
||||
pre.src-screen:before { content: 'Gnu Screen'; }
|
||||
pre.src-sed:before { content: 'Sed'; }
|
||||
pre.src-sh:before { content: 'shell'; }
|
||||
pre.src-sql:before { content: 'SQL'; }
|
||||
pre.src-sqlite:before { content: 'SQLite'; }
|
||||
/* additional languages in org.el's org-babel-load-languages alist */
|
||||
pre.src-forth:before { content: 'Forth'; }
|
||||
pre.src-io:before { content: 'IO'; }
|
||||
pre.src-J:before { content: 'J'; }
|
||||
pre.src-makefile:before { content: 'Makefile'; }
|
||||
pre.src-maxima:before { content: 'Maxima'; }
|
||||
pre.src-perl:before { content: 'Perl'; }
|
||||
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
||||
pre.src-scala:before { content: 'Scala'; }
|
||||
pre.src-shell:before { content: 'Shell Script'; }
|
||||
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
||||
/* additional language identifiers per "defun org-babel-execute"
|
||||
in ob-*.el */
|
||||
pre.src-cpp:before { content: 'C++'; }
|
||||
pre.src-abc:before { content: 'ABC'; }
|
||||
pre.src-coq:before { content: 'Coq'; }
|
||||
pre.src-groovy:before { content: 'Groovy'; }
|
||||
/* additional language identifiers from org-babel-shell-names in
|
||||
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
||||
the execution function name together. */
|
||||
pre.src-bash:before { content: 'bash'; }
|
||||
pre.src-csh:before { content: 'csh'; }
|
||||
pre.src-ash:before { content: 'ash'; }
|
||||
pre.src-dash:before { content: 'dash'; }
|
||||
pre.src-ksh:before { content: 'ksh'; }
|
||||
pre.src-mksh:before { content: 'mksh'; }
|
||||
pre.src-posh:before { content: 'posh'; }
|
||||
/* Additional Emacs modes also supported by the LaTeX listings package */
|
||||
pre.src-ada:before { content: 'Ada'; }
|
||||
pre.src-asm:before { content: 'Assembler'; }
|
||||
pre.src-caml:before { content: 'Caml'; }
|
||||
pre.src-delphi:before { content: 'Delphi'; }
|
||||
pre.src-html:before { content: 'HTML'; }
|
||||
pre.src-idl:before { content: 'IDL'; }
|
||||
pre.src-mercury:before { content: 'Mercury'; }
|
||||
pre.src-metapost:before { content: 'MetaPost'; }
|
||||
pre.src-modula-2:before { content: 'Modula-2'; }
|
||||
pre.src-pascal:before { content: 'Pascal'; }
|
||||
pre.src-ps:before { content: 'PostScript'; }
|
||||
pre.src-prolog:before { content: 'Prolog'; }
|
||||
pre.src-simula:before { content: 'Simula'; }
|
||||
pre.src-tcl:before { content: 'tcl'; }
|
||||
pre.src-tex:before { content: 'TeX'; }
|
||||
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
||||
pre.src-verilog:before { content: 'Verilog'; }
|
||||
pre.src-vhdl:before { content: 'VHDL'; }
|
||||
pre.src-xml:before { content: 'XML'; }
|
||||
pre.src-nxml:before { content: 'XML'; }
|
||||
/* add a generic configuration mode; LaTeX export needs an additional
|
||||
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
||||
pre.src-conf:before { content: 'Configuration File'; }
|
||||
|
||||
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; }
|
||||
th.org-right { text-align: center; }
|
||||
th.org-left { text-align: center; }
|
||||
th.org-center { text-align: center; }
|
||||
td.org-right { text-align: right; }
|
||||
td.org-left { text-align: left; }
|
||||
td.org-center { text-align: center; }
|
||||
dt { font-weight: bold; }
|
||||
.footpara:nth-child(2) { display: inline; }
|
||||
.footpara { display: block; }
|
||||
.footpara { display: inline; }
|
||||
.footdef { margin-bottom: 1em; }
|
||||
.figure { padding: 1em; }
|
||||
.figure p { text-align: center; }
|
||||
@@ -84,6 +175,7 @@
|
||||
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
||||
.org-info-js_search-highlight
|
||||
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
||||
.org-svg { width: 90%; }
|
||||
/*]]>*/-->
|
||||
</style>
|
||||
<link rel="stylesheet" type="text/css" href="stylesheets/manual.css" />
|
||||
@@ -92,7 +184,7 @@
|
||||
@licstart The following is the entire license notice for the
|
||||
JavaScript code in this tag.
|
||||
|
||||
Copyright (C) 2012-2013 Free Software Foundation, Inc.
|
||||
Copyright (C) 2012-2018 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
|
||||
@@ -141,9 +233,9 @@ for the JavaScript code in this tag.
|
||||
<li> <a href="index.html">Overview</a>
|
||||
<li> <a href="https://github.com/joaotavora/yasnippet/blob/master/README.mdown">
|
||||
Intro and Tutorial</a>
|
||||
<li class="center">Snippet
|
||||
<ul>
|
||||
<li> <a href="snippet-organization.html">Organization</a>
|
||||
<li class="center border">Snippet
|
||||
<ul class="nopad">
|
||||
<li> <span class='current'>Organization</span>
|
||||
<li> <a href="snippet-expansion.html">Expansion</a>
|
||||
<li> <a href="snippet-development.html">Development</a>
|
||||
<li> <a href="snippet-menu.html">Menu</a>
|
||||
@@ -159,23 +251,24 @@ for the JavaScript code in this tag.
|
||||
<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"><span class="todo TODO">TODO</span> The <code>.yas-make-groups</code> file</a></li>
|
||||
<li><a href="#sec-5">The <code>.yas-setup.el</code> file</a></li>
|
||||
<li><a href="#sec-6">The <code>.yas-compiled-snippet.el</code> file</a></li>
|
||||
<li><a href="#sec-7">The <code>.yas-skip</code> file</a></li>
|
||||
<li><a href="#org91b0471">Basic structure</a></li>
|
||||
<li><a href="#org10ee311">Setting up <code>yas-snippet-dirs</code></a></li>
|
||||
<li><a href="#org7468fa9">The <code>.yas-parents</code> file</a></li>
|
||||
<li><a href="#orgac3b0a5"><span class="todo TODO">TODO</span> The <code>.yas-make-groups</code> file</a></li>
|
||||
<li><a href="#orge57abf6">The <code>.yas-setup.el</code> file</a></li>
|
||||
<li><a href="#org40a5619">The <code>.yas-compiled-snippet.el</code> file</a></li>
|
||||
<li><a href="#org2f7147a">The <code>.yas-skip</code> file</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1" class="outline-2">
|
||||
<h2 id="sec-1">Basic structure</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<div id="outline-container-org91b0471" class="outline-2">
|
||||
<h2 id="org91b0471">Basic structure</h2>
|
||||
<div class="outline-text-2" id="text-org91b0471">
|
||||
<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.
|
||||
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 mode names.
|
||||
</p>
|
||||
|
||||
<pre class="example">
|
||||
@@ -197,9 +290,9 @@ triggering mechanism (see <a href="snippet-expansion.html">Expanding Snippets</a
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-2" class="outline-2">
|
||||
<h2 id="sec-2">Setting up <code>yas-snippet-dirs</code></h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<div id="outline-container-org10ee311" class="outline-2">
|
||||
<h2 id="org10ee311">Setting up <code>yas-snippet-dirs</code></h2>
|
||||
<div class="outline-text-2" id="text-org10ee311">
|
||||
<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
|
||||
@@ -212,10 +305,8 @@ The default considers:
|
||||
</p>
|
||||
|
||||
<ul class="org-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>
|
||||
<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>
|
||||
@@ -224,7 +315,6 @@ out:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
|
||||
<pre class="src src-emacs-lisp"><span class="org-comment-delimiter">;; </span><span class="org-comment">Develop in ~/emacs.d/mysnippets, but also</span>
|
||||
<span class="org-comment-delimiter">;; </span><span class="org-comment">try out snippets in ~/Downloads/interesting-snippets</span>
|
||||
(<span class="org-keyword">setq</span> yas-snippet-dirs '(<span class="org-string">"~/emacs.d/mysnippets"</span>
|
||||
@@ -244,9 +334,9 @@ snippets in the first collection.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-3" class="outline-2">
|
||||
<h2 id="sec-3">The <code>.yas-parents</code> file</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
<div id="outline-container-org7468fa9" class="outline-2">
|
||||
<h2 id="org7468fa9">The <code>.yas-parents</code> file</h2>
|
||||
<div class="outline-text-2" id="text-org7468fa9">
|
||||
<p>
|
||||
It's very useful to have certain modes share snippets between
|
||||
themselves. To do this, choose a mode subdirectory and place a
|
||||
@@ -274,13 +364,13 @@ mode.
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-sec-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">
|
||||
<div id="outline-container-orgac3b0a5" class="outline-2">
|
||||
<h2 id="orgac3b0a5"><span class="todo TODO">TODO</span> The <code>.yas-make-groups</code> file</h2>
|
||||
<div class="outline-text-2" id="text-orgac3b0a5">
|
||||
<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 <i>the menu</i> is organized much more
|
||||
considered groups of snippets and <a href="snippet-menu.html">the menu</a> is organized much more
|
||||
cleanly:
|
||||
</p>
|
||||
|
||||
@@ -318,9 +408,9 @@ Yet another way to create a nice snippet menu is to write into
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-5" class="outline-2">
|
||||
<h2 id="sec-5">The <code>.yas-setup.el</code> file</h2>
|
||||
<div class="outline-text-2" id="text-5">
|
||||
<div id="outline-container-orge57abf6" class="outline-2">
|
||||
<h2 id="orge57abf6">The <code>.yas-setup.el</code> file</h2>
|
||||
<div class="outline-text-2" id="text-orge57abf6">
|
||||
<p>
|
||||
If there is file named <code>.yas-setup.el</code> in a mode's snippet
|
||||
subdirectory, it is loaded along with the snippets. Utility
|
||||
@@ -329,9 +419,9 @@ functions used by the snippets can be put here.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-6" class="outline-2">
|
||||
<h2 id="sec-6">The <code>.yas-compiled-snippet.el</code> file</h2>
|
||||
<div class="outline-text-2" id="text-6">
|
||||
<div id="outline-container-org40a5619" class="outline-2">
|
||||
<h2 id="org40a5619">The <code>.yas-compiled-snippet.el</code> file</h2>
|
||||
<div class="outline-text-2" id="text-org40a5619">
|
||||
<p>
|
||||
You may compile a top-level snippet directory with the
|
||||
<code>yas-compile-directory</code> function, which will create a
|
||||
@@ -347,9 +437,9 @@ Alternatively, you may compile all directories in the list
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-7" class="outline-2">
|
||||
<h2 id="sec-7">The <code>.yas-skip</code> file</h2>
|
||||
<div class="outline-text-2" id="text-7">
|
||||
<div id="outline-container-org2f7147a" class="outline-2">
|
||||
<h2 id="org2f7147a">The <code>.yas-skip</code> file</h2>
|
||||
<div class="outline-text-2" id="text-org2f7147a">
|
||||
<p>
|
||||
A <code>.yas-skip</code> file in a mode's snippet subdirectory tells YASnippet
|
||||
not to load snippets from there.
|
||||
@@ -358,7 +448,7 @@ not to load snippets from there.
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<hr><p class='creator'>Generated by <a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.2.50.5 (<a href="http://orgmode.org">Org</a> mode 8.2.10) from 0.12.2 (2017-08-29 02:08:58)</p>
|
||||
<hr><p class='creator'>Generated by <a href="https://www.gnu.org/software/emacs/">Emacs</a> 26.1 (<a href="https://orgmode.org">Org</a> mode 9.1.9) from 0.13.0 (2018-05-13 16:12:51)</p>
|
||||
<p class='xhtml-validation'><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user