Variable: org-html-preamble

org-html-preamble is a customizable variable defined in ox-html.el.gz.

Value

t

Documentation

Non-nil means insert a preamble in HTML export.

When t, insert a string as defined by the formatting string in org-html-preamble-format. When set to a string, use this formatting string instead (see org-html-postamble-format for an example of such a formatting string).

When set to a function, apply this function and insert the returned string. The function takes the property list of export options as its only argument.

Setting :html-preamble in publishing projects will take precedence over this variable.

Source Code

;; Defined in /usr/src/emacs/lisp/org/ox-html.el.gz
;;;; Template :: Preamble

(defcustom org-html-preamble t
  "Non-nil means insert a preamble in HTML export.

When t, insert a string as defined by the formatting string in
`org-html-preamble-format'.  When set to a string, use this
formatting string instead (see `org-html-postamble-format' for an
example of such a formatting string).

When set to a function, apply this function and insert the
returned string.  The function takes the property list of export
options as its only argument.

Setting :html-preamble in publishing projects will take
precedence over this variable."
  :group 'org-export-html
  :type '(choice (const :tag "No preamble" nil)
		 (const :tag "Default preamble" t)
		 (string :tag "Custom formatting string")
		 (function :tag "Function (must return a string)")))