Org API
Table of Contents
- Org-E-ASCII API functions (org-e-ascii.el)
- org-e-ascii-bold
bold contents info - org-e-ascii-center-block
center-block contents info - org-e-ascii-clock
clock contents info - org-e-ascii-code
code contents info - org-e-ascii-drawer
drawer contents info - org-e-ascii-dynamic-block
dynamic-block contents info - org-e-ascii-entity
entity contents info - org-e-ascii-example-block
example-block contents info - org-e-ascii-export-block
export-block contents info - org-e-ascii-export-snippet
export-snippet contents info - org-e-ascii-export-to-ascii
&optional subtreep visible-only body-only ext-plist pub-dir - org-e-ascii-filter-headline-blank-lines
headline back-end info - org-e-ascii-fixed-width
fixed-width contents info - org-e-ascii-footnote-reference
footnote-reference contents info - org-e-ascii-headline
headline contents info - org-e-ascii-horizontal-rule
horizontal-rule contents info - org-e-ascii-inline-src-block
inline-src-block contents info - org-e-ascii-inlinetask
inlinetask contents info - org-e-ascii-italic
italic contents info - org-e-ascii-item
item contents info - org-e-ascii-keyword
keyword contents info - org-e-ascii-latex-environment
latex-environment contents info - org-e-ascii-latex-fragment
latex-fragment contents info - org-e-ascii-line-break
line-break contents info - org-e-ascii-link
link desc info - org-e-ascii-macro
macro contents info - org-e-ascii-paragraph
paragraph contents info - org-e-ascii-plain-list
plain-list contents info - org-e-ascii-plain-text
text info - org-e-ascii-planning
planning contents info - org-e-ascii-quote-block
quote-block contents info - org-e-ascii-quote-section
quote-section contents info - org-e-ascii-radio-target
radio-target contents info - org-e-ascii-section
section contents info - org-e-ascii-special-block
special-block contents info - org-e-ascii-src-block
src-block contents info - org-e-ascii-statistics-cookie
statistics-cookie contents info - org-e-ascii-strike-through
strike-through contents info - org-e-ascii-subscript
subscript contents info - org-e-ascii-superscript
superscript contents info - org-e-ascii-table
table contents info - org-e-ascii-table-cell
table-cell contents info - org-e-ascii-table-row
table-row contents info - org-e-ascii-template
contents info - org-e-ascii-timestamp
timestamp contents info - org-e-ascii-underline
underline contents info - org-e-ascii-verbatim
verbatim contents info - org-e-ascii-verse-block
verse-block contents info
- org-e-ascii-bold
Org-E-ASCII API functions (org-e-ascii.el)
org-e-ascii-bold bold contents info
Transcode bold from Org to ASCII.
contents is the text with bold markup. info is a plist holding
contextual information.
org-e-ascii-center-block center-block contents info
Transcode a center-block element from Org to ASCII.
contents holds the contents of the block. info is a plist
holding contextual information.
org-e-ascii-clock clock contents info
Transcode a clock object from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-code code contents info
Return a code object from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-drawer drawer contents info
Transcode a drawer element from Org to ASCII.
contents holds the contents of the block. info is a plist
holding contextual information.
org-e-ascii-dynamic-block dynamic-block contents info
Transcode a dynamic-block element from Org to ASCII.
contents holds the contents of the block. info is a plist
holding contextual information.
org-e-ascii-entity entity contents info
Transcode an entity object from Org to ASCII.
contents are the definition itself. info is a plist holding
contextual information.
org-e-ascii-example-block example-block contents info
Transcode a example-block element from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-export-block export-block contents info
Transcode a export-block element from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-export-snippet export-snippet contents info
Transcode a export-snippet object from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-export-to-ascii &optional subtreep visible-only body-only ext-plist pub-dir
Export current buffer to a text file.
If narrowing is active in the current buffer, only export its narrowed part.
If a region is active, export that region.
When optional argument subtreep is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument visible-only is non-nil, don't export
contents of hidden elements.
When optional argument body-only is non-nil, strip title, table
of contents and footnote definitions from output.
ext-plist, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
When optional argument pub-dir is set, use it as the publishing
directory.
Return output file's name.
org-e-ascii-filter-headline-blank-lines headline back-end info
Filter controlling number of blank lines after an headline.
headline is a string representing a transcoded headline.
back-end is symbol specifying back-end used for export. info is
plist containing the communication channel.
This function only applies to e-ascii back-end. See org-e-ascii-headline-spacing for information.
For any other back-end, headline is returned as-is.
org-e-ascii-fixed-width fixed-width contents info
Transcode a fixed-width element from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-footnote-reference footnote-reference contents info
Transcode a footnote-reference element from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-headline headline contents info
Transcode an headline element from Org to ASCII.
contents holds the contents of the headline. info is a plist
holding contextual information.
org-e-ascii-horizontal-rule horizontal-rule contents info
Transcode an horizontal-rule object from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-inline-src-block inline-src-block contents info
Transcode an inline-src-block element from Org to ASCII.
contents holds the contents of the item. info is a plist holding
contextual information.
org-e-ascii-inlinetask inlinetask contents info
Transcode an inlinetask element from Org to ASCII.
contents holds the contents of the block. info is a plist
holding contextual information.
org-e-ascii-italic italic contents info
Transcode italic from Org to ASCII.
contents is the text with italic markup. info is a plist holding
contextual information.
org-e-ascii-item item contents info
Transcode an item element from Org to ASCII.
contents holds the contents of the item. info is a plist holding
contextual information.
org-e-ascii-keyword keyword contents info
Transcode a keyword element from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-latex-environment latex-environment contents info
Transcode a latex-environment element from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-latex-fragment latex-fragment contents info
Transcode a latex-fragment object from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-line-break line-break contents info
Transcode a line-break object from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-link link desc info
Transcode a link object from Org to ASCII.
desc is the description part of the link, or the empty string.
info is a plist holding contextual information.
org-e-ascii-macro macro contents info
Transcode a macro element from Org to ASCII.
contents is nil. info is a plist holding contextual
information.
org-e-ascii-paragraph paragraph contents info
Transcode a paragraph element from Org to ASCII.
contents is the contents of the paragraph, as a string. info is
the plist used as a communication channel.
org-e-ascii-plain-list plain-list contents info
Transcode a plain-list element from Org to ASCII.
contents is the contents of the list. info is a plist holding
contextual information.
org-e-ascii-plain-text text info
Transcode a text string from Org to ASCII.
info is a plist used as a communication channel.
org-e-ascii-planning planning contents info
Transcode a planning element from Org to ASCII.
contents is nil. info is a plist used as a communication
channel.
org-e-ascii-quote-block quote-block contents info
Transcode a quote-block element from Org to ASCII.
contents holds the contents of the block. info is a plist
holding contextual information.
org-e-ascii-quote-section quote-section contents info
Transcode a quote-section element from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-radio-target radio-target contents info
Transcode a radio-target object from Org to ASCII.
contents is the contents of the target. info is a plist holding
contextual information.
org-e-ascii-section section contents info
Transcode a section element from Org to ASCII.
contents is the contents of the section. info is a plist holding
contextual information.
org-e-ascii-special-block special-block contents info
Transcode a special-block element from Org to ASCII.
contents holds the contents of the block. info is a plist
holding contextual information.
org-e-ascii-src-block src-block contents info
Transcode a src-block element from Org to ASCII.
contents holds the contents of the item. info is a plist holding
contextual information.
org-e-ascii-statistics-cookie statistics-cookie contents info
Transcode a statistics-cookie object from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-strike-through strike-through contents info
Transcode strike-through from Org to ASCII.
contents is text with strike-through markup. info is a plist
holding contextual information.
org-e-ascii-subscript subscript contents info
Transcode a subscript object from Org to ASCII.
contents is the contents of the object. info is a plist holding
contextual information.
org-e-ascii-superscript superscript contents info
Transcode a superscript object from Org to ASCII.
contents is the contents of the object. info is a plist holding
contextual information.
org-e-ascii-table table contents info
Transcode a table element from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-table-cell table-cell contents info
Transcode a table-cell object from Org to ASCII.
contents is the cell contents. info is a plist used as
a communication channel.
org-e-ascii-table-row table-row contents info
Transcode a table-row element from Org to ASCII.
contents is the row contents. info is a plist used as
a communication channel.
org-e-ascii-template contents info
Return complete document string after ASCII conversion.
contents is the transcoded contents string. info is a plist
holding export options.
org-e-ascii-timestamp timestamp contents info
Transcode a timestamp object from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-underline underline contents info
Transcode underline from Org to ASCII.
contents is the text with underline markup. info is a plist
holding contextual information.
org-e-ascii-verbatim verbatim contents info
Return a verbatim object from Org to ASCII.
contents is nil. info is a plist holding contextual information.
org-e-ascii-verse-block verse-block contents info
Transcode a verse-block element from Org to ASCII.
contents is verse block contents. info is a plist holding
contextual information.