diff --git a/faq.html b/faq.html index 9e93d0f..6b9a552 100644 --- a/faq.html +++ b/faq.html @@ -7,7 +7,7 @@ - + @@ -349,7 +349,7 @@ directive:
-

Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

Validate XHTML 1.0

diff --git a/index.html b/index.html index b37b3ac..57e867a 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@ - + @@ -336,7 +336,7 @@ $ rake convert_bundles # will convert ruby, rails and html bundles f
-

Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

Validate XHTML 1.0

diff --git a/snippet-development.html b/snippet-development.html index ee4961c..99d44c9 100644 --- a/snippet-development.html +++ b/snippet-development.html @@ -7,7 +7,7 @@ - + @@ -906,7 +906,7 @@ adjustments to the google group or, better yet, patch the
-

Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

Validate XHTML 1.0

diff --git a/snippet-expansion.html b/snippet-expansion.html index ae1507a..03b3e21 100644 --- a/snippet-expansion.html +++ b/snippet-expansion.html @@ -7,7 +7,7 @@ - + @@ -617,7 +617,7 @@ See the documentation on variable -

Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

Validate XHTML 1.0

diff --git a/snippet-menu.html b/snippet-menu.html index 9f45de9..b59fdc3 100644 --- a/snippet-menu.html +++ b/snippet-menu.html @@ -7,7 +7,7 @@ - + @@ -257,7 +257,7 @@ variables.
-

Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

Validate XHTML 1.0

diff --git a/snippet-organization.html b/snippet-organization.html index a045b95..e688eb0 100644 --- a/snippet-organization.html +++ b/snippet-organization.html @@ -7,7 +7,7 @@ - + @@ -367,7 +367,7 @@ ruby-mode/
-

Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

Validate XHTML 1.0

diff --git a/snippet-reference.html b/snippet-reference.html index 3ae711a..ae4be1c 100644 --- a/snippet-reference.html +++ b/snippet-reference.html @@ -7,7 +7,7 @@ - + @@ -132,31 +132,31 @@ for the JavaScript code in this tag.
-

yas-skip-and-clear-or-delete-char (&optional field)

+

yas-skip-and-clear-or-delete-char (&optional field)

Clears unmodified field if at field start, skips to next tab. @@ -269,20 +269,20 @@ Otherwise deletes a character normally by calling delete-char.

-

yas-exit-snippet (snippet)

+

yas-exit-snippet (snippet)

-

Goto exit-marker of SNIPPET. +

Goto exit-marker of snippet.

-

yas-abort-snippet (&optional snippet)

+

yas-abort-snippet (&optional snippet)

-

/WARNING/: no doc for symbol yas-abort-snippet +

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

@@ -299,10 +299,10 @@ Otherwise deletes a character normally by calling delete-char.
-

yas-next-field (&optional arg)

+

yas-next-field (&optional arg)

-

Navigate to the /ARG/th next field. +

Navigate to the ARGth next field.

If there's none, exit the snippet. @@ -325,7 +325,7 @@ Otherwise delegate to yas-next-field.

-

yas-describe-tables (&optional choose)

+

yas-describe-tables (&optional choose)

Display snippets for each table. @@ -335,7 +335,7 @@ Otherwise delegate to yas-next-field.

-

yas-tryout-snippet (&optional debug)

+

yas-tryout-snippet (&optional debug)

Test current buffer's snippet template in other buffer. @@ -345,13 +345,13 @@ Otherwise delegate to yas-next-field.

-

yas-load-snippet-buffer (table &optional interactive)

+

yas-load-snippet-buffer (table &optional interactive)

-

Parse and load current buffer's snippet definition into TABLE. +

Parse and load current buffer's snippet definition into table.

-TABLE is a symbol naming a passed to yas–table-get-create. +table is a symbol naming a passed to yas--table-get-create.

When called interactively, prompt for the table name. @@ -361,14 +361,14 @@ When called interactively, prompt for the table name.

-

yas-new-snippet (&optional no-template)

+

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. +no-template is non-nil.

@@ -389,14 +389,14 @@ visited file in snippet-mode.
-

yas-insert-snippet (&optional no-condition)

+

yas-insert-snippet (&optional no-condition)

Choose a snippet to expand, pop-up a list of choices according -to yas--prompt-function. +to yas-prompt-functions.

-With prefix argument NO-CONDITION, bypass filtering of snippets +With prefix argument no-condition, bypass filtering of snippets by condition.

@@ -415,7 +415,7 @@ by condition.
-

yas-expand-from-trigger-key (&optional field)

+

yas-expand-from-trigger-key (&optional field)

Expand a snippet before point. @@ -425,8 +425,8 @@ 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. +Optional argument field is for non-interactive use and is an +object satisfying yas--field-p to restrict the expansion to.

