From b925a0388f2626c4a8fff327c3180e423998e4c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Wed, 1 Oct 2014 21:19:17 +0100 Subject: [PATCH] Automatic documentation update. From 08b044e559cc350c6e7142d088ec2d4a82e378cb --- faq.html | 4 +- index.html | 4 +- snippet-development.html | 4 +- snippet-expansion.html | 4 +- snippet-menu.html | 4 +- snippet-organization.html | 4 +- snippet-reference.html | 155 +++++++++++++++++++++++++++++--------- 7 files changed, 133 insertions(+), 46 deletions(-) diff --git a/faq.html b/faq.html index 866da45..5f19491 100644 --- a/faq.html +++ b/faq.html @@ -7,7 +7,7 @@ - + @@ -391,7 +391,7 @@ directive:
-

Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

Validate XHTML 1.0

diff --git a/index.html b/index.html index 223723b..e49d901 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@ - + @@ -194,7 +194,7 @@ for the JavaScript code in this tag.
-

Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

Validate XHTML 1.0

diff --git a/snippet-development.html b/snippet-development.html index 2a7e031..449ecb4 100644 --- a/snippet-development.html +++ b/snippet-development.html @@ -7,7 +7,7 @@ - + @@ -877,7 +877,7 @@ performs the normal Emacs delete-char command.
-

Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

Validate XHTML 1.0

diff --git a/snippet-expansion.html b/snippet-expansion.html index 9594879..668f72b 100644 --- a/snippet-expansion.html +++ b/snippet-expansion.html @@ -7,7 +7,7 @@ - + @@ -633,7 +633,7 @@ See the documentation on variable -

Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

Validate XHTML 1.0

diff --git a/snippet-menu.html b/snippet-menu.html index 6c971c3..cedbff3 100644 --- a/snippet-menu.html +++ b/snippet-menu.html @@ -7,7 +7,7 @@ - + @@ -269,7 +269,7 @@ variables.
-

Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

Validate XHTML 1.0

diff --git a/snippet-organization.html b/snippet-organization.html index 4e5ea34..87f67b5 100644 --- a/snippet-organization.html +++ b/snippet-organization.html @@ -7,7 +7,7 @@ - + @@ -379,7 +379,7 @@ ruby-mode/
-

Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

Validate XHTML 1.0

