File: `ox.el.html`

This library implements a generic export engine for Org, built on its syntactical parser: Org Elements.

Besides that parser, the generic exporter is made of three distinct parts:

- The communication channel consists of a property list, which is
  created and updated during the process. Its use is to offer
  every piece of information, would it be about initial environment
  or contextual data, all in a single place.

- The transcoder walks the parse tree, ignores or treat as plain
  text elements and objects according to export options, and
  eventually calls backend specific functions to do the real
  transcoding, concatenating their return value along the way.

- The filter system is activated at the very beginning and the very
  end of the export process, and each time an element or an object
  has been converted. It is the entry point to fine-tune standard
  output from backend transcoders. See "The Filter System"
  section for more information.

The core functions is org-export-as. It returns the transcoded buffer as a string. Its derivatives are org-export-to-buffer and org-export-to-file.

An export backend is defined with org-export-define-backend. This function can also support specific buffer keywords, OPTION keyword's items and filters. Refer to function's documentation for more information.

If the new backend shares most properties with another one, org-export-define-derived-backend can be used to simplify the process.

Any backend can define its own variables. Among them, those customizable should belong to the org-export-BACKEND group.

Tools for common tasks across backends are implemented in the following part of the file.

Eventually, a dispatcher (org-export-dispatch) is provided in the last one.

See <https://orgmode.org/worg/dev/org-export-reference.html> for more information.

Defined variables (125)