@@ -436,7 +436,7 @@ object satisfying yas–field-p to

yas-about ()

-

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

/warning/: no doc for symbol yas-about

@@ -453,10 +453,10 @@ object satisfying yas–field-p to
-

yas-compile-directory (top-level-dir)

+

yas-compile-directory (top-level-dir)

-

Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR. +

Create .yas-compiled-snippets.el files under subdirs of top-level-dir.

This works by stubbing a few functions, then calling @@ -467,10 +467,10 @@ This works by stubbing a few functions, then calling

-

yas-reload-all (&optional interactive)

+

yas-reload-all (&optional interactive)

-

Reload all snippets and rebuild the /YAS/nippet menu. +

Reload all snippets and rebuild the YASnippet menu.

When called interactively force immediate reload of all known @@ -482,16 +482,16 @@ loading.

-

yas-load-directory (top-level-dir &optional use-jit interactive)

+

yas-load-directory (top-level-dir &optional use-jit interactive)

-

Load snippets in directory hierarchy TOP-LEVEL-DIR. +

Load snippets in directory hierarchy top-level-dir.

-Below TOP-LEVEL-DIR each directory should be a mode name. +Below top-level-dir each directory should be a mode name.

-Optional USE-JIT use jit-loading of snippets. +Optional use-jit use jit-loading of snippets.

@@ -501,7 +501,7 @@ Optional USE-JIT use jit-loading of snippets.

yas-minor-mode-on ()

-

Turn on /YAS/nippet minor mode. +

Turn on YASnippet minor mode.

Honour yas-dont-activate, which see. @@ -521,13 +521,13 @@ Honour yas-dont-activate, which se

-

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; +With prefix arg, enable Yas-Global mode if arg is positive; otherwise, disable it. If called from Lisp, enable the mode if -ARG is omitted or nil. +arg is omitted or nil.

Yas minor mode is enabled in all buffers where @@ -539,13 +539,14 @@ See yas-minor-mode for more informati

-

yas-minor-mode (&optional arg)

+

yas-minor-mode (&optional arg)

-

Toggle /YAS/nippet mode. +

Toggle YASnippet mode.

-When /YAS/nippet mode is enabled, yas-expand, normally bound to the TAB key, expands snippets of code depending on the major +When YASnippet mode is enabled, yas-expand, normally bound to +the tab key, expands snippets of code depending on the major mode.

@@ -562,15 +563,15 @@ Key bindings:

-

yas-expand (&optional field)

+

yas-expand (&optional field)

Expand a snippet before point. If no snippet -expansion is possible, defer to yas-fallback-behaviour (which see). +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. +Optional argument field is for non-interactive use and is an +object satisfying yas--field-p to restrict the expansion to.

@@ -670,7 +671,7 @@ The text that will be used in menu to represent the trigger.

