1 ;;; ox-texinfo.el --- Texinfo Back-End for Org Export Engine -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
4 ;; Author: Jonathan Leech-Pepin <jonathan.leechpepin at gmail dot com>
5 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; See Org manual for details.
31 (defvar orgtbl-exp-regexp
)
37 (org-export-define-backend 'texinfo
38 '((bold . org-texinfo-bold
)
39 (center-block . org-texinfo-center-block
)
40 (clock . org-texinfo-clock
)
41 (code . org-texinfo-code
)
42 (drawer . org-texinfo-drawer
)
43 (dynamic-block . org-texinfo-dynamic-block
)
44 (entity . org-texinfo-entity
)
45 (example-block . org-texinfo-example-block
)
46 (export-block . org-texinfo-export-block
)
47 (export-snippet . org-texinfo-export-snippet
)
48 (fixed-width . org-texinfo-fixed-width
)
49 (footnote-definition . org-texinfo-footnote-definition
)
50 (footnote-reference . org-texinfo-footnote-reference
)
51 (headline . org-texinfo-headline
)
52 (inline-src-block . org-texinfo-inline-src-block
)
53 (inlinetask . org-texinfo-inlinetask
)
54 (italic . org-texinfo-italic
)
55 (item . org-texinfo-item
)
56 (keyword . org-texinfo-keyword
)
57 (line-break . org-texinfo-line-break
)
58 (link . org-texinfo-link
)
59 (node-property . org-texinfo-node-property
)
60 (paragraph . org-texinfo-paragraph
)
61 (plain-list . org-texinfo-plain-list
)
62 (plain-text . org-texinfo-plain-text
)
63 (planning . org-texinfo-planning
)
64 (property-drawer . org-texinfo-property-drawer
)
65 (quote-block . org-texinfo-quote-block
)
66 (radio-target . org-texinfo-radio-target
)
67 (section . org-texinfo-section
)
68 (special-block . org-texinfo-special-block
)
69 (src-block . org-texinfo-src-block
)
70 (statistics-cookie . org-texinfo-statistics-cookie
)
71 (strike-through . org-texinfo-strike-through
)
72 (subscript . org-texinfo-subscript
)
73 (superscript . org-texinfo-superscript
)
74 (table . org-texinfo-table
)
75 (table-cell . org-texinfo-table-cell
)
76 (table-row . org-texinfo-table-row
)
77 (target . org-texinfo-target
)
78 (template . org-texinfo-template
)
79 (timestamp . org-texinfo-timestamp
)
80 (underline . org-texinfo-underline
)
81 (verbatim . org-texinfo-verbatim
)
82 (verse-block . org-texinfo-verse-block
))
84 '((:filter-headline . org-texinfo--filter-section-blank-lines
)
85 (:filter-parse-tree . org-texinfo--normalize-headlines
)
86 (:filter-section . org-texinfo--filter-section-blank-lines
))
88 '(?i
"Export to Texinfo"
89 ((?t
"As TEXI file" org-texinfo-export-to-texinfo
)
90 (?i
"As INFO file" org-texinfo-export-to-info
)
91 (?o
"As INFO file and open"
93 (if a
(org-texinfo-export-to-info t s v b
)
94 (org-open-file (org-texinfo-export-to-info nil s v b
)))))))
96 '((:texinfo-filename
"TEXINFO_FILENAME" nil nil t
)
97 (:texinfo-class
"TEXINFO_CLASS" nil org-texinfo-default-class t
)
98 (:texinfo-header
"TEXINFO_HEADER" nil nil newline
)
99 (:texinfo-post-header
"TEXINFO_POST_HEADER" nil nil newline
)
100 (:subtitle
"SUBTITLE" nil nil parse
)
101 (:subauthor
"SUBAUTHOR" nil nil newline
)
102 (:texinfo-dircat
"TEXINFO_DIR_CATEGORY" nil nil t
)
103 (:texinfo-dirtitle
"TEXINFO_DIR_TITLE" nil nil t
)
104 (:texinfo-dirdesc
"TEXINFO_DIR_DESC" nil nil t
)
105 (:texinfo-printed-title
"TEXINFO_PRINTED_TITLE" nil nil t
)
107 (:texinfo-classes nil nil org-texinfo-classes
)
108 (:texinfo-format-headline-function nil nil org-texinfo-format-headline-function
)
109 (:texinfo-node-description-column nil nil org-texinfo-node-description-column
)
110 (:texinfo-active-timestamp-format nil nil org-texinfo-active-timestamp-format
)
111 (:texinfo-inactive-timestamp-format nil nil org-texinfo-inactive-timestamp-format
)
112 (:texinfo-diary-timestamp-format nil nil org-texinfo-diary-timestamp-format
)
113 (:texinfo-link-with-unknown-path-format nil nil org-texinfo-link-with-unknown-path-format
)
114 (:texinfo-tables-verbatim nil nil org-texinfo-tables-verbatim
)
115 (:texinfo-table-scientific-notation nil nil org-texinfo-table-scientific-notation
)
116 (:texinfo-def-table-markup nil nil org-texinfo-def-table-markup
)
117 (:texinfo-text-markup-alist nil nil org-texinfo-text-markup-alist
)
118 (:texinfo-format-drawer-function nil nil org-texinfo-format-drawer-function
)
119 (:texinfo-format-inlinetask-function nil nil org-texinfo-format-inlinetask-function
)))
123 ;;; User Configurable Variables
125 (defgroup org-export-texinfo nil
126 "Options for exporting Org mode files to Texinfo."
127 :tag
"Org Export Texinfo"
129 :package-version
'(Org .
"8.0")
134 (defcustom org-texinfo-coding-system nil
135 "Default document encoding for Texinfo output.
137 If nil it will default to `buffer-file-coding-system'."
138 :group
'org-export-texinfo
139 :type
'coding-system
)
141 (defcustom org-texinfo-default-class
"info"
142 "The default Texinfo class."
143 :group
'org-export-texinfo
144 :type
'(string :tag
"Texinfo class"))
146 (defcustom org-texinfo-classes
148 "@documentencoding AUTO\n@documentlanguage AUTO"
149 ("@chapter %s" .
"@unnumbered %s")
150 ("@section %s" .
"@unnumberedsec %s")
151 ("@subsection %s" .
"@unnumberedsubsec %s")
152 ("@subsubsection %s" .
"@unnumberedsubsubsec %s")))
153 "Alist of Texinfo classes and associated header and structure.
154 If #+TEXINFO_CLASS is set in the buffer, use its value and the
155 associated information. Here is the structure of each cell:
159 (numbered-section . unnumbered-section)
166 The header string is inserted in the header of the generated
167 document, right after \"@setfilename\" and \"@settitle\"
170 If it contains the special string
172 \"@documentencoding AUTO\"
174 \"AUTO\" will be replaced with an appropriate coding system. See
175 `org-texinfo-coding-system' for more information. Likewise, if
176 the string contains the special string
178 \"@documentlanguage AUTO\"
180 \"AUTO\" will be replaced with the language defined in the
181 buffer, through #+LANGUAGE keyword, or globally, with
182 `org-export-default-language', which see.
185 The sectioning structure
186 ------------------------
188 The sectioning structure of the class is given by the elements
189 following the header string. For each sectioning level, a number
190 of strings is specified. A %s formatter is mandatory in each
191 section string and will be replaced by the title of the section.
193 Instead of a list of sectioning commands, you can also specify
194 a function name. That function will be called with two
195 parameters, the reduced) level of the headline, and a predicate
196 non-nil when the headline should be numbered. It must return
197 a format string in which the section title will be added."
198 :group
'org-export-texinfo
200 :package-version
'(Org .
"8.2")
202 (list (string :tag
"Texinfo class")
203 (string :tag
"Texinfo header")
204 (repeat :tag
"Levels" :inline t
207 (string :tag
" numbered")
208 (string :tag
"unnumbered"))
209 (function :tag
"Hook computing sectioning"))))))
213 (defcustom org-texinfo-format-headline-function
214 'org-texinfo-format-headline-default-function
215 "Function to format headline text.
217 This function will be called with 5 arguments:
218 TODO the todo keyword (string or nil).
219 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
220 PRIORITY the priority of the headline (integer or nil)
221 TEXT the main headline text (string).
222 TAGS the tags as a list of strings (list of strings or nil).
224 The function result will be used in the section format string."
225 :group
'org-export-texinfo
228 :package-version
'(Org .
"8.3"))
230 ;;;; Node listing (menu)
232 (defcustom org-texinfo-node-description-column
32
233 "Column at which to start the description in the node listings.
234 If a node title is greater than this length, the description will
235 be placed after the end of the title."
236 :group
'org-export-texinfo
241 (defcustom org-texinfo-active-timestamp-format
"@emph{%s}"
242 "A printf format string to be applied to active timestamps."
243 :group
'org-export-texinfo
246 (defcustom org-texinfo-inactive-timestamp-format
"@emph{%s}"
247 "A printf format string to be applied to inactive timestamps."
248 :group
'org-export-texinfo
251 (defcustom org-texinfo-diary-timestamp-format
"@emph{%s}"
252 "A printf format string to be applied to diary timestamps."
253 :group
'org-export-texinfo
258 (defcustom org-texinfo-link-with-unknown-path-format
"@indicateurl{%s}"
259 "Format string for links with unknown path type."
260 :group
'org-export-texinfo
265 (defcustom org-texinfo-tables-verbatim nil
266 "When non-nil, tables are exported verbatim."
267 :group
'org-export-texinfo
270 (defcustom org-texinfo-table-scientific-notation
"%s\\,(%s)"
271 "Format string to display numbers in scientific notation.
272 The format should have \"%s\" twice, for mantissa and exponent
273 \(i.e. \"%s\\\\times10^{%s}\").
275 When nil, no transformation is made."
276 :group
'org-export-texinfo
278 (string :tag
"Format string")
279 (const :tag
"No formatting" nil
)))
281 (defcustom org-texinfo-def-table-markup
"@samp"
282 "Default setting for @table environments."
283 :group
'org-export-texinfo
288 (defcustom org-texinfo-text-markup-alist
'((bold .
"@strong{%s}")
290 (italic .
"@emph{%s}")
292 "Alist of Texinfo expressions to convert text markup.
294 The key must be a symbol among `bold', `code', `italic',
295 `strike-through', `underscore' and `verbatim'. The value is
296 a formatting string to wrap fontified text with.
298 Value can also be set to the following symbols: `verb' and
299 `code'. For the former, Org will use \"@verb\" to create
300 a format string and select a delimiter character that isn't in
301 the string. For the latter, Org will use \"@code\" to typeset
302 and try to protect special characters.
304 If no association can be found for a given markup, text will be
306 :group
'org-export-texinfo
308 :options
'(bold code italic strike-through underscore verbatim
))
312 (defcustom org-texinfo-format-drawer-function
(lambda (_name contents
) contents
)
313 "Function called to format a drawer in Texinfo code.
315 The function must accept two parameters:
316 NAME the drawer name, like \"LOGBOOK\"
317 CONTENTS the contents of the drawer.
319 The function should return the string to be exported.
321 The default function simply returns the value of CONTENTS."
322 :group
'org-export-texinfo
324 :package-version
'(Org .
"8.2")
329 (defcustom org-texinfo-format-inlinetask-function
330 'org-texinfo-format-inlinetask-default-function
331 "Function called to format an inlinetask in Texinfo code.
333 The function must accept six parameters:
334 TODO the todo keyword, as a string
335 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
336 PRIORITY the inlinetask priority, as a string
337 NAME the inlinetask name, as a string.
338 TAGS the inlinetask tags, as a list of strings.
339 CONTENTS the contents of the inlinetask, as a string.
341 The function should return the string to be exported."
342 :group
'org-export-texinfo
347 (defcustom org-texinfo-info-process
'("makeinfo %f")
348 "Commands to process a Texinfo file to an INFO file.
350 This is a list of strings, each of them will be given to the
351 shell as a command. %f in the command will be replaced by the
352 relative file name, %F by the absolute file name, %b by the file
353 base name (i.e. without directory and extension parts), %o by the
354 base directory of the file and %O by the absolute file name of
356 :group
'org-export-texinfo
357 :type
'(repeat :tag
"Shell command sequence"
358 (string :tag
"Shell command")))
360 (defcustom org-texinfo-logfiles-extensions
361 '("aux" "toc" "cp" "fn" "ky" "pg" "tp" "vr")
362 "The list of file extensions to consider as Texinfo logfiles.
363 The logfiles will be remove if `org-texinfo-remove-logfiles' is
365 :group
'org-export-texinfo
366 :type
'(repeat (string :tag
"Extension")))
368 (defcustom org-texinfo-remove-logfiles t
369 "Non-nil means remove the logfiles produced by compiling a Texinfo file.
370 By default, logfiles are files with these extensions: .aux, .toc,
371 .cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove,
372 set `org-texinfo-logfiles-extensions'."
373 :group
'org-export-latex
378 (defconst org-texinfo-max-toc-depth
4
379 "Maximum depth for creation of detailed menu listings.
380 Beyond this depth, Texinfo will not recognize the nodes and will
381 cause errors. Left as a constant in case this value ever
384 (defconst org-texinfo-supported-coding-systems
385 '("US-ASCII" "UTF-8" "ISO-8859-15" "ISO-8859-1" "ISO-8859-2" "koi8-r" "koi8-u")
386 "List of coding systems supported by Texinfo, as strings.
387 Specified coding system will be matched against these strings.
388 If two strings share the same prefix (e.g. \"ISO-8859-1\" and
389 \"ISO-8859-15\"), the most specific one has to be listed first.")
391 (defconst org-texinfo-inline-image-rules
393 (regexp-opt '("eps" "pdf" "png" "jpg" "jpeg" "gif" "svg"))))
394 "Rules characterizing image files that can be inlined.")
397 ;;; Internal Functions
399 (defun org-texinfo--filter-section-blank-lines (headline _backend _info
)
400 "Filter controlling number of blank lines after a section."
401 (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" "\n\n" headline
))
403 (defun org-texinfo--normalize-headlines (tree _backend info
)
404 "Normalize headlines in TREE.
406 BACK-END is the symbol specifying back-end used for export. INFO
407 is a plist used as a communication channel.
409 Make sure every headline in TREE contains a section, since those
410 are required to install a menu. Also put exactly one blank line
411 at the end of each section.
414 (org-element-map tree
'headline
416 (org-element-put-property hl
:post-blank
1)
417 (let ((contents (org-element-contents hl
)))
419 (let ((first (org-element-map contents
'(headline section
)
421 (unless (eq (org-element-type first
) 'section
)
422 (apply #'org-element-set-contents
424 (cons `(section (:parent
,hl
)) contents
)))))))
428 (defun org-texinfo--find-verb-separator (s)
429 "Return a character not used in string S.
430 This is used to choose a separator for constructs like \\verb."
431 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
432 (cl-loop for c across ll
433 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
434 return
(char-to-string c
))))
436 (defun org-texinfo--text-markup (text markup _info
)
437 "Format TEXT depending on MARKUP text markup.
438 INFO is a plist used as a communication channel. See
439 `org-texinfo-text-markup-alist' for details."
440 (pcase (cdr (assq markup org-texinfo-text-markup-alist
))
441 ;; No format string: Return raw text.
444 (let ((separator (org-texinfo--find-verb-separator text
)))
445 (concat "@verb{" separator text separator
"}")))
447 (format "@code{%s}" (replace-regexp-in-string "[@{}]" "@\\&" text
)))
448 ;; Else use format string.
449 (fmt (format fmt text
))))
451 (defun org-texinfo--get-node (blob info
)
452 "Return node or anchor associated to BLOB.
453 BLOB is an element or object. INFO is a plist used as
454 a communication channel. The function guarantees the node or
455 anchor name is unique."
456 (let ((cache (plist-get info
:texinfo-node-cache
)))
457 (or (cdr (assq blob cache
))
459 (org-texinfo--sanitize-node
460 (if (eq (org-element-type blob
) 'headline
)
461 (org-export-data (org-export-get-alt-title blob info
) info
)
462 (org-export-get-reference blob info
)))))
463 ;; Ensure NAME is unique.
464 (while (rassoc name cache
) (setq name
(concat name
"x")))
465 (plist-put info
:texinfo-node-cache
(cons (cons blob name
) cache
))
468 (defun org-texinfo--sanitize-node (title)
469 "Bend string TITLE to node line requirements.
470 Trim string and collapse multiple whitespace characters as they
471 are not significant. Also remove the following characters: @
473 (replace-regexp-in-string
475 (replace-regexp-in-string
476 "\\`(\\(.*)\\)" "[\\1"
477 (org-trim (replace-regexp-in-string "[ \t]\\{2,\\}" " " title
)))))
479 (defun org-texinfo--sanitize-content (text)
480 "Escape special characters in string TEXT.
481 Special characters are: @ { }"
482 (replace-regexp-in-string "[@{}]" "@\\&" text
))
484 (defun org-texinfo--wrap-float (value info
&optional type label caption short
)
485 "Wrap string VALUE within a @float command.
486 INFO is the current export state, as a plist. TYPE is float
487 type, as a string. LABEL is the cross reference label for the
488 float, as a string. CAPTION and SHORT are, respectively, the
489 caption and shortcaption used for the float, as secondary
490 strings (e.g., returned by `org-export-get-caption')."
492 (org-export-create-backend
494 :transcoders
'((link .
(lambda (object c i
) c
))
495 (radio-target .
(lambda (object c i
) c
))
498 (org-export-create-backend
500 :transcoders
'((footnote-reference . ignore
)
501 (inline-src-block . ignore
)
502 (link .
(lambda (object c i
) c
))
503 (radio-target .
(lambda (object c i
) c
))
505 (verbatim . ignore
))))
507 (if (and short caption
)
508 (format "@shortcaption{%s}\n"
509 (org-export-data-with-backend short short-backend info
))
512 (if (or short caption
)
513 (format "@caption{%s}\n"
514 (org-export-data-with-backend
516 (if (equal short-str
"") short-backend backend
)
519 (format "@float %s%s\n%s\n%s%s@end float"
520 type
(if label
(concat "," label
) "") value caption-str short-str
)))
524 (defun org-texinfo-template (contents info
)
525 "Return complete document string after Texinfo conversion.
526 CONTENTS is the transcoded contents string. INFO is a plist
527 holding export options."
528 (let ((title (org-export-data (plist-get info
:title
) info
))
529 ;; Copying data is the contents of the first headline in
530 ;; parse tree with a non-nil copying property.
531 (copying (org-element-map (plist-get info
:parse-tree
) 'headline
533 (and (org-not-nil (org-element-property :COPYING hl
))
534 (org-element-contents hl
)))
537 "\\input texinfo @c -*- texinfo -*-\n"
538 "@c %**start of header\n"
539 (let ((file (or (plist-get info
:texinfo-filename
)
540 (let ((f (plist-get info
:output-file
)))
541 (and f
(concat (file-name-sans-extension f
) ".info"))))))
542 (and file
(format "@setfilename %s\n" file
)))
543 (format "@settitle %s\n" title
)
544 ;; Insert class-defined header.
545 (org-element-normalize-string
546 (let ((header (nth 1 (assoc (plist-get info
:texinfo-class
)
547 org-texinfo-classes
)))
549 (catch 'coding-system
550 (let ((case-fold-search t
)
551 (name (symbol-name (or org-texinfo-coding-system
552 buffer-file-coding-system
))))
553 (dolist (system org-texinfo-supported-coding-systems
"UTF-8")
554 (when (string-match-p (regexp-quote system
) name
)
555 (throw 'coding-system system
))))))
556 (language (plist-get info
:language
))
557 (case-fold-search nil
))
558 ;; Auto coding system.
559 (replace-regexp-in-string
560 "^@documentencoding \\(AUTO\\)$"
562 (replace-regexp-in-string
563 "^@documentlanguage \\(AUTO\\)$" language header t nil
1) t nil
1)))
564 ;; Additional header options set by #+TEXINFO_HEADER.
565 (let ((texinfo-header (plist-get info
:texinfo-header
)))
566 (and texinfo-header
(org-element-normalize-string texinfo-header
)))
567 "@c %**end of header\n\n"
568 ;; Additional options set by #+TEXINFO_POST_HEADER.
569 (let ((texinfo-post-header (plist-get info
:texinfo-post-header
)))
570 (and texinfo-post-header
571 (org-element-normalize-string texinfo-post-header
)))
574 (format "@copying\n%s@end copying\n\n"
575 (org-element-normalize-string
576 (org-export-data copying info
))))
577 ;; Info directory information. Only supply if both title and
578 ;; category are provided.
579 (let ((dircat (plist-get info
:texinfo-dircat
))
581 (let ((title (plist-get info
:texinfo-dirtitle
)))
583 (string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title
)
584 (format "* %s." (match-string 1 title
))))))
585 (when (and dircat dirtitle
)
586 (concat "@dircategory " dircat
"\n"
589 (let ((desc (plist-get info
:texinfo-dirdesc
)))
590 (cond ((not desc
) nil
)
591 ((string-suffix-p "." desc
) desc
)
592 (t (concat desc
"."))))))
593 (if dirdesc
(format "%-23s %s" dirtitle dirdesc
) dirtitle
))
595 "@end direntry\n\n")))
599 (when (plist-get info
:with-title
)
601 (format "@title %s\n" (or (plist-get info
:texinfo-printed-title
) title
""))
602 (let ((subtitle (plist-get info
:subtitle
)))
604 (format "@subtitle %s\n"
605 (org-export-data subtitle info
))))))
606 (when (plist-get info
:with-author
)
609 (let ((author (org-string-nw-p
610 (org-export-data (plist-get info
:author
) info
)))
611 (email (and (plist-get info
:with-email
)
613 (org-export-data (plist-get info
:email
) info
)))))
614 (cond ((and author email
)
615 (format "@author %s (@email{%s})\n" author email
))
616 (author (format "@author %s\n" author
))
617 (email (format "@author @email{%s}\n" email
))))
619 (let ((subauthor (plist-get info
:subauthor
)))
621 (org-element-normalize-string
622 (replace-regexp-in-string "^" "@author " subauthor
))))))
623 (and copying
"@page\n@vskip 0pt plus 1filll\n@insertcopying\n")
625 ;; Table of contents.
626 (and (plist-get info
:with-toc
) "@contents\n\n")
627 ;; Configure Top Node when not for Tex
630 (format "@top %s\n" title
)
631 (and copying
"@insertcopying\n")
634 (org-texinfo-make-menu (plist-get info
:parse-tree
) info
'master
)
639 (and (plist-get info
:with-creator
)
640 (concat (plist-get info
:creator
) "\n"))
646 ;;; Transcode Functions
650 (defun org-texinfo-bold (_bold contents info
)
651 "Transcode BOLD from Org to Texinfo.
652 CONTENTS is the text with bold markup. INFO is a plist holding
653 contextual information."
654 (org-texinfo--text-markup contents
'bold info
))
658 (defun org-texinfo-center-block (_center-block contents _info
)
659 "Transcode a CENTER-BLOCK element from Org to Texinfo.
660 CONTENTS holds the contents of the block. INFO is a plist used
661 as a communication channel."
666 (defun org-texinfo-clock (clock _contents info
)
667 "Transcode a CLOCK element from Org to Texinfo.
668 CONTENTS is nil. INFO is a plist holding contextual
672 (format "@strong{%s} " org-clock-string
)
673 (format (plist-get info
:texinfo-inactive-timestamp-format
)
674 (concat (org-timestamp-translate (org-element-property :value clock
))
675 (let ((time (org-element-property :duration clock
)))
676 (and time
(format " (%s)" time
)))))
681 (defun org-texinfo-code (code _contents info
)
682 "Transcode a CODE object from Org to Texinfo.
683 CONTENTS is nil. INFO is a plist used as a communication
685 (org-texinfo--text-markup (org-element-property :value code
) 'code info
))
689 (defun org-texinfo-drawer (drawer contents info
)
690 "Transcode a DRAWER element from Org to Texinfo.
691 CONTENTS holds the contents of the block. INFO is a plist
692 holding contextual information."
693 (let* ((name (org-element-property :drawer-name drawer
))
694 (output (funcall (plist-get info
:texinfo-format-drawer-function
)
700 (defun org-texinfo-dynamic-block (_dynamic-block contents _info
)
701 "Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
702 CONTENTS holds the contents of the block. INFO is a plist
703 holding contextual information."
708 (defun org-texinfo-entity (entity _contents _info
)
709 "Transcode an ENTITY object from Org to Texinfo.
710 CONTENTS are the definition itself. INFO is a plist holding
711 contextual information."
712 (let ((ent (org-element-property :latex entity
)))
713 (if (org-element-property :latex-math-p entity
) (format "@math{%s}" ent
) ent
)))
717 (defun org-texinfo-example-block (example-block _contents info
)
718 "Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
719 CONTENTS is nil. INFO is a plist holding contextual
721 (format "@verbatim\n%s@end verbatim"
722 (org-export-format-code-default example-block info
)))
726 (defun org-texinfo-export-block (export-block _contents _info
)
727 "Transcode a EXPORT-BLOCK element from Org to Texinfo.
728 CONTENTS is nil. INFO is a plist holding contextual information."
729 (when (string= (org-element-property :type export-block
) "TEXINFO")
730 (org-remove-indentation (org-element-property :value export-block
))))
734 (defun org-texinfo-export-snippet (export-snippet _contents _info
)
735 "Transcode a EXPORT-SNIPPET object from Org to Texinfo.
736 CONTENTS is nil. INFO is a plist holding contextual information."
737 (when (eq (org-export-snippet-backend export-snippet
) 'texinfo
)
738 (org-element-property :value export-snippet
)))
742 (defun org-texinfo-fixed-width (fixed-width _contents _info
)
743 "Transcode a FIXED-WIDTH element from Org to Texinfo.
744 CONTENTS is nil. INFO is a plist holding contextual information."
745 (format "@example\n%s\n@end example"
746 (org-remove-indentation
747 (org-texinfo--sanitize-content
748 (org-element-property :value fixed-width
)))))
750 ;;;; Footnote Reference
752 (defun org-texinfo-footnote-reference (footnote _contents info
)
753 "Create a footnote reference for FOOTNOTE.
755 FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
756 plist holding contextual information."
757 (let ((def (org-export-get-footnote-definition footnote info
)))
758 (format "@footnote{%s}"
759 (org-trim (org-export-data def info
)))))
763 (defun org-texinfo-headline (headline contents info
)
764 "Transcode a HEADLINE element from Org to Texinfo.
765 CONTENTS holds the contents of the headline. INFO is a plist
766 holding contextual information."
767 (let* ((class (plist-get info
:texinfo-class
))
768 (level (org-export-get-relative-level headline info
))
769 (numberedp (org-export-numbered-headline-p headline info
))
770 (class-sectioning (assoc class
(plist-get info
:texinfo-classes
)))
771 ;; Find the index type, if any.
772 (index (org-element-property :INDEX headline
))
773 ;; Create node info, to insert it before section formatting.
774 ;; Use custom menu title if present.
775 (node (format "@node %s\n" (org-texinfo--get-node headline info
)))
776 ;; Section formatting will set two placeholders: one for the
777 ;; title and the other for the contents.
779 (if (org-not-nil (org-element-property :APPENDIX headline
))
781 (let ((sec (if (and (symbolp (nth 2 class-sectioning
))
782 (fboundp (nth 2 class-sectioning
)))
783 (funcall (nth 2 class-sectioning
) level numberedp
)
784 (nth (1+ level
) class-sectioning
))))
786 ;; No section available for that LEVEL.
788 ;; Section format directly returned by a function.
790 ;; (numbered-section . unnumbered-section)
791 ((not (consp (cdr sec
)))
792 (concat (if (or index
(not numberedp
)) (cdr sec
) (car sec
))
795 (and (plist-get info
:with-todo-keywords
)
796 (let ((todo (org-element-property :todo-keyword headline
)))
797 (and todo
(org-export-data todo info
)))))
798 (todo-type (and todo
(org-element-property :todo-type headline
)))
799 (tags (and (plist-get info
:with-tags
)
800 (org-export-get-tags headline info
)))
801 (priority (and (plist-get info
:with-priority
)
802 (org-element-property :priority headline
)))
803 (text (org-export-data (org-element-property :title headline
) info
))
804 (full-text (funcall (plist-get info
:texinfo-format-headline-function
)
805 todo todo-type priority text tags
))
806 (contents (if (org-string-nw-p contents
) (concat "\n" contents
) "")))
808 ;; Case 1: This is a footnote section: ignore it.
809 ((org-element-property :footnote-section-p headline
) nil
)
810 ;; Case 2: This is the `copying' section: ignore it
811 ;; This is used elsewhere.
812 ((org-not-nil (org-element-property :COPYING headline
)) nil
)
813 ;; Case 3: An index. If it matches one of the known indexes,
814 ;; print it as such following the contents, otherwise
815 ;; print the contents and leave the index up to the user.
822 (and (member index
'("cp" "fn" "ky" "pg" "tp" "vr"))
823 (concat "\n@printindex " index
))))))
824 ;; Case 4: This is a deep sub-tree: export it as a list item.
825 ;; Also export as items headlines for which no section
826 ;; format has been found.
827 ((or (not section-fmt
) (org-export-low-level-p headline info
))
828 ;; Build the real contents of the sub-tree.
829 (concat (and (org-export-first-sibling-p headline info
)
830 (format "@%s\n" (if numberedp
'enumerate
'itemize
)))
831 "@item\n" full-text
"\n"
833 (if (org-export-last-sibling-p headline info
)
834 (format "@end %s" (if numberedp
'enumerate
'itemize
))
836 ;; Case 5: Standard headline. Export it as a section.
837 (t (concat node
(format section-fmt full-text contents
))))))
839 (defun org-texinfo-format-headline-default-function
840 (todo _todo-type priority text tags
)
841 "Default format function for a headline.
842 See `org-texinfo-format-headline-function' for details."
843 (concat (when todo
(format "@strong{%s} " todo
))
844 (when priority
(format "@emph{#%s} " priority
))
846 (when tags
(format " :%s:" (mapconcat 'identity tags
":")))))
848 ;;;; Inline Src Block
850 (defun org-texinfo-inline-src-block (inline-src-block _contents _info
)
851 "Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
852 CONTENTS holds the contents of the item. INFO is a plist holding
853 contextual information."
854 (let* ((code (org-element-property :value inline-src-block
))
855 (separator (org-texinfo--find-verb-separator code
)))
856 (concat "@verb{" separator code separator
"}")))
860 (defun org-texinfo-inlinetask (inlinetask contents info
)
861 "Transcode an INLINETASK element from Org to Texinfo.
862 CONTENTS holds the contents of the block. INFO is a plist
863 holding contextual information."
864 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
865 (todo (and (plist-get info
:with-todo-keywords
)
866 (let ((todo (org-element-property :todo-keyword inlinetask
)))
867 (and todo
(org-export-data todo info
)))))
868 (todo-type (org-element-property :todo-type inlinetask
))
869 (tags (and (plist-get info
:with-tags
)
870 (org-export-get-tags inlinetask info
)))
871 (priority (and (plist-get info
:with-priority
)
872 (org-element-property :priority inlinetask
))))
873 (funcall (plist-get info
:texinfo-format-inlinetask-function
)
874 todo todo-type priority title tags contents
)))
876 (defun org-texinfo-format-inlinetask-default-function
877 (todo _todo-type priority title tags contents
)
878 "Default format function for a inlinetasks.
879 See `org-texinfo-format-inlinetask-function' for details."
881 (concat (when todo
(format "@strong{%s} " todo
))
882 (when priority
(format "#%c " priority
))
884 (when tags
(format ":%s:" (mapconcat #'identity tags
":"))))))
885 (format "@center %s\n\n%s\n" full-title contents
)))
889 (defun org-texinfo-italic (_italic contents info
)
890 "Transcode ITALIC from Org to Texinfo.
891 CONTENTS is the text with italic markup. INFO is a plist holding
892 contextual information."
893 (org-texinfo--text-markup contents
'italic info
))
897 (defun org-texinfo-item (item contents info
)
898 "Transcode an ITEM element from Org to Texinfo.
899 CONTENTS holds the contents of the item. INFO is a plist holding
900 contextual information."
901 (format "@item%s\n%s"
902 (let ((tag (org-element-property :tag item
)))
903 (if tag
(concat " " (org-export-data tag info
)) ""))
908 (defun org-texinfo-keyword (keyword _contents info
)
909 "Transcode a KEYWORD element from Org to Texinfo.
910 CONTENTS is nil. INFO is a plist holding contextual information."
911 (let ((key (org-element-property :key keyword
))
912 (value (org-element-property :value keyword
)))
914 ((string= key
"TEXINFO") value
)
915 ((string= key
"CINDEX") (format "@cindex %s" value
))
916 ((string= key
"FINDEX") (format "@findex %s" value
))
917 ((string= key
"KINDEX") (format "@kindex %s" value
))
918 ((string= key
"PINDEX") (format "@pindex %s" value
))
919 ((string= key
"TINDEX") (format "@tindex %s" value
))
920 ((string= key
"VINDEX") (format "@vindex %s" value
))
922 (cond ((string-match-p "\\<tables\\>" value
)
923 (concat "@listoffloats "
924 (org-export-translate "Table" :utf-8 info
)))
925 ((string-match-p "\\<listings\\>" value
)
926 (concat "@listoffloats "
927 (org-export-translate "Listing" :utf-8 info
))))))))
931 (defun org-texinfo-line-break (_line-break _contents _info
)
932 "Transcode a LINE-BREAK object from Org to Texinfo.
933 CONTENTS is nil. INFO is a plist holding contextual information."
938 (defun org-texinfo-link (link desc info
)
939 "Transcode a LINK object from Org to Texinfo.
941 DESC is the description part of the link, or the empty string.
942 INFO is a plist holding contextual information. See
944 (let* ((type (org-element-property :type link
))
945 (raw-path (org-element-property :path link
))
946 ;; Ensure DESC really exists, or set it to nil.
947 (desc (and (not (string= desc
"")) desc
))
949 ((member type
'("http" "https" "ftp"))
950 (concat type
":" raw-path
))
951 ((string= type
"file") (org-export-file-uri raw-path
))
954 ((org-export-custom-protocol-maybe link desc
'texinfo
))
955 ((org-export-inline-image-p link org-texinfo-inline-image-rules
)
956 (org-texinfo--inline-image link info
))
957 ((equal type
"radio")
958 (let ((destination (org-export-resolve-radio-link link info
)))
959 (if (not destination
) desc
960 (format "@ref{%s,,%s}"
961 (org-texinfo--get-node destination info
)
963 ((member type
'("custom-id" "id" "fuzzy"))
965 (if (equal type
"fuzzy")
966 (org-export-resolve-fuzzy-link link info
)
967 (org-export-resolve-id-link link info
))))
968 (pcase (org-element-type destination
)
970 (format org-texinfo-link-with-unknown-path-format
971 (org-texinfo--sanitize-content path
)))
972 ;; Id link points to an external file.
974 (if desc
(format "@uref{file://%s,%s}" destination desc
)
975 (format "@uref{file://%s}" destination
)))
977 (format "@ref{%s,%s}"
978 (org-texinfo--get-node destination info
)
981 ((org-export-numbered-headline-p destination info
)
984 (org-export-get-headline-number destination info
) "."))
986 (org-element-property :title destination
) info
)))))
988 (format "@ref{%s,,%s}"
989 (org-texinfo--get-node destination info
)
992 ;; No description is provided: first try to
993 ;; associate destination to a number.
994 ((let ((n (org-export-get-ordinal destination info
)))
997 (t (mapconcat #'number-to-string n
".")))))
998 ;; Then grab title of headline containing
1000 ((let ((h (org-element-lineage destination
'(headline) t
)))
1003 (org-element-property :title destination
) info
))))
1004 ;; Eventually, just return "Top" to refer to the
1005 ;; beginning of the info file.
1007 ((string= type
"mailto")
1008 (format "@email{%s}"
1009 (concat (org-texinfo--sanitize-content path
)
1010 (and desc
(concat "," desc
)))))
1011 ;; External link with a description part.
1012 ((and path desc
) (format "@uref{%s,%s}" path desc
))
1013 ;; External link without a description part.
1014 (path (format "@uref{%s}" path
))
1015 ;; No path, only description. Try to do something useful.
1017 (format (plist-get info
:texinfo-link-with-unknown-path-format
) desc
)))))
1019 (defun org-texinfo--inline-image (link info
)
1020 "Return Texinfo code for an inline image.
1021 LINK is the link pointing to the inline image. INFO is the
1022 current state of the export, as a plist."
1023 (let* ((parent (org-export-get-parent-element link
))
1024 (label (and (org-element-property :name parent
)
1025 (org-texinfo--get-node parent info
)))
1026 (caption (org-export-get-caption parent
))
1027 (shortcaption (org-export-get-caption parent t
))
1028 (path (org-element-property :path link
))
1030 (file-name-sans-extension
1031 (if (file-name-absolute-p path
) (expand-file-name path
) path
)))
1032 (extension (file-name-extension path
))
1033 (attributes (org-export-read-attribute :attr_texinfo parent
))
1034 (height (or (plist-get attributes
:height
) ""))
1035 (width (or (plist-get attributes
:width
) ""))
1036 (alt (or (plist-get attributes
:alt
) ""))
1037 (image (format "@image{%s,%s,%s,%s,%s}"
1038 filename width height alt extension
)))
1039 (cond ((or caption shortcaption
)
1040 (org-texinfo--wrap-float image
1042 (org-export-translate "Figure" :utf-8 info
)
1046 (label (concat "@anchor{" label
"}\n" image
))
1052 (defun org-texinfo-make-menu (scope info
&optional master
)
1053 "Create the menu for inclusion in the Texinfo document.
1055 SCOPE is a headline or a full parse tree. INFO is the
1056 communication channel, as a plist.
1058 When optional argument MASTER is non-nil, generate a master menu,
1059 including detailed node listing."
1060 (let ((menu (org-texinfo--build-menu scope info
)))
1061 (when (org-string-nw-p menu
)
1062 (org-element-normalize-string
1064 "@menu\n%s@end menu"
1068 (org-texinfo--build-menu
1070 (let ((toc-depth (plist-get info
:with-toc
)))
1071 (if (wholenump toc-depth
) toc-depth
1072 org-texinfo-max-toc-depth
)))))
1073 (when (org-string-nw-p detailmenu
)
1074 (concat "\n@detailmenu\n"
1075 "--- The Detailed Node Listing ---\n\n"
1077 "@end detailmenu\n"))))))))))
1079 (defun org-texinfo--build-menu (scope info
&optional level
)
1080 "Build menu for entries within SCOPE.
1081 SCOPE is a headline or a full parse tree. INFO is a plist
1082 containing contextual information. When optional argument LEVEL
1083 is an integer, build the menu recursively, down to this depth."
1086 (org-texinfo--format-entries (org-texinfo--menu-entries scope info
) info
))
1089 (org-element-normalize-string
1092 (let ((entries (org-texinfo--menu-entries h info
)))
1095 (format "%s\n\n%s\n"
1096 (org-export-data (org-export-get-alt-title h info
) info
)
1097 (org-texinfo--format-entries entries info
))
1098 (org-texinfo--build-menu h info
(1- level
))))))
1099 (org-texinfo--menu-entries scope info
) "\n")))))
1101 (defun org-texinfo--format-entries (entries info
)
1102 "Format all direct menu entries in SCOPE, as a string.
1103 SCOPE is either a headline or a full Org document. INFO is
1104 a plist containing contextual information."
1105 (org-element-normalize-string
1108 (let* ((title (org-export-data
1109 (org-export-get-alt-title h info
) info
))
1110 (node (org-texinfo--get-node h info
))
1111 (entry (concat "* " title
":"
1112 (if (string= title node
) ":"
1113 (concat " " node
". "))))
1114 (desc (org-element-property :DESCRIPTION h
)))
1115 (if (not desc
) entry
1116 (format (format "%%-%ds %%s" org-texinfo-node-description-column
)
1120 (defun org-texinfo--menu-entries (scope info
)
1121 "List direct children in SCOPE needing a menu entry.
1122 SCOPE is a headline or a full parse tree. INFO is a plist
1123 holding contextual information."
1124 (let* ((cache (or (plist-get info
:texinfo-entries-cache
)
1125 (plist-get (plist-put info
:texinfo-entries-cache
1126 (make-hash-table :test
#'eq
))
1127 :texinfo-entries-cache
)))
1128 (cached-entries (gethash scope cache
'no-cache
)))
1129 (if (not (eq cached-entries
'no-cache
)) cached-entries
1131 (org-element-map (org-element-contents scope
) 'headline
1133 (and (not (org-not-nil (org-element-property :COPYING h
)))
1134 (not (org-element-property :footnote-section-p h
))
1135 (not (org-export-low-level-p h info
))
1142 (defun org-texinfo-node-property (node-property _contents _info
)
1143 "Transcode a NODE-PROPERTY element from Org to Texinfo.
1144 CONTENTS is nil. INFO is a plist holding contextual
1147 (org-element-property :key node-property
)
1148 (let ((value (org-element-property :value node-property
)))
1149 (if value
(concat " " value
) ""))))
1153 (defun org-texinfo-paragraph (_paragraph contents _info
)
1154 "Transcode a PARAGRAPH element from Org to Texinfo.
1155 CONTENTS is the contents of the paragraph, as a string. INFO is
1156 the plist used as a communication channel."
1161 (defun org-texinfo-plain-list (plain-list contents info
)
1162 "Transcode a PLAIN-LIST element from Org to Texinfo.
1163 CONTENTS is the contents of the list. INFO is a plist holding
1164 contextual information."
1165 (let* ((attr (org-export-read-attribute :attr_texinfo plain-list
))
1166 (indic (or (plist-get attr
:indic
)
1167 (plist-get info
:texinfo-def-table-markup
)))
1168 (table-type (plist-get attr
:table-type
))
1169 (type (org-element-property :type plain-list
))
1171 ((eq type
'ordered
) "enumerate")
1172 ((eq type
'unordered
) "itemize")
1173 ((member table-type
'("ftable" "vtable")) table-type
)
1175 (format "@%s\n%s@end %s"
1176 (if (eq type
'descriptive
) (concat list-type
" " indic
) list-type
)
1182 (defun org-texinfo-plain-text (text info
)
1183 "Transcode a TEXT string from Org to Texinfo.
1184 TEXT is the string to transcode. INFO is a plist holding
1185 contextual information."
1186 ;; First protect @, { and }.
1187 (let ((output (org-texinfo--sanitize-content text
)))
1188 ;; Activate smart quotes. Be sure to provide original TEXT string
1189 ;; since OUTPUT may have been modified.
1190 (when (plist-get info
:with-smart-quotes
)
1192 (org-export-activate-smart-quotes output
:texinfo info text
)))
1193 ;; LaTeX into @LaTeX{} and TeX into @TeX{}
1194 (let ((case-fold-search nil
)
1196 (while (string-match "\\(\\(?:La\\)?TeX\\)" output start
)
1197 (setq output
(replace-match
1198 (format "@%s{}" (match-string 1 output
)) nil t output
)
1199 start
(match-end 0))))
1200 ;; Convert special strings.
1201 (when (plist-get info
:with-special-strings
)
1202 (while (string-match (regexp-quote "...") output
)
1203 (setq output
(replace-match "@dots{}" nil t output
))))
1204 ;; Handle break preservation if required.
1205 (when (plist-get info
:preserve-breaks
)
1206 (setq output
(replace-regexp-in-string
1207 "\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output
)))
1213 (defun org-texinfo-planning (planning _contents info
)
1214 "Transcode a PLANNING element from Org to Texinfo.
1215 CONTENTS is nil. INFO is a plist holding contextual
1223 (let ((closed (org-element-property :closed planning
)))
1226 (format "@strong{%s} " org-closed-string
)
1227 (format (plist-get info
:texinfo-inactive-timestamp-format
)
1228 (org-timestamp-translate closed
)))))
1229 (let ((deadline (org-element-property :deadline planning
)))
1232 (format "@strong{%s} " org-deadline-string
)
1233 (format (plist-get info
:texinfo-active-timestamp-format
)
1234 (org-timestamp-translate deadline
)))))
1235 (let ((scheduled (org-element-property :scheduled planning
)))
1238 (format "@strong{%s} " org-scheduled-string
)
1239 (format (plist-get info
:texinfo-active-timestamp-format
)
1240 (org-timestamp-translate scheduled
)))))))
1244 ;;;; Property Drawer
1246 (defun org-texinfo-property-drawer (_property-drawer contents _info
)
1247 "Transcode a PROPERTY-DRAWER element from Org to Texinfo.
1248 CONTENTS holds the contents of the drawer. INFO is a plist
1249 holding contextual information."
1250 (and (org-string-nw-p contents
)
1251 (format "@verbatim\n%s@end verbatim" contents
)))
1255 (defun org-texinfo-quote-block (quote-block contents _info
)
1256 "Transcode a QUOTE-BLOCK element from Org to Texinfo.
1257 CONTENTS holds the contents of the block. INFO is a plist
1258 holding contextual information."
1259 (let* ((title (org-element-property :name quote-block
))
1260 (start-quote (concat "@quotation"
1262 (format " %s" title
)))))
1263 (format "%s\n%s@end quotation" start-quote contents
)))
1267 (defun org-texinfo-radio-target (radio-target text info
)
1268 "Transcode a RADIO-TARGET object from Org to Texinfo.
1269 TEXT is the text of the target. INFO is a plist holding
1270 contextual information."
1271 (format "@anchor{%s}%s"
1272 (org-export-get-reference radio-target info
)
1277 (defun org-texinfo-section (section contents info
)
1278 "Transcode a SECTION element from Org to Texinfo.
1279 CONTENTS holds the contents of the section. INFO is a plist
1280 holding contextual information."
1284 (let ((parent (org-export-get-parent-headline section
)))
1285 (and parent
(org-texinfo-make-menu parent info
))))))
1289 (defun org-texinfo-special-block (special-block contents _info
)
1290 "Transcode a SPECIAL-BLOCK element from Org to Texinfo.
1291 CONTENTS holds the contents of the block. INFO is a plist used
1292 as a communication channel."
1293 (let ((opt (org-export-read-attribute :attr_texinfo special-block
:options
))
1294 (type (org-element-property :type special-block
)))
1295 (format "@%s%s\n%s@end %s"
1297 (if opt
(concat " " opt
) opt
)
1303 (defun org-texinfo-src-block (src-block _contents info
)
1304 "Transcode a SRC-BLOCK element from Org to Texinfo.
1305 CONTENTS holds the contents of the item. INFO is a plist holding
1306 contextual information."
1307 (let* ((lisp (string-match-p "lisp"
1308 (org-element-property :language src-block
)))
1309 (code (org-texinfo--sanitize-content
1310 (org-export-format-code-default src-block info
)))
1312 (if lisp
"@lisp\n%s@end lisp" "@example\n%s@end example")
1314 (caption (org-export-get-caption src-block
))
1315 (shortcaption (org-export-get-caption src-block t
)))
1316 (if (not (or caption shortcaption
)) value
1317 (org-texinfo--wrap-float value
1319 (org-export-translate "Listing" :utf-8 info
)
1320 (org-export-get-reference src-block info
)
1324 ;;;; Statistics Cookie
1326 (defun org-texinfo-statistics-cookie (statistics-cookie _contents _info
)
1327 "Transcode a STATISTICS-COOKIE object from Org to Texinfo.
1328 CONTENTS is nil. INFO is a plist holding contextual information."
1329 (org-element-property :value statistics-cookie
))
1334 (defun org-texinfo-strike-through (_strike-through contents info
)
1335 "Transcode STRIKE-THROUGH from Org to Texinfo.
1336 CONTENTS is the text with strike-through markup. INFO is a plist
1337 holding contextual information."
1338 (org-texinfo--text-markup contents
'strike-through info
))
1342 (defun org-texinfo-subscript (_subscript contents _info
)
1343 "Transcode a SUBSCRIPT object from Org to Texinfo.
1344 CONTENTS is the contents of the object. INFO is a plist holding
1345 contextual information."
1346 (format "@math{_%s}" contents
))
1350 (defun org-texinfo-superscript (_superscript contents _info
)
1351 "Transcode a SUPERSCRIPT object from Org to Texinfo.
1352 CONTENTS is the contents of the object. INFO is a plist holding
1353 contextual information."
1354 (format "@math{^%s}" contents
))
1358 (defun org-texinfo-table (table contents info
)
1359 "Transcode a TABLE element from Org to Texinfo.
1360 CONTENTS is the contents of the table. INFO is a plist holding
1361 contextual information."
1362 (if (eq (org-element-property :type table
) 'table.el
)
1363 (format "@verbatim\n%s@end verbatim"
1364 (org-element-normalize-string
1365 (org-element-property :value table
)))
1366 (let* ((col-width (org-export-read-attribute :attr_texinfo table
:columns
))
1368 (if col-width
(format "@columnfractions %s" col-width
)
1369 (org-texinfo-table-column-widths table info
)))
1370 (caption (org-export-get-caption table
))
1371 (shortcaption (org-export-get-caption table t
))
1372 (table-str (format "@multitable %s\n%s@end multitable"
1375 (if (not (or caption shortcaption
)) table-str
1376 (org-texinfo--wrap-float table-str
1378 (org-export-translate "Table" :utf-8 info
)
1379 (org-export-get-reference table info
)
1383 (defun org-texinfo-table-column-widths (table info
)
1384 "Determine the largest table cell in each column to process alignment.
1385 TABLE is the table element to transcode. INFO is a plist used as
1386 a communication channel."
1387 (let ((widths (make-vector (cdr (org-export-table-dimensions table info
)) 0)))
1388 (org-element-map table
'table-row
1391 (org-element-map row
'table-cell
1393 ;; Length of the cell in the original buffer is only an
1394 ;; approximation of the length of the cell in the
1395 ;; output. It can sometimes fail (e.g. it considers
1396 ;; "/a/" being larger than "ab").
1397 (let ((w (- (org-element-property :contents-end cell
)
1398 (org-element-property :contents-begin cell
))))
1399 (aset widths idx
(max w
(aref widths idx
))))
1403 (format "{%s}" (mapconcat (lambda (w) (make-string w ?a
)) widths
"} {"))))
1407 (defun org-texinfo-table-cell (table-cell contents info
)
1408 "Transcode a TABLE-CELL element from Org to Texinfo.
1409 CONTENTS is the cell contents. INFO is a plist used as
1410 a communication channel."
1412 (let ((scientific-notation
1413 (plist-get info
:texinfo-table-scientific-notation
)))
1416 (string-match orgtbl-exp-regexp contents
))
1417 ;; Use appropriate format string for scientific notation.
1418 (format scientific-notation
1419 (match-string 1 contents
)
1420 (match-string 2 contents
))
1422 (when (org-export-get-next-element table-cell info
) "\n@tab ")))
1426 (defun org-texinfo-table-row (table-row contents info
)
1427 "Transcode a TABLE-ROW element from Org to Texinfo.
1428 CONTENTS is the contents of the row. INFO is a plist used as
1429 a communication channel."
1430 ;; Rules are ignored since table separators are deduced from
1431 ;; borders of the current row.
1432 (when (eq (org-element-property :type table-row
) 'standard
)
1434 (if (and (= 1 (org-export-table-row-group table-row info
))
1435 (org-export-table-has-header-p
1436 (org-export-get-parent-table table-row
) info
))
1439 (concat rowgroup-tag contents
"\n"))))
1443 (defun org-texinfo-target (target _contents info
)
1444 "Transcode a TARGET object from Org to Texinfo.
1445 CONTENTS is nil. INFO is a plist holding contextual
1447 (format "@anchor{%s}" (org-export-get-reference target info
)))
1451 (defun org-texinfo-timestamp (timestamp _contents info
)
1452 "Transcode a TIMESTAMP object from Org to Texinfo.
1453 CONTENTS is nil. INFO is a plist holding contextual
1455 (let ((value (org-texinfo-plain-text
1456 (org-timestamp-translate timestamp
) info
)))
1457 (pcase (org-element-property :type timestamp
)
1458 ((or `active
`active-range
)
1459 (format (plist-get info
:texinfo-active-timestamp-format
) value
))
1460 ((or `inactive
`inactive-range
)
1461 (format (plist-get info
:texinfo-inactive-timestamp-format
) value
))
1462 (_ (format (plist-get info
:texinfo-diary-timestamp-format
) value
)))))
1466 (defun org-texinfo-underline (_underline contents info
)
1467 "Transcode UNDERLINE from Org to Texinfo.
1468 CONTENTS is the text with underline markup. INFO is a plist
1469 holding contextual information."
1470 (org-texinfo--text-markup contents
'underline info
))
1474 (defun org-texinfo-verbatim (verbatim _contents info
)
1475 "Transcode a VERBATIM object from Org to Texinfo.
1476 CONTENTS is nil. INFO is a plist used as a communication
1478 (org-texinfo--text-markup
1479 (org-element-property :value verbatim
) 'verbatim info
))
1483 (defun org-texinfo-verse-block (_verse-block contents _info
)
1484 "Transcode a VERSE-BLOCK element from Org to Texinfo.
1485 CONTENTS is verse block contents. INFO is a plist holding
1486 contextual information."
1487 (format "@display\n%s@end display" contents
))
1490 ;;; Interactive functions
1492 (defun org-texinfo-export-to-texinfo
1493 (&optional async subtreep visible-only body-only ext-plist
)
1494 "Export current buffer to a Texinfo file.
1496 If narrowing is active in the current buffer, only export its
1499 If a region is active, export that region.
1501 A non-nil optional argument ASYNC means the process should happen
1502 asynchronously. The resulting file should be accessible through
1503 the `org-export-stack' interface.
1505 When optional argument SUBTREEP is non-nil, export the sub-tree
1506 at point, extracting information from the headline properties
1509 When optional argument VISIBLE-ONLY is non-nil, don't export
1510 contents of hidden elements.
1512 When optional argument BODY-ONLY is non-nil, only write code
1513 between \"\\begin{document}\" and \"\\end{document}\".
1515 EXT-PLIST, when provided, is a property list with external
1516 parameters overriding Org default settings, but still inferior to
1517 file-local settings.
1519 Return output file's name."
1521 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1522 (org-export-coding-system org-texinfo-coding-system
))
1523 (org-export-to-file 'texinfo outfile
1524 async subtreep visible-only body-only ext-plist
)))
1526 (defun org-texinfo-export-to-info
1527 (&optional async subtreep visible-only body-only ext-plist
)
1528 "Export current buffer to Texinfo then process through to INFO.
1530 If narrowing is active in the current buffer, only export its
1533 If a region is active, export that region.
1535 A non-nil optional argument ASYNC means the process should happen
1536 asynchronously. The resulting file should be accessible through
1537 the `org-export-stack' interface.
1539 When optional argument SUBTREEP is non-nil, export the sub-tree
1540 at point, extracting information from the headline properties
1543 When optional argument VISIBLE-ONLY is non-nil, don't export
1544 contents of hidden elements.
1546 When optional argument BODY-ONLY is non-nil, only write code
1547 between \"\\begin{document}\" and \"\\end{document}\".
1549 EXT-PLIST, when provided, is a property list with external
1550 parameters overriding Org default settings, but still inferior to
1551 file-local settings.
1553 When optional argument PUB-DIR is set, use it as the publishing
1556 Return INFO file's name."
1558 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1559 (org-export-coding-system org-texinfo-coding-system
))
1560 (org-export-to-file 'texinfo outfile
1561 async subtreep visible-only body-only ext-plist
1562 (lambda (file) (org-texinfo-compile file
)))))
1565 (defun org-texinfo-publish-to-texinfo (plist filename pub-dir
)
1566 "Publish an org file to Texinfo.
1568 FILENAME is the filename of the Org file to be published. PLIST
1569 is the property list for the given project. PUB-DIR is the
1570 publishing directory.
1572 Return output file name."
1573 (org-publish-org-to 'texinfo filename
".texi" plist pub-dir
))
1576 (defun org-texinfo-convert-region-to-texinfo ()
1577 "Assume the current region has Org syntax, and convert it to Texinfo.
1578 This can be used in any buffer. For example, you can write an
1579 itemized list in Org syntax in an Texinfo buffer and use this
1580 command to convert it."
1582 (org-export-replace-region-by 'texinfo
))
1584 (defun org-texinfo-compile (file)
1585 "Compile a texinfo file.
1587 FILE is the name of the file being compiled. Processing is done
1588 through the command specified in `org-texinfo-info-process',
1589 which see. Output is redirected to \"*Org INFO Texinfo Output*\"
1592 Return INFO file name or an error if it couldn't be produced."
1593 (message "Processing Texinfo file %s..." file
)
1594 (let* ((log-name "*Org INFO Texinfo Output*")
1595 (log (get-buffer-create log-name
))
1597 (org-compile-file file org-texinfo-info-process
"info"
1598 (format "See %S for details" log-name
)
1600 (when org-texinfo-remove-logfiles
1601 (let ((base (file-name-sans-extension output
)))
1602 (dolist (ext org-texinfo-logfiles-extensions
)
1603 (let ((file (concat base
"." ext
)))
1604 (when (file-exists-p file
) (delete-file file
))))))
1605 (message "Process completed.")
1609 (provide 'ox-texinfo
)
1612 ;; generated-autoload-file: "org-loaddefs.el"
1615 ;;; ox-texinfo.el ends here