File: klink.el.html
; link =
< pathname [, cell-ref] [, position] >
< @ cell-ref > ;; In same buffer
< journal-name, journal-item-number [, cell-ref] [, position] >
; pathname =
path ;; display path in Emacs buffer
!path ;; execute pathname within a shell
&path ;; execute path as a windowed program
-path ;; Load as an Emacs Lisp program
; cell-ref =
cell - 1a, 012, 1.2, 1a=012 (both relative and absolute ids separated
by an equal sign)
range - 1a-5c, 1a-+3 (include 3 cells past 1a) (not yet implemented)
tree - 1a+ (not yet implemented)
optionally followed by a period and 1 or more relative position specs
(not yet implemented):
previous-cell - .b
down-a-level - .d
end-of-branch - .e
follow-next-link - .l
return-to-prev-location - .r
return-to-prev-buffer - .rf
sibling - .s, .2s for 2 siblings forward
tail-of-tree - .t
up-a-level - .u
last char of cell - .f
and then optionally followed by any amount of whitespace, a pipe |
character and then one or more view specification characters. (Augment
viewspec characters may be given instead, preceded by a colon. They are
ignored for now.)
; position (relative to cell start) = (not yet implemented)
char-pos, e.g. 28 or C28
word-num, e.g. W5
line-num, e.g. L2
paragraph-num, e.g. P3
regexp-match, e.g. "regexp"
Defined variables (3)
klink:c-style-modes | C-related major modes with where klinks appear only within comments. |
klink:cell-ref-regexp | Regexp matching a cell reference including relative and view specs. |
klink:ignore-modes | Major modes in which to ignore potential klinks to avoid false positives. |
Defined functions (11)
actypes::link-to-kotl | (LINK) |
klink:absolute | (LABEL-AND-POS) |
klink:act | (KLINK START-POS) |
klink:at-p | () |
klink:create | (REFERENCE) |
klink:create-link | (REFERENCE) |
klink:parse | (REFERENCE) |
klink:replace-label | (KLINK LINK-BUF START NEW-LABEL) |
klink:set-yank-handler | (KLINK) |
klink:update-label | (KLINK START LINK-BUF) |
klink:yank-handler | (KLINK) |