-Display a /YAS/nippet menu in the menu bar. +Display a YASnippet menu in the menu bar.

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

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

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

  • If set to full, every submenu is listed @@ -746,7 +747,7 @@ This affects yas-insert-snippet a How to act when yas-expand does not expand a snippet.

      -
    • call-other-command means try to temporarily disable /YAS/nippet +
    • call-other-command means try to temporarily disable YASnippet and call the next command bound to whatever key was used to invoke yas-expand. @@ -755,9 +756,9 @@ How to act when yas-expand does notyas-expand returns nil)
    • -
    • A Lisp form (apply COMMAND . ARGS) means interactively call - COMMAND, if ARGS is non-nil, call COMMAND non-interactively - with ARGS as arguments. +
    • A Lisp form (apply command . args) means interactively call + command, if args is non-nil, call command non-interactively + with args as arguments.
    @@ -850,21 +851,21 @@ Functions to prompt for keys, templates, etc interactively. These functions are called with the following arguments:

      -
    • PROMPT: A string to prompt the user +
    • prompt: A string to prompt the user
    • -
    • CHOICES: a list of strings or objects. +
    • choices: a list of strings or objects.
    • -
    • optional DISPLAY-FN : A function that, when applied to each of +
    • optional display-fn : A function that, when applied to each of
    -

    the objects in CHOICES will return a string. +

    the objects in choices will return a string.

    The return value of any function you put here should be one of -the objects in CHOICES, properly formatted with DISPLAY-FN (if +the objects in choices, properly formatted with display-fn (if that is passed).

      @@ -917,7 +918,7 @@ nil.
-

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

+

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

Integrate with hippie expand. @@ -930,25 +931,25 @@ Just put this function in hippie-expand-try-functions-list.

-

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. -BODY is executed at most once every snippet expansion attempt, to check +

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. +It doesn't make any sense to call func programatically.

-

yas-unimplemented (&optional missing-feature)

+

yas-unimplemented (&optional missing-feature)

-

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

/warning/: no doc for symbol yas-unimplemented

@@ -965,10 +966,10 @@ It doesn't make any sense to call FUNC programatically.
-

yas-default-from-field (number)

+

yas-default-from-field (number)

-

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

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

@@ -995,10 +996,10 @@ It doesn't make any sense to call FUNC programatically.
-

yas-field-value (number)

+

yas-field-value (number)

-

Get the string for field with NUMBER. +

Get the string for field with number.

Use this in primary and mirror transformations to tget. @@ -1008,10 +1009,10 @@ 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. +

Verify that the current field value is in possibilities.

Otherwise throw exception. @@ -1021,47 +1022,47 @@ Otherwise throw exception.

-

yas-throw (text)

+

yas-throw (text)

-

Throw a yas–exception with TEXT as the reason. +

Throw a yas–exception with text as the reason.

-

yas-key-to-value (alist)

+

yas-key-to-value (alist)

-

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

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

-

yas-choose-value (&rest possibilities)

+

yas-choose-value (&rest possibilities)

-

Prompt for a string in POSSIBILITIES and return it. +

Prompt for a string in possibilities and return it.

-The last element of POSSIBILITIES may be a list of strings. +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 /SUBEXP/th match. +

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. +If found, the content of subexp group subexp (default 0) is + returned, or else the original str will be returned.

@@ -1078,33 +1079,33 @@ If found, the content of subexp group SUBEXP (default 0) is
-

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

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

-MENU is a list, its elements can be: +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 +
  • (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 +
  • (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. +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. @@ -1114,43 +1115,43 @@ This function does nothing if yas-use-menu<

-

yas-define-snippets (mode snippets)

+

yas-define-snippets (mode snippets)

-

Define SNIPPETS for MODE. +

Define snippets for mode.

-SNIPPETS is a list of snippet definitions, each taking the +snippets is a list of snippet definitions, each taking the following form

- (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID) + (key template name condition group expand-env file keybinding uuid)

-Within these, only KEY and TEMPLATE are actually mandatory. +Within these, only key and template are actually mandatory.

-TEMPLATE might be a Lisp form or a string, depending on whether +template might be a Lisp form or a string, depending on whether this is a snippet or a snippet-command.

-CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have -been yas–read-lisp-ed and will eventually be -yas–eval-lisp-ed. +condition, expand-env and keybinding are Lisp forms, they have +been yas--read-lisp-ed and will eventually be +yas--eval-lisp-ed.

The remaining elements are strings.

-FILE is probably of very little use if you're programatically +file is probably of very little use if you're programatically defining snippets.

-UUID is the snippets "unique-id". Loading a second snippet file +uuid is the snippets "unique-id". Loading a second snippet file with the same uuid replaced the previous snippet.

-You can use yas–parse-template to return such lists based on +You can use yas--parse-template to return such lists based on the current buffers contents.

@@ -1158,14 +1159,14 @@ the current buffers contents.
-

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

+

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

-

Expand snippet CONTENT at current point. +

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

@@ -1173,47 +1174,47 @@ considered when expanding the snippet.
-

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

+

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

-

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

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

-

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

+

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

-

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

/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 +

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

-

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

+

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

-

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

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

-

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

+

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

Display choices in a x-window prompt. @@ -1326,7 +1327,7 @@ snippet expansion is attempted:

  • If it evaluates to the a cons (require-snippet-condition - . REQUIREMENT) + . requirement)
    • Snippets bearing no "# condition:" directive are not @@ -1338,13 +1339,13 @@ snippet expansion is attempted:
    • If the snippet has a condition that evaluates to non-nil - RESULT: + result:
        -
      • If REQUIREMENT is t, the snippet is considered +
      • If requirement is t, the snippet is considered
      • -
      • If REQUIREMENT is eq RESULT, the snippet is +
      • If requirement is eq result, the snippet is considered
      • @@ -1469,7 +1470,7 @@ isn't a trigger key, "foo-bar" is tried, respecting a second

        -/WARNING/: no doc for symbol yas-extra-modes +/warning/: no doc for symbol yas-extra-modes

  • @@ -1481,7 +1482,7 @@ isn't a trigger key, "foo-bar" is tried, respecting a second

    -Log level for yas–message 4 means trace most anything, 0 means nothing. +Log level for yas--message 4 means trace most anything, 0 means nothing.

    @@ -1503,7 +1504,7 @@ The active keymap while a snippet expansion is in progress.
    -

    Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-27T21:59-0500 from 860858de429775c17c74537805dbbc7906f8f994 +


    Generated by Org version 7.9.3f with Emacs version 24 on 2013-11-28T23:36-0500 from eda83304afc7894f0b5ddc15b04b041be52b94fb

    Validate XHTML 1.0