`org-export-allow-bind-keywords`	Non-nil means BIND keywords can define local variable values.
`org-export-async-debug`	Non-nil means asynchronous export process should leave data behind.
`org-export-async-init-file`	File used to initialize external export process.
`org-export-before-parsing-functions`	Abnormal hook run before parsing an export buffer.
`org-export-before-processing-functions`	Abnormal hook run at the beginning of the export process.
`org-export-body-only`	The initial "Body only" setting when exporting with ‘org-export-dispatch’.
`org-export-coding-system`	Coding system for the exported file.
`org-export-copy-to-kill-ring`	Non-nil means pushing export output to the kill ring.
`org-export-creator-string`	Information about the creator of the document.
`org-export-current-backend`	Name, if any, of the backend used during an export process.
`org-export-date-timestamp-format`	Timestamp format string to use for DATE keyword.
`org-export-default-inline-image-rule`	Default rule for link matching an inline image.
`org-export-default-language`	The default language for export and clocktable translations, as a string.
`org-export-dictionary`	Dictionary for export engine.
`org-export-dispatch-last-action`	Last command called from the dispatcher.
`org-export-dispatch-last-position`	The position where the last export command was created using the dispatcher.
`org-export-dispatch-use-expert-ui`	Non-nil means using a non-intrusive ‘org-export-dispatch’.
`org-export-exclude-tags`	Tags that exclude a tree from export.
`org-export-expand-links`	When non-nil, expand environment variables in file paths.
`org-export-filter-babel-call-functions`	List of functions applied to a transcoded babel-call.
`org-export-filter-body-functions`	List of functions applied to transcoded body.
`org-export-filter-bold-functions`	List of functions applied to transcoded bold text.
`org-export-filter-center-block-functions`	List of functions applied to a transcoded center block.
`org-export-filter-clock-functions`	List of functions applied to a transcoded clock.
`org-export-filter-code-functions`	List of functions applied to transcoded code text.
`org-export-filter-diary-sexp-functions`	List of functions applied to a transcoded diary-sexp.
`org-export-filter-drawer-functions`	List of functions applied to a transcoded drawer.
`org-export-filter-dynamic-block-functions`	List of functions applied to a transcoded dynamic-block.
`org-export-filter-entity-functions`	List of functions applied to a transcoded entity.
`org-export-filter-example-block-functions`	List of functions applied to a transcoded example-block.
`org-export-filter-export-block-functions`	List of functions applied to a transcoded export-block.
`org-export-filter-export-snippet-functions`	List of functions applied to a transcoded export-snippet.
`org-export-filter-final-output-functions`	List of functions applied to the transcoded string.
`org-export-filter-fixed-width-functions`	List of functions applied to a transcoded fixed-width.
`org-export-filter-footnote-definition-functions`	List of functions applied to a transcoded footnote-definition.
`org-export-filter-footnote-reference-functions`	List of functions applied to a transcoded footnote-reference.
`org-export-filter-headline-functions`	List of functions applied to a transcoded headline.
`org-export-filter-horizontal-rule-functions`	List of functions applied to a transcoded horizontal-rule.
`org-export-filter-inline-babel-call-functions`	List of functions applied to a transcoded inline-babel-call.
`org-export-filter-inline-src-block-functions`	List of functions applied to a transcoded inline-src-block.
`org-export-filter-inlinetask-functions`	List of functions applied to a transcoded inlinetask.
`org-export-filter-italic-functions`	List of functions applied to transcoded italic text.
`org-export-filter-item-functions`	List of functions applied to a transcoded item.
`org-export-filter-keyword-functions`	List of functions applied to a transcoded keyword.
`org-export-filter-latex-environment-functions`	List of functions applied to a transcoded latex-environment.
`org-export-filter-latex-fragment-functions`	List of functions applied to a transcoded latex-fragment.
`org-export-filter-line-break-functions`	List of functions applied to a transcoded line-break.
`org-export-filter-link-functions`	List of functions applied to a transcoded link.
`org-export-filter-node-property-functions`	List of functions applied to a transcoded node-property.
`org-export-filter-options-functions`	List of functions applied to the export options.
`org-export-filter-paragraph-functions`	List of functions applied to a transcoded paragraph.
`org-export-filter-parse-tree-functions`	List of functions applied to the parsed tree.
`org-export-filter-plain-list-functions`	List of functions applied to a transcoded plain-list.
`org-export-filter-plain-text-functions`	List of functions applied to plain text.
`org-export-filter-planning-functions`	List of functions applied to a transcoded planning.
`org-export-filter-property-drawer-functions`	List of functions applied to a transcoded property-drawer.
`org-export-filter-quote-block-functions`	List of functions applied to a transcoded quote block.
`org-export-filter-radio-target-functions`	List of functions applied to a transcoded radio-target.
`org-export-filter-section-functions`	List of functions applied to a transcoded section.
`org-export-filter-special-block-functions`	List of functions applied to a transcoded special block.
`org-export-filter-src-block-functions`	List of functions applied to a transcoded src-block.
`org-export-filter-statistics-cookie-functions`	List of functions applied to a transcoded statistics-cookie.
`org-export-filter-strike-through-functions`	List of functions applied to transcoded strike-through text.
`org-export-filter-subscript-functions`	List of functions applied to a transcoded subscript.
`org-export-filter-superscript-functions`	List of functions applied to a transcoded superscript.
`org-export-filter-table-cell-functions`	List of functions applied to a transcoded table-cell.
`org-export-filter-table-functions`	List of functions applied to a transcoded table.
`org-export-filter-table-row-functions`	List of functions applied to a transcoded table-row.
`org-export-filter-target-functions`	List of functions applied to a transcoded target.
`org-export-filter-timestamp-functions`	List of functions applied to a transcoded timestamp.
`org-export-filter-underline-functions`	List of functions applied to transcoded underline text.
`org-export-filter-verbatim-functions`	List of functions applied to transcoded verbatim text.
`org-export-filter-verse-block-functions`	List of functions applied to a transcoded verse block.
`org-export-filters-alist`	Alist between filters properties and initial values.
`org-export-force-publishing`	The initial "Force publishing" setting for ‘org-export-dispatch’.
`org-export-global-macros`	Alist between macro names and expansion templates.
`org-export-headline-levels`	The last level which is still exported as a headline.
`org-export-in-background`	Non-nil means export and publishing commands will run in background.
`org-export-initial-scope`	The initial scope when exporting with ‘org-export-dispatch’.
`org-export-max-depth`	Maximum nesting depth for headlines, counting from 0.
`org-export-options-alist`	Alist between export properties and ways to set them.
`org-export-preserve-breaks`	Non-nil means preserve all line breaks when exporting.
`org-export-process-citations`	Non-nil means process citations using citation processors.
`org-export-registered-backends`	List of backends currently available in the exporter.
`org-export-select-tags`	Tags that select a tree for export.
`org-export-show-temporary-export-buffer`	Non-nil means show buffer after exporting to temp buffer.
`org-export-smart-quotes-alist`	Smart quotes translations.
`org-export-snippet-translation-alist`	Alist between export snippets backends and exporter backends.
`org-export-stack-contents`	Record asynchronously generated export results and processes.
`org-export-stack-mode-abbrev-table`	Abbrev table for ‘org-export-stack-mode’.
`org-export-stack-mode-hook`	Hook run after entering ‘org-export-stack-mode’.
`org-export-stack-mode-map`	Keymap for Org Export Stack.
`org-export-stack-mode-syntax-table`	Syntax table for ‘org-export-stack-mode’.
`org-export-time-stamp-file`	Non-nil means insert a time stamp into the exported file.
`org-export-timestamp-file`	Non-nil means insert a time stamp into the exported file.
`org-export-visible-only`	The initial "Visible only" setting when exporting with ‘org-export-dispatch’.
`org-export-with-archived-trees`	Whether sub-trees with the ARCHIVE tag should be exported.
`org-export-with-author`	Non-nil means insert author name into the exported file.
`org-export-with-broken-links`	Non-nil means do not raise an error on broken links.
`org-export-with-clocks`	Non-nil means export CLOCK keywords.
`org-export-with-creator`	Non-nil means the postamble should contain a creator sentence.
`org-export-with-date`	Non-nil means insert date in the exported document.
`org-export-with-drawers`	Non-nil means export contents of standard drawers.
`org-export-with-email`	Non-nil means insert author email into the exported file.
`org-export-with-emphasize`	Non-nil means interpret word, /word/, _word_ and +word+.
`org-export-with-entities`	Non-nil means interpret entities when exporting.
`org-export-with-fixed-width`	Non-nil means export lines starting with ":".
`org-export-with-footnotes`	Non-nil means Org footnotes should be exported.
`org-export-with-inlinetasks`	Non-nil means inlinetasks should be exported.
`org-export-with-latex`	Non-nil means process LaTeX environments and fragments.
`org-export-with-planning`	Non-nil means include planning info in export.
`org-export-with-priority`	Non-nil means include priority cookies in export.
`org-export-with-properties`	Non-nil means export contents of properties drawers.
`org-export-with-section-numbers`	Non-nil means add section numbers to headlines when exporting.
`org-export-with-smart-quotes`	Non-nil means activate smart quotes during export.
`org-export-with-special-strings`	Non-nil means interpret "\-", "--" and "---" for export.
`org-export-with-statistics-cookies`	Non-nil means include statistics cookies in export.
`org-export-with-sub-superscripts`	Non-nil means interpret "_" and "^" for export.
`org-export-with-tables`	Non-nil means export tables.
`org-export-with-tags`	If nil, do not export tags, just remove them from headlines.
`org-export-with-tasks`	Non-nil means include TODO items for export.
`org-export-with-timestamps`	Non-nil means allow timestamps in export.
`org-export-with-title`	Non-nil means print title into the exported file.
`org-export-with-toc`	Non-nil means create a table of contents in exported files.
`org-export-with-todo-keywords`	Non-nil means include TODO keywords in export.

