File: idlw-help.el.html

The help link information for IDLWAVE's online help feature for system routines is extracted automatically from the IDL documentation, and is available, along with general routine information, in the file idlw-rinfo.el. The HTML help file themselves are not distributable with Emacs, but are available, along with new versions of IDLWAVE, documentation, and more information, at:

          https://github.com/jdtsmith/idlwave

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

Defined variables (31)

idlwave-extra-help-functionThe function to call for online help if the normal help fails.
idlwave-help-activate-links-aggressivelyObsolete variable.
idlwave-help-assistant-commandThe command, rooted at ‘idlwave-system-directory’, which invokes the
idlwave-help-assistant-help-with-topic-historyThe history of help topics selected with the minibuffer.
idlwave-help-browser-functionFunction to use to display HTML help.
idlwave-help-browser-generic-argsProgram args to use if using ‘browse-url-generic-program’.
idlwave-help-browser-generic-programProgram to run if using ‘browse-url-generic-program’.
idlwave-help-browser-is-localWhether the browser will display locally in an Emacs window.
idlwave-help-directoryObsolete variable. See ‘idlwave-html-help-location’.
idlwave-help-doclib-keywordA regexp for the heading word to search for in doclib headers
idlwave-help-doclib-nameA regexp for the heading word to search for in doclib headers
idlwave-help-fontify-source-codeNon-nil means, fontify source code displayed as help like normal code.
idlwave-help-frameThe frame for display of IDL online help.
idlwave-help-frame-parametersThe frame parameters for the special Online Help frame.
idlwave-help-frame-widthThe default width of the help frame.
idlwave-help-menuMenu for Help IDLWAVE system.
idlwave-help-mode-abbrev-tableAbbrev table for ‘idlwave-help-mode’.
idlwave-help-mode-hookHook run after entering ‘idlwave-help-mode’.
idlwave-help-mode-line-indicatorUsed for the special mode line in the ‘idlwave-help-mode’.
idlwave-help-mode-mapThe keymap used in ‘idlwave-help-mode’.
idlwave-help-mode-syntax-tableSyntax table for ‘idlwave-help-mode’.
idlwave-help-return-frameThe frame to return to from the help frame.
idlwave-help-source-try-headerNon-nil means, try to find help in routine header when displaying source.
idlwave-help-use-assistantWhether to use the IDL Assistant as the help browser.
idlwave-help-use-dedicated-frameNon-nil means, use a separate frame for Online Help if possible.
idlwave-help-use-hhObsolete variable.
idlwave-html-help-is-availableIs the system online help text available?
idlwave-html-help-locationThe directory where the idl_html_help/ dir lives.
idlwave-html-help-pre-v6Whether pre or post-v6.0 IDL help documents are being used.
idlwave-html-system-help-locationThe directory, relative to ‘idlwave-system-directory’, where the IDL
idlwave-max-popup-menu-itemsMaximum number of items per pane in popup menus.

Defined functions (32)

idlwave-do-context-help(&optional ARG)
idlwave-do-context-help1(&optional ARG)
idlwave-do-mouse-completion-help(EV)
idlwave-entry-has-help(ENTRY)
idlwave-grep(REGEXP LIST)
idlwave-has-help(NAME TYPE CLASS)
idlwave-help-assistant-help-with-topic(&optional TOPIC)
idlwave-help-assistant-open-link(&optional LINK)
idlwave-help-assistant-start(&optional FULL-LINK)
idlwave-help-diagnostics(STRING &optional DING)
idlwave-help-display-help-window(&optional POS-OR-FUNC)
idlwave-help-error(NAME TYPE CLASS KEYWORD)
idlwave-help-find-first-header(&optional ARG)
idlwave-help-find-header(ARG)
idlwave-help-find-in-doc-header(NAME TYPE CLASS KEYWORD &optional EXACT)
idlwave-help-find-routine-definition(NAME TYPE CLASS KEYWORD)
idlwave-help-fontify()
idlwave-help-get-help-buffer()
idlwave-help-get-special-help(NAME TYPE CLASS KEYWORD)
idlwave-help-html-link(LINK)
idlwave-help-menu(ARG1)
idlwave-help-mode()
idlwave-help-quit()
idlwave-help-return-to-calling-frame()
idlwave-help-select-help-frame()
idlwave-help-show-help-frame()
idlwave-help-toggle-header-match-and-def(&optional ARG TOP)
idlwave-help-toggle-header-top-and-def(&optional ARG)
idlwave-help-with-source(NAME TYPE CLASS KEYWORD)
idlwave-highlight-linked-completions()
idlwave-html-help-location()
idlwave-online-help(LINK &optional NAME TYPE CLASS KEYWORD)

Defined faces (1)

idlwave-help-linkFace for highlighting links into IDLWAVE online help.