yasnippet/doc/snippet-menu.org
Noam Postavsky f6cace08f3 convert old rst manuals to org mode
This is just the initial conversion with pandoc, they still need to be
fixed up. Also define new org files as a project in yas-doc-helper.el.
2013-11-26 23:09:16 -05:00

68 lines
2.1 KiB
Org Mode

* YASnippet menu
When =yas-minor-mode= is active, YASnippet will setup a menu just after
the "Buffers" menu in the menubar.
In this menu, you can find
- The currently loaded snippet definitions, organized by major mode,
and optional grouping.
- A rundown of the most common commands, (followed by their
keybindings) including commands to load directories and reload all
snippet definitions.
- A series of submenus for customizing and exploring YASnippet
behavior.
[[images/menu-1.png]]
** Loading snippets from menu
Invoking "Load snippets..." from the menu invokes =yas-load-directory=
and prompts you for a snippet directory hierarchy to load.
Also useful is the "Reload all" options which uncondionally reloads all
the snippets directories defined in =yas-root-directory= and rebuilds
the menus.
** Snippet menu behavior
YASnippet will list in this section all the loaded snippet definitions
organized by snippet table name.
You can use this section to explore currently loaded snippets. If you
click on one of them, the default behavior is to expand it,
unconditionally, inside the current buffer.
You can however, customize variable =yas-visit-from-menu= to be =t=
which will take you to the snippet definition file when you select it
from the menu.
If you want the menu show only snippet tables whose name corresponds to
a "real" major mode. You do this by setting =yas-use-menu= to
='real-modes=.
Finally, to have the menu show only the tables for the currently active
mode, set =yas-use-menu= to =abbreviate=.
These customizations can also be found in the menu itself, under the
"Snippet menu behavior" submenu.
** Controlling indenting
The "Indenting" submenu contains options to control the values of
=yas-indent-line= and =yas-also-auto-indent-first-line=. See
[[snippet-development.html][Writing snippets]] .
** Prompting method
The "Prompting method" submenu contains options to control the value of
=yas-prompt-functions=. See [[snippet-expansion.html][Expanding
snippets]] .
** Misc
The "Misc" submenu contains options to control the values of more
variables.