|
@@ -24,8 +24,9 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
:CUSTOM_ID: attributes
|
|
|
:END:
|
|
|
|
|
|
- Element attributes are accessed with ~org-element-get-property~
|
|
|
- function.
|
|
|
+ Element attributes are accessed with ~org-element-property~
|
|
|
+ function. Other accessors relative to elements are
|
|
|
+ ~org-element-type~ and ~org-element-contents~.
|
|
|
|
|
|
In addition to these properties, each element can optionally get
|
|
|
some more from affiliated keywords, namely: ~:attr_ascii~,
|
|
@@ -186,11 +187,30 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
closing line or at buffer's end (integer).
|
|
|
- ~:hiddenp~ :: Non-nil if block is hidden (symbol:
|
|
|
~org-hide-block~, nil).
|
|
|
+ - ~:label-fmt~ :: Format string used to write labels in current
|
|
|
+ block, if different from
|
|
|
+ ~org-coderef-label-format~ (string or nil).
|
|
|
+ - ~:language~ :: Language of the code in the block, if specified
|
|
|
+ (string or nil).
|
|
|
+ - ~:number-lines~ :: Non-nil if code lines should be numbered.
|
|
|
+ A ~new~ value starts numbering from 1 wheareas ~continued~
|
|
|
+ resume numbering from previous numbered block (symbol: ~new~,
|
|
|
+ ~continued~ or nil).
|
|
|
- ~:options~ :: Block's options located on the block's opening line
|
|
|
(string).
|
|
|
+ - ~:parameters~ :: Optional header arguments (string or nil).
|
|
|
- ~:post-blank~ :: Number of blank lines between block's closing
|
|
|
line and next non-blank line or buffer's end
|
|
|
(integer).
|
|
|
+ - ~:preserve-indent~ :: Non-nil when indentation within the block
|
|
|
+ mustn't be modified upon export (boolean).
|
|
|
+ - ~:retain-labels~ :: Non-nil if labels should be kept visible upon
|
|
|
+ export (boolean).
|
|
|
+ - ~:switches~ :: Optional switches for code block export (string or
|
|
|
+ nil).
|
|
|
+ - ~:use-labels~ :: Non-nil if links to labels contained in the
|
|
|
+ block should display the label instead of the
|
|
|
+ line number (boolean).
|
|
|
- ~:value~ :: Contents (string).
|
|
|
|
|
|
** Export Block
|
|
@@ -511,11 +531,28 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
- ~coderef~ :: Line in some source code,
|
|
|
- ~custom-id~ :: Specific headline's custom-id,
|
|
|
- ~file~ :: External file,
|
|
|
- - ~fuzzy~ :: Target or an headline in the current parse tree,
|
|
|
+ - ~fuzzy~ :: Target, target keyword, a named element or an
|
|
|
+ headline in the current parse tree,
|
|
|
- ~id~ :: Specific headline's id,
|
|
|
- - ~radio~ :: Radio-target,
|
|
|
+ - ~radio~ :: Radio-target.
|
|
|
It can also be any ~org-link-types~ element.
|
|
|
|
|
|
+
|
|
|
+ Notes relative to export:
|
|
|
+
|
|
|
+ - A fuzzy link leading to a target keyword should be ignored during
|
|
|
+ export: it's an invisible target.
|
|
|
+ - A fuzzy link with no description should display the
|
|
|
+ cross-reference number of its target. This number can be:
|
|
|
+ - If link's destination is a target object within a footnote, it
|
|
|
+ will be footnote's number.
|
|
|
+ - If link's destination is a target object in a list, it will be
|
|
|
+ an item number.
|
|
|
+ - If link leads to a named element, it will be the sequence number
|
|
|
+ of that element among named elements of the same type.
|
|
|
+ - Otherwise, it will be the number of the headline containing
|
|
|
+ link's destination.
|
|
|
+
|
|
|
** Macro
|
|
|
|
|
|
Object.
|
|
@@ -684,14 +721,28 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
block's closing line or at buffer's end (integer).
|
|
|
- ~:hiddenp~ :: Non-nil if block is hidden (symbol:
|
|
|
~org-hide-block~ nil).
|
|
|
+ - ~:label-fmt~ :: Format string used to write labels in current
|
|
|
+ block, if different from
|
|
|
+ ~org-coderef-label-format~ (string or nil).
|
|
|
- ~:language~ :: Language of the code in the block, if specified
|
|
|
(string or nil).
|
|
|
+ - ~:number-lines~ :: Non-nil if code lines should be numbered.
|
|
|
+ A ~new~ value starts numbering from 1 wheareas ~continued~
|
|
|
+ resume numbering from previous numbered block (symbol: ~new~,
|
|
|
+ ~continued~ or nil).
|
|
|
- ~:parameters~ :: Optional header arguments (string or nil).
|
|
|
- ~:post-blank~ :: Number of blank lines between block's closing
|
|
|
line and next non-blank line or buffer's end
|
|
|
(integer).
|
|
|
+ - ~:preserve-indent~ :: Non-nil when indentation within the block
|
|
|
+ mustn't be modified upon export (boolean).
|
|
|
+ - ~:retain-labels~ :: Non-nil if labels should be kept visible upon
|
|
|
+ export (boolean).
|
|
|
- ~:switches~ :: Optional switches for code block export (string or
|
|
|
nil).
|
|
|
+ - ~:use-labels~ :: Non-nil if links to labels contained in the
|
|
|
+ block should display the label instead of the
|
|
|
+ line number (boolean).
|
|
|
- ~:value~ :: Source code (string).
|
|
|
|
|
|
** Statistics Cookie
|
|
@@ -764,21 +815,23 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
|
|
|
** Target
|
|
|
|
|
|
- Recursive object.
|
|
|
+ Object.
|
|
|
|
|
|
- ~:begin~ :: Buffer position before first /less-than/ opening sign
|
|
|
(integer).
|
|
|
- - ~:contents-begin~ :: Buffer position after last /less-than/
|
|
|
- opening sign (integer).
|
|
|
- - ~:contents-end~ :: Buffer position before first /greater-than/
|
|
|
- closing sign (integer).
|
|
|
- ~:end~ :: Buffer position before first non-blank character after
|
|
|
last /greater-than/ closing sign, or at paragraph's end
|
|
|
(integer).
|
|
|
- ~:post-blank~ :: Number of white spaces between last
|
|
|
/greater-than/ closing sign and next non-blank
|
|
|
character or paragraph's end (integer).
|
|
|
- - ~:raw-value~ :: Uninterpreted contents (string).
|
|
|
+ - ~:value~ :: Target's ID (string).
|
|
|
+
|
|
|
+
|
|
|
+ Notes relatives to export:
|
|
|
+
|
|
|
+ - Target should become an anchor, if back-end permits it.
|
|
|
+ - Target's ID shouldn't be visible on export.
|
|
|
|
|
|
** Time Stamp
|
|
|
|
|
@@ -901,14 +954,6 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
- category :: option
|
|
|
- type :: alist (STRING . LIST)
|
|
|
|
|
|
-** ~:genealogy~
|
|
|
-
|
|
|
- Flat list of current object or element's parents from closest to
|
|
|
- farthest, along with their contents.
|
|
|
-
|
|
|
- - category :: local
|
|
|
- - type :: list of elements and objects
|
|
|
-
|
|
|
** ~:headline-levels~
|
|
|
:PROPERTIES:
|
|
|
:CUSTOM_ID: headline-levels
|
|
@@ -939,6 +984,14 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
- category :: tree
|
|
|
- type :: integer
|
|
|
|
|
|
+** ~:ignore-list~
|
|
|
+
|
|
|
+ List of elements and objects that will be unconditionally ignored
|
|
|
+ during export.
|
|
|
+
|
|
|
+ - category :: option
|
|
|
+ - type :: list of elements
|
|
|
+
|
|
|
** ~:input-file~
|
|
|
|
|
|
Full path to input file, if any.
|
|
@@ -1157,6 +1210,93 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
- category :: option
|
|
|
- type :: symbol (nil, t)
|
|
|
|
|
|
+* The Filter System
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: filter-system
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Filters sets are lists of functions. They allow to pre-process
|
|
|
+ parse tree before export and to post-process output of each
|
|
|
+ transcoded object or element.
|
|
|
+
|
|
|
+ Each function in a set must accept three arguments: a string (or
|
|
|
+ a parse tree as a special case), a symbol representing the current
|
|
|
+ back-end, and the communication channel, as a plist.
|
|
|
+
|
|
|
+ From the developer side, filters sets can be installed in the
|
|
|
+ process with the help of ~org-BACKEND-filters-alist~ variable. Each
|
|
|
+ association has a key among the following symbols and a function or
|
|
|
+ a list of functions as value:
|
|
|
+
|
|
|
+ - ~:filter-babel-call~
|
|
|
+ - ~:filter-center-block~
|
|
|
+ - ~:filter-comment~
|
|
|
+ - ~:filter-comment-block~
|
|
|
+ - ~:filter-drawer~
|
|
|
+ - ~:filter-dynamic-block~
|
|
|
+ - ~:filter-emphasis~
|
|
|
+ - ~:filter-entity~
|
|
|
+ - ~:filter-example-block~
|
|
|
+ - ~:filter-export-block~
|
|
|
+ - ~:filter-export-snippet~
|
|
|
+ - ~:filter-final-output~
|
|
|
+ - ~:filter-fixed-width~
|
|
|
+ - ~:filter-footnote-definition~
|
|
|
+ - ~:filter-footnote-reference~
|
|
|
+ - ~:filter-headline~
|
|
|
+ - ~:filter-horizontal-rule~
|
|
|
+ - ~:filter-inline-babel-call~
|
|
|
+ - ~:filter-inline-src-block~
|
|
|
+ - ~:filter-inlinetask~
|
|
|
+ - ~:filter-item~
|
|
|
+ - ~:filter-keyword~
|
|
|
+ - ~:filter-latex-environment~
|
|
|
+ - ~:filter-latex-fragment~
|
|
|
+ - ~:filter-line-break~
|
|
|
+ - ~:filter-link~
|
|
|
+ - ~:filter-macro~
|
|
|
+ - ~:filter-paragraph~
|
|
|
+ - ~:filter-parse-tree~
|
|
|
+ - ~:filter-plain-list~
|
|
|
+ - ~:filter-plain-text~
|
|
|
+ - ~:filter-property-drawer~
|
|
|
+ - ~:filter-quote-block~
|
|
|
+ - ~:filter-quote-section~
|
|
|
+ - ~:filter-radio-target~
|
|
|
+ - ~:filter-section~
|
|
|
+ - ~:filter-special-block~
|
|
|
+ - ~:filter-src-block~
|
|
|
+ - ~:filter-statistics-cookie~
|
|
|
+ - ~:filter-subscript~
|
|
|
+ - ~:filter-superscript~
|
|
|
+ - ~:filter-table~
|
|
|
+ - ~:filter-target~
|
|
|
+ - ~:filter-time-stamp~
|
|
|
+ - ~:filter-verbatim~
|
|
|
+ - ~:filter-verse-block~
|
|
|
+
|
|
|
+
|
|
|
+ For example, =e-ascii= back-end implements a filter that makes sure
|
|
|
+ sections end with two blank lines:
|
|
|
+
|
|
|
+ #+BEGIN_SRC emacs-lisp
|
|
|
+ (defun org-e-ascii-filter-section-blank-lines (headline back-end info)
|
|
|
+ "Filter controlling number of blank lines after a section."
|
|
|
+ (if (not (eq back-end 'e-ascii)) headline
|
|
|
+ (let ((blanks (make-string 2 ?\n)))
|
|
|
+ (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline))))
|
|
|
+ #+END_SRC
|
|
|
+
|
|
|
+ The filter is then installed with the following:
|
|
|
+
|
|
|
+ #+BEGIN_SRC emacs-lisp
|
|
|
+ (defconst org-e-ascii-filters-alist
|
|
|
+ '((:filter-headline . org-e-ascii-filter-section-blank-lines)
|
|
|
+ (:filter-section . org-e-ascii-filter-section-blank-lines))
|
|
|
+ "Alist between filters keywords and back-end specific filters.
|
|
|
+ See `org-export-filters-alist' for more information.")
|
|
|
+ #+END_SRC
|
|
|
+
|
|
|
* The Toolbox
|
|
|
:PROPERTIES:
|
|
|
:CUSTOM_ID: toolbox
|
|
@@ -1264,6 +1404,31 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
See also: [[#get-relative-level][~org-export-get-relative-level~]],
|
|
|
[[#number-to-roman][~org-export-number-to-roman~]], [[#last-sibling-p][~org-export-last-sibling-p~]].
|
|
|
|
|
|
+** ~org-export-format-code~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: format-code
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Helper function to format source code. It applies a given function
|
|
|
+ on each line of the code, passing current line number and
|
|
|
+ associated code reference label, if any, as arguments.
|
|
|
+
|
|
|
+ See also: [[#format-code-default][~org-export-format-code-default~]], [[#get-loc][~org-export-get-loc~]],
|
|
|
+ [[#unravel-code][~org-export-unravel-code~]].
|
|
|
+
|
|
|
+** ~org-export-format-code-default~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: format-code-default
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Return contents of a =src-block= or =example-block= element in
|
|
|
+ a format suited for raw text or verbatim output. More
|
|
|
+ specifically, it takes care of line numbering and labels
|
|
|
+ integration depending of element's switches, but no formatting is
|
|
|
+ otherwise applied to source code.
|
|
|
+
|
|
|
+ See also: [[#format-code][~org-export-format-code~]], [[#unravel-code][~org-export-unravel-code~]].
|
|
|
+
|
|
|
** ~org-export-footnote-first-reference-p~
|
|
|
:PROPERTIES:
|
|
|
:CUSTOM_ID: footnote-first-reference-p
|
|
@@ -1314,6 +1479,19 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
[[#footnote-first-reference-p][~org-export-footnote-first-reference-p~]],
|
|
|
[[#get-footnote-definition][~org-export-get-footnote-definition~]].
|
|
|
|
|
|
+** ~org-export-get-genealogy~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: get-genealogy
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Return flat list of current object or element's parents from
|
|
|
+ closest to farthest, along with their contents.
|
|
|
+
|
|
|
+ See also: [[#get-next-element][~org-export-get-next-element]], [[#get-parent][~org-export-get-parent]],
|
|
|
+ [[#get-parent-headline][~org-export-get-parent-headline~]],
|
|
|
+ [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
|
|
|
+ [[#get-previous-element][~org-export-get-previous-element~]].
|
|
|
+
|
|
|
** ~org-export-get-headline-number~
|
|
|
:PROPERTIES:
|
|
|
:CUSTOM_ID: get-headline-number
|
|
@@ -1321,7 +1499,23 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
|
|
|
Return the section number of an headline, as a list of integers.
|
|
|
|
|
|
- See also: [[#number-to-roman][~org-export-number-to-roman~]].
|
|
|
+ See also: [[#headline-numbered-p][~org-export-headline-numbered-p~]],
|
|
|
+ [[#number-to-roman][~org-export-number-to-roman~]].
|
|
|
+
|
|
|
+** ~org-export-get-loc~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: get-loc
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Return count of accumulated lines of code from previous
|
|
|
+ line-numbered =example-block= and =src-block= elements, according
|
|
|
+ to current element's switches.
|
|
|
+
|
|
|
+ In other words, the first line of code in the current block is
|
|
|
+ supposed to be numbered as the returned value plus one, assuming
|
|
|
+ its ~:number-lines~ properties is non-nil.
|
|
|
+
|
|
|
+ See also: [[#format-code][~org-export-format-code~]], [[#unravel-code][~org-export-unravel-code~]].
|
|
|
|
|
|
** ~org-export-get-next-element~
|
|
|
:PROPERTIES:
|
|
@@ -1331,27 +1525,84 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
Return element (resp. object or string) after an element
|
|
|
(resp. object), or nil.
|
|
|
|
|
|
- See also: [[#get-previous-element][~org-export-get-previous-element~]],
|
|
|
- [[#get-parent-headline][~org-export-get-parent-headline~]].
|
|
|
+ See also: [[#get-genealogy][~org-export-get-genealogy~]], [[#get-parent][~org-export-get-parent~]],
|
|
|
+ [[#get-parent-headline][~org-export-get-parent-headline~]],
|
|
|
+ [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
|
|
|
+ [[#get-previous-element][~org-export-get-previous-element~]].
|
|
|
|
|
|
** ~org-export-get-ordinal~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: get-ordinal
|
|
|
+ :END:
|
|
|
|
|
|
- Associate a sequence number to any object or element.
|
|
|
+ Associate a sequence number to any object or element. It is meant
|
|
|
+ to be used to build captions.
|
|
|
+
|
|
|
+ Also, it could be applied on a fuzzy link's destination, since such
|
|
|
+ links are expected to be replaced with the sequence number of their
|
|
|
+ destination, provided they have no description.
|
|
|
+
|
|
|
+ Taken from =e-ascii= back-end, the following example shows how
|
|
|
+ fuzzy links could be handled :
|
|
|
+
|
|
|
+ #+BEGIN_SRC emacs-lisp :exports code
|
|
|
+ (let ((type (org-element-property :type link)))
|
|
|
+ (cond
|
|
|
+ ...
|
|
|
+ ;; Do not apply a special syntax on fuzzy links pointing to targets.
|
|
|
+ ((string= type "fuzzy")
|
|
|
+ (let ((destination (org-export-resolve-fuzzy-link link info)))
|
|
|
+ ;; Ignore invisible "#+TARGET: path".
|
|
|
+ (unless (eq (org-element-type destination) 'keyword)
|
|
|
+ ;; If link has a description, use it.
|
|
|
+ (if (org-string-nw-p desc) desc
|
|
|
+ (when destination
|
|
|
+ (let ((number (org-export-get-ordinal destination info)))
|
|
|
+ (when number
|
|
|
+ (if (atom number) (number-to-string number)
|
|
|
+ (mapconcat 'number-to-string number ".")))))))))
|
|
|
+ ...))
|
|
|
+ #+END_SRC
|
|
|
+
|
|
|
+ See also : [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]]
|
|
|
+
|
|
|
+** ~org-export-get-parent~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: get-parent
|
|
|
+ :END:
|
|
|
|
|
|
- This isn't appropriate for footnotes references, whose sequence
|
|
|
- isn't always linear. In that case, use
|
|
|
- [[#get-footnote-number][~org-export-get-footnote-number~]] instead.
|
|
|
+ Return closest element containing current element or object, if
|
|
|
+ any. Return nil otherwise.
|
|
|
+
|
|
|
+ See also: [[#get-genealogy][~org-export-get-genealogy~]],
|
|
|
+ [[#get-next-element][~org-export-get-next-element~]], [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
|
|
|
+ [[#get-parent-headline][~org-export-get-parent-headline~]],
|
|
|
+ [[#get-previous-element][~org-export-get-previous-element~]].
|
|
|
|
|
|
** ~org-export-get-parent-headline~
|
|
|
:PROPERTIES:
|
|
|
- :CUSTOM_ID: #get-parent-headline
|
|
|
+ :CUSTOM_ID: get-parent-headline
|
|
|
:END:
|
|
|
|
|
|
Return the headline containing provided element or object, if any.
|
|
|
Return nil otherwise.
|
|
|
|
|
|
- See also: [[#get-previous-element][~org-export-get-previous-element~]],
|
|
|
- [[#get-next-element][~org-export-get-next-element~]].
|
|
|
+ See also: [[#get-genealogy][~org-export-get-genealogy~]],
|
|
|
+ [[#get-next-element][~org-export-get-next-element~]], [[#get-parent][~org-export-get-parent]],
|
|
|
+ [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
|
|
|
+ [[#get-previous-element][~org-export-get-previous-element~]].
|
|
|
+
|
|
|
+** ~org-export-get-parent-paragraph~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: get-parent-paragraph
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Return the paragraph containing provided object, if any. Return
|
|
|
+ nil otherwise.
|
|
|
+
|
|
|
+ See also: [[#get-genealogy][~org-export-get-genealogy~]], [[#get-parent][~org-export-get-parent~]],
|
|
|
+ [[#get-parent-headline][~org-export-get-parent-headline~]],
|
|
|
+ [[#get-previous-element][~org-export-get-previous-element~]], [[#get-next-element][~org-export-get-next-element~]].
|
|
|
|
|
|
** ~org-export-get-previous-element~
|
|
|
:PROPERTIES:
|
|
@@ -1361,8 +1612,10 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
Return element (resp. object or string) before an element
|
|
|
(resp. object), or nil.
|
|
|
|
|
|
- See also: [[#get-next-element][~org-export-get-next-element~]],
|
|
|
- [[#get-parent-headline][~org-export-get-parent-headline~]].
|
|
|
+ See also: [[#get-genealogy][~org-export-get-genealogy~]],
|
|
|
+ [[#get-next-element][~org-export-get-next-element~]], [[#get-parent][~org-export-get-parent~]],
|
|
|
+ [[#get-parent-headline][~org-export-get-parent-headline~]],
|
|
|
+ [[#get-parent-paragraph][~org-export-get-parent-paragraph~]].
|
|
|
|
|
|
** ~org-export-get-relative-level~
|
|
|
:PROPERTIES:
|
|
@@ -1373,16 +1626,19 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
the parsed tree. It is meant to be used over ~:level~ headline's
|
|
|
property.
|
|
|
|
|
|
- See also: [[#get-headline-number][~org-export-get-headline-number~]],
|
|
|
- [[#first-sibling-p][~org-export-first-sibling-p~]], [[#last-sibling-p][~org-export-last-sibling-p~]].
|
|
|
+ See also:[[#first-sibling-p][~org-export-first-sibling-p~]],
|
|
|
+ [[#get-headline-number][~org-export-get-headline-number~]],[[#headline-numbered-p][~org-export-headline-numbered-p~]],
|
|
|
+ [[#last-sibling-p][~org-export-last-sibling-p~]].
|
|
|
|
|
|
-** ~org-export-handle-code~
|
|
|
+** ~org-export-headline-numbered-p~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: headline-numbered-p
|
|
|
+ :END:
|
|
|
|
|
|
- Update line numbering and clean references in source code, when
|
|
|
- appropriate. It can also add text properties to format source code
|
|
|
- only after some processing.
|
|
|
+ Non nil when a given headline should be numbered.
|
|
|
|
|
|
- See also: [[#resolve-coderef][~org-export-resolve-coderef~]].
|
|
|
+ See also: [[#get-headline-number][~org-export-get-headline-number~]],
|
|
|
+ [[#get-relative-level][~org-export-get-relative-level~]].
|
|
|
|
|
|
** ~org-export-inline-image-p~
|
|
|
:PROPERTIES:
|
|
@@ -1390,7 +1646,8 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
:END:
|
|
|
|
|
|
Non-nil when the link provided should be considered as an inline
|
|
|
- image.
|
|
|
+ image. It also accepts an optional set of rules in order to tweak
|
|
|
+ the definition of an inline image.
|
|
|
|
|
|
See also: [[#solidify-link-text][~org-export-solidify-link-text~]],
|
|
|
[[#get-coderef-format][~org-export-get-coderef-format~]], [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]].
|
|
@@ -1424,8 +1681,8 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
:END:
|
|
|
|
|
|
Search for a code reference within ~src-block~ and ~example-block~
|
|
|
- elements. Return corresponding –possibly accumulated— line number,
|
|
|
- or reference itself, depending on container's switches.
|
|
|
+ elements. Return corresponding --possibly accumulated-- line
|
|
|
+ number, or reference itself, depending on container's switches.
|
|
|
|
|
|
See also : [[#get-coderef-format][~org-export-get-coderef-format~]],
|
|
|
[[#resolve-id-link][~org-export-resolve-id-link~]], [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]].
|
|
@@ -1439,7 +1696,7 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
attribute – within the parsed tree, and return that element,
|
|
|
object, or nil.
|
|
|
|
|
|
- See also: [[#resolve-coderef][~org-export-resolve-coderef~]],
|
|
|
+ See also: [[#get-ordinal][~org-export-get-ordinal~]], [[#resolve-coderef][~org-export-resolve-coderef~]],
|
|
|
[[#resolve-id-link][~org-export-resolve-id-link~]], [[#solidify-link-text][~org-export-solidify-link-text~]].
|
|
|
|
|
|
** ~org-export-resolve-id-link~
|
|
@@ -1454,6 +1711,22 @@ and [[#toolbox][tools]] provided by the exporter.
|
|
|
See also : [[#resolve-coderef][~org-export-resolve-coderef~]],
|
|
|
[[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]], [[#solidify-link-text][~org-export-solidify-link-text~]].
|
|
|
|
|
|
+** ~org-export-unravel-code~
|
|
|
+ :PROPERTIES:
|
|
|
+ :CUSTOM_ID: unravel-code
|
|
|
+ :END:
|
|
|
+
|
|
|
+ Clean source code from an =example-block= or a =src-block= element
|
|
|
+ and extract code references out of it.
|
|
|
+
|
|
|
+ Its purpose is to allow to transform raw source code first and then
|
|
|
+ integrate line numbers or references back into the final output.
|
|
|
+ That final task can be achieved with the help of
|
|
|
+ ~org-export-format-code~ function.
|
|
|
+
|
|
|
+ See also: [[#format-code][~org-export-format-code~]],
|
|
|
+ [[#format-code-default][~org-export-format-code-default~]], [[#get-loc][~org-export-get-loc~]].
|
|
|
+
|
|
|
** ~org-export-solidify-link-text~
|
|
|
:PROPERTIES:
|
|
|
:CUSTOM_ID: solidify-link-text
|