HyWiki Menu

The HyWiki minibuffer menu 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 following table details the potentially prompted for referent types, as given by hywiki-referent-menu, with the “HyWiki RefType>” prompt (Activity appears only if the activities package is loaded):

Menu Item       Command                  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
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
===================================================================

Below are notes on a few of the HyWiki referent types.

Command

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.

Find

Search all of the HyWiki pages for matches of the WikiWord using the hywiki-word-grep command.

HyRolo

Search all of the HyRolo files for matches of the WikiWord using the hyrolo-fgrep command.

Page

Display the HyWiki page named for the WikiWord, e.g. WikiWord.org.

Spec

Create and highlight a WikiWord but defer specifying its type and creating its referent until the WikiWord is activated with the Action Key. When activated, prompt for and choose a typed referent. See hywiki-referent-menu for valid referent types. Select Page for a standard HyWiki page.

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 hywiki-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.