Variable: org-babel-common-header-args-w-values

org-babel-common-header-args-w-values is a variable defined in ob-core.el.gz.

Value

((cache (no yes)) (cmdline . :any) (colnames (nil no yes))
 (comments (no link yes org both noweb)) (dir . :any)
 (eval (yes no no-export strip-export never-export eval never query))
 (exports (code results both none)) (epilogue . :any) (file . :any)
 (file-desc . :any) (file-ext . :any) (file-mode (493 365 292 :any))
 (hlines (no yes)) (mkdirp (yes no)) (no-expand) (noeval)
 (noweb (yes no tangle strip-tangle no-export strip-export))
 (noweb-ref . :any) (noweb-sep . :any) (noweb-prefix (no yes))
 (output-dir . :any) (padline (yes no)) (post . :any)
 (prologue . :any)
 (results (file list vector table scalar verbatim)
	  (raw html latex org code pp drawer link graphics)
	  (replace silent none discard append prepend) (output value))
 (rownames (no yes)) (sep . :any) (session . :any) (shebang . :any)
 (tangle (tangle yes no :any)) (tangle-mode (493 365 292 :any))
 (var . :any) (wrap . :any))

Documentation

Alist defining common header args and their allowed values.

Keys of the alist are header arg symbols. Values of the alist are either a symbol :any or a list of allowed values as symbols:

   (header-name . :any)
   (header-name . ((value1 value2 value3 ...))
   (header-name . ((value1 value2 value3 ... :any))

When Org considers header-arg property inheritance, the innermost value from the list is considered.

Symbol :any in the value list implies that any value is allowed. Yet the explicitly listed values from the list will be offered as completion candidates.

FIXME: This is currently just supported for results and exports. Values in the alist can also be a list of lists. The inner lists define exclusive groups of values that can be set at the same time for a given header argument.

  (results . ((file list ...)
             (raw html ...))

The above example allows multi-component header arguments like

   #+begin_src bash :results file raw
   <:results will combine the two values "file raw".>

   #+begin_src bash :results file list
   <:results will only use the last value "list".>

   #+property: header-args :results file html
   ...
   #+begin_src bash :results list
   <:results will inherit with partial override "list html".>

See info node (org)Results of evaluation for more details.

Source Code

;; Defined in /usr/src/emacs/lisp/org/ob-core.el.gz
(defconst org-babel-common-header-args-w-values
  '((cache	. ((no yes)))
    (cmdline	. :any)
    (colnames	. ((nil no yes)))
    (comments	. ((no link yes org both noweb)))
    (dir	. :any)
    (eval	. ((yes no no-export strip-export never-export eval never
			query)))
    (exports	. ((code results both none)))
    (epilogue   . :any)
    (file	. :any)
    (file-desc  . :any)
    (file-ext   . :any)
    (file-mode  . ((#o755 #o555 #o444 :any)))
    (hlines	. ((no yes)))
    (mkdirp	. ((yes no)))
    (no-expand)
    (noeval)
    (noweb	. ((yes no tangle strip-tangle no-export strip-export)))
    (noweb-ref	. :any)
    (noweb-sep  . :any)
    (noweb-prefix . ((no yes)))
    (output-dir . :any)
    (padline	. ((yes no)))
    (post       . :any)
    (prologue   . :any)
    (results	. ((file list vector table scalar verbatim)
		   (raw html latex org code pp drawer link graphics)
		   (replace silent none discard append prepend)
		   (output value)))
    (rownames	. ((no yes)))
    (sep	. :any)
    (session	. :any)
    (shebang	. :any)
    (tangle	. ((tangle yes no :any)))
    (tangle-mode . ((#o755 #o555 #o444 :any)))
    (var	. :any)
    (wrap       . :any))
  "Alist defining common header args and their allowed values.

Keys of the alist are header arg symbols.
Values of the alist are either a symbol `:any' or a list of allowed
values as symbols:

   (header-name . :any)
   (header-name . ((value1 value2 value3 ...))
   (header-name . ((value1 value2 value3 ... :any))

When Org considers header-arg property inheritance, the innermost
value from the list is considered.

Symbol `:any' in the value list implies that any value is allowed.
Yet the explicitly listed values from the list will be offered as
completion candidates.

FIXME: This is currently just supported for `results' and `exports'.
Values in the alist can also be a list of lists.  The inner lists
define exclusive groups of values that can be set at the same time for
a given header argument.

  (results . ((file list ...)
             (raw html ...))

The above example allows multi-component header arguments like

   #+begin_src bash :results file raw
   <:results will combine the two values \"file raw\".>

   #+begin_src bash :results file list
   <:results will only use the last value \"list\".>

   #+property: header-args :results file html
   ...
   #+begin_src bash :results list
   <:results will inherit with partial override \"list html\".>

See info node `(org)Results of evaluation' for more details.")