List of org-mode hooks - examples of use

Defined in: org.el

    Hook that is run after org.el has been loaded.

Defined in: org.el

    Hook that is run after `org-cycle' has changed the buffer visibility.
    The function(s) in this hook must accept a single argument which indicates
    the new state that was set by the most recent `org-cycle' command.  The
    argument is a symbol.  After a global state change, it can have the values
    `overview', `content', or `all'.  After a local state change, it can have
    the values `folded', `children', or `subtree'.

Defined in: org.el

    Hook being run after inserting a new heading.

Defined in: org.el

    Hook that is run after `org-occur' has constructed a sparse tree.
    This can be used to recenter the window to show as much of the structure
    as possible.

Defined in: org.el

    Function to use to generate link descriptions from links. If
    nil the link location will be used. This function must take two
    parameters; the first is the link and the second the description
    org-insert-link has generated, and should return the description
    to use.

Defined in: org.el

    Function to translate links with different syntax to Org syntax.
    This can be used to translate links created for example by the Planner
    or emacs-wiki packages to Org syntax.
    The function must accept two parameters, a TYPE containing the link
    protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
    which is everything after the link protocol.  It should return a cons
    with possibly modified values of type and path.
    Org contains a function for this, so if you set this variable to
    `org-translate-link-from-planner', you should be able follow many
    links created by planner.

Defined in: org.el

    Hook that is run after a link has been followed.