Defined functions (163)

`org-export--annotate-info`	(BACKEND INFO &optional SUBTREEP VISIBLE-ONLY EXT-PLIST)
`org-export--blindly-expand-include`
`org-export--collect-headline-numbering`	(DATA OPTIONS)
`org-export--collect-tree-properties`	(DATA INFO)
`org-export--copy-to-kill-ring-p`	()
`org-export--delete-comment-trees`	()
`org-export--dispatch-action`	(PROMPT ALLOWED-KEYS ENTRIES OPTIONS FIRST-KEY EXPERTP)
`org-export--dispatch-ui`	(OPTIONS FIRST-KEY EXPERTP)
`org-export--expand-links`	(TREE INFO)
`org-export--footnote-reference-map`	(FUNCTION DATA INFO &optional BODY-FIRST)
`org-export--get-buffer-attributes`	()
`org-export--get-export-attributes`	(&optional BACKEND SUBTREEP VISIBLE-ONLY BODY-ONLY)
`org-export--get-global-options`	(&optional BACKEND)
`org-export--get-inbuffer-options`	(&optional BACKEND)
`org-export--get-min-level`	(DATA OPTIONS)
`org-export--get-subtree-options`	(&optional BACKEND)
`org-export--inclusion-absolute-lines`	(FILE LOCATION ONLY-CONTENTS LINES)
`org-export--install-footnote-definitions`	(DEFINITIONS TREE)
`org-export--keep-spaces`	(DATA INFO)
`org-export--list-bound-variables`	()
`org-export--missing-definitions`	(TREE DEFINITIONS)
`org-export--parse-option-keyword`	(OPTIONS &optional BACKEND)
`org-export--prepare-file-contents`	(FILE &optional LINES IND MINLEVEL ID FOOTNOTES INCLUDER)
`org-export--prune-tree`	(DATA INFO)
`org-export--remove-uninterpreted-data`	(DATA INFO)
`org-export--selected-trees`	(DATA INFO)
`org-export--set-variables`	(VARIABLE-ALIST)
`org-export--skip-p`	(DATUM OPTIONS SELECTED EXCLUDED)
`org-export--smart-quote-status`	(S INFO)
`org-export--stack-generate`	()
`org-export--stack-num-predicate`	(A B)
`org-export--stack-source-at-point`	()
`org-export--update-included-link`	(FILE-DIR INCLUDER-DIR)
`org-export-activate-smart-quotes`	(S ENCODING INFO &optional ORIGINAL)
`org-export-add-to-stack`	(SOURCE BACKEND &optional PROCESS)
`org-export-as`	(BACKEND &optional SUBTREEP VISIBLE-ONLY BODY-ONLY EXT-PLIST)
`org-export-async-start`	(FUN BODY)
`org-export-backend-blocks`	(CL-X)
`org-export-backend-blocks--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-filters`	(CL-X)
`org-export-backend-filters--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-menu`	(CL-X)
`org-export-backend-menu--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-name`	(CL-X)
`org-export-backend-name--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-options`	(CL-X)
`org-export-backend-options--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-p`	(CL-X)
`org-export-backend-p--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-parent`	(CL-X)
`org-export-backend-parent--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-backend-transcoders`	(CL-X)
`org-export-backend-transcoders--cmacro`	(CL-WHOLE-ARG CL-X)
`org-export-barf-if-invalid-backend`	(BACKEND)
`org-export-collect-elements`	(TYPE INFO &optional PREDICATE)
`org-export-collect-figures`	(INFO PREDICATE)
`org-export-collect-footnote-definitions`	(INFO &optional DATA BODY-FIRST)
`org-export-collect-headlines`	(INFO &optional N SCOPE)
`org-export-collect-listings`	(INFO)
`org-export-collect-tables`	(INFO)
`org-export-copy-buffer`
`org-export-create-backend`
`org-export-create-backend--cmacro`
`org-export-custom-protocol-maybe`	(LINK DESC BACKEND &optional INFO)
`org-export-data`	(DATA INFO)
`org-export-data-with-backend`	(DATA BACKEND INFO)
`org-export-define-backend`	(BACKEND TRANSCODERS &rest BODY)
`org-export-define-derived-backend`	(CHILD PARENT &rest BODY)
`org-export-derived-backend-p`	(BACKEND &rest BACKENDS)
`org-export-dispatch`	(&optional ARG)
`org-export-excluded-from-toc-p`	(HEADLINE INFO)
`org-export-expand`	(BLOB CONTENTS &optional WITH-AFFILIATED)
`org-export-expand-include-keyword`	(&optional INCLUDED DIR FOOTNOTES INCLUDER-FILE EXPAND-ENV)
`org-export-file-uri`	(FILENAME)
`org-export-filter-apply-functions`	(FILTERS VALUE INFO)
`org-export-first-sibling-p`	(BLOB INFO)
`org-export-footnote-first-reference-p`	(FOOTNOTE-REFERENCE INFO &optional DATA BODY-FIRST)
`org-export-format-code`	(CODE FUN &optional NUM-LINES REF-ALIST)
`org-export-format-code-default`	(ELEMENT INFO)
`org-export-format-reference`	(REFERENCE)
`org-export-get-all-filters`	(BACKEND)
`org-export-get-all-options`	(BACKEND)
`org-export-get-all-transcoders`	(BACKEND)
`org-export-get-alt-title`	(HEADLINE _)
`org-export-get-backend`	(NAME)
`org-export-get-caption`	(ELEMENT &optional SHORT)
`org-export-get-category`	(BLOB INFO)
`org-export-get-coderef-format`	(PATH DESC)
`org-export-get-date`	(INFO &optional FMT)
`org-export-get-environment`	(&optional BACKEND SUBTREEP EXT-PLIST)
`org-export-get-footnote-definition`	(FOOTNOTE-REFERENCE INFO)
`org-export-get-footnote-number`	(FOOTNOTE INFO &optional DATA BODY-FIRST)
`org-export-get-headline-number`	(HEADLINE INFO)
`org-export-get-loc`	(ELEMENT INFO)
`org-export-get-next-element`	(BLOB INFO &optional N)
`org-export-get-node-property`	(PROPERTY DATUM &optional INHERITED)
`org-export-get-ordinal`	(ELEMENT INFO &optional TYPES PREDICATE)
`org-export-get-parent-headline`	(BLOB)
`org-export-get-parent-table`	(OBJECT)
`org-export-get-previous-element`	(BLOB INFO &optional N)
`org-export-get-reference`	(DATUM INFO)
`org-export-get-relative-level`	(HEADLINE INFO)
`org-export-get-table-cell-at`	(ADDRESS TABLE INFO)
`org-export-get-tags`	(ELEMENT INFO &optional TAGS INHERITED)
`org-export-inline-image-p`	(LINK &optional RULES)
`org-export-insert-default-template`	(&optional BACKEND SUBTREEP)
`org-export-insert-image-links`	(DATA INFO &optional RULES)
`org-export-install-filters`	(INFO)
`org-export-last-sibling-p`	(DATUM INFO)
`org-export-link--remote-local-copy`	(LINK)
`org-export-link-localise`	(LINK)
`org-export-link-remote-p`	(LINK)
`org-export-low-level-p`	(HEADLINE INFO)
`org-export-match-search-cell-p`	(DATUM CELLS)
`org-export-new-reference`	(REFERENCES)
`org-export-number-to-roman`	(N)
`org-export-numbered-headline-p`	(HEADLINE INFO)
`org-export-output-file-name`	(EXTENSION &optional SUBTREEP PUB-DIR)
`org-export-parse-include-value`	(VALUE &optional DIR)
`org-export-raw-string`	(S)
`org-export-read-attribute`	(ATTRIBUTE ELEMENT &optional PROPERTY)
`org-export-register-backend`	(BACKEND)
`org-export-replace-region-by`	(BACKEND)
`org-export-resolve-coderef`	(REF INFO)
`org-export-resolve-fuzzy-link`	(LINK INFO &rest PSEUDO-TYPES)
`org-export-resolve-id-link`	(LINK INFO)
`org-export-resolve-link`	(LINK INFO)
`org-export-resolve-radio-link`	(LINK INFO)
`org-export-search-cells`	(DATUM)
`org-export-snippet-backend`	(EXPORT-SNIPPET)
`org-export-stack`	()
`org-export-stack-clear`	()
`org-export-stack-mode`	()
`org-export-stack-refresh`	()
`org-export-stack-remove`	(&optional SOURCE)
`org-export-stack-view`	(&optional IN-EMACS)
`org-export-string-as`	(STRING BACKEND &optional BODY-ONLY EXT-PLIST)
`org-export-string-to-search-cell`	(S)
`org-export-table-cell-address`	(TABLE-CELL INFO)
`org-export-table-cell-alignment`	(TABLE-CELL INFO)
`org-export-table-cell-borders`	(TABLE-CELL INFO)
`org-export-table-cell-ends-colgroup-p`	(TABLE-CELL INFO)
`org-export-table-cell-starts-colgroup-p`	(TABLE-CELL INFO)
`org-export-table-cell-width`	(TABLE-CELL INFO)
`org-export-table-dimensions`	(TABLE INFO)
`org-export-table-has-header-p`	(TABLE INFO)
`org-export-table-has-special-column-p`	(TABLE)
`org-export-table-row-ends-header-p`	(TABLE-ROW INFO)
`org-export-table-row-ends-rowgroup-p`	(TABLE-ROW INFO)
`org-export-table-row-group`	(TABLE-ROW INFO)
`org-export-table-row-in-header-p`	(TABLE-ROW INFO)
`org-export-table-row-is-special-p`	(TABLE-ROW _)
`org-export-table-row-number`	(TABLE-ROW INFO)
`org-export-table-row-starts-header-p`	(TABLE-ROW INFO)
`org-export-table-row-starts-rowgroup-p`	(TABLE-ROW INFO)
`org-export-to-buffer`	(BACKEND BUFFER &optional ASYNC SUBTREEP VISIBLE-ONLY BODY-ONLY EXT-PLIST POST-PROCESS)
`org-export-to-file`	(BACKEND FILE &optional ASYNC SUBTREEP VISIBLE-ONLY BODY-ONLY EXT-PLIST POST-PROCESS)
`org-export-toc-entry-backend`	(PARENT &rest TRANSCODERS)
`org-export-transcoder`	(BLOB INFO)
`org-export-translate`	(S ENCODING INFO)
`org-export-unravel-code`	(ELEMENT)
`org-export-with-backend`	(BACKEND DATA &optional CONTENTS INFO)
`org-export-with-buffer-copy`

File: ox.el.html

Defined variables (125)

Defined functions (163)

Defined faces (0)

File: `ox.el.html`