File: org-indent.el.html

This is an implementation of dynamic virtual indentation. It works by adding text properties to a buffer to make sure lines are indented according to outline structure.

The process is synchronous, toggled at every buffer modification. Though, the initialization (indentation of text already in the buffer), which can take a few seconds in large buffers, happens on idle time.

Defined variables (20)

org-indent--deepest-levelMaximum theoretical headline depth.
org-indent--heading-line-prefixesVector containing line prefix strings for headlines.
org-indent--initial-markerPosition of initialization before interrupt.
org-indent--inlinetask-line-prefixesVector containing line prefix strings for inline tasks.
org-indent--text-line-prefixesVector containing line prefixes strings for regular text.
org-indent-agent-active-delayTime to run agent before switching to other idle processes.
org-indent-agent-passive-delayTime to run agent before switching to other idle processes.
org-indent-agent-resume-delayMinimal time for other idle processes before switching back to agent.
org-indent-agent-resume-timerTimer to reschedule agent after switching to other idle processes.
org-indent-agent-timerTimer running the initialize agent.
org-indent-agentized-buffersList of buffers watched by the initialize agent.
org-indent-boundary-charThe end of the virtual indentation strings, a single-character string.
org-indent-indentation-per-levelIndentation per level in number of characters.
org-indent-inlinetask-first-starFirst star of inline tasks, with correct face.
org-indent-modeNon-nil if Org-Indent mode is enabled.
org-indent-mode-hookHook run after entering or leaving ‘org-indent-mode’.
org-indent-mode-turns-off-org-adapt-indentationNon-nil means setting ‘org-indent-mode’ will turn off indentation adaptation.
org-indent-mode-turns-on-hiding-starsNon-nil means setting ‘org-indent-mode’ will turn on ‘org-hide-leading-stars’.
org-indent-modified-headline-flagNon-nil means the last deletion operated on a headline.
org-indent-post-buffer-init-functionsHook run after org-indent finishes initializing a buffer.

Defined functions (11)

org-indent--compute-prefixes()
org-indent-add-properties(BEG END &optional DELAY)
org-indent-indent-buffer()
org-indent-initialize-agent()
org-indent-initialize-buffer(BUFFER DELAY)
org-indent-mode(&optional ARG)
org-indent-notify-modified-headline(BEG END)
org-indent-refresh-maybe(BEG END _)
org-indent-remove-properties(BEG END)
org-indent-remove-properties-from-string(STRING)
org-indent-set-line-properties(LEVEL INDENTATION &optional HEADING)

Defined faces (1)

org-indentFace for outline indentation. The default is to make it look like whitespace. But you may find it useful to make it ever so slightly different.