HyWiki Menu

The HyWiki minibuffer menu at {C-h h h} offers quick access to important HyWiki features. It looks like this:

HyWiki>  Act BacklinkConsult Create DiredHyWiki EditPage FindReferent GrepConsult
         Help Info Link ModeSet/ Org-M-RET/ Publish TagFind

The BacklinkConsult and GrepConsult and items appear only when the Consult package is installed prior to loading Hyperbole. These commands are especially useful as they allow for fast line-level searching across many files with interactive search pattern narrowing.

Below are descriptions of each menu item.

Act

Activate HyWikiWord link at point.

BacklinkConsult

Use hywiki-consult-backlink to prompt for a HyWikiWord and then consult grep over its HyWiki backlink references, selecting one.

Create

Create and display a new or existing HyWikiWord referent, prompting with any existing referent names. With either hywiki-referent-prompt-flag set or a prefix argument, prompt for and choose a typed referent; otherwise, create and/or display a HyWiki page.

The referent types menu, specified by hywiki-referent-menu, selects the referent type for a HyWikiWord and prompts for any arguments it requires. It looks like this (Note that ‘Activity’ appears only if the Activities package is available):

HyWiki RefType>  Activity Bookmark Denote Command Elisp Find Gbut HyRolo
                 InfoIndex Keys pathLink infoNode OrgID Page orgRoamNode
                 Spec glossarY

Menu Item       RefType Add Command       Display Action Description
===================================================================
Activity        hywiki-add-activity       Activate a saved Activity
Bookmark        hywiki-add-bookmark       Jump to an Emacs bookmark
Command         hywiki-add-command        Run a Hypb action or cmd
Denote          hywiki-add-denote         Display a denote file
Elisp           hywiki-add-elisp          Evaluate an Elisp sexp
Find            hywiki-add-find           Grep through hywiki dir
Gbut            hywiki-add-global-button  Activate a global button
HyRolo          hywiki-add-hyrolo         Search hyrolo-file-list
InfoIndex       hywiki-add-info-index     Display an Info index item
Keys            hywiki-add-key-series     Execute a series of keys
pathLink        hywiki-add-path-link      Display a path and opt pos
infoNode        hywiki-add-info-node      Display an Info doc node
OrgID           hywiki-add-org-id         Display a sect for Org ID
Page            hywiki-add-page           Display a HyWiki page#sect
orgRoamNode     hywiki-add-org-roam-node  Display an Org Roam node
Spec            hywiki-add-spec           Defer referent linkage
glossarY        hywiki-add-glossary-entry Display a HyWiki term def
===================================================================

In more detail:

Activity

Add a HyWikiWord that activates a saved activity from the Activities package.

Bookmark

Add a HyWikiWord that jumps to an Emacs bookmark.

Command

Add a HyWikiWord that runs an Emacs interactive command or Hyperbole action type. If the command referent is just a symbol without any arguments, then the WikiWord is passed as the sole argument when the command is run. If the command takes a single argument and the empty string is given for the argument, then this is replaced with the WikiWord when the command is run.

Denote

Add a HyWikiWord that displays a denote file. When called interactively or with a WikiWord argument of nil or the empty string, then set the WikiWord argument to any wikiword at point; otherwise, convert the description from the denote file chosen to a wikiword.

Elisp

Add a HyWikiWord that evaluates an Elisp sexpression.

Find

Add a HyWikiWord that greps through hywiki-directory for its matches. It searches all of the HyWiki pages for matches of the WikiWord using the hywiki-word-grep command.

Gbut

Add a HyWikiWord that activates a named Hyperbole global button.

HyRolo

Add a HyWikiWord that searches hyrolo-file-list for matches of the WikiWord using the hyrolo-fgrep command.

InfoIndex

Add a HyWikiWord that displays an Info index item.

Keys

Add a HyWikiWord that executes a key series.

pathLink

Add a HyWikiWord that links to a path and possible position. See the documention for hpath:find for the rich forms of paths that may be used.

infoNode

Add a HyWikiWord that displays an Info node.

OrgID

Add an Org link that displays an Org section given its Org ID.

Page

Add/Reset a HyWikiWord to display its standard HyWiki page or a section therein, e.g. WikiWord.org, within the hywiki-directory.

Add a HyWikiWord that displays an Org Roam node given its title.

Spec

Add a HyWikiWord without a specified referent (the HyWikiWord reference is highlighted but no referent is displayed). Defer referent creation until the first activation of the HyWikiWord, at which point the HyWiki RefType menu is displayed for selection.

Glossary

Add or edit the definition of a HyWikiWord that displays its own definition from the HyWiki’s Glossary.org file.

A HyWiki can contain a Glossary.org file with heading titles that represent terms associated with the HyWiki. The body of each heading section is the definition of the term. Terms can consist of multiple words and do not have to be HyWikiWords but may be.

There are three ways to work with HyWiki glossary terms:

1. Use a hydef Action Button to display the term’s definition. For example, ‘<hydef Action Key>’ or ‘<hydef "Action Key">’
2. Create a HyWikiWord with a glossary referent type. With hywiki-mode active, {M-0 M-RET y} or {C-h h h c y} will turn the wikiword at point into or will prompt you for a wikiword name whose referent displays the definition for the wikiword.
3. Programmatically display a glossary entry. Call (hywiki-get-definition "term" t) to display the entry.

DiredHyWiki

Display and edit HyWiki pages in current hywiki-directory. Use dired unless action-key-modeline-buffer-id-function is set to smart-treemacs-modeline, then use the Treemacs package.

EditPage

Prompt with completion for and find a HyWiki page, typically editable. If the page is already in a buffer, point is left unchanged.

FindReferent

Prompt with completion for and find any kind of HyWiki referent.

GrepConsult

Grep over HyWiki pages with interactive hywiki-consult-grep. Any words may be used.

Help

Report on a HyWikiWord’s attributes.

Info

Display Hyperbole manual section on HyWiki.

Link

Prompt for and add a link at point to a HyWiki page.

ModeSet/

Select from three states for the global minor mode, hywiki-mode.

All-Editable-Buffers

This is the default setting. Highlight HyWikiWord references within HyWiki page buffers only. The hywiki-mode variable is set to ‘:pages’. Programatically, use: (hywiki-mode :pages).

HyWiki-Pages-Only

Highlight HyWikiWord references within all editable buffers except those with major modes in hypb:exclude-major-modes. The hywiki-mode variable is set to ‘:all’. Programatically, use: (hywiki-mode :all).

Nowhere

Disable highlighting HyWikiWord references everywhere. The hywiki-mode variable is set to ‘nil’. Programatically, use: (hywiki-mode nil).

Org-M-RET/

Menu to customize contexts in which Hyperbole Action and Assist Keys override Org’s {M-RET} command. The default is when on ‘Hyperbole-Buttons-Only’. Use ‘All-Hyperbole-Contexts’ to make the Action Key create new HyWiki pages when pressed on as-yet undefined HyWikiWords; otherwise, you must use {C-h h h c} to create a new HyWiki page instead. Use ‘None’ if you want to use Org’s {M-RET} command in every context within Org mode.

Publish

Publish modified pages in the HyWiki to HTML; prefix arg to publish all pages.

TagFind

Find a matching Org tag across all HyWiki pages.