Variable: org-create-file-search-functions

org-create-file-search-functions is a variable defined in ol.el.gz.

Value

nil

Documentation

List of functions to construct the right search string for a file link.

These functions are called in turn with point at the location to which the link should point.

A function in the hook should first test if it would like to handle this file type, for example by checking the major-mode or the file extension. If it decides not to handle this file, it should just return nil to give other functions a chance. If it does handle the file, it must return the search string to be used when following the link. The search string will be part of the file link, given after a double colon, and org-open-at-point will automatically search for it. If special measures must be taken to make the search successful, another function should be added to the companion hook org-execute-file-search-functions, which see.

A function in this hook may also use org-link-store-props and set
:description property to provide a suggestion for the descriptive
text to be used for this link when it gets inserted into an Org buffer with M-x org-insert-link (org-insert-link).

Source Code

;; Defined in /usr/src/emacs/lisp/org/ol.el.gz
(defvar org-create-file-search-functions nil
  "List of functions to construct the right search string for a file link.

These functions are called in turn with point at the location to
which the link should point.

A function in the hook should first test if it would like to
handle this file type, for example by checking the `major-mode'
or the file extension.  If it decides not to handle this file, it
should just return nil to give other functions a chance.  If it
does handle the file, it must return the search string to be used
when following the link.  The search string will be part of the
file link, given after a double colon, and `org-open-at-point'
will automatically search for it.  If special measures must be
taken to make the search successful, another function should be
added to the companion hook `org-execute-file-search-functions',
which see.

A function in this hook may also use `org-link-store-props' and set
`:description' property to provide a suggestion for the descriptive
text to be used for this link when it gets inserted into an Org buffer
with \\[org-insert-link].")