GNU Emacs Lisp Reference Manual

32.3: Defining Abbrevs

These functions define an abbrev in a specified abbrev table. define-abbrev is the low-level basic function, while add-abbrev is used by commands that ask for information from the user.

Function: add-abbrev table type arg

This function adds an abbreviation to abbrev table table based on information from the user. The argument type is a string describing in English the kind of abbrev this will be (typically, "global" or "mode-specific"); this is used in prompting the user. The argument arg is the number of words in the expansion.

The return value is the symbol that internally represents the new abbrev, or nil if the user declines to confirm redefining an existing abbrev.

Function: define-abbrev table name expansion hook

This function defines an abbrev in table named name, to expand to expansion, and call hook. The return value is an uninterned symbol that represents the abbrev inside Emacs; its name is name.

The argument name should be a string. The argument expansion should be a string, or nil to undefine the abbrev.

The argument hook is a function or nil. If hook is non-nil, then it is called with no arguments after the abbrev is replaced with expansion; point is located at the end of expansion when hook is called.

The use count of the abbrev is initialized to zero.

User Option: only-global-abbrevs

If this variable is non-nil, it means that the user plans to use global abbrevs only. This tells the commands that define mode-specific abbrevs to define global ones instead. This variable does not alter the behavior of the functions in this section; it is examined by their callers.