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