From cdbb51ec43e88194ecd3366e4c860cfd93f672b5 Mon Sep 17 00:00:00 2001 From: Noam Postavsky Date: Tue, 24 Dec 2013 11:57:25 -0500 Subject: [PATCH] Automatic documentation update. From 78c8b5eb8058e8da523542b1b1de7e21a5b60e14 --- faq.html | 5 +- index.html | 5 +- snippet-development.html | 5 +- snippet-expansion.html | 9 +- snippet-menu.html | 5 +- snippet-organization.html | 5 +- snippet-reference.html | 1756 ++++++++++++++++++++----------------- 7 files changed, 960 insertions(+), 830 deletions(-) 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.
  • Menu
  • FAQ +
  • Reference @@ -390,7 +391,7 @@ directive:
    -

    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

    Validate XHTML 1.0

    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.
  • Menu
  • FAQ +
  • Reference @@ -193,7 +194,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

    Validate XHTML 1.0

    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.
  • Menu
  • FAQ +
  • Reference @@ -839,7 +840,7 @@ performs the normal Emacs 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

    Validate XHTML 1.0

    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.
  • Menu
  • FAQ +
  • Reference @@ -150,7 +151,7 @@ for the JavaScript code in this tag.
  • FAQ +
  • Reference @@ -268,7 +269,7 @@ variables.
    -

    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

    Validate XHTML 1.0

    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.
  • Menu
  • FAQ +
  • Reference @@ -378,7 +379,7 @@ ruby-mode/
    -

    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

    Validate XHTML 1.0

    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.
  • Menu
  • FAQ +
  • Reference @@ -135,103 +136,112 @@ for the JavaScript code in this tag. + + +

    Table of Contents

    @@ -239,59 +249,15 @@ for the JavaScript code in this tag.
    -

    Reference

    +

    Interactive functions

    - - - -
    -
    -

    Interactive functions

    -
    - - -
    - -
    -

    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-exit-all-snippets ()

    -
    - -

    Exit all snippets. -

    -
    - -
    - -
    -

    yas-exit-snippet (snippet)

    -
    - -

    Goto exit-marker of snippet. -

    -
    - -
    - -
    -

    yas-abort-snippet (&optional snippet)

    -
    +
    +

    yas-abort-snippet (&optional snippet)

    +

    /warning/: no doc for symbol yas-abort-snippet

    @@ -299,65 +265,23 @@ Otherwise deletes a character normally by calling delete-char.
    -
    -

    yas-prev-field ()

    -
    +
    +

    yas-visit-snippet-file ()

    +
    -

    Navigate to prev field. If there's none, exit the snippet. -

    -
    - -
    - -
    -

    yas-next-field (&optional arg)

    -
    - -

    Navigate to the argth 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-describe-tables (&optional choose)

    -
    - -

    Display snippets for each table. -

    -
    - -
    - -
    -

    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.

    @@ -371,169 +295,9 @@ When called interactively, prompt for the table name.
    -
    -

    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-about ()

    -
    - -

    /warning/: no doc for symbol yas-about -

    -
    - -
    - -
    -

    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 argth 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-exit-all-snippets ()

    +
    + +

    Exit all snippets. +

    +
    + +
    + +
    +

    yas-tryout-snippet (&optional debug)

    +
    + +

    Test current buffer's snippet template in other buffer. +

    +
    + +
    + +
    +

    yas-exit-snippet (snippet)

    +
    + +

    Goto exit-marker of snippet. +

    +
    + +
    + +
    +

    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.

    @@ -573,12 +482,148 @@ Key bindings:
    -
    -

    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-describe-tables (&optional choose)

    +
    + +

    Display snippets for each table. +

    +
    + +
    + +
    +

    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-about ()

    +
    + +

    /warning/: no doc for symbol yas-about +

    +
    + +
    + +
    +

    yas-prev-field ()

    +
    + +

    Navigate to prev field. If there's none, exit the snippet. +

    +
    + +
    + +
    +

    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.

    -
    -

    Customization variables

    -
    +
    +

    Customization variables

    +
    -
    -

    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-visit-from-menu

    -
    - - -

    -If non-nil visit snippets's files from menu, instead of expanding them. -

    -

    -This can only work when snippets are loaded from files. -

    -
    - -
    - -
    -

    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-trigger-symbol

    -
    - - -

    -The text that will be used in menu to represent the trigger. -

    -
    - -
    - -
    -

    yas-use-menu

    -
    - - -

    -Display a YASnippetnippet menu in the menu bar. -

    -

    -When non-nil, submenus for each snippet table will be listed -under the menu "Yasnippet". -

    -
      -
    • If set to abbreviate, only the current major-mode -
      • -
    - -

    menu and the modes set in yas--extra-modes are listed. -

    -
      -
    • If set to full, every submenu is listed - -
      • -
    • It set to nil, don't display a menu at all (this requires a - yas-reload-all call if the menu is already visible). -
      • -
    - - -

    -Any other non-nil value, every submenu is listed. -

    -
    - -
    - -
    -

    yas-choose-tables-first

    -
    +
    +

    yas-choose-tables-first

    +

    @@ -731,9 +659,49 @@ This affects yas-insert-snippet,

    -
    -

    yas-choose-keys-first

    -
    +
    +

    yas-snippet-revival

    +
    + + +

    +Non-nil means re-activate snippet fields after undo/redo. +

    +
    + +
    + +
    +

    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-snippet-revival

      -
      - - -

      -Non-nil means re-activate snippet fields after undo/redo. -

      -
      - -
      - -
      -

      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. -

      -
      - -
      - -
      -

      Useful functions

      -
      +
      +

      yas-visit-from-menu

      +
      -
      - -
      -

      yas-active-keys ()

      -
      - -

      Return all active trigger keys for current buffer and point. +

      +If non-nil visit snippets's files from menu, instead of expanding them. +

      +

      +This can only work when snippets are loaded from files.

      -
      -

      yas-hippie-try-expand (first-time?)

      -
      +
      +

      yas-triggers-in-field

      +
      + + +

      +If non-nil, allow stacked expansions (snippets inside snippets). +

      +

      +Otherwise yas-next-field-or-maybe-expand just moves on to the +next field +

      +
      + +
      + +
      +

      yas-trigger-symbol

      +
      + + +

      +The text that will be used in menu to represent the trigger. +

      +
      + +
      + +
      +

      yas-use-menu

      +
      + + +

      +Display a YASnippet menu in the menu bar. +

      +

      +When non-nil, submenus for each snippet table will be listed +under the menu "Yasnippet". +

      +
        +
      • If set to abbreviate, only the current major-mode +
        • +
      + +

      menu and the modes set in yas--extra-modes are listed. +

      +
        +
      • If set to full, every submenu is listed + +
        • +
      • It set to nil, don't display a menu at all (this requires a + yas-reload-all call if the menu is already visible). +
        • +
      + + +

      +Any other non-nil value, every submenu is listed. +

      +
      + +
      + +
      +

      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-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-snippet-dirs ()

      +
      + +

      Return yas-snippet-dirs (which see) as a list. +

      +
      + +
      + +
      +

      yas-good-grace

      +
      + + +

      +If non-nil, don't raise errors in inline elisp evaluation. +

      +

      +An error string "[yas] error" is returned instead. +

      +
      + +
      + +
      +

      Useful functions

      +
      + + +
      + +
      +

      yas-default-from-field (number)

      +
      + +

      /warning/: no doc for symbol yas-default-from-field +

      +
      + +
      + +
      +

      yas-completing-prompt (prompt choices &optional display-fn completion-fn)

      +
      + +

      /warning/: no doc for symbol yas-completing-prompt +

      +
      + +
      + +
      +

      yas-selected-text ()

      +
      + +

      Return yas-selected-text if that exists and is non-empty, else nil. +

      +
      + +
      + +
      +

      yas-hippie-try-expand (first-time?)

      +

      Integrate with hippie expand.

      @@ -941,100 +1019,19 @@ Just put this function in hippie-expand-try-functions-list.
      -
      -

      yas-define-condition-cache (func doc &rest body)

      -
      +
      +

      yas-global-mode-cmhh ()

      +
      -

      Define a function func with doc doc and body body. -body is executed at most once every snippet expansion attempt, to check -expansion conditions. -

      -

      -It doesn't make any sense to call func programatically. +

      /warning/: no doc for symbol yas-global-mode-cmhh

      -
      -

      yas-unimplemented (&optional missing-feature)

      -
      - -

      /warning/: no doc for symbol yas-unimplemented -

      -
      - -
      - -
      -

      yas-inside-string ()

      -
      - -

      Return non-nil if the point is inside a string according to font-lock. -

      -
      - -
      - -
      -

      yas-default-from-field (number)

      -
      - -

      /warning/: no doc for symbol yas-default-from-field -

      -
      - -
      - -
      -

      yas-selected-text ()

      -
      - -

      Return yas-selected-text if that exists and is non-empty, else nil. -

      -
      - -
      - -
      -

      yas-text ()

      -
      - -

      Return yas-text if that exists and is non-empty, else nil. -

      -
      - -
      - -
      -

      yas-field-value (number)

      -
      - -

      Get the string for field with number. -

      -

      -Use this in primary and mirror transformations to tget. -

      -
      - -
      - -
      -

      yas-verify-value (possibilities)

      -
      - -

      Verify that the current field value is in possibilities. -

      -

      -Otherwise throw exception. -

      -
      - -
      - -
      -

      yas-throw (text)

      -
      +
      +

      yas-throw (text)

      +

      Throw a yas–exception with text as the reason.

      @@ -1042,46 +1039,29 @@ Otherwise throw exception.
      -
      -

      yas-key-to-value (alist)

      -
      +
      +

      yas-inside-string ()

      +
      -

      /warning/: no doc for symbol yas-key-to-value +

      Return non-nil if the point is inside a string according to font-lock.

      -
      -

      yas-choose-value (&rest possibilities)

      -
      +
      +

      yas-x-prompt (prompt choices &optional display-fn)

      +
      -

      Prompt for a string in possibilities and return it. -

      -

      -The last element of possibilities may be a list of strings. +

      Display choices in a x-window prompt.

      -
      -

      yas-substr (str pattern &optional subexp)

      -
      - -

      Search pattern in str and return subexpth match. -

      -

      -If found, the content of subexp group subexp (default 0) is - returned, or else the original str will be returned. -

      -
      - -
      - -
      -

      yas-text ()

      -
      +
      +

      yas-text ()

      +

      Return yas-text if that exists and is non-empty, else nil.

      @@ -1089,45 +1069,29 @@ If found, the content of subexp group subexp (default 0) is
      -
      -

      yas-define-menu (mode menu &optional omit-items)

      -
      +
      +

      yas-ido-prompt (prompt choices &optional display-fn)

      +
      -

      Define a snippet menu for mode according to menu, omitting omit-items. -

      -

      -menu is a list, its elements can be: -

      -
        -
      • (yas-item uuid) : Creates an entry the snippet identified with - uuid. The menu entry for a snippet thus identified is - permanent, i.e. it will never move (be reordered) in the menu. - -
        • -
      • (yas-separator) : Creates a separator - -
        • -
      • (yas-submenu name submenu) : Creates a submenu with name, - submenu has the same form as menu. name is also added to the - list of groups of the snippets defined thereafter. -
        • -
      - - -

      -omit-items is a list of snippet uuid's that will always be -omitted from mode's menu, even if they're manually loaded. -

      -

      -This function does nothing if yas-use-menu is nil. +

      /warning/: no doc for symbol yas-ido-prompt

      -
      -

      yas-define-snippets (mode snippets)

      -
      +
      +

      yas-dropdown-prompt (_prompt choices &optional display-fn)

      +
      + +

      /warning/: no doc for symbol yas-dropdown-prompt +

      +
      + +
      + +
      +

      yas-define-snippets (mode snippets)

      +

      Define snippets for mode.

      @@ -1169,44 +1133,19 @@ the current buffers contents.
      -
      -

      yas-expand-snippet (content &optional start end expand-env)

      -
      +
      +

      yas-global-mode-enable-in-buffers ()

      +
      -

      Expand snippet content at current point. -

      -

      -Text between start and end will be deleted before inserting -template. expand-env is are let-style variable to value bindings -considered when expanding the snippet. +

      /warning/: no doc for symbol yas-global-mode-enable-in-buffers

      -
      -

      yas-dropdown-prompt (_prompt choices &optional display-fn)

      -
      - -

      /warning/: no doc for symbol yas-dropdown-prompt -

      -
      - -
      - -
      -

      yas-completing-prompt (prompt choices &optional display-fn completion-fn)

      -
      - -

      /warning/: no doc for symbol yas-completing-prompt -

      -
      - -
      - -
      -

      yas-no-prompt (_prompt choices &optional _display-fn)

      -
      +
      +

      yas-no-prompt (_prompt choices &optional _display-fn)

      +

      /warning/: no doc for symbol yas-no-prompt

      @@ -1214,72 +1153,187 @@ considered when expanding the snippet.
      -
      -

      yas-ido-prompt (prompt choices &optional display-fn)

      -
      +
      +

      yas-active-keys ()

      +
      -

      /warning/: no doc for symbol yas-ido-prompt +

      Return all active trigger keys for current buffer and point.

      -
      -

      yas-x-prompt (prompt choices &optional display-fn)

      -
      +
      +

      yas-define-condition-cache (func doc &rest body)

      +
      -

      Display choices in a x-window prompt. +

      Define a function func with doc doc and body body. +body is executed at most once every snippet expansion attempt, to check +expansion conditions. +

      +

      +It doesn't make any sense to call func programatically. +

      +
      + +
      + +
      +

      yas-global-mode-check-buffers ()

      +
      + +

      /warning/: no doc for symbol yas-global-mode-check-buffers +

      +
      + +
      + +
      +

      yas-define-menu (mode menu &optional omit-items)

      +
      + +

      Define a snippet menu for mode according to menu, omitting omit-items. +

      +

      +menu is a list, its elements can be: +

      +
        +
      • (yas-item uuid) : Creates an entry the snippet identified with + uuid. The menu entry for a snippet thus identified is + permanent, i.e. it will never move (be reordered) in the menu. + +
        • +
      • (yas-separator) : Creates a separator + +
        • +
      • (yas-submenu name submenu) : Creates a submenu with name, + submenu has the same form as menu. name is also added to the + list of groups of the snippets defined thereafter. +
        • +
      + + +

      +omit-items is a list of snippet uuid's that will always be +omitted from mode's menu, even if they're manually loaded. +

      +

      +This function does nothing if yas-use-menu is nil. +

      +
      + +
      + +
      +

      yas-field-value (number)

      +
      + +

      Get the string for field with number. +

      +

      +Use this in primary and mirror transformations to tget. +

      +
      + +
      + +
      +

      yas-verify-value (possibilities)

      +
      + +

      Verify that the current field value is in possibilities. +

      +

      +Otherwise throw exception. +

      +
      + +
      + +
      +

      yas-key-to-value (alist)

      +
      + +

      /warning/: no doc for symbol yas-key-to-value +

      +
      + +
      + +
      +

      yas-choose-value (&rest possibilities)

      +
      + +

      Prompt for a string in possibilities and return it. +

      +

      +The last element of possibilities may be a list of strings. +

      +
      + +
      + +
      +

      yas-substr (str pattern &optional subexp)

      +
      + +

      Search pattern in str and return subexpth match. +

      +

      +If found, the content of subexp group subexp (default 0) is + returned, or else the original str will be returned. +

      +
      + +
      + +
      +

      yas-unimplemented (&optional missing-feature)

      +
      + +

      /warning/: no doc for symbol yas-unimplemented +

      +
      + +
      + +
      +

      yas-expand-snippet (content &optional start end expand-env)

      +
      + +

      Expand snippet content at current point. +

      +

      +Text between start and end will be deleted before inserting +template. expand-env is are let-style variable to value bindings +considered when expanding the snippet.

      -
      -

      Useful variables

      -
      +
      +

      Useful variables

      +
      -
      -

      yas-moving-away-p

      -
      +
      +

      yas-global-mode-buffers

      +

      -Non-nil if user is about to exit field. +/warning/: no doc for symbol yas-global-mode-buffers

      -
      -

      yas-modified-p

      -
      - - -

      -Non-nil if field has been modified by user or transformation. -

      -
      - -
      - -
      -

      yas-snippet-end

      -
      - - -

      -End position of the last snippet committed. -

      -
      - -
      - -
      -

      yas-snippet-beg

      -
      +
      +

      yas-snippet-beg

      +

      @@ -1289,9 +1343,46 @@ Beginning position of the last snippet committed.

      -
      -

      yas-dont-activate

      -
      +
      +

      yas-after-exit-snippet-hook

      +
      + + +

      +Hooks to run after a snippet exited. +

      +

      +The hooks will be run in an environment where some variables bound to +proper values: +

      +

      +yas-snippet-beg : The beginning of the region of the snippet. +

      +

      +yas-snippet-end : Similar to beg. +

      +

      +Attention: These hooks are not run when exiting nested/stacked snippet expansion! +

      +
      + +
      + +
      +

      yas-global-mode-hook

      +
      + + +

      +/warning/: no doc for symbol yas-global-mode-hook +

      +
      + +
      + +
      +

      yas-dont-activate

      +

      @@ -1321,9 +1412,33 @@ mode's hook.

      -
      -

      yas-buffer-local-condition

      -
      +
      +

      yas-minor-mode-map

      +
      + + +

      +The keymap used when yas-minor-mode is active. +

      +
      + +
      + +
      +

      yas-moving-away-p

      +
      + + +

      +Non-nil if user is about to exit field. +

      +
      + +
      + +
      +

      yas-buffer-local-condition

      +

      @@ -1412,9 +1527,21 @@ snippet itself contains a condition that returns the symbol

      -
      -

      yas-before-expand-snippet-hook

      -
      +
      +

      yas-modified-p

      +
      + + +

      +Non-nil if field has been modified by user or transformation. +

      +
      + +
      + +
      +

      yas-before-expand-snippet-hook

      +

      @@ -1424,34 +1551,21 @@ Hooks to run just before expanding a snippet.

      -
      -

      yas-after-exit-snippet-hook

      -
      +
      +

      yas-keymap

      +

      -Hooks to run after a snippet exited. -

      -

      -The hooks will be run in an environment where some variables bound to -proper values: -

      -

      -yas-snippet-beg : The beginning of the region of the snippet. -

      -

      -yas-snippet-end : Similar to beg. -

      -

      -Attention: These hooks are not run when exiting nested/stacked snippet expansion! +The active keymap while a snippet expansion is in progress.

      -
      -

      yas-key-syntaxes

      -
      +
      +

      yas-key-syntaxes

      +

      @@ -1475,21 +1589,33 @@ isn't a trigger key, "foo-bar" is tried, respecting a second

      -
      -

      yas-extra-modes

      -
      +
      +

      yas-snippet-end

      +

      -/warning/: no doc for symbol yas-extra-modes +End position of the last snippet committed.

      -
      -

      yas-verbosity

      -
      +
      +

      yas-minor-mode-hook

      +
      + + +

      +Hook run when yas-minor-mode is turned on. +

      +
      + +
      + +
      +

      yas-verbosity

      +

      @@ -1499,23 +1625,21 @@ Log level for yas--message 4 means trace most anything, 0 means not

      -
      -

      yas-keymap

      -
      +
      +

      yas-minor-mode-major-mode

      +

      -The active keymap while a snippet expansion is in progress. +/warning/: no doc for symbol yas-minor-mode-major-mode

      - -
      -

      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

      Validate XHTML 1.0