Defined in: org.el

    Non-nil means, ask for confirmation before executing shell links.
    Shell links can be dangerous: just think about a link
    
         [[shell:rm -rf ~/*][Google Search]]
    
    This link would show up in your Org-mode document as \"Google Search\",
    but really it would remove your entire home directory.
    Therefore we advise against setting this variable to nil.
    Just change it to `y-or-n-p' of you want to confirm with a
    single keystroke rather than having to type \"yes\".

Defined in: org.el

    Non-nil means, ask for confirmation before executing Emacs Lisp links.
    Elisp links can be dangerous: just think about a link
    
         [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
    
    This link would show up in your Org-mode document as \"Google Search\",
    but really it would remove your entire home directory.
    Therefore we advise against setting this variable to nil.
    Just change it to `y-or-n-p' of you want to confirm with a
    single keystroke rather than having to type \"yes\".

Defined in: org.el

    Hook which is run after the state of a TODO item was changed.
    The new state (a string with a TODO keyword, or nil) is available in the
    Lisp variable `state'.

Defined in: org.el

    Hook that is run after the tags in a line have changed.

Defined in: org.el

    Function that modifies values for display in column view.
    For example, it can be used to cut out a certain part from a time stamp.
    The function must take 2 arguments:
    
    column-title    The title of the column (*not* the property name)
    value           The value that should be modified.
    
    The function should return the value that should be displayed,
    or nil if the normal value should be used.

Defined in: org.el

    Function to be called when `C-c C-c' is used.
    This is for getting out of special buffers like remember.

Defined in: org.el

    Mode hook for Org-mode, run after the mode was turned on.

Defined in: org.el

    Functions to be called for special font lock stuff.

Defined in: org.el

    List of functions that are called to create and store a link.
    Each function will be called in turn until one returns a non-nil
    value.  Each function should check if it is responsible for creating
    this link (for example by looking at the major mode).
    If not, it must exit and return nil.
    If yes, it should return a non-nil value after a calling
    `org-store-link-props' with a list of properties and values.
    Special properties are:
    
    :type         The link prefix. like \"http\".  This must be given.
    :link         The link, like \"http://www.astro.uva.nl/~dominik\".
                  This is obligatory as well.
    :description  Optional default description for the second pair
                  of brackets in an Org-mode link.  The user can still change
                  this when inserting this link into an Org-mode buffer.
    
    In addition to these, any additional properties can be specified
    and then used in remember templates.

Defined in: org.el

    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 `setq' to set the variable
    `description' to provide a suggestion for the descriptive text to
    be used for this link when it gets inserted into an Org-mode
    buffer with \\[org-insert-link].

Defined in: org.el

    List of functions to execute a file search triggered by a link.
    
    Functions added to this hook must accept a single argument, the
    search string that was part of the file link, the part after the
    double colon.  The function must first check if it would like to
    handle this search, for example by checking the major-mode or the
    file extension.  If it decides not to handle this search, it
    should just return nil to give other functions a chance.  If it
    does handle the search, it must return a non-nil value to keep
    other functions from trying.
    
    Each function can access the current prefix argument through the
    variable `current-prefix-argument'.  Note that a single prefix is
    used to force opening a link in Emacs, so it may be good to only
    use a numeric or double prefix to guide the search function.
    
    In case this is needed, a function in this hook can also restore
    the window configuration before `org-open-at-point' was called using:
    
        (set-window-configuration org-window-config-before-follow-link)

Defined in: org.el

    Hook for functions that are allowed to block a state change.
    
    Each function gets as its single argument a property list, see
    `org-trigger-hook' for more information about this list.
    
    If any of the functions in this hook returns nil, the state change
    is blocked.

Defined in: org.el

    Hook for functions that are triggered by a state change.
    
    Each function gets as its single argument a property list with at least
    the following elements:
    
     (:type type-of-change :position pos-at-entry-start
      :from old-state :to new-state)
    
    Depending on the type, more properties may be present.
    
    This mechanism is currently implemented for:
    
    TODO state changes
    ------------------
    :type  todo-state-change
    :from  previous state (keyword as a string), or nil
    :to    new state (keyword as a string), or nil

Defined in: org.el

    Hook that is called after a TODO statistics cookie has been updated.
    Each function is called with two arguments: the number of not-done entries
    and the number of done entries.
    
    For example, the following function, when added to this hook, will switch
    an entry to DONE when all children are done, and back to TODO when new
    entries are set to a TODO status.  Note that this hook is only called
    when there is a statistics cookie in the headline!
    
     (defun org-summary-todo (n-done n-not-done)
       \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
       (let (org-log-done org-log-states)   ; turn off logging
         (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))

Defined in: org-agenda.el

    Hook run just before displaying an agenda buffer.

Defined in: org-agenda.el

    Hook for org-agenda-mode, run after the mode is turned on.

Defined in: org-agenda.el

    Function to be called at each match during agenda construction.
    If this function returns nil, the current match should not be skipped.
    Otherwise, the function must return a position from where the search
    should be continued.
    This may also be a Lisp form, it will be evaluated.
    Never set this variable using `setq' or so, because then it will apply
    to all future agenda commands.  Instead, bind it with `let' to scope
    it dynamically into the agenda-constructing command.  A good way to set
    it is through options in org-agenda-custom-commands.

Defined in: org-agenda.el

    Normal hook run after an item has been shown from the agenda.
    Point is in the buffer where the item originated.

Defined in: org-clock.el

    When non-nil, should be a function to create `org-clock-heading'.
    This is the string shown in the mode line when a clock is running.
    The function is called with point at the beginning of the headline.

Defined in: org-exp.el

    Hook for preprocessing an export buffer.
    Pretty much the first thing when exporting is running this hook.

Defined in: org-exp.el

    Hook for preprocessing an export buffer.
    This is run after the contents of included files have been inserted.

Defined in: org-exp.el

    Hook for preprocessing an export buffer.
    This is run after selection of trees to be exported has happened.
    This selection includes tags-based selection, as well as removal
    of commented and archived trees.

Defined in: org-exp.el

    Hook run before backend-specific functions are called during preprocessing.

Defined in: org-exp.el

    Hook for preprocessing an export buffer.
    This is run as the last thing in the preprocessing buffer, just before
    returning the buffer string to the backend.

Defined in: org-exp.el

    Hook run before  an iCalendar file has been saved.
    This can be used to modify the result of the export.

Defined in: org-exp.el

    Hook run after an iCalendar file has been saved.
    The iCalendar buffer is still current when this hook is run.
    A good way to use this is to tell a desktop calendar application to re-read
    the iCalendar file.

Defined in: org-mouse.el

    Function to create the context menu.
    The value of this variable is the function invoked by
    `org-mouse-context-menu' as the context menu.

Defined in: org-publish.el

    Hook run before export on the Org file.
    If the functions in this hook modify the original Org buffer, the
    modified buffer will be used for export, but the buffer will be
    restored and saved back to its initial state after export.

Defined in: org-publish.el

    Hook run after export on the exported buffer.
    If functions in this hook modify the buffer, it will be saved.

Defined in: org-remember.el

    Hook that is run right before a remember process is finalized.
    The remember buffer is still current when this hook runs.

Defined in: org-remember.el

    Hook for the minor `org-remember-mode'.

If you want to display dormant article when following Gnus articles:

(add-hook 'org-follow-link-hook 
          (lambda () (if (eq major-mode 'gnus-summary-mode)
                         (gnus-summary-insert-dormant-articles))))