diff --git a/faq.html b/faq.html index 5c9d55c..6f64473 100644 --- a/faq.html +++ b/faq.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-10T23:03-0500 from b944cc9b12ff88ebbe36a4de6fa73116d1fc2fb5 +
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-24T11:50-0500 from 78c8b5eb8058e8da523542b1b1de7e21a5b60e14
diff --git a/index.html b/index.html index 4ae4a16..c244862 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-10T23:03-0500 from b944cc9b12ff88ebbe36a4de6fa73116d1fc2fb5 +
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-24T11:50-0500 from 78c8b5eb8058e8da523542b1b1de7e21a5b60e14
diff --git a/snippet-development.html b/snippet-development.html index 3ade524..1048676 100644 --- a/snippet-development.html +++ b/snippet-development.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.delete-char
command.
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-10T23:03-0500 from b944cc9b12ff88ebbe36a4de6fa73116d1fc2fb5 +
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-24T11:50-0500 from 78c8b5eb8058e8da523542b1b1de7e21a5b60e14
diff --git a/snippet-expansion.html b/snippet-expansion.html index 500f12f..f6099a6 100644 --- a/snippet-expansion.html +++ b/snippet-expansion.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-10T23:03-0500 from b944cc9b12ff88ebbe36a4de6fa73116d1fc2fb5 +
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-24T11:50-0500 from 78c8b5eb8058e8da523542b1b1de7e21a5b60e14
diff --git a/snippet-menu.html b/snippet-menu.html index 258af6e..afb2f82 100644 --- a/snippet-menu.html +++ b/snippet-menu.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-10T23:03-0500 from b944cc9b12ff88ebbe36a4de6fa73116d1fc2fb5 +
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-24T11:50-0500 from 78c8b5eb8058e8da523542b1b1de7e21a5b60e14
diff --git a/snippet-organization.html b/snippet-organization.html index 6741750..83f01ec 100644 --- a/snippet-organization.html +++ b/snippet-organization.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-10T23:03-0500 from b944cc9b12ff88ebbe36a4de6fa73116d1fc2fb5 +
Generated by Org version 7.9.3f with Emacs version 24 on 2013-12-24T11:50-0500 from 78c8b5eb8058e8da523542b1b1de7e21a5b60e14
diff --git a/snippet-reference.html b/snippet-reference.html index 4d7b07d..9f16ae5 100644 --- a/snippet-reference.html +++ b/snippet-reference.html @@ -7,7 +7,7 @@ - + @@ -125,6 +125,7 @@ for the JavaScript code in this tag.yas-skip-and-clear-or-delete-char
(&optional field
)yas-exit-all-snippets
()yas-exit-snippet
(snippet
)yas-abort-snippet
(&optional snippet
)yas-prev-field
()yas-next-field
(&optional arg
)yas-next-field-or-maybe-expand
()yas-describe-tables
(&optional choose
)yas-tryout-snippet
(&optional debug
)yas-load-snippet-buffer
(table
&optional interactive
)yas-new-snippet
(&optional no-template
)yas-visit-snippet-file
()yas-load-snippet-buffer
(table
&optional interactive
)yas-global-mode
(&optional arg
)yas-skip-and-clear-or-delete-char
(&optional field
)yas-next-field
(&optional arg
)yas-insert-snippet
(&optional no-condition
)yas-expand-from-keymap
()yas-expand-from-trigger-key
(&optional field
)yas-about
()yas-activate-extra-mode
(mode
)yas-recompile-all
()yas-compile-directory
(top-level-dir
)yas-direct-keymaps-reload
()yas-exit-all-snippets
()yas-tryout-snippet
(&optional debug
)yas-exit-snippet
(snippet
)yas-expand
(&optional field
)yas-expand-from-keymap
()yas-minor-mode
(&optional arg
)yas-minor-mode-on
()yas-reload-all
(&optional interactive
)yas-load-directory
(top-level-dir
&optional use-jit
interactive
)yas-minor-mode-on
()yas-direct-keymaps-reload
()yas-global-mode
(&optional arg
)yas-minor-mode
(&optional arg
)yas-expand
(&optional field
)yas-new-snippet
(&optional no-template
)yas-load-snippet-buffer-and-close
(table
&optional kill
)yas-describe-tables
(&optional choose
)yas-deactivate-extra-mode
(mode
)yas-next-field-or-maybe-expand
()yas-about
()yas-prev-field
()yas-expand-from-trigger-key
(&optional field
)yas-expand-only-for-last-commands
yas-visit-from-menu
yas-good-grace
yas-wrap-around-region
yas-trigger-symbol
yas-use-menu
yas-choose-tables-first
yas-choose-keys-first
yas-fallback-behavior
yas-triggers-in-field
yas-snippet-revival
yas-also-auto-indent-first-line
yas-indent-line
yas-new-snippet-default
yas-choose-keys-first
yas-fallback-behavior
yas-wrap-around-region
yas-prompt-functions
yas-visit-from-menu
yas-triggers-in-field
yas-trigger-symbol
yas-use-menu
yas-indent-line
yas-expand-only-for-last-commands
yas-snippet-dirs
()yas-good-grace
yas-active-keys
()yas-hippie-try-expand
(first-time?
)yas-define-condition-cache
(func
doc
&rest body
)yas-unimplemented
(&optional missing-feature
)yas-inside-string
()yas-default-from-field
(number
)yas-completing-prompt
(prompt
choices
&optional display-fn
completion-fn
)yas-selected-text
()yas-hippie-try-expand
(first-time?
)yas-global-mode-cmhh
()yas-throw
(text
)yas-inside-string
()yas-x-prompt
(prompt
choices
&optional display-fn
)yas-text
()yas-ido-prompt
(prompt
choices
&optional display-fn
)yas-dropdown-prompt
(_prompt
choices
&optional display-fn
)yas-define-snippets
(mode
snippets
)yas-global-mode-enable-in-buffers
()yas-no-prompt
(_prompt
choices
&optional _display-fn
)yas-active-keys
()yas-define-condition-cache
(func
doc
&rest body
)yas-global-mode-check-buffers
()yas-define-menu
(mode
menu
&optional omit-items
)yas-field-value
(number
)yas-verify-value
(possibilities
)yas-throw
(text
)yas-key-to-value
(alist
)yas-choose-value
(&rest possibilities
)yas-substr
(str
pattern
&optional subexp
)yas-text
()yas-define-menu
(mode
menu
&optional omit-items
)yas-define-snippets
(mode
snippets
)yas-unimplemented
(&optional missing-feature
)yas-expand-snippet
(content
&optional start
end
expand-env
)yas-dropdown-prompt
(_prompt
choices
&optional display-fn
)yas-completing-prompt
(prompt
choices
&optional display-fn
completion-fn
)yas-no-prompt
(_prompt
choices
&optional _display-fn
)yas-ido-prompt
(prompt
choices
&optional display-fn
)yas-x-prompt
(prompt
choices
&optional display-fn
)yas-moving-away-p
yas-modified-p
yas-snippet-end
yas-global-mode-buffers
yas-snippet-beg
yas-dont-activate
yas-buffer-local-condition
yas-before-expand-snippet-hook
yas-after-exit-snippet-hook
yas-key-syntaxes
yas-extra-modes
yas-verbosity
yas-global-mode-hook
yas-dont-activate
yas-minor-mode-map
yas-moving-away-p
yas-buffer-local-condition
yas-modified-p
yas-before-expand-snippet-hook
yas-keymap
yas-key-syntaxes
yas-snippet-end
yas-minor-mode-hook
yas-verbosity
yas-minor-mode-major-mode
yas-skip-and-clear-or-delete-char
(&optional field
)Clears unmodified field if at field start, skips to next tab. -
-
-Otherwise deletes a character normally by calling delete-char
.
-
yas-abort-snippet
(&optional snippet
)yas-abort-snippet
(&optional snippet
)/warning/: no doc for symbol yas-abort-snippet
delete-char
.
yas-prev-field
()yas-next-field
(&optional arg
)Navigate to the arg
th next field.
+
Choose a snippet to edit, selection like yas-insert-snippet
.
-If there's none, exit the snippet.
+Only success if selected snippet was loaded from a file. Put the
+visited file in snippet-mode
.
yas-next-field-or-maybe-expand
()Try to expand a snippet at a key before point. -
-
-Otherwise delegate to yas-next-field
.
-
yas-tryout-snippet
(&optional debug
)Test current buffer's snippet template in other buffer. -
-yas-load-snippet-buffer
(table
&optional interactive
)yas-load-snippet-buffer
(table
&optional interactive
)Parse and load current buffer's snippet definition into table
.
yas-new-snippet
(&optional no-template
)Pops a new buffer for writing a snippet. -
-
-Expands a snippet-writing snippet, unless the optional prefix arg
-no-template
is non-nil.
-
yas-visit-snippet-file
()Choose a snippet to edit, selection like yas-insert-snippet
.
-
-Only success if selected snippet was loaded from a file. Put the
-visited file in snippet-mode
.
-
yas-insert-snippet
(&optional no-condition
)Choose a snippet to expand, pop-up a list of choices according
-to yas-prompt-functions
.
-
-With prefix argument no-condition
, bypass filtering of snippets
-by condition.
-
yas-expand-from-keymap
()Expand/run snippets from keymaps, possibly falling back to original binding. -
- -yas-expand-from-trigger-key
(&optional field
)Expand a snippet before point. -
-
-If no snippet expansion is possible, fall back to the behaviour
-defined in yas-fallback-behavior
.
-
-Optional argument field
is for non-interactive use and is an
-object satisfying yas--field-p
to restrict the expansion to.
-
yas-recompile-all
()Compile every dir in yas-snippet-dirs
.
-
yas-compile-directory
(top-level-dir
)Create .yas-compiled-snippets.el files under subdirs of top-level-dir
.
-
-This works by stubbing a few functions, then calling
-yas-load-directory
.
-
yas-reload-all
(&optional interactive
)Reload all snippets and rebuild the YASnippetnippet menu. -
-
-When called interactively force immediate reload of all known
-snippets under yas-snippet-dirs
, otherwise use just-in-time
-loading.
-
yas-load-directory
(top-level-dir
&optional use-jit
interactive
)Load snippets in directory hierarchy top-level-dir
.
-
-Below top-level-dir
each directory should be a mode name.
-
-Optional use-jit
use jit-loading of snippets.
-
yas-minor-mode-on
()Turn on YASnippetnippet minor mode. -
-
-Honour yas-dont-activate
, which see.
-
yas-direct-keymaps-reload
()Force reload the direct keybinding for active snippet tables. -
-yas-global-mode
(&optional arg
)yas-global-mode
(&optional arg
)Toggle Yas minor mode in all buffers.
With prefix arg
, enable Yas-Global mode if arg
is positive;
@@ -549,14 +313,159 @@ See yas-minor-mode
for more informati
yas-minor-mode
(&optional arg
)yas-skip-and-clear-or-delete-char
(&optional field
)Toggle YASnippetnippet mode. +
Clears unmodified field if at field start, skips to next tab.
-When YASnippetnippet mode is enabled, yas-expand
, normally bound to
+Otherwise deletes a character normally by calling delete-char
.
+
yas-next-field
(&optional arg
)Navigate to the arg
th next field.
+
+If there's none, exit the snippet. +
+yas-insert-snippet
(&optional no-condition
)Choose a snippet to expand, pop-up a list of choices according
+to yas-prompt-functions
.
+
+With prefix argument no-condition
, bypass filtering of snippets
+by condition.
+
yas-activate-extra-mode
(mode
)Activates the snippets for the given mode
in the buffer.
+
+The function can be called in the hook of a minor mode to +activate snippets associated with that mode. +
+yas-recompile-all
()Compile every dir in yas-snippet-dirs
.
+
yas-compile-directory
(top-level-dir
)Create .yas-compiled-snippets.el files under subdirs of top-level-dir
.
+
+This works by stubbing a few functions, then calling
+yas-load-directory
.
+
yas-direct-keymaps-reload
()Force reload the direct keybinding for active snippet tables. +
+yas-tryout-snippet
(&optional debug
)Test current buffer's snippet template in other buffer. +
+yas-expand
(&optional field
)Expand a snippet before point. If no snippet
+expansion is possible, defer to yas-fallback-behavior
(which see).
+
+Optional argument field
is for non-interactive use and is an
+object satisfying yas--field-p
to restrict the expansion to.
+
yas-expand-from-keymap
()Expand/run snippets from keymaps, possibly falling back to original binding. +
+ +yas-minor-mode
(&optional arg
)Toggle YASnippet mode. +
+
+When YASnippet mode is enabled, yas-expand
, normally bound to
the tab key, expands snippets of code depending on the major
mode.
yas-expand
(&optional field
)yas-minor-mode-on
()Expand a snippet before point. If no snippet
-expansion is possible, defer to yas-fallback-behavior
(which see).
+
Turn on YASnippet minor mode. +
+
+Honour yas-dont-activate
, which see.
+
yas-reload-all
(&optional interactive
)Reload all snippets and rebuild the YASnippet menu. +
+
+When called interactively force immediate reload of all known
+snippets under yas-snippet-dirs
, otherwise use just-in-time
+loading.
+
yas-load-directory
(top-level-dir
&optional use-jit
interactive
)Load snippets in directory hierarchy top-level-dir
.
+
+Below top-level-dir
each directory should be a mode name.
+
+Optional use-jit
use jit-loading of snippets.
+
yas-new-snippet
(&optional no-template
)Pops a new buffer for writing a snippet. +
+
+Expands a snippet-writing snippet, unless the optional prefix arg
+no-template
is non-nil.
+
yas-load-snippet-buffer-and-close
(table
&optional kill
)Load the snippet with yas-load-snippet-buffer
, possibly
+ save, then quit-window
if saved.
+
+If the snippet is new, ask the user whether (and where) to save +it. If the snippet already has a file, just save it. +
+
+The prefix argument kill
is passed to quit-window
.
+
+Don't use this from a Lisp program, call yas-load-snippet-buffer
+and kill-buffer
instead.
+
yas-deactivate-extra-mode
(mode
)Deactivates the snippets for the given mode
in the buffer.
+
yas-next-field-or-maybe-expand
()Try to expand a snippet at a key before point. +
+
+Otherwise delegate to yas-next-field
.
+
yas-expand-from-trigger-key
(&optional field
)Expand a snippet before point. +
+
+If no snippet expansion is possible, fall back to the behaviour
+defined in yas-fallback-behavior
.
Optional argument field
is for non-interactive use and is an
@@ -588,133 +633,16 @@ object satisfying yas--field-p
to restrict the expansion to.
yas-expand-only-for-last-commands
-List of last-command
values to restrict tab-triggering to, or nil.
-
-Leave this set at nil (the default) to be able to trigger an -expansion simply by placing the cursor after a valid tab trigger, -using whichever commands. -
--Optionally, set this to something like '(self-insert-command) if -you to wish restrict expansion to only happen when the last -letter of the snippet tab trigger was typed immediately before -the trigger key itself. -
-yas-good-grace
-If non-nil, don't raise errors in inline elisp evaluation. -
--An error string "[yas] error" is returned instead. -
-yas-wrap-around-region
-If non-nil, snippet expansion wraps around selected region. -
--The wrapping occurs just before the snippet's exit marker. This -can be overridden on a per-snippet basis. -
-yas-choose-tables-first
yas-choose-tables-first
@@ -731,9 +659,49 @@ This affects yas-insert-snippet
,
yas-choose-keys-first
yas-also-auto-indent-first-line
+Non-nil means also auto indent first line according to mode. +
+
+Naturally this is only valid when yas-indent-line
is auto
+
yas-new-snippet-default
+Default snippet to use when creating a new snippet. +If nil, don't use any snippet. +
+yas-choose-keys-first
@@ -749,16 +717,16 @@ This affects yas-insert-snippet
a
yas-fallback-behavior
yas-fallback-behavior
How to act when yas-expand
does not expand a snippet.
call-other-command
means try to temporarily disable YASnippetnippet
+call-other-command
means try to temporarily disable YASnippet
and call the next command bound to whatever key was used to
invoke yas-expand
.
@@ -778,81 +746,25 @@ How to act when yas-expand
does not
-yas-triggers-in-field
yas-wrap-around-region
-If non-nil, allow stacked expansions (snippets inside snippets). +If non-nil, snippet expansion wraps around selected region.
-Otherwise yas-next-field-or-maybe-expand
just moves on to the
-next field
+The wrapping occurs just before the snippet's exit marker. This
+can be overridden on a per-snippet basis.
yas-also-auto-indent-first-line
-Non-nil means also auto indent first line according to mode. -
-
-Naturally this is only valid when yas-indent-line
is auto
-
yas-indent-line
-Controls indenting applied to a recent snippet expansion. -
--The following values are possible: -
-fixed
Indent the snippet to the current column;
-
-auto
Indent each line of the snippet with indent-according-to-mode
--Every other value means don't apply any snippet-side indentation -after expansion (the manual per-line "$>" indentation still -applies). -
-yas-prompt-functions
yas-prompt-functions
@@ -901,36 +813,202 @@ nil.
yas-snippet-dirs
()Return yas-snippet-dirs
(which see) as a list.
-