d82b951ca2e1a1e5fa4f5468b4e57b0cf4e51152
[worg.git] / dev / org-export-reference.org
1 #+TITLE:      Org Export Reference Documentation
2 #+AUTHOR:     Nicolas Goaziou
3 #+EMAIL:      n.goaziou AT gmail DOT com
4 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
5 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
6 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
7 #+TAGS:       Write(w) Update(u) Fix(f) Check(c) NEW(n)
8 #+LANGUAGE:   en
9 #+PRIORITIES: A C B
10 #+CATEGORY:   worg
11
12 [[file:../index.org][{Back to Worg's index}]]
13
14 This document is aimed at back-end developers for the generic export
15 engine =org-export.el=.  It assumes a good understanding of Org
16 syntax --- as specified by /Org Elements/ --- from the reader.
17
18 It covers [[#back-end][back-end creation]] process, all [[#attributes][attributes]] associated to each
19 element or object type, properties offered by the [[#communication][communication
20 channel]] during export, the [[#filter-system][filter system]] internals and [[#toolbox][tools]] provided
21 by the exporter.
22
23
24 * Defining a Back-End
25
26   A back-end is defined with ~org-export-define-backend~ macro.  It
27   requires two mandatory arguments: the back-end name and its
28   translation table, an alist that associates element and object types
29   to translator functions.  According to the macro doc-string:
30
31   #+BEGIN_QUOTE
32   These functions should return a string without any trailing space,
33   or nil.  They must accept three arguments: the object or element
34   itself, its contents or nil when it isn't recursive and the property
35   list used as a communication channel.
36
37   Contents, when not nil, are stripped from any global indentation
38   (although the relative one is preserved).  They also always end with
39   a single newline character.
40
41   If, for a given type, no function is found, that element or object
42   type will simply be ignored, along with any blank line or white
43   space at its end.  The same will happen if the function returns the
44   nil value.  If that function returns the empty string, the type will
45   be ignored, but the blank lines or white spaces will be kept.
46
47   In addition to element and object types, one function can be
48   associated to the ~template~ symbol and another one to the
49   ~plain-text~ symbol.
50
51   The former returns the final transcoded string, and can be used to
52   add a preamble and a postamble to document's body.  It must accept
53   two arguments: the transcoded string and the property list
54   containing export options.
55
56   The latter, when defined, is to be called on every text not
57   recognized as an element or an object.  It must accept two
58   arguments: the text string and the information channel.  It is an
59   appropriate place to protect special chars relative to the back-end.
60   #+END_QUOTE
61
62   Optionally, the macro can set-up back-end specific properties (like
63   values from specific buffer keywords) accessible from every
64   translator function with the ~:options-alist~ keyword.  See
65   ~org-export-options-alist~ for details on the structure of the
66   value.
67
68   As an example, the following excerpt from =e-latex= back-end
69   definition introduces three new buffer keywords (and their
70   headline's property counterpart), and redefine ~DATE~ default value:
71
72   #+BEGIN_SRC emacs-lisp
73   (org-export-define-backend e-latex
74     ...
75     :options-alist ((:date "DATE" nil org-e-latex-date-format t)
76                     (:latex-class "LATEX_CLASS" nil org-e-latex-default-class t)
77                     (:latex-class-options "LATEX_CLASS_OPTIONS" nil nil t)
78                     (:latex-header-extra "LATEX_HEADER" nil nil newline)))
79   #+END_SRC
80
81   It is also possible, with ~:export-block~ keyword, to associate
82   given block names to the ~export-block~ type.  Such blocks can
83   contain raw code that will be directly inserted in the output, as
84   long as the corresponding translator function says so.
85
86   In the following example, in the ~e-html~ back-end, =HTML= blocks
87   are export blocks.  The associated translator function inserts their
88   contents as-is, and ignores any other export block.
89
90   #+BEGIN_SRC emacs-lisp
91   (org-export-define-backend e-html
92     (...
93      (export-block . org-e-html-export-block)
94      ... )
95     :export-block "HTML")
96
97   (defun org-e-html-export-block (export-block contents info)
98     "Transcode a EXPORT-BLOCK element from Org to HTML.
99   CONTENTS is nil.  INFO is a plist used as a communication
100   channel."
101     (when (string= (org-element-property :type export-block) "HTML")
102       (org-element-property :value export-block)))
103   #+END_SRC
104
105   Eventually ~org-export-define-backend~ allows to define back-ends
106   specific filters.  Refer to [[#filter-system][The Filter System]] section for more
107   information.
108
109   If the new back-end shares most properties with another one,
110   ~org-export-define-derived-backend~ macro can be used to simplify
111   the process.  In the example below, we implement a new back-end
112   which behaves like =e-latex= excepted for headlines and the
113   template.
114
115   #+BEGIN_SRC emacs-lisp
116   (org-export-define-derived-backend my-latex e-latex
117     :translate-alist ((headline . custom-headline-translator)
118                       (template . custom-template)))
119   #+END_SRC
120
121   Back-ends defined with either function can be registered in the
122   export dispatcher using special keyword =:menu-entry= (and also
123   =:sub-menu-entry= for a derived back-end).  See macros docstrings
124   for more information.
125
126 * Elements Attributes
127   :PROPERTIES:
128   :CUSTOM_ID: attributes
129   :END:
130
131   Element attributes are accessed with ~org-element-property~
132   function.  Other accessors relative to elements are
133   ~org-element-type~ and ~org-element-contents~.
134
135   Each greater element, element and object has a fixed set of
136   properties attached to it.  Among them, four are shared by all
137   types: ~:begin~ and ~:end~, which refer to the beginning and ending
138   buffer positions of the considered element or object, ~:post-blank~,
139   which holds the number of blank lines, or white spaces, at its end
140   and ~:parent~ which refers to the element or object containing it.
141
142   Greater elements, elements and objects containing objects will have
143   ~:contents-begin~ and ~:contents-end~ properties to delimit
144   contents.  Greater elements and elements accepting affiliated
145   keywords will also have a ~:post-affiliated~ property, referring to
146   the buffer position after any affiliated keyword, when applicable.
147
148   In addition to these properties, each element can optionally get
149   some more from affiliated keywords, namely: ~:attr_ascii~,
150   ~:attr_docbook~, ~:attr_html~, ~:attr_latex~, ~:attr_odt~,
151   ~:caption~, ~:header~, ~:name~, ~:plot~, and ~:results~.
152
153   At the lowest level, a ~:parent~ property is also attached to any
154   string, as a text property.
155
156   Other properties, specific to each element or object, are listed
157   below.
158
159 ** Babel Call
160
161    Element.
162
163    - ~:info~ :: Information about function being called, as returned
164                 by ~ob-babel-lob-get-info~ (string).
165 ** Bold
166
167    Recursive object.
168
169    No specific property.
170
171 ** Center Block
172
173    Greater element.
174
175    - ~:hiddenp~ :: Non-nil if the block is hidden (boolean).
176
177 ** Clock
178
179    Element.
180
181    - ~:duration~ :: Clock duration for a closed clock, or nil (string
182                     or nil).
183    - ~:status~ :: Status of current clock (symbol: ~closed~ or
184                   ~running~).
185    - ~:value~ :: Timestamp associated to clock keyword (timestamp
186                  object).
187
188 ** Code
189
190    Object.
191
192    - ~:value~ :: Contents (string).
193
194 ** Comment
195
196    Element.
197
198    - ~:value~ :: Comments, with pound signs (string).
199
200 ** Comment Block
201
202    Element.
203
204    - ~:value~ :: Comments, without block's boundaries (string).
205    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
206
207 ** Diary Sexp
208
209    Element.
210
211    - ~:value~ :: Full Sexp (string).
212
213 ** Drawer
214
215    Greater element.
216
217    - ~:drawer-name~ :: Drawer's name (string).
218    - ~:hiddenp~ :: Non-nil if the drawer is hidden (boolean).
219
220    /Note relative to export:/ The idea behind drawers is that they are
221    transparent export-wise.  By default, they should return their
222    contents only.
223
224 ** Dynamic Block
225
226    Greater element.
227
228    - ~:arguments~ :: Block's parameters (string).
229    - ~:block-name~ :: Block's name (string).
230    - ~:drawer-name~ :: Drawer's name (string).
231    - ~:hiddenp~ :: Non-nil if the block is hidden (boolean).
232
233 ** Entity
234
235    Object.
236
237    - ~:ascii~ :: Entity's ASCII representation (string).
238    - ~:html~ :: Entity's HTML representation (string).
239    - ~:latex~ :: Entity's LaTeX representation (string).
240    - ~:latex-math-p~ :: Non-nil if entity's LaTeX representation
241         should be in math mode (boolean).
242    - ~:latin1~ :: Entity's Latin-1 encoding representation (string).
243    - ~:name~ :: Entity's name, without backslash nor brackets
244                 (string).
245    - ~:use-brackets-p~ :: Non-nil if entity is written with optional
246         brackets in original buffer (boolean).
247    - ~:utf-8~ :: Entity's UTF-8 encoding representation (string).
248
249 ** Example Block
250
251    Element.
252
253    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
254    - ~:label-fmt~ :: Format string used to write labels in current
255                      block, if different from
256                      ~org-coderef-label-format~ (string or nil).
257    - ~:language~ :: Language of the code in the block, if specified
258                     (string or nil).
259    - ~:number-lines~ :: Non-nil if code lines should be numbered.
260         A ~new~ value starts numbering from 1 wheareas ~continued~
261         resume numbering from previous numbered block (symbol: ~new~,
262         ~continued~ or nil).
263    - ~:options~ :: Block's options located on the block's opening line
264                    (string).
265    - ~:parameters~ :: Optional header arguments (string or nil).
266    - ~:preserve-indent~ :: Non-nil when indentation within the block
267         mustn't be modified upon export (boolean).
268    - ~:retain-labels~ :: Non-nil if labels should be kept visible upon
269         export (boolean).
270    - ~:switches~ :: Optional switches for code block export (string or
271                     nil).
272    - ~:use-labels~ :: Non-nil if links to labels contained in the
273                       block should display the label instead of the
274                       line number (boolean).
275    - ~:value~ :: Contents (string).
276
277 ** Export Block
278
279    Element.
280
281    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
282    - ~:type~ :: Related back-end's name (string).
283    - ~:value~ :: Contents (string).
284
285 ** Export Snippet
286
287    Object.
288
289    - ~:back-end~ :: Relative back-end's name (string).
290    - ~:value~ :: Export code (string).
291
292 ** Fixed Width
293
294    Element.
295
296    - ~:value~ :: Contents, with colons (string).
297
298 ** Footnote Definition
299
300    Greater element.
301
302    - ~:label~ :: Label used for references (string).
303
304 ** Footnote Reference
305
306    Object.
307
308    - ~:inline-definition~ :: Footnote's definition, when inlined
309         (secondary string or nil).
310    - ~:label~ :: Footnote's label, if any (string or nil).
311    - ~:raw-definition~ :: Uninterpreted footnote's definition, when
312         inlined (string or nil).
313    - ~:type~ :: Determine whether reference has its definition inline,
314                 or not (symbol: ~inline~, ~standard~).
315
316 ** Headline
317
318    Greater element.
319
320    In addition to the following list, any property specified in
321    a property drawer attached to the headline will be accessible as an
322    attribute (with underscores replaced with hyphens and a lowercase
323    name, i.e. ~:custom-id~).
324    
325    - ~:archivedp~ :: Non-nil if the headline has an archive tag
326                      (boolean).
327    - ~:closed~ :: Headline's CLOSED reference, if any (timestamp
328                   object or nil)
329    - ~:commentedp~ :: Non-nil if the headline has a comment keyword
330                       (boolean).
331    - ~:deadline~ :: Headline's DEADLINE reference, if any (timestamp
332                     object or nil).
333    - ~:footnote-section-p~ :: Non-nil if the headline is a footnote
334         section (boolean).
335    - ~:hiddenp~ :: Non-nil if the headline is hidden (boolean).
336    - ~:level~ :: Reduced level of the headline (integer).
337    - ~:pre-blank~ :: Number of blank lines between the headline and
338                      the first non-blank line of its contents
339                      (integer).
340    - ~:priority~ :: Headline's priority, as a character (integer).
341    - ~:quotedp~ :: Non-nil if the headline contains a quote keyword
342                    (boolean).
343    - ~:raw-value~ :: Raw headline's text, without the stars and the
344                      tags (string).
345    - ~:scheduled~ :: Headline's SCHEDULED reference, if any (timestamp
346                      object or nil).
347    - ~:tags~ :: Headline's tags, if any, without the archive
348                 tag. (list of strings).
349    - ~:title~ :: Parsed headline's text, without the stars and the
350                  tags (secondary string).
351    - ~:todo-keyword~ :: Headline's TODO keyword without quote and
352         comment strings, if any (string or nil).
353    - ~:todo-type~ :: Type of headline's TODO keyword, if any (symbol:
354                      ~done~, ~todo~).
355
356 ** Horizontal Rule
357
358    Element.
359
360    No specific property.
361
362 ** Inline Babel Call
363
364    Object.
365
366    - ~:info~ :: Information about function called, as returned by
367                 ~org-babel-lob-get-info~ (list).
368
369    /Note relative to export:/ Since Babel related blocks are expanded
370    before parsing, these can safely be ignored by back-ends.
371
372 ** Inline Src Block
373
374    Object.
375
376    - ~:language~ :: Language of the code in the block (string).
377    - ~:parameters~ :: Optional header arguments (string or nil).
378    - ~:value~ :: Source code (string).
379
380 ** Inlinetask
381
382    Greater element.
383    
384    In addition to the following list, any property specified in
385    a property drawer attached to the headline will be accessible as an
386    attribute (with underscores replaced with hyphens and a lowercase
387    name, i.e. ~:custom-id~).
388
389    - ~:closed~ :: Inlinetask's CLOSED reference, if any (timestamp
390                   object or nil)
391    - ~:deadline~ :: Inlinetask's DEADLINE reference, if any (timestamp
392                     object or nil).
393    - ~:hiddenp~ :: Non-nil if the headline is hidden (boolean).
394    - ~:level~ :: Reduced level of the inlinetask (integer).
395    - ~:priority~ :: Headline's priority, as a character (integer).
396    - ~:raw-value~ :: Raw inlinetask's text, without the stars and the
397                      tags (string).
398    - ~:scheduled~ :: Inlinetask's SCHEDULED reference, if any
399                      (timestamp object or nil).
400    - ~:tags~ :: Inlinetask's tags, if any (list of strings).
401    - ~:title~ :: Parsed inlinetask's text, without the stars and the
402                  tags (secondary string).
403    - ~:todo-keyword~ :: Inlinetask's TODO keyword, if any (string or
404         nil).
405    - ~:todo-type~ :: Type of inlinetask's TODO keyword, if any
406                      (symbol: ~done~, ~todo~).
407
408 ** Italic
409
410    Recursive object.
411
412    No specific property.
413
414 ** Item
415
416    Greater element.
417
418    - ~:bullet~ :: Item's bullet (string).
419    - ~:checkbox~ :: Item's check-box, if any (symbol: ~on~, ~off~,
420                     ~trans~, nil).
421    - ~:counter~ :: Item's counter, if any.  Literal counters become
422                    ordinals (integer).
423    - ~:raw-tag~ :: Uninterpreted item's tag, if any (string or nil).
424    - ~:tag~ :: Parsed item's tag, if any (secondary string or nil).
425    - ~:hiddenp~ :: Non-nil if item is hidden (boolean).
426    - ~:structure~ :: Full list's structure, as returned by
427                      ~org-list-struct~ (alist).
428
429 ** Keyword
430
431    Element.
432
433    - ~:key~ :: Keyword's name (string).
434    - ~:value~ :: Keyword's value (string).
435
436    /Note relative to export:/ Each back-end should, as far as
437    possible, support a number of common keywords.  These include:
438
439    - Back-end relative keyword (i.e. "LATEX" for =e-latex=), which
440      should always return its value as-is.
441
442    - "TARGET" keyword, which should always return a nil value.
443
444    - "TOC" keyword.  It accepts four common values: "headlines",
445      "tables", "figures", "listings".  Also, "headlines" value can
446      have an optional numeric argument to specify depth of the
447      contents.
448
449      See [[#collect-headlines][~org-export-collect-headlines~]], [[#collect-tables][~org-export-collect-tables~]],
450      [[#collect-figures][~org-export-collect-figures~]] and [[#collect-listings][~org-export-collect-listings~]].
451
452    - "INDEX" keyword.
453
454 ** LaTeX Environment
455
456    Element.
457
458    - ~:begin~ :: Buffer position at first affiliated keyword or at the
459                  beginning of the first line of environment (integer).
460    - ~:end~ :: Buffer position at the first non-blank line after last
461                line of the environment, or buffer's end (integer).
462    - ~:post-blank~ :: Number of blank lines between last environment's
463                       line and next non-blank line or buffer's end
464                       (integer).
465    - ~:value~ :: LaTeX code (string).
466
467 ** LaTeX Fragment
468
469    Object.
470
471    - ~:value~ :: LaTeX code (string).
472
473 ** Line Break
474
475    Element.
476
477    No specific property.
478
479 ** Link
480
481    Recursive object.
482
483    - ~:application~ :: Name of application requested to open the link
484                        in Emacs (string or nil). It only applies to
485                        "file" type links.
486    - ~:path~ :: Identifier for link's destination.  It is usually the
487                 link part with type, if specified, removed (string).
488    - ~:raw-link~ :: Uninterpreted link part (string).
489    - ~:search-option~ :: Additional information for file location
490         (string or nil). It only applies to "file" type links.
491    - ~:type~ :: Link's type.  Possible types (string) are:
492      - ~coderef~ :: Line in some source code,
493      - ~custom-id~ :: Specific headline's custom-id,
494      - ~file~ :: External file,
495      - ~fuzzy~ :: Target, target keyword, a named element or an
496                   headline in the current parse tree,
497      - ~id~ :: Specific headline's id,
498      - ~radio~ :: Radio-target.
499      It can also be any ~org-link-types~ element.
500
501
502    /Notes relative to export:/
503
504    - A fuzzy link leading to a target keyword should be ignored during
505      export: it's an invisible target.
506
507    - A fuzzy link with no description should display the
508      cross-reference number of its target.  This number can be:
509
510      - If link's destination is a target object within a footnote, it
511        will be footnote's number.
512
513      - If link's destination is a target object in a list, it will be
514        an item number.
515
516      - If link leads to a named element, it will be the sequence number
517        of that element among named elements of the same type.
518
519      - Otherwise, it will be the number of the headline containing
520        link's destination.
521
522      See [[#get-ordinal][~org-export-get-ordinal~]] function.
523
524 ** Macro
525
526    Object.
527
528    - ~:args~ :: Arguments passed to the macro (list of strings).
529    - ~:key~ :: Macro's name (string).
530    - ~:value~ :: Replacement text (string).
531
532    /Note relative to export:/ Macro expansion takes place before
533    buffer parsing. As such, export back-ends don't have to handle:
534    they'll never see them.
535
536 ** Paragraph
537
538    Element containing objects.
539
540    No specific property.
541
542 ** Plain List
543
544    Greater element.
545
546    - ~:structure~ :: Full list's structure, as returned by
547                      ~org-list-struct~ (alist).
548    - ~:type~ :: List's type (symbol: ~descriptive~, ~ordered~,
549                 ~unordered~).
550
551 ** Planning
552
553    Element.
554
555    - ~:closed~ :: Timestamp associated to closed keyword, if any
556                   (timestamp object or nil).
557    - ~:deadline~ :: Timestamp associated to deadline keyword, if any
558                     (timestamp object or nil).
559    - ~:scheduled~ :: Timestamp associated to scheduled keyword, if any
560                      (timestamp object or nil).
561
562 ** Property Drawer
563
564    Element.
565
566    - ~:hiddenp~ :: Non-nil if drawer is hidden (boolean).
567    - ~:properties~ :: Properties defined in the drawer (alist).
568
569 ** =Quote= Block
570
571    Greater element.
572
573    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
574
575 ** =Quote= Section
576
577    Element.
578
579    - ~:value~ :: Quoted text (string).
580
581 ** Radio Target
582
583    Recursive object.
584
585    - ~:raw-value~ :: Uninterpreted contents (string).
586
587 ** Section
588
589    Greater element.
590
591    No specific property.
592
593 ** Special Block
594
595    Greater element.
596
597    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
598    - ~:type~ :: Block's name (string).
599
600 ** Src Block
601
602    Element.
603
604    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
605    - ~:label-fmt~ :: Format string used to write labels in current
606                      block, if different from
607                      ~org-coderef-label-format~ (string or nil).
608    - ~:language~ :: Language of the code in the block, if specified
609                     (string or nil).
610    - ~:number-lines~ :: Non-nil if code lines should be numbered.
611         A ~new~ value starts numbering from 1 wheareas ~continued~
612         resume numbering from previous numbered block (symbol: ~new~,
613         ~continued~ or nil).
614    - ~:parameters~ :: Optional header arguments (string or nil).
615    - ~:preserve-indent~ :: Non-nil when indentation within the block
616         mustn't be modified upon export (boolean).
617    - ~:retain-labels~ :: Non-nil if labels should be kept visible upon
618         export (boolean).
619    - ~:switches~ :: Optional switches for code block export (string or
620                     nil).
621    - ~:use-labels~ :: Non-nil if links to labels contained in the
622                       block should display the label instead of the
623                       line number (boolean).
624    - ~:value~ :: Source code (string).
625
626 ** Statistics Cookie
627
628    Object.
629
630    - ~:value~ :: Full cookie (string).
631
632 ** Strike Through
633
634    Recursive object.
635
636    No specific property.
637
638 ** Subscript
639
640    Recursive object.
641
642    - ~:use-brackets-p~ :: Non-nil if contents are enclosed in curly
643         brackets (t, nil).
644
645 ** Superscript
646
647    Recursive object.
648
649    - ~:use-brackets-p~ :: Non-nil if contents are enclosed in curly
650         brackets (t, nil).
651
652 ** Table
653
654    Greater element.
655
656    - ~:tblfm~ :: Formulas associated to the table, if any (string or
657                  nil).
658    - ~:type~ :: Table's origin (symbol: ~table.el~, ~org~).
659    - ~:value~ :: Raw ~table.el~ table or nil (string or nil).
660
661 ** Table Cell
662
663    Recursive object.
664
665    No specific property.
666
667 ** Table Row
668
669    Element containing objects.
670
671    - ~:type~ :: Row's type (symbol: ~standard~, ~rule~).
672
673 ** Target
674
675    Object.
676
677    - ~:value~ :: Target's ID (string).
678
679
680    Notes relatives to export:
681
682    - Target should become an anchor, if back-end permits it.
683    - Target's ID shouldn't be visible on export.
684
685 ** Timestamp
686
687    Object.
688
689    - ~:day-end~ :: Day part from timestamp end.  If no ending date is
690                    defined, it defaults to start day part (integer).
691    - ~:day-start~ :: Day part from timestamp start (integer).
692    - ~:hour-start~ :: Hour part from timestamp end. If no ending date
693                       is defined, it defaults to start hour part, if
694                       any (integer or nil).
695    - ~:hour-start~ :: Hour part from timestamp start, if specified
696                       (integer or nil).
697    - ~:minute-start~ :: Minute part from timestamp end. If no ending
698         date is defined, it defaults to start minute part, if any
699         (integer or nil).
700    - ~:minute-start~ :: Minute part from timestamp start, if specified
701         (integer or nil).
702    - ~:month-end~ :: Month part from timestamp end.  If no ending date
703                      is defined, it defaults to start month part
704                      (integer).
705    - ~:month-start~ :: Month part from timestamp start (integer).
706    - ~:raw-value~ :: Raw timestamp (string).
707    - ~:repeater-type~ :: Type of repeater, if any (symbol: ~catch-up~,
708         ~restart~, ~cumulate~ or nil)
709    - ~:repeater-unit~ :: Unit of shift, if a repeater is defined
710         (symbol: ~year~, ~month~, ~week~, ~day~, ~hour~ or nil).
711    - ~:repeater-value~ :: Value of shift, if a repeater is defined
712         (integer or nil).
713    - ~:type~ :: Type of timestamp (symbol: ~active~, ~active-range~,
714                 ~diary~, ~inactive~, ~inactive-range~).
715    - ~:year-end~ :: Year part from timestamp end.  If no ending date
716                     is defined, it defaults to start year part
717                     (integer).
718    - ~:year-start~ :: Year part from timestamp start (integer).
719
720 ** Underline
721
722    Recursive object.
723
724    No specific property.
725
726 ** Verbatim
727
728    Object.
729
730    - ~:value~ :: Contents (string).
731
732 ** Verse Block
733
734    Element containing objects.
735
736    - ~:hiddenp~ :: Non-nil if block is hidden (boolean).
737
738 * The Communication Channel
739   :PROPERTIES:
740   :CUSTOM_ID: communication
741   :END:
742
743   This is the full list of properties available during transcode
744   process, with their category (~option~ or ~tree~) and their value
745   type.
746
747 ** ~:author~
748
749    Author's name.
750     
751    - category :: option
752    - type :: string
753
754 ** ~:back-end~
755
756    Current back-end used for transcoding.
757
758    - category :: tree
759    - type :: symbol
760
761 ** ~:creator~
762
763    String to write as creation information.
764
765    - category :: option
766    - type :: string
767
768 ** ~:date~
769
770    String to use as date.
771
772    - category :: option
773    - type :: string
774
775 ** ~:description~
776
777    Description text for the current data.
778
779    - category :: option
780    - type :: string
781
782 ** ~:email~
783
784    Author's email.
785
786    - category :: option
787    - type :: string
788
789 ** ~:exclude-tags~
790
791    Tags for exclusion of sub-trees from export process.
792
793    - category :: option
794    - type :: list of strings
795
796 ** ~:exported-data~
797
798    Hash table used to memoize results from [[#data][~org-export-data~]].
799
800    - category :: tree
801    - type :: hash table
802
803 ** ~:filetags~
804
805    List of global tags for buffer.  Used by [[#get-tags][~org-export-get-tags~]] to
806    get tags with inheritance.
807    - category :: option
808    - type :: list of strings
809
810 ** ~:footnote-definition-alist~
811
812    /Alist/ between footnote labels and their definition, as parsed
813    data.  Only non-inline footnotes are represented in this /alist/.
814    Also, every definition isn't guaranteed to be referenced in the
815    parse tree.  The purpose of this property is to preserve
816    definitions from oblivion – i.e. when the parse tree comes from
817    a part of the original buffer –, it isn't meant for direct use in
818    a back-end.  To retrieve a definition relative to a reference, use
819    [[#get-footnote-definition][~org-export-get-footnote-definition~]] instead.
820
821    - category :: option
822    - type :: alist (STRING . LIST)
823
824 ** ~:headline-levels~
825    :PROPERTIES:
826    :CUSTOM_ID: headline-levels
827    :END:
828
829    Maximum level being exported as an headline.  Comparison is done
830    with the relative level of headlines in the parse tree, not
831    necessarily with their actual level.
832
833    - category :: option
834    - type :: integer
835
836 ** ~:headline-numbering~
837
838    Alist between headlines' beginning position and their numbering, as
839    a list of numbers – cf. [[#get-headline-number][~org-export-get-headline-number~]].
840
841    - category :: tree
842    - type :: alist (INTEGER . LIST)
843
844 ** ~:headline-offset~
845
846    Difference between relative and real level of headlines in the
847    parse tree.  For example, a value of -1 means a level 2 headline
848    should be considered as level 1 —
849    cf. [[#get-relative-level][~org-export-get-relative-level~]].
850
851    - category :: tree
852    - type :: integer
853
854 ** ~:ignore-list~
855
856    List of elements and objects that will be unconditionally ignored
857    during export.
858
859    - category :: option
860    - type :: list of elements
861
862 ** ~:id-alist~
863
864    Alist between ID strings and destination file's path, relative to
865    current directory.
866
867    - category :: option
868    - type :: alist (STRING . STRING)
869
870 ** ~:input-file~
871
872    Full path to input file, if any.
873
874    - category :: option
875    - type :: string or nil
876
877 ** ~:keywords~
878
879    List of keywords attached to data.
880
881    - category :: option
882    - type :: string
883
884 ** ~:language~
885
886    Default language used for translations.
887
888    - category :: option
889    - type :: string
890
891 ** ~:parse-tree~
892
893    Whole parse tree, available at any time during transcoding.
894
895    - category :: option
896    - type :: list (as returned by ~org-element-parse-buffer~)
897
898 ** ~:preserve-breaks~
899
900    Non-nil means transcoding should preserve all line breaks.
901
902    - category :: option
903    - type :: symbol (nil, t)
904
905 ** ~:section-numbers~
906
907    Non-nil means transcoding should add section numbers to headlines.
908
909    - category :: option
910    - type :: symbol (nil, t)
911
912 ** ~:select-tags~
913    :PROPERTIES:
914    :CUSTOM_ID: select-tags
915    :END:
916
917    List of tags enforcing inclusion of sub-trees in transcoding.  When
918    such a tag is present, sub-trees without it are /de facto/ excluded
919    from the process.  See [[#use-select-tags][~:use-select-tags~]].
920
921    - category :: option
922    - type :: list of strings
923
924 ** ~:target-list~
925
926    List of targets raw names encountered in the parse tree.  This is
927    used to partly resolve "fuzzy" links —
928    cf. [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]].
929
930    - category :: tree
931    - type :: list of strings
932
933 ** ~:time-stamp-file~
934
935    Non-nil means transcoding should insert a time stamp in the output.
936
937    - category :: option
938    - type :: symbol (nil, t)
939
940 ** ~:translate-alist~
941
942    Alist between element and object types and transcoding functions
943    relative to the current back-end.  Special keys ~template~ and
944    ~plain-text~ are also possible.
945
946    - category :: option
947    - type :: alist (SYMBOL . FUNCTION)
948
949 ** ~:use-select-tags~
950    :PROPERTIES:
951    :CUSTOM_ID: use-select-tags
952    :END:
953
954    When non-nil, a select tags has been found in the parse tree.
955    Thus, any headline without one will be filtered out.  See
956    [[#select-tags][~:select-tags~]].
957
958    - category :: tree
959    - type :: interger or nil
960
961 ** ~:with-archived-trees~
962
963    Non-nil when archived sub-trees should also be transcoded.  If it
964    is set to the ~headline~ symbol, only the archived headline's name
965    is retained.
966
967    - category :: option
968    - type :: symbol (nil, t, ~headline~)
969
970 ** ~:with-author~
971
972    Non-nil means author's name should be included in the output.
973
974    - category :: option
975    - type :: symbol (nil, t)
976
977 ** ~:with-clocks~
978
979    Non-nil means clock keywords should be exported.
980
981    - category :: option
982    - type :: symbol (nil, t)
983
984 ** ~:with-creator~
985
986    Non-nil means a creation sentence should be inserted at the end of
987    the transcoded string.  If the value is ~comment~, it should be
988    commented.
989
990    - category :: option
991    - type :: symbol (~comment~, nil, t)
992
993 ** ~:with-date~
994
995    Non nil means output should contain a date.
996
997    - category :: option
998    - type :: symbol (nil, t)
999
1000 ** ~:with-drawers~
1001
1002    Non-nil means drawers should be exported.  If its value is a list
1003    of names, only drawers with such names will be transcoded.
1004
1005    - category :: option
1006    - type :: symbol (nil, t) or list of strings
1007
1008 ** ~:with-email~
1009
1010    Non-nil means output should contain author's email.
1011
1012    - category :: option
1013    - type :: symbol (nil, t)
1014
1015 ** ~:with-emphasize~
1016
1017    Non-nil means emphasized text should be interpreted.
1018
1019    - category :: option
1020    - type :: symbol (nil, t)
1021
1022 ** ~:with-fixed-width~
1023
1024    Non-nil if transcoder should interpret strings starting with
1025    a colon as a fixed-with — verbatim — area.
1026
1027    - category :: option
1028    - type :: symbol (nil, t)
1029
1030 ** ~:with-footnotes~
1031
1032    Non-nil if transcoder should interpret footnotes.
1033
1034    - category :: option
1035    - type :: symbol (nil, t)
1036
1037 ** ~:with-plannings~
1038
1039    Non-nil means transcoding should include planning info.
1040
1041    - category :: option
1042    - type :: symbol (nil, t)
1043
1044 ** ~:with-priority~
1045
1046    Non-nil means transcoding should include priority cookies.
1047
1048    - category :: option
1049    - type :: symbol (nil, t)
1050
1051 ** ~:with-smart-quotes~
1052
1053    Non-nil means activate smart quotes during export.
1054
1055    - category :: option
1056    - type :: symbol (nil ,t)
1057
1058 ** ~:with-special-strings~
1059
1060    Non-nil means transcoding should interpret special strings in plain
1061    text.
1062
1063    - category :: option
1064    - type :: symbol (nil, t)
1065
1066 ** ~:with-sub-superscript~
1067
1068    Non-nil means transcoding should interpret subscript and
1069    superscript.  With a value of ~{}~, only interpret those using
1070    curly brackets.
1071
1072    - category :: option
1073    - type :: symbol (nil, ~{}~, t)
1074
1075 ** ~:with-tables~
1076
1077    Non-nil means transcoding should interpret tables.
1078
1079    - category :: option
1080    - type :: symbol (nil, t)
1081
1082 ** ~:with-tags~
1083
1084    Non-nil means transcoding should keep tags in headlines.
1085    A ~not-in-toc~ value will remove them from the table of contents,
1086    if any, nonetheless.
1087
1088    - category :: option
1089    - type :: symbol (nil, t, ~not-in-toc~)
1090
1091 ** ~:with-tasks~
1092
1093    Non-nil means transcoding should include headlines with a TODO
1094    keyword.  A ~todo~ value will only include headlines with a TODO
1095    type keyword while a ~done~ value will do the contrary.  If a list
1096    of strings is provided, only tasks with keywords belonging to that
1097    list will be kept.
1098
1099    - category :: option
1100    - type :: symbol (t, ~todo~, ~done~, nil) or list of strings
1101
1102 ** ~:with-timestamps~
1103
1104    Non-nil means transcoding should include time stamps.  Special
1105    value ~active~ (resp. ~inactive~) ask to export only active
1106    (resp. inactive) timestamps.  Otherwise, completely remove them.
1107
1108    - category :: option
1109    - type :: symbol: (~active~, ~inactive~, t, nil)
1110
1111 ** ~:with-toc~
1112
1113    Non-nil means that a table of contents has to be added to the
1114    output.  An integer value limits its depth.
1115
1116    - category :: option
1117    - type :: symbol (nil, t or integer)
1118
1119 ** ~:with-todo-keywords~
1120
1121    Non-nil means transcoding should include TODO keywords.
1122
1123    - category :: option
1124    - type :: symbol (nil, t)
1125
1126 * The Filter System
1127   :PROPERTIES:
1128   :CUSTOM_ID: filter-system
1129   :END:
1130
1131   Filters sets are lists of functions.  They allow to pre-process
1132   parse tree before export and to post-process output of each
1133   transcoded object or element.
1134
1135   Each function in a set must accept three arguments: a string (or
1136   a parse tree as a special case), a symbol representing the current
1137   back-end, and the communication channel, as a plist.
1138
1139   From the developer side, filters sets can be installed using
1140   ~:filters-alist~ keyword while defining the back-end with
1141   ~org-export-define-derived-backend~.  Each association has a key
1142   among the following symbols and a function or a list of functions as
1143   value:
1144
1145   - ~:filter-babel-call~
1146   - ~:filter-bold~
1147   - ~:filter-center-block~
1148   - ~:filter-clock~
1149   - ~:filter-code~
1150   - ~:filter-comment~
1151   - ~:filter-comment-block~
1152   - ~:filter-drawer~
1153   - ~:filter-dynamic-block~
1154   - ~:filter-entity~
1155   - ~:filter-example-block~
1156   - ~:filter-export-block~
1157   - ~:filter-export-snippet~
1158   - ~:filter-final-output~
1159   - ~:filter-fixed-width~
1160   - ~:filter-footnote-definition~
1161   - ~:filter-footnote-reference~
1162   - ~:filter-headline~
1163   - ~:filter-horizontal-rule~
1164   - ~:filter-inline-babel-call~
1165   - ~:filter-inline-src-block~
1166   - ~:filter-inlinetask~
1167   - ~:filter-italic~
1168   - ~:filter-item~
1169   - ~:filter-keyword~
1170   - ~:filter-latex-environment~
1171   - ~:filter-latex-fragment~
1172   - ~:filter-line-break~
1173   - ~:filter-link~
1174   - ~:filter-macro~
1175   - ~:filter-paragraph~
1176   - ~:filter-parse-tree~
1177   - ~:filter-plain-list~
1178   - ~:filter-plain-text~
1179   - ~:filter-planning~
1180   - ~:filter-property-drawer~
1181   - ~:filter-quote-block~
1182   - ~:filter-quote-section~
1183   - ~:filter-radio-target~
1184   - ~:filter-section~
1185   - ~:filter-special-block~
1186   - ~:filter-src-block~
1187   - ~:filter-strike-through~
1188   - ~:filter-statistics-cookie~
1189   - ~:filter-subscript~
1190   - ~:filter-superscript~
1191   - ~:filter-table~
1192   - ~:filter-table-cell~
1193   - ~:filter-table-row~
1194   - ~:filter-target~
1195   - ~:filter-timestamp~
1196   - ~:filter-underline~
1197   - ~:filter-verbatim~
1198   - ~:filter-verse-block~
1199
1200
1201   For example, =e-ascii= back-end implements a filter that makes sure
1202   headlines end with two blank lines:
1203
1204   #+BEGIN_SRC emacs-lisp
1205   (org-export-define-backend e-ascii
1206     ...
1207     :filters-alist ((:filter-headline . org-e-ascii-filter-headline-blank-lines)
1208                     (:filter-section . org-e-ascii-filter-headline-blank-lines)))
1209
1210   (defun org-e-ascii-filter-section-blank-lines (headline back-end info)
1211     "Filter controlling number of blank lines after a section."
1212     (if (not (eq back-end 'e-ascii)) headline
1213       (let ((blanks (make-string 2 ?\n)))
1214         (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline))))
1215   #+END_SRC
1216
1217 * The Toolbox
1218   :PROPERTIES:
1219   :CUSTOM_ID: toolbox
1220   :END:
1221
1222   A whole set of tools is available to help build new exporters.  Any
1223   function general enough to have its use across a couple of back-ends
1224   may be added here.
1225
1226   Many of them are high-level access to properties from the
1227   communication channel.  As such, they should be preferred to
1228   straight access to communication channel, when possible.
1229
1230 ** ~org-element-adopt-element~
1231    :PROPERTIES:
1232    :CUSTOM_ID: adopt-element
1233    :END:
1234
1235    Add an element to the contents of another element.
1236
1237    See also: [[#set-element][~org-element-set-element~]]
1238
1239 ** ~org-element-set-element~
1240    :PROPERTIES:
1241    :CUSTOM_ID: set-element
1242    :END:
1243
1244    Replace an element with another in the parse tree.
1245
1246    See also: [[#adopt-element][~org-element-adopt-element~]].
1247
1248 ** ~org-export-activate-smart-quotes~
1249    :PROPERTIES:
1250    :CUSTOM_ID: activate-smart-quotes
1251    :END:
1252
1253    Transform quotes and apostrophes into their "smart" counterpart in
1254    a given string.
1255
1256    It should be used after a check against ~:with-smart-quotes~ value
1257    in communication channel.
1258
1259    Since this function needs the original string, it may be useful to
1260    apply others transformations (i.e. characters protection) on a copy
1261    of that string and provide the pristine original string as the
1262    optional argument.
1263
1264    For example, in ~e-html~ back-end, it is necessary to protect "<",
1265    ">" and "&" characters before calling this function.  Here's an
1266    excerpt of the ~plain-text~ transcoder:
1267
1268    #+BEGIN_SRC emacs-lisp
1269    (let ((output text))
1270      ;; Protect following characters: <, >, &.
1271      (setq output (org-e-html-encode-plain-text output))
1272      ;; Handle smart quotes.  Be sure to provide original string since
1273      ;; OUTPUT may have been modified.
1274      (when (plist-get info :with-smart-quotes)
1275        (setq output (org-export-activate-smart-quotes output :html info text)))
1276      ...
1277      ;; Return value.
1278      output)
1279    #+END_SRC
1280
1281 ** ~org-export-collect-figures~
1282    :PROPERTIES:
1283    :CUSTOM_ID: collect-figures
1284    :END:
1285
1286    Return a list of all exportable figures in parse tree.
1287
1288    Used to build a table of figures.
1289    
1290    See also: [[#collect-headlines][~org-export-collect-headlines~]],
1291    [[#collect-tables][~org-export-collect-tables~]], [[#collect-listings][~org-export-collect-listings~]].
1292
1293 ** ~org-export-collect-footnote-definitions~
1294    :PROPERTIES:
1295    :CUSTOM_ID: collect-footnote-definitions
1296    :END:
1297
1298    List actually used footnotes definitions in order to add footnote
1299    listings throughout the transcoded data.
1300
1301    Feed it with the whole parse tree to get the full footnote listing.
1302    Feed it with the current headline to get partial footnote listing
1303    relative to that headline.
1304
1305    Number, label, if any, and definition are provided.
1306
1307    See also: [[#footnote-first-reference-p][~org-export-footnote-first-reference-p~]],
1308    [[#get-footnote-definition][~org-export-get-footnote-definition~]],
1309    [[#get-footnote-number][~org-export-get-footnote-number~]].
1310
1311 ** ~org-export-collect-headlines~
1312    :PROPERTIES:
1313    :CUSTOM_ID: collect-headlines
1314    :END:
1315
1316    Return a list of all exportable headlines, possibly limited to
1317    a certain depth.
1318
1319    Used to build a table of contents.
1320
1321    See also: [[#collect-tables][~org-export-collect-tables~]],
1322    [[#collect-figures][~org-export-collect-figures~]], [[#collect-listings][~org-export-collect-listings~]].
1323
1324 ** ~org-export-collect-listings~
1325    :PROPERTIES:
1326    :CUSTOM_ID: collect-listings
1327    :END:
1328
1329    Return a list of all exportable source blocks with a caption or
1330    a name in parse tree.
1331
1332    Used to build a table of listings.
1333
1334    See also: [[#collect-headlines][~org-export-collect-headlines~]],
1335    [[#collect-tables][~org-export-collect-tables~]], [[#collect-figures][~org-export-collect-figures~]].
1336 ** ~org-export-collect-tables~
1337    :PROPERTIES:
1338    :CUSTOM_ID: collect-tables
1339    :END:
1340
1341    Return a list of all exportable tables with a caption or a name in
1342    parse tree.
1343
1344    Used to build a table of tables.
1345
1346    See also: [[#collect-headlines][~org-export-collect-headlines~]],
1347    [[#collect-figures][~org-export-collect-figures~]], [[#collect-listings][~org-export-collect-listings~]].
1348
1349 ** ~org-export-data~
1350    :PROPERTIES:
1351    :CUSTOM_ID: data
1352    :END:
1353
1354    Transcode a given element, object, secondary string or string using
1355    current back-end.
1356
1357    It is used primarily to transcode secondary strings, like ~:title~.
1358    For example =e-beamer= back-end uses the following:
1359
1360    #+BEGIN_SRC emacs-lisp
1361    (defun org-e-beamer-template (contents info)
1362      (let ((title (org-export-data (plist-get info :title) info)))
1363        ...))
1364    #+END_SRC
1365
1366 ** ~org-export-first-sibling-p~
1367    :PROPERTIES:
1368    :CUSTOM_ID: first-sibling-p
1369    :END:
1370
1371    Non-nil if an headline is the first of its siblings.
1372
1373    Used to know when to start a list if headline's relative level is
1374    below the one specified in [[#headline-levels][~:headline-levels~]] property.
1375
1376    See also: [[#get-relative-level][~org-export-get-relative-level~]],
1377    [[#number-to-roman][~org-export-number-to-roman~]], [[#last-sibling-p][~org-export-last-sibling-p~]].
1378
1379 ** ~org-export-footnote-first-reference-p~
1380    :PROPERTIES:
1381    :CUSTOM_ID: footnote-first-reference-p
1382    :END:
1383
1384    Non-nil when a footnote reference if the first reference relative
1385    to its definition.
1386
1387    Used when a back-end needs to attach the footnote definition only
1388    to the first occurrence of the corresponding label.
1389
1390    See also: [[#collect-footnote-definitions][~org-export-collect-footnote-definitions~]],
1391    [[#get-footnote-definition][~org-export-get-footnote-definition~]],
1392    [[#get-footnote-number][~org-export-get-footnote-number~]].
1393
1394 ** ~org-export-format-code-default~
1395    :PROPERTIES:
1396    :CUSTOM_ID: format-code-default
1397    :END:
1398
1399    Return contents of a =src-block= or =example-block= element in
1400    a format suited for raw text or verbatim output.  More
1401    specifically, it takes care of line numbering and labels
1402    integration depending of element's switches, but no formatting is
1403    otherwise applied to source code.
1404
1405    See also: [[#format-code][~org-export-format-code~]], [[#unravel-code][~org-export-unravel-code~]].
1406
1407 ** ~org-export-format-code~
1408    :PROPERTIES:
1409    :CUSTOM_ID: format-code
1410    :END:
1411
1412    Helper function to format source code.  It applies a given function
1413    on each line of the code, passing current line number and
1414    associated code reference label, if any, as arguments.
1415
1416    See also: [[#format-code-default][~org-export-format-code-default~]], [[#get-loc][~org-export-get-loc~]],
1417    [[#unravel-code][~org-export-unravel-code~]].
1418
1419 ** ~org-export-get-caption~
1420    :PROPERTIES:
1421    :CUSTOM_ID: get-caption
1422    :END:
1423
1424    Return the caption of a given element, as a secondary string.  With
1425    an optional argument, return the short caption instead.
1426
1427    As an example, =e-ascii= back-end, when creating a list of
1428    listings, uses the following:
1429
1430    #+BEGIN_SRC emacs-lisp
1431    (defun org-e-ascii--list-listings (keyword info)
1432      (let ((title (org-e-ascii--translate "List of Listings" info)))
1433        (concat title "\n"
1434                ...
1435                (mapconcat
1436                 (lambda (src-block)
1437                   ...
1438                   ;; Use short name in priority, if available.
1439                   (let ((caption (or (org-export-get-caption src-block t)
1440                                      (org-export-get-caption src-block))))
1441                     (org-export-data caption info)
1442                     ...))
1443                 (org-export-collect-listings info) "\n"))))
1444    #+END_SRC
1445
1446    See also: [[#read-attribute][~org-export-read-attribute~]].
1447
1448 ** ~org-export-get-category~
1449    :PROPERTIES:
1450    :CUSTOM_ID: get-category
1451    :END:
1452
1453    Return category associated to a given element or object.  Unlike to
1454    the ~:category~ property from headlines and inlinetasks, this
1455    function handles inheritance and ~CATEGORY~ keywords.  Therefore,
1456    it should be the preferred way to retrieve a category during
1457    export.
1458
1459    See also: [[#get-node-property][~org-export-get-node-property~]].
1460
1461 ** ~org-export-get-coderef-format~
1462    :PROPERTIES:
1463    :CUSTOM_ID: get-coderef-format
1464    :END:
1465
1466    Return an appropriate format string for code reference links.
1467
1468    See also: [[#resolve-coderef][~org-export-resolve-coderef~]].
1469
1470 ** ~org-export-get-footnote-definition~
1471    :PROPERTIES:
1472    :CUSTOM_ID: get-footnote-definition
1473    :END:
1474
1475    Retrieve the footnote definition relative to a given footnote
1476    reference.
1477
1478    If the footnote definition in inline, it is returned as a secondary
1479    string.  Otherwise, it is full Org data.
1480
1481    See also: [[#collect-footnote-definitions][~org-export-collect-footnote-definitions~]],
1482    [[#footnote-first-reference-p][~org-export-footnote-first-reference-p~]],
1483    [[#get-footnote-number][~org-export-get-footnote-number~]].
1484
1485 ** ~org-export-get-footnote-number~
1486    :PROPERTIES:
1487    :CUSTOM_ID: get-footnote-number
1488    :END:
1489
1490    Return the ordinal attached to a footnote reference or definition.
1491
1492    See also: [[#collect-footnote-definitions][~org-export-collect-footnote-definitions~]],
1493    [[#footnote-first-reference-p][~org-export-footnote-first-reference-p~]],
1494    [[#get-footnote-definition][~org-export-get-footnote-definition~]].
1495
1496 ** ~org-export-get-genealogy~
1497    :PROPERTIES:
1498    :CUSTOM_ID: get-genealogy
1499    :END:
1500
1501    Return flat list of current object or element's parents from
1502    closest to farthest, along with their contents.
1503
1504    See also: [[#get-next-element][~org-export-get-next-element~]], [[#get-parent][~org-export-get-parent~]],
1505    [[#get-parent-headline][~org-export-get-parent-headline~]],
1506    [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
1507    [[#get-previous-element][~org-export-get-previous-element~]].
1508
1509 ** ~org-export-get-headline-number~
1510    :PROPERTIES:
1511    :CUSTOM_ID: get-headline-number
1512    :END:
1513
1514    Return the section number of an headline, as a list of integers.
1515
1516    See also: [[#headline-numbered-p][~org-export-headline-numbered-p~]],
1517    [[#number-to-roman][~org-export-number-to-roman~]].
1518
1519 ** ~org-export-get-loc~
1520    :PROPERTIES:
1521    :CUSTOM_ID: get-loc
1522    :END:
1523
1524    Return count of accumulated lines of code from previous
1525    line-numbered =example-block= and =src-block= elements, according
1526    to current element's switches.
1527
1528    In other words, the first line of code in the current block is
1529    supposed to be numbered as the returned value plus one, assuming
1530    its ~:number-lines~ properties is non-nil.
1531
1532    See also: [[#format-code][~org-export-format-code~]], [[#unravel-code][~org-export-unravel-code~]].
1533
1534 ** ~org-export-get-next-element~
1535    :PROPERTIES:
1536    :CUSTOM_ID: get-next-element
1537    :END:
1538
1539    Return element (resp. object or string) after an element
1540    (resp. object), or nil.
1541
1542    See also: [[#get-genealogy][~org-export-get-genealogy~]], [[#get-parent][~org-export-get-parent~]],
1543    [[#get-parent-headline][~org-export-get-parent-headline~]],
1544    [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
1545    [[#get-previous-element][~org-export-get-previous-element~]].
1546
1547 ** ~org-export-get-node-property~
1548    :PROPERTIES:
1549    :CUSTOM_ID: get-node-property
1550    :END:
1551
1552    Return the node property associated to an element or object.  If
1553    the element is an headline, this is equivalent to reading the
1554    property with ~org-element-property~.
1555
1556    Though, this function can optionally handle inheritance.
1557
1558    See also: [[#get-category][~org-export-get-category~]].
1559
1560 ** ~org-export-get-ordinal~
1561    :PROPERTIES:
1562    :CUSTOM_ID: get-ordinal
1563    :END:
1564
1565    Associate a sequence number to any object or element.  It is meant
1566    to be used to build captions.
1567
1568    Also, it could be applied on a fuzzy link's destination, since such
1569    links are expected to be replaced with the sequence number of their
1570    destination, provided they have no description.
1571
1572    Taken from =e-ascii= back-end, the following example shows how
1573    fuzzy links could be handled :
1574
1575    #+BEGIN_SRC emacs-lisp :exports code
1576    (let ((type (org-element-property :type link)))
1577      (cond
1578       ...
1579       ;; Do not apply a special syntax on fuzzy links pointing to targets.
1580       ((string= type "fuzzy")
1581        (let ((destination (org-export-resolve-fuzzy-link link info)))
1582          ;; Ignore invisible "#+TARGET: path".
1583          (unless (eq (org-element-type destination) 'keyword)
1584            ;; If link has a description, use it.
1585            (if (org-string-nw-p desc) desc
1586              (when destination
1587                (let ((number (org-export-get-ordinal destination info)))
1588                  (when number
1589                    (if (atom number) (number-to-string number)
1590                      (mapconcat 'number-to-string number ".")))))))))
1591       ...))
1592    #+END_SRC
1593
1594    See also : [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]]
1595
1596 ** ~org-export-get-parent-element~
1597    :PROPERTIES:
1598    :CUSTOM_ID: get-parent-paragraph
1599    :END:
1600
1601    Return the first element containing provided object, if any.
1602    Return nil otherwise.
1603
1604    See also: [[#get-genealogy][~org-export-get-genealogy~]], [[#get-parent][~org-export-get-parent~]],
1605    [[#get-parent-headline][~org-export-get-parent-headline~]],
1606    [[#get-previous-element][~org-export-get-previous-element~]], [[#get-next-element][~org-export-get-next-element~]].
1607
1608 ** ~org-export-get-parent-headline~
1609    :PROPERTIES:
1610    :CUSTOM_ID: get-parent-headline
1611    :END:
1612
1613    Return the headline containing provided element or object, if any.
1614    Return nil otherwise.
1615
1616    See also: [[#get-genealogy][~org-export-get-genealogy~]],
1617    [[#get-next-element][~org-export-get-next-element~]], [[#get-parent][~org-export-get-parent~]],
1618    [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
1619    [[#get-previous-element][~org-export-get-previous-element~]].
1620
1621 ** ~org-export-get-parent~
1622    :PROPERTIES:
1623    :CUSTOM_ID: get-parent
1624    :END:
1625
1626    Return closest element containing current element or object, if
1627    any.  Return nil otherwise.
1628
1629    See also: [[#get-genealogy][~org-export-get-genealogy~]],
1630    [[#get-next-element][~org-export-get-next-element~]], [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
1631    [[#get-parent-headline][~org-export-get-parent-headline~]],
1632    [[#get-previous-element][~org-export-get-previous-element~]].
1633
1634 ** ~org-export-get-previous-element~
1635    :PROPERTIES:
1636    :CUSTOM_ID: get-previous-element
1637    :END:
1638
1639    Return element (resp. object or string) before an element
1640    (resp. object), or nil.
1641
1642    See also: [[#get-genealogy][~org-export-get-genealogy~]],
1643    [[#get-next-element][~org-export-get-next-element~]], [[#get-parent][~org-export-get-parent~]],
1644    [[#get-parent-headline][~org-export-get-parent-headline~]],
1645    [[#get-parent-paragraph][~org-export-get-parent-paragraph~]].
1646
1647 ** ~org-export-get-relative-level~
1648    :PROPERTIES:
1649    :CUSTOM_ID: get-relative-level
1650    :END:
1651
1652    Return headline level, relatively to the lower headline level in
1653    the parsed tree.  It is meant to be used over ~:level~ headline's
1654    property.
1655
1656    See also:[[#first-sibling-p][~org-export-first-sibling-p~]],
1657     [[#get-headline-number][~org-export-get-headline-number~]],[[#headline-numbered-p][~org-export-headline-numbered-p~]],
1658     [[#last-sibling-p][~org-export-last-sibling-p~]].
1659
1660 ** ~org-export-get-table-cell-at~
1661    :PROPERTIES:
1662    :CUSTOM_ID: get-table-cell-at
1663    :END:
1664
1665    Return exportable cell object at a given position, or nil.  Hence,
1666    position ~(0 . 0)~ will always point to the first exportable cell
1667    in the table.
1668
1669    See also: [[#table-cell-address][~org-export-table-cell-address~]],
1670    [[#table-dimensions][~org-export-table-dimensions~]].
1671
1672 ** ~org-export-get-tags~
1673    :PROPERTIES:
1674    :CUSTOM_ID: get-tags
1675    :END:
1676
1677    Return list of exportable tags attached to a given headline or
1678    inlinetask element.  With an optional argument, tags are inherited
1679    from parent headlines and ~FILETAGS~ keywords.
1680
1681    In particular, it removes select tags and exclude tags. The
1682    function also accepts an arbitrary list of tags for further
1683    cleaning.
1684
1685    For example, =e-latex= back-end uses the following snippet in the
1686    inlinetask transcode function.
1687
1688    #+BEGIN_SRC emacs-lisp
1689    (let ((title (org-export-data (org-element-property :title inlinetask) info))
1690       (todo (and (plist-get info :with-todo-keywords)
1691                  (let ((todo (org-element-property :todo-keyword inlinetask)))
1692                    (and todo (org-export-data todo info)))))
1693       (todo-type (org-element-property :todo-type inlinetask))
1694       (tags (and (plist-get info :with-tags)
1695                  (org-export-get-tags inlinetask info)))
1696       (priority (and (plist-get info :with-priority)
1697                      (org-element-property :priority inlinetask))))
1698   ...)
1699    #+END_SRC
1700
1701 ** ~org-export-headline-numbered-p~
1702    :PROPERTIES:
1703    :CUSTOM_ID: headline-numbered-p
1704    :END:
1705
1706    Non nil when a given headline should be numbered.
1707
1708    See also: [[#get-headline-number][~org-export-get-headline-number~]],
1709    [[#get-relative-level][~org-export-get-relative-level~]].
1710
1711 ** ~org-export-inline-image-p~
1712    :PROPERTIES:
1713    :CUSTOM_ID: inline-image-p
1714    :END:
1715
1716    Non-nil when the link provided should be considered as an inline
1717    image.  Note that it always return nil when the link has
1718    a description.
1719
1720    It accepts an optional set of rules in order to tweak the
1721    definition of an inline image, which is, by default, any link
1722    targetting a local file whose extension is either "png", "jpeg",
1723    "jpg", "gif", "tiff", "tif", "xbm", "xpm", "pbm", "pgm" or "ppm".
1724
1725    A set of rules consists in an alist whose key is a type of link, as
1726    a string, and whose value is a regexp matching link's path.  As an
1727    example, =e-html= back-end uses the following rules:
1728
1729    #+BEGIN_SRC emacs-lisp
1730    '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
1731      ("http" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
1732      ("https" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
1733    #+END_SRC
1734
1735    See also: [[#solidify-link-text][~org-export-solidify-link-text~]],
1736    [[#get-coderef-format][~org-export-get-coderef-format~]], [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]].
1737
1738 ** ~org-export-last-sibling-p~
1739    :PROPERTIES:
1740    :CUSTOM_ID: last-sibling-p
1741    :END:
1742
1743    Non-nil if an headline is the last of its siblings.
1744
1745    Used to know when to close a list if headline's relative level is
1746    below the one specified in [[#headline-levels][~:headline-levels~]] property.
1747
1748    See also: [[#get-relative-level][~org-export-get-relative-level~]],
1749    [[#number-to-roman][~org-export-number-to-roman~]], [[#first-sibling-p][~org-export-first-sibling-p~]].
1750
1751 ** ~org-export-number-to-roman~
1752    :PROPERTIES:
1753    :CUSTOM_ID: number-to-roman
1754    :END:
1755
1756    Convert numbers to roman numbers. It can be used to provide roman
1757    numbering for headlines and numbered lists.
1758
1759    See also: [[#get-headline-number][~org-export-get-headline-number~]].
1760
1761 ** ~org-export-read-attribute~
1762    :PROPERTIES:
1763    :CUSTOM_ID: read-attribute
1764    :END:
1765
1766    Read a property from a given element as a plist.  It can be used to
1767    normalize affiliated keywords' syntax.  For example, the following
1768    affiliated keywords:
1769
1770    #+BEGIN_SRC org
1771    ,#+ATTR_HTML: :width 10 :height 5
1772    ,#+ATTR_HTML: :file "filename.ext"
1773    #+END_SRC
1774
1775    would be returned as:
1776
1777    #+BEGIN_SRC emacs-lisp
1778    '(:width 10 :height 5 :file "filename.ext")
1779    #+END_SRC
1780
1781    See also: [[#get-caption][~org-export-get-caption~]].
1782
1783 ** ~org-export-resolve-coderef~
1784    :PROPERTIES:
1785    :CUSTOM_ID: resolve-coderef
1786    :END:
1787
1788    Search for a code reference within ~src-block~ and ~example-block~
1789    elements.  Return corresponding --possibly accumulated-- line
1790    number, or reference itself, depending on container's switches.
1791
1792    See also : [[#get-coderef-format][~org-export-get-coderef-format~]],
1793    [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]], [[#resolve-id-link][~org-export-resolve-id-link~]],
1794    [[#resolve-radio-link][~org-export-resolve-radio-link~]].
1795
1796 ** ~org-export-resolve-fuzzy-link~
1797    :PROPERTIES:
1798    :CUSTOM_ID: resolve-fuzzy-link
1799    :END:
1800
1801    Search destination of a fuzzy link — i.e. it has a ~fuzzy~ ~:type~
1802    attribute – within the parsed tree, and return that element,
1803    object, or nil.
1804
1805    See also: [[#get-ordinal][~org-export-get-ordinal~]], [[#resolve-coderef][~org-export-resolve-coderef~]],
1806    [[#resolve-id-link][~org-export-resolve-id-link~]], [[#resolve-radio-link][~org-export-resolve-radio-link~]],
1807    [[#solidify-link-text][~org-export-solidify-link-text~]].
1808
1809 ** ~org-export-resolve-id-link~
1810    :PROPERTIES:
1811    :CUSTOM_ID: resolve-id-link
1812    :END:
1813
1814    Search headline targetted by an id link --- i.e. it has a ~id~ or
1815    ~custom-id~ ~:type~ attribute --- within the parse tree.  Return
1816    the matching headline in the tree, the name of the external file,
1817    as a string, or nil.
1818
1819    See also : [[#resolve-coderef][~org-export-resolve-coderef~]],
1820    [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]], [[#resolve-radio-link][~org-export-resolve-radio-link~]],
1821    [[#solidify-link-text][~org-export-solidify-link-text~]].
1822
1823 ** ~org-export-resolve-radio-link~
1824    :PROPERTIES:
1825    :CUSTOM_ID: resolve-radio-link
1826    :END:
1827
1828    Return first radio target object matching a radio link --- that is
1829    with a ~radio~ ~:type~ attribute --- in the parse tree, or nil.
1830
1831    Typically, target's contents are exported through ~org-export-data~
1832    and used as link description, as in the following excerpt from
1833    =org-e-latex.el=:
1834
1835    #+BEGIN_SRC emacs-lisp
1836    (defun org-e-latex-link (link desc info)
1837      (let* ((type (org-element-property :type link))
1838             ...)
1839        (cond
1840         ...
1841         ((string= type "radio")
1842          (let ((destination (org-export-resolve-radio-link link info)))
1843            (when destination
1844              (format "\\hyperref[%s]{%s}"
1845                      (org-export-solidify-link-text path)
1846                      (org-export-data (org-element-contents destination) info)))))
1847         ...)))
1848    #+END_SRC
1849
1850    See also : [[#resolve-coderef][~org-export-resolve-coderef~]],
1851    [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]], [[#resolve-id-link][~org-export-resolve-id-link~]],
1852    [[#solidify-link-text][~org-export-solidify-link-text~]].
1853
1854 ** ~org-export-solidify-link-text~
1855    :PROPERTIES:
1856    :CUSTOM_ID: solidify-link-text
1857    :END:
1858
1859    Normalize a string, replacing most non-standard characters with
1860    hyphens.
1861
1862    Used to turn targets names into safer versions for links.
1863
1864    See also: [[#inline-image-p][~org-export-inline-image-p~]],
1865    [[#resolve-id-link][~org-export-resolve-id-link~]], [[#resolve-fuzzy-link][~org-export-resolve-fuzzy-link~]],
1866    [[#resolve-radio-link][~org-export-resolve-radio-link~]].
1867
1868 ** ~org-export-table-cell-address~
1869    :PROPERTIES:
1870    :CUSTOM_ID: table-cell-address
1871    :END:
1872
1873    Return row and column of a given cell object.  Positions are
1874    0-indexed and only exportable rows and columns are considered.  The
1875    function returns nil if called on a non-exportable cell.
1876
1877    See also: [[#get-table-cell-at][~org-export-get-table-cell-at~]],
1878    [[#table-dimensions][~org-export-table-dimensions~]].
1879
1880 ** ~org-export-table-cell-alignment~
1881    :PROPERTIES:
1882    :CUSTOM_ID: table-cell-alignment
1883    :END:
1884
1885    Return expected alignment for the contents of a given cell object.
1886    It can be either ~left~, ~right~ or ~center~.
1887
1888    See also: [[#table-cell-borders][~org-export-table-cell-borders~]],
1889    [[#table-cell-width][~org-export-table-cell-width~]].
1890
1891 ** ~org-export-table-cell-borders~
1892    :PROPERTIES:
1893    :CUSTOM_ID: table-cell-borders
1894    :END:
1895
1896    Indicate expected borders for a given cell object.  When non-nil,
1897    return value is a list of symbols among ~top~, ~bottom~, ~above~,
1898    ~below~, ~left~ and ~right~.
1899
1900    Special values ~top~ and ~bottom~ only happen for cells in,
1901    respectively, the first and the last exportable rows.
1902
1903    See also: [[#table-cell-alignment][~org-export-table-cell-alignment~]],
1904    [[#table-cell-width][~org-export-table-cell-width~]].
1905
1906 ** ~org-export-table-cell-ends-colgroup-p~
1907    :PROPERTIES:
1908    :CUSTOM_ID: table-cell-ends-colgroup-p
1909    :END:
1910
1911    Non-nil when a table cell object ends a column group.
1912
1913    See also: [[#table-cell-starts-colgroup-p][~org-export-table-cell-starts-colgroup-p~]].
1914
1915 ** ~org-export-table-cell-starts-colgroup-p~
1916    :PROPERTIES:
1917    :CUSTOM_ID: table-cell-starts-colgroup-p
1918    :END:
1919
1920    Non-nil when a table cell object starts a column group.
1921
1922    See also: [[#table-cell-ends-colgroup-p][~org-export-table-cell-ends-colgroup-p~]].
1923
1924 ** ~org-export-table-cell-width~
1925    :PROPERTIES:
1926    :CUSTOM_ID: table-cell-width
1927    :END:
1928
1929    Return expected width for contents of a given cell object.
1930
1931    Only width specified explicitely through meta-data is considered.
1932    If no such information can be found, return nil instead.
1933
1934    Some back-end may still need to know the actual width of exported
1935    cell's contents in order to compute column's width.  In that case,
1936    every cell in the column must be transcoded in order to find the
1937    widest one.  The snippet below, extracted from =org-e-ascii.el=
1938    illustrates a possible implementation.
1939
1940    #+BEGIN_SRC emacs-lisp
1941    (or (org-export-table-cell-width table-cell info)
1942        (let* ((max-width 0)
1943               (table (org-export-get-parent-table table-cell info))
1944               (specialp (org-export-table-has-special-column-p table))
1945               (col (cdr (org-export-table-cell-address table-cell info))))
1946          (org-element-map
1947           table 'table-row
1948           (lambda (row)
1949             ;; For each exportable row, get the cell at column COL and
1950             ;; transcode its contents.  Then compare its length with
1951             ;; MAX-WIDTH and keep the greater of two.
1952             (setq max-width
1953                   (max (length
1954                         (org-export-data
1955                          (org-element-contents
1956                           (elt (if specialp (car (org-element-contents row))
1957                                  (org-element-contents row))
1958                                col))
1959                          info))
1960                        max-width)))
1961           info)
1962          max-width))
1963    #+END_SRC
1964
1965    See also: [[#table-cell-alignment][~org-export-table-cell-alignment~]],
1966    [[#table-cell-borders][~org-export-table-cell-borders~]].
1967
1968 ** ~org-export-table-dimensions~
1969    :PROPERTIES:
1970    :CUSTOM_ID: table-dimensions
1971    :END:
1972
1973    Return the number of exportable rows and columns in a given table.
1974
1975    See also: [[#get-table-cell-at][~org-export-get-table-cell-at~]],
1976    [[#table-cell-address][~org-export-table-cell-address~]].
1977
1978 ** ~org-export-table-has-header-p~
1979    :PROPERTIES:
1980    :CUSTOM_ID: table-has-header-p
1981    :END:
1982
1983    Non-nil when table has at least two row groups.
1984
1985    See also: [[#table-has-special-column-p][~org-export-table-has-special-column-p~]],
1986    [[#table-row-is-special-p][~org-export-table-row-is-special-p~]].
1987
1988 ** ~org-export-table-has-special-column-p~
1989    :PROPERTIES:
1990    :CUSTOM_ID: table-has-special-column-p
1991    :END:
1992
1993    Non-nil when first column in the table only contains meta-data.
1994
1995    See also: [[#table-has-header-p][~org-export-table-has-header-p~]],
1996    [[#table-row-is-special-p][~org-export-table-row-is-special-p~]].
1997
1998 ** ~org-export-table-row-ends-header-p~
1999    :PROPERTIES:
2000    :CUSTOM_ID: table-row-ends-header-p
2001    :END:
2002
2003    Non-nil when a table row element ends table's header.
2004
2005    See also: [[#table-row-ends-rowgroup-p][~org-export-table-row-ends-rowgroup-p~]],
2006    [[#table-row-group][~org-export-table-row-group~]],
2007    [[#table-row-starts-header-p][~org-export-table-row-starts-header-p~]],
2008    [[#table-row-starts-rowgroup-p][~org-export-table-row-starts-rowgroup-p~]].
2009
2010 ** ~org-export-table-row-ends-rowgroup-p~
2011    :PROPERTIES:
2012    :CUSTOM_ID: table-row-ends-rowgroup-p
2013    :END:
2014
2015    Non-nil when a a table row element ends a rowgroup, header
2016    included.
2017
2018    See also: [[#table-cell-starts-ends-header-p][~org-export-table-row-ends-header-p~]],
2019    [[#table-row-group][~org-export-table-row-group~]],
2020    [[#table-row-starts-header-p][~org-export-table-row-starts-header-p~]],
2021    [[#table-row-starts-rowgroup-p][~org-export-table-row-starts-rowgroup-p~]].
2022
2023 ** ~org-export-table-row-group~
2024    :PROPERTIES:
2025    :CUSTOM_ID: table-row-group
2026    :END:
2027
2028    Return row group number for a given table row element.
2029
2030    See also: [[#table-cell-starts-ends-header-p][~org-export-table-row-ends-header-p~]],
2031    [[#table-row-ends-rowgroup-p][~org-export-table-row-ends-rowgroup-p~]],
2032    [[#table-row-starts-header-p][~org-export-table-row-starts-header-p~]],
2033    [[#table-row-starts-rowgroup-p][~org-export-table-row-starts-rowgroup-p~]].
2034
2035 ** ~org-export-table-row-is-special-p~
2036    :PROPERTIES:
2037    :CUSTOM_ID: table-row-is-special-p
2038    :END:
2039
2040    Non-nil a given table row element only contains meta-data.
2041
2042    See also: [[#table-has-header-p][~org-export-table-has-header-p~]],
2043    [[#table-has-special-column-p][~org-export-table-has-special-column-p~]].
2044
2045 ** ~org-export-table-row-starts-header-p~
2046    :PROPERTIES:
2047    :CUSTOM_ID: table-row-starts-header-p
2048    :END:
2049
2050    Non-nil when a table row element starts table's header.
2051
2052    See also: [[#table-cell-starts-ends-header-p][~org-export-table-row-ends-header-p~]],
2053    [[#table-row-ends-rowgroup-p][~org-export-table-row-ends-rowgroup-p~]],
2054    [[#table-row-group][~org-export-table-row-group~]],
2055    [[#table-row-starts-rowgroup-p][~org-export-table-row-starts-rowgroup-p~]].
2056
2057 ** ~org-export-table-row-starts-rowgroup-p~
2058    :PROPERTIES:
2059    :CUSTOM_ID: table-row-starts-rowgroup-p
2060    :END:
2061
2062    Non-nil when a table row element starts a rowgroup, header
2063    included.
2064
2065    See also: [[#table-cell-starts-ends-header-p][~org-export-table-row-ends-header-p~]],
2066    [[#table-row-ends-rowgroup-p][~org-export-table-row-ends-rowgroup-p~]],
2067    [[#table-row-group][~org-export-table-row-group~]],
2068    [[#table-row-starts-header-p][~org-export-table-row-starts-header-p~]].
2069
2070 ** ~org-export-translate~
2071
2072    Translate a string, i.e. "Table of Contents", according to language
2073    specification.
2074
2075    Refer to ~org-export-dictionary~ variable for the list of all
2076    supported strings.
2077
2078 ** ~org-export-unravel-code~
2079    :PROPERTIES:
2080    :CUSTOM_ID: unravel-code
2081    :END:
2082
2083    Clean source code from an =example-block= or a =src-block= element
2084    and extract code references out of it.
2085
2086    Its purpose is to allow to transform raw source code first and then
2087    integrate line numbers or references back into the final output.
2088    That final task can be achieved with the help of
2089    ~org-export-format-code~ function.
2090
2091    See also: [[#format-code][~org-export-format-code~]],
2092    [[#format-code-default][~org-export-format-code-default~]], [[#get-loc][~org-export-get-loc~]].
2093
2094 ** ~org-export-with-backend~
2095    :PROPERTIES:
2096    :CUSTOM_ID: with-backend
2097    :END:
2098
2099    Export an element or object using locally another back-end.
2100
2101    In a derived back-end, it may be used as a fall-back function once
2102    all specific cases have been handled.  Thus, =e-beamer= back-end,
2103    derived from =e-latex=, takes care of every internal link type and
2104    delagates everything else to its parent back-end:
2105
2106    #+BEGIN_SRC emacs-lisp
2107    (let ((type (org-element-property :type link))
2108          (path (org-element-property :path link)))
2109      (cond
2110       ;; Handle every internal link type, but be careful to ignore "id"
2111       ;; type links pointing to external files.
2112       ((equal type "radio") ...)
2113       ((and (member type '("custom-id" "fuzzy" "id"))
2114             (let ((destination (if (string= type "fuzzy")
2115                                    (org-export-resolve-fuzzy-link link info)
2116                                  (org-export-resolve-id-link link info))))
2117               (case (org-element-type destination)
2118                 (headline ...)
2119                 (target ...)))))
2120       ;; Otherwise, use `e-latex' back-end.
2121       (t (org-export-with-backend 'e-latex link contents info))))
2122    #+END_SRC
2123
2124
2125 # Local Variables:
2126 # sentence-end-double-space: t
2127 # End: