Variable: org-link-parameters
org-link-parameters is a customizable variable defined in ol.el.gz.
Value
Large value
(("helpful" :store helpful--org-link-store)
("hypb-msg" :follow
#[257 "\300\301\"\207"
[message "Message: %s"]
4 "\n\n(fn PATH)"]
:export
#[771 "\211\300=\205�\301\302\303\304\305#\206�$\207"
[html format "<a href=\"#\" title=\"%s\" onclick=\"alert('%s'); return false;\">%s</a>" replace-regexp-in-string "'" "\\\\'"]
10 "\n\n(fn PATH DESC BACKEND)"])
("hy" :complete hywiki-org-link-complete :export hywiki-org-link-export :follow hywiki-find-referent :htmlize-link hywiki-section-to-headline-reference :store hywiki-org-link-store)
("roam" :follow org-roam-link-follow-link)
("attachment" :follow org-attach-follow :complete org-attach-complete-link)
("id" :follow org-id-open)
("w3m" :store org-w3m-store-link)
("rmail" :follow org-rmail-open :store org-rmail-store-link)
("mhe" :follow org-mhe-open :store org-mhe-store-link)
("man" :follow org-man-open :export org-man-export :store org-man-store-link)
("irc" :follow org-irc-visit :store org-irc-store-link :export org-irc-export)
("info" :follow org-info-open :export org-info-export :store org-info-store-link :insert-description org-info-description-as-command)
("gnus" :follow org-gnus-open :store org-gnus-store-link)
("eww" :follow org-eww-open :store org-eww-store-link)
("eshell" :follow org-eshell-open :store org-eshell-store-link)
("doi" :follow org-link-doi-open :export org-link-doi-export)
("docview" :follow org-docview-open :export org-docview-export :store org-docview-store-link)
("bibtex" :follow org-bibtex-open :store org-bibtex-store-link)
("bbdb" :follow org-bbdb-open :export org-bbdb-export :complete org-bbdb-complete-link :store org-bbdb-store-link)
("file+sys")
("file+emacs")
("shell" :follow org-link--open-shell)
("news" :follow
#[514 "\301\300\302Q\"\207"
["news" browse-url ":"]
6 "\n\n(fn URL ARG)"])
("mailto" :follow
#[514 "\301\300\302Q\"\207"
["mailto" browse-url ":"]
6 "\n\n(fn URL ARG)"])
("https" :follow
#[514 "\301\300\302Q\"\207"
["https" browse-url ":"]
6 "\n\n(fn URL ARG)"])
("http" :follow
#[514 "\301\300\302Q\"\207"
["http" browse-url ":"]
6 "\n\n(fn URL ARG)"])
("ftp" :follow
#[514 "\301\300\302Q\"\207"
["ftp" browse-url ":"]
6 "\n\n(fn URL ARG)"])
("help" :follow helpful--org-link-follow :store org-link--store-help)
("file" :complete org-link-complete-file)
("elisp" :follow org-link--open-elisp))
Documentation
Alist of properties that defines all the links in Org mode.
The key in each association is a string of the link type. Subsequent optional elements make up a property list for that type.
All properties are optional. However, the most important ones are, in this order, :follow, :export, and :store, described below.
:follow
Function used to follow the link, when the org-open-at-point
command runs on it. It is called with two arguments: the path,
as a string, and a universal prefix argument.
Here, you may use org-link-open-as-file helper function for
types similar to "file".
:export
Function that accepts four arguments:
- the path, as a string,
- the description as a string, or nil,
- the export back-end,
- the export communication channel, as a plist.
When nil, export for that type of link is delegated to the
back-end.
:store
Function responsible for storing the link. See the function
org-store-link-functions for a description of the expected
arguments.
Additional properties provide more specific control over the link.
:activate-func
Function to run at the end of Font Lock activation. It must
accept four arguments:
- the buffer position at the start of the link,
- the buffer position at its end,
- the path, as a string,
- a boolean, non-nil when the link has brackets.
:complete
Function that inserts a link with completion. The function
takes one optional prefix argument.
:insert-description
String or function used as a default when prompting users for a
link's description. A string is used as-is, a function is
called with two arguments: the link location (a string such as
"~/foobar", "id:some-org-id" or "https://www.foo.com")
and the description generated by org-insert-link. It should
return the description to use (this reflects the behavior of
org-link-make-description-function). If it returns nil, no
default description is used, but no error is thrown (from the
user's perspective, this is equivalent to a default description
of "").
:display
Value for invisible text property on the hidden parts of the
link. The most useful value is full, which will not fold the
link in descriptive display. Default is org-link.
:face
Face for the link, or a function returning a face. The
function takes one argument, which is the path.
The default face is org-link.
:help-echo
String or function used as a value for the help-echo text
property. The function is called with one argument, the help
string to display, and should return a string.
:htmlize-link
Function or plist for the htmlize-link text property. The
function takes no argument.
Default is (:uri "type:path")
:keymap
Active keymap when point is on the link. Default is
org-mouse-map.
:mouse-face
Face used when hovering over the link. Default is
highlight.
This variable was added, or its default value changed, in Org version
9.1.
Source Code
;; Defined in /usr/src/emacs/lisp/org/ol.el.gz
(defcustom org-link-parameters nil
"Alist of properties that defines all the links in Org mode.
The key in each association is a string of the link type.
Subsequent optional elements make up a property list for that
type.
All properties are optional. However, the most important ones
are, in this order, `:follow', `:export', and `:store', described
below.
`:follow'
Function used to follow the link, when the `org-open-at-point'
command runs on it. It is called with two arguments: the path,
as a string, and a universal prefix argument.
Here, you may use `org-link-open-as-file' helper function for
types similar to \"file\".
`:export'
Function that accepts four arguments:
- the path, as a string,
- the description as a string, or nil,
- the export back-end,
- the export communication channel, as a plist.
When nil, export for that type of link is delegated to the
back-end.
`:store'
Function responsible for storing the link. See the function
`org-store-link-functions' for a description of the expected
arguments.
Additional properties provide more specific control over the
link.
`:activate-func'
Function to run at the end of Font Lock activation. It must
accept four arguments:
- the buffer position at the start of the link,
- the buffer position at its end,
- the path, as a string,
- a boolean, non-nil when the link has brackets.
`:complete'
Function that inserts a link with completion. The function
takes one optional prefix argument.
`:insert-description'
String or function used as a default when prompting users for a
link's description. A string is used as-is, a function is
called with two arguments: the link location (a string such as
\"~/foobar\", \"id:some-org-id\" or \"https://www.foo.com\")
and the description generated by `org-insert-link'. It should
return the description to use (this reflects the behavior of
`org-link-make-description-function'). If it returns nil, no
default description is used, but no error is thrown (from the
user's perspective, this is equivalent to a default description
of \"\").
`:display'
Value for `invisible' text property on the hidden parts of the
link. The most useful value is `full', which will not fold the
link in descriptive display. Default is `org-link'.
`:face'
Face for the link, or a function returning a face. The
function takes one argument, which is the path.
The default face is `org-link'.
`:help-echo'
String or function used as a value for the `help-echo' text
property. The function is called with one argument, the help
string to display, and should return a string.
`:htmlize-link'
Function or plist for the `htmlize-link' text property. The
function takes no argument.
Default is (:uri \"type:path\")
`:keymap'
Active keymap when point is on the link. Default is
`org-mouse-map'.
`:mouse-face'
Face used when hovering over the link. Default is
`highlight'."
:group 'org-link
:package-version '(Org . "9.1")
:type '(alist :tag "Link display parameters"
:value-type plist))