diff --git a/snippet-reference.html b/snippet-reference.html index 2d248a9..c7751f1 100644 --- a/snippet-reference.html +++ b/snippet-reference.html @@ -7,7 +7,7 @@ - + @@ -163,7 +163,7 @@ for the JavaScript code in this tag.
  • yas-expand-from-keymap ()
  • yas-minor-mode (&optional arg)
  • yas-minor-mode-on ()
    • -
  • yas-reload-all (&optional interactive)
    • +
  • yas-reload-all (&optional no-jit interactive)
  • yas-load-directory (top-level-dir &optional use-jit interactive)
  • yas-new-snippet (&optional no-template)
  • yas-load-snippet-buffer-and-close (table &optional kill)
    • @@ -205,8 +205,11 @@ for the JavaScript code in this tag.
  • yas-throw (text)
  • yas-inside-string ()
  • yas-x-prompt (prompt choices &optional display-fn)
    • +
  • yas-shortest-key-until-whitespace (_start-point)
    • +
  • yas-longest-key-from-whitespace (start-point)
  • yas-text ()
  • yas-ido-prompt (prompt choices &optional display-fn)
    • +
  • yas-try-key-from-whitespace (_start-point)
  • yas-dropdown-prompt (_prompt choices &optional display-fn)
  • yas-define-snippets (mode snippets)
  • yas-global-mode-enable-in-buffers ()
    • @@ -243,6 +246,7 @@ for the JavaScript code in this tag.
  • yas-minor-mode-hook
  • yas-verbosity
  • yas-minor-mode-major-mode
    • +
  • yas-installed-snippets-dir
    • @@ -497,16 +501,20 @@ Honour yas-dont-activate, which se
    -

    yas-reload-all (&optional interactive)

    +

    yas-reload-all (&optional no-jit interactive)

    Reload all snippets and rebuild the YASnippet menu.

    -When called interactively force immediate reload of all known +When no-jit is non-nil force immediate reload of all known snippets under yas-snippet-dirs, otherwise use just-in-time loading.

    +

    +When called interactively, use just-in-time loading when given a +prefix argument. +

    @@ -521,7 +529,7 @@ loading. Below top-level-dir each directory should be a mode name.

    -Optional use-jit use jit-loading of snippets. +With prefix argument use-jit do jit-loading of snippets.

    @@ -948,7 +956,7 @@ the trigger key itself.

    yas-snippet-dirs ()

    -

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

    Return variable yas-snippet-dirs as list of strings.

    @@ -1059,8 +1067,32 @@ Just put this function in hippie-expand-try-functions-list. +
    +

    yas-shortest-key-until-whitespace (_start-point)

    +
    + +

    Like yas-longest-key-from-whitespace but take the shortest key. +

    +
    + +
    + +
    +

    yas-longest-key-from-whitespace (start-point)

    +
    + +

    As yas-key-syntaxes element, look for longest key between point and whitespace. +

    +

    +A newline will be considered whitespace even if the mode syntax +marks it as something else (typically comment ender). +

    +
    + +
    +
    -

    yas-text ()

    +

    yas-text ()

    Return yas-text if that exists and is non-empty, else nil. @@ -1070,7 +1102,7 @@ Just put this function in hippie-expand-try-functions-list.

    -

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

    +

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

    /warning/: no doc for symbol yas-ido-prompt @@ -1079,8 +1111,22 @@ Just put this function in hippie-expand-try-functions-list.

    +
    +

    yas-try-key-from-whitespace (_start-point)

    +
    + +

    As yas-key-syntaxes element, look for whitespace delimited key. +

    +

    +A newline will be considered whitespace even if the mode syntax +marks it as something else (typically comment ender). +

    +
    + +
    +
    -

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

    +

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

    /warning/: no doc for symbol yas-dropdown-prompt @@ -1090,7 +1136,7 @@ Just put this function in hippie-expand-try-functions-list.

    -

    yas-define-snippets (mode snippets)

    +

    yas-define-snippets (mode snippets)

    Define snippets for mode. @@ -1134,7 +1180,7 @@ the current buffers contents.

    -

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

    +

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

    /warning/: no doc for symbol yas-global-mode-enable-in-buffers @@ -1144,7 +1190,7 @@ the current buffers contents.

    -

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

    +

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

    /warning/: no doc for symbol yas-no-prompt @@ -1154,7 +1200,7 @@ the current buffers contents.

    -

    yas-active-keys ()

    +

    yas-active-keys ()

    Return all active trigger keys for current buffer and point. @@ -1164,7 +1210,7 @@ the current buffers contents.

    -

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

    +

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

    Define a function func with doc doc and body body. @@ -1179,7 +1225,7 @@ It doesn't make any sense to call func programatically.

    -

    yas-global-mode-check-buffers ()

    +

    yas-global-mode-check-buffers ()

    /warning/: no doc for symbol yas-global-mode-check-buffers @@ -1189,7 +1235,7 @@ It doesn't make any sense to call func programatically.

    -

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

    +

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

    Define a snippet menu for mode according to menu, omitting omit-items. @@ -1222,7 +1268,7 @@ omitted from mode's menu, even if they're manually loaded.

    -

    yas-field-value (number)

    +

    yas-field-value (number)

    Get the string for field with number. @@ -1235,7 +1281,7 @@ Use this in primary and mirror transformations to tget.

    -

    yas-verify-value (possibilities)

    +

    yas-verify-value (possibilities)

    Verify that the current field value is in possibilities. @@ -1248,7 +1294,7 @@ Otherwise throw exception.

    -

    yas-key-to-value (alist)

    +

    yas-key-to-value (alist)

    /warning/: no doc for symbol yas-key-to-value @@ -1258,7 +1304,7 @@ Otherwise throw exception.

    -

    yas-choose-value (&rest possibilities)

    +

    yas-choose-value (&rest possibilities)

    Prompt for a string in possibilities and return it. @@ -1271,7 +1317,7 @@ The last element of possibilities may be a list of strings.

    -

    yas-substr (str pattern &optional subexp)

    +

    yas-substr (str pattern &optional subexp)

    Search pattern in str and return subexpth match. @@ -1285,7 +1331,7 @@ If found, the content of subexp group subexp (default 0) is

    -

    yas-unimplemented (&optional missing-feature)

    +

    yas-unimplemented (&optional missing-feature)

    /warning/: no doc for symbol yas-unimplemented @@ -1295,7 +1341,7 @@ If found, the content of subexp group subexp (default 0) is

    -

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

    +

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

    Expand snippet content at current point. @@ -1578,21 +1624,50 @@ The active keymap while a snippet expansion is in progress.

    -List of character syntaxes used to find a trigger key before point. -The list is tried in the order while scanning characters -backwards from point. For example, if the list is '("w" "w_") -first look for trigger keys which are composed exclusively of -"word"-syntax characters, and then, if that fails, look for -keys which are either of "word" or "symbol" -syntax. Triggering after +Syntaxes and functions to help look for trigger keys before point. +

    +

    +Each element in this list specifies how to skip buffer positions +backwards and look for the start of a trigger key. +

    +

    +Each element can be either a string or a function receiving the +original point as an argument. A string element is simply passed +to skip-syntax-backward whereas a function element is called +with no arguments and should also place point before the original +position. +

    +

    +The string between the resulting buffer position and the original +point is matched against the trigger keys in the active snippet +tables. +

    +

    +If no expandable snippets are found, the next element is the list +is tried, unless a function element returned the symbol again, +in which case it is called again from the previous position and +may once more reposition point. +

    +

    +For example, if yas-key-syntaxes' value is '("w" "w_"), +trigger keys composed exclusively of "word"-syntax characters +are looked for first. Failing that, longer keys composed of +"word" or "symbol" syntax are looked for. Therefore, +triggering after

    foo-bar

    -will, according to the "w" element first try "bar". If that -isn't a trigger key, "foo-bar" is tried, respecting a second -"w_" element. +will, according to the "w" element first try "barbaz". If +that isn't a trigger key, "foo-barbaz" is tried, respecting the +second "w_" element. Notice that even if "baz" is a trigger +key for an active snippet, it won't be expanded, unless a +function is added to yas-key-syntaxes that eventually places +point between "bar" and "baz". +

    +

    +See also Info node `(elisp) Syntax Descriptors'.

    @@ -1643,12 +1718,24 @@ Log level for yas--message 4 means trace most anything, 0 means not /warning/: no doc for symbol yas-minor-mode-major-mode

    + +
    + +
    +

    yas-installed-snippets-dir

    +
    + + +

    +/warning/: no doc for symbol yas-installed-snippets-dir +

    +
    -

    Generated by Org version 7.9.3f with Emacs version 24 on 2014-06-17T19:49-0400 from e53ec1e0c3611c3a0f4ac6228aab041a82b9d3bb +

    Generated by Org version 7.9.3f with Emacs version 24 on 2014-10-01T21:16+0100 from 08b044e559cc350c6e7142d088ec2d4a82e378cb

    Validate XHTML 1.0