Using HyWikiWords

To display/jump to a HyWiki referent, simply move point onto any highlighted HyWikiWord reference and press the Action Key {M-RET}. This also highlights any other instances of HyWikiWords across all visible Emacs windows if not already done. If you have set the Org {M-RET} option to ‘None’ with {C-h h h o n}, then you will have to use the HyWiki Act menu command {C-h h h a} instead to jump to HyWiki referents.

For help on any HyWikiWord to see what it will do when activated, use {C-u M-RET} or {C-h A} with point on the word. This shows its attributes and the documentation for its implicit button type as well as its action type.

HyWiki is fully compatible with Org mode and if you prefer your HyWikiWord links to be Org-style links, then delimit them with double square brackets and the ‘hy:’ prefix like so: ‘[[hy:MyWikiWord]]’. If you set hywiki-org-link-type-required to ‘nil’, then you don’t need the ‘hy:’ prefix, e.g. ‘[[MyWikiWord]]’. Existing HyWiki page names then will override Org’s standard handling of such links.

HyWikiWord links can also jump to a section headline within a page by following the page name with a ‘#’ character and then the section headline name (sans any asterisks and other markup). For example, if your Emacs page has a ‘Major Modes’ section, then either ‘Emacs#Major-Modes’, ‘"Emacs#Major Modes"’ or ‘[[hy:Emacs#Major Modes]]’ will work as a link to that section. In fact, any paired delimiters can be used: ‘(), <>, [], or {}’. Note that without delimiters, you must convert spaces in section names to ’-’ characters. Section links are highlighted regardless of whether associated sections exist or not, but when activating a link with a section reference, HyWiki will give you an error if the exact section name cannot be found.

As HyWikiWord references are typed, highlighting occurs immediately after an existing HyWikiWord is entered when not within a delimited Org ‘[[link]]’, Org ‘<<<radio button target>>>’ or a Hyperbole ‘<[implicit button name]>’ or ‘<(explicit button text)>’.

HyWikiWords are a form of Hyperbole implicit buttons. HyWiki adds two implicit button types at low priorities to support HyWikiWords, so that they trigger only when other types are not recognized first.

hywiki-existing-word

On a HyWikiWord with an existing referent, display the referent. A call to (hywiki-active-in-current-buffer-p) must return non-‘nil’ for this to activate.

hywiki-word

When on a non-existing HyWikiWord, create it and display its referent. This is the Action Key function that activates HyWikiWords. A call to (hywiki-active-in-current-buffer-p) must return non-‘nil’ for this to activate.

If the associated HyWiki referent is a page, create it automatically unless it is the first HyWiki page to be created, in which case, prompt the user whether to create it, to prevent any unexpected HyWiki use.