Skip to content
Hiroaki Otsu edited this page Sep 20, 2013 · 3 revisions

Abount the defined source within pophint-config.el

Description of source

NAME

NAME is a "name" property value of the source.
The following command, which is named having NAME, is defined by defining the source.
You can use the source by M-x the command or binding key for the command.

pophint:do-NAME ... do pophint:do using the source of NAME.

Note: Entity of the source is a variable which is named pophint:source-NAME.
Note: Abount pophint:do, see Command.

TGT

TGT is a description about where to show hint.

ACT

ACT is a action when user select hint.

Catalog of source

The following source exists within pophint-config.el.

  • Quoted
    • NAME : quoted
    • TGT : Quoted text
    • ACT : Move to the hint position.
  • URL/Path
    • NAME : url-or-path
    • TGT : String like URL/Filepath
    • ACT : Move to the hint position.
  • Cmt
    • NAME : comment-line
    • TGT : Comment part in one line
    • ACT : Move to the hint position.
  • Line
    • NAME : one-line
    • TGT : One line
    • ACT : Move to the hint position.
  • Sym
    • NAME : symbol
    • TGT : Constituent characters of symbol
    • ACT : Move to the hint position.
  • Link
    • NAME : help-btn/info-ref/w3m-anchor/eww-anchor
    • TGT : Link text
    • ACT : Follow the hint link.
  • Node
    • NAME : dired-node
    • TGT : Name part of File/Directory in dired mode buffer
    • ACT : Move to the hint position.
  • RangeYank
    • NAME : rangeyank
    • TGT : Break of word
    • ACT : Move to the hint position as region start. show hints for region end. copy the selected region.

The handled source by pophint:do-flexibly

When do pophint:do-flexibly which handle multiple source,
the handled source is gotten from pophint:global-sources/pophint:sources.
The definition is the following.

Note: About above command/variable, see Command.

pophint:global-sources

  • Quoted
  • URL/Path
  • Cmt
  • Line
  • Sym

pophint:sources

  • Link (help-mode, Info-mode, w3m-mode, eww-mode)
  • Node (dired-mode)
Clone this wiki locally