Variable: org-fold-show-context-detail

org-fold-show-context-detail is a customizable variable defined in org-fold.el.gz.

Value

((agenda . local)
 (bookmark-jump . lineage)
 (isearch . lineage)
 (default . ancestors))

Documentation

Alist between context and visibility span when revealing a location.

Some actions may move point into invisible locations. As a consequence, Org always exposes a neighborhood around point. How much is shown depends on the initial action, or context. Valid contexts are

  agenda when exposing an entry from the agenda
  org-goto when using the command org-goto (C-c C-j (org-goto))
  occur-tree when using the command org-occur (C-c / (org-sparse-tree) /)
  tags-tree when constructing a sparse tree based on tags matches
  link-search when exposing search matches associated with a link
  mark-goto when exposing the jump goal of a mark
  bookmark-jump when exposing a bookmark location
  isearch when exiting from an incremental search
  default default for all contexts not set explicitly

Allowed visibility spans are

  minimal show current headline; if point is not on headline,
                 also show entry

  local show current headline, entry and next headline

  ancestors show current headline and its direct ancestors; if
                 point is not on headline, also show entry

  ancestors-full show current subtree and its direct ancestors

  lineage show current headline, its direct ancestors and all
                 their children; if point is not on headline, also show
                 entry and first child

  tree show current headline, its direct ancestors and all
                 their children; if point is not on headline, also show
                 entry and all children

  canonical show current headline, its direct ancestors along with
                 their entries and children; if point is not located on
                 the headline, also show current entry and all children

As special cases, a nil or t value means show all contexts in minimal or canonical view, respectively.

Some views can make displayed information very compact, but also make it harder to edit the location of the match. In such a case, use the command org-fold-reveal (C-c C-r (org-fold-reveal)) to show more context.

This variable was added, or its default value changed, in Org version
9.0.

Aliases

org-show-context-detail (obsolete since 9.6)

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-fold.el.gz
(defcustom org-fold-show-context-detail '((agenda . local)
				  (bookmark-jump . lineage)
				  (isearch . lineage)
				  (default . ancestors))
  "Alist between context and visibility span when revealing a location.

\\<org-mode-map>Some actions may move point into invisible
locations.  As a consequence, Org always exposes a neighborhood
around point.  How much is shown depends on the initial action,
or context.  Valid contexts are

  agenda         when exposing an entry from the agenda
  org-goto       when using the command `org-goto' (`\\[org-goto]')
  occur-tree     when using the command `org-occur' (`\\[org-sparse-tree] /')
  tags-tree      when constructing a sparse tree based on tags matches
  link-search    when exposing search matches associated with a link
  mark-goto      when exposing the jump goal of a mark
  bookmark-jump  when exposing a bookmark location
  isearch        when exiting from an incremental search
  default        default for all contexts not set explicitly

Allowed visibility spans are

  minimal        show current headline; if point is not on headline,
                 also show entry

  local          show current headline, entry and next headline

  ancestors      show current headline and its direct ancestors; if
                 point is not on headline, also show entry

  ancestors-full show current subtree and its direct ancestors

  lineage        show current headline, its direct ancestors and all
                 their children; if point is not on headline, also show
                 entry and first child

  tree           show current headline, its direct ancestors and all
                 their children; if point is not on headline, also show
                 entry and all children

  canonical      show current headline, its direct ancestors along with
                 their entries and children; if point is not located on
                 the headline, also show current entry and all children

As special cases, a nil or t value means show all contexts in
`minimal' or `canonical' view, respectively.

Some views can make displayed information very compact, but also
make it harder to edit the location of the match.  In such
a case, use the command `org-fold-reveal' (`\\[org-fold-reveal]') to show
more context."
  :group 'org-fold-reveal-location
  :version "26.1"
  :package-version '(Org . "9.0")
  :type '(choice
	  (const :tag "Canonical" t)
	  (const :tag "Minimal" nil)
	  (repeat :greedy t :tag "Individual contexts"
		  (cons
		   (choice :tag "Context"
			   (const agenda)
			   (const org-goto)
			   (const occur-tree)
			   (const tags-tree)
			   (const link-search)
			   (const mark-goto)
			   (const bookmark-jump)
			   (const isearch)
			   (const default))
		   (choice :tag "Detail level"
			   (const minimal)
			   (const local)
			   (const ancestors)
                           (const ancestors-full)
			   (const lineage)
			   (const tree)
			   (const canonical))))))