help-dwim - Perl Development Environment
Description: Perl Development Environment

Next: perldoc, Previous: compile-dwim, Up: Top

## 14 Find documents using help-dwim

A big obstacle for novice to used to emacs is that there are so many keys to remember. I like dwim commands. `help-dwim.el` provide a single command as interface for several kinds of document commands, such as `describe-function`, `describe-variable`, `woman`. And you can add more if you follow the rules.

A type of help-dwim commands should provide:

- a functions or a character sets to find which symbol under point
- an obarray to search whether the symbol belong to this type
- an optional predicate function to filter unwanted symbol
- a handler to show the document of the symbol

— Function: help-dwim-register type activate &optional body

> Register a new type of help command. An new type has a form (TYPE . [FINDER OBARRAY PREDICATE HANDLER]). If ACTIVATE is non-nil, the type will add to `help-dwim-active-type`, and BODY will eval intermediately. BODY is the code to eval when the type is activated. If the type is register without activated, the BODY will add to `help-dwim-autoloads`. When you use `help-dwim-active-type` or `help-dwim-customize-type` add the type, the code will also eval then.

— Command: help-dwim-customize-type

> Customize which type of help command should activate.

— Function: help-dwim-active-type type &optional append

> Active a type for current buffer *ONLY*. The TYPE will gain a highest prority unless APPEND is non-nil.