1 ;;; ox-texinfo.el --- Texinfo Back-End for Org Export Engine
3 ;; Copyright (C) 2012-2014 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.
28 (eval-when-compile (require 'cl
))
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 (comment .
(lambda (&rest args
) ""))
43 (comment-block .
(lambda (&rest args
) ""))
44 (drawer . org-texinfo-drawer
)
45 (dynamic-block . org-texinfo-dynamic-block
)
46 (entity . org-texinfo-entity
)
47 (example-block . org-texinfo-example-block
)
48 (export-block . org-texinfo-export-block
)
49 (export-snippet . org-texinfo-export-snippet
)
50 (fixed-width . org-texinfo-fixed-width
)
51 (footnote-definition . org-texinfo-footnote-definition
)
52 (footnote-reference . org-texinfo-footnote-reference
)
53 (headline . org-texinfo-headline
)
54 (inline-src-block . org-texinfo-inline-src-block
)
55 (inlinetask . org-texinfo-inlinetask
)
56 (italic . org-texinfo-italic
)
57 (item . org-texinfo-item
)
58 (keyword . org-texinfo-keyword
)
59 (line-break . org-texinfo-line-break
)
60 (link . org-texinfo-link
)
61 (node-property . org-texinfo-node-property
)
62 (paragraph . org-texinfo-paragraph
)
63 (plain-list . org-texinfo-plain-list
)
64 (plain-text . org-texinfo-plain-text
)
65 (planning . org-texinfo-planning
)
66 (property-drawer . org-texinfo-property-drawer
)
67 (quote-block . org-texinfo-quote-block
)
68 (radio-target . org-texinfo-radio-target
)
69 (section . org-texinfo-section
)
70 (special-block . org-texinfo-special-block
)
71 (src-block . org-texinfo-src-block
)
72 (statistics-cookie . org-texinfo-statistics-cookie
)
73 (subscript . org-texinfo-subscript
)
74 (superscript . org-texinfo-superscript
)
75 (table . org-texinfo-table
)
76 (table-cell . org-texinfo-table-cell
)
77 (table-row . org-texinfo-table-row
)
78 (target . org-texinfo-target
)
79 (template . org-texinfo-template
)
80 (timestamp . org-texinfo-timestamp
)
81 (verbatim . org-texinfo-verbatim
)
82 (verse-block . org-texinfo-verse-block
))
83 :export-block
"TEXINFO"
85 '((:filter-headline . org-texinfo-filter-section-blank-lines
)
86 (:filter-parse-tree . org-texinfo--normalize-headlines
)
87 (:filter-section . org-texinfo-filter-section-blank-lines
))
89 '(?i
"Export to Texinfo"
90 ((?t
"As TEXI file" org-texinfo-export-to-texinfo
)
91 (?i
"As INFO file" org-texinfo-export-to-info
)))
93 '((:texinfo-filename
"TEXINFO_FILENAME" nil nil t
)
94 (:texinfo-class
"TEXINFO_CLASS" nil org-texinfo-default-class t
)
95 (:texinfo-header
"TEXINFO_HEADER" nil nil newline
)
96 (:texinfo-post-header
"TEXINFO_POST_HEADER" nil nil newline
)
97 (:subtitle
"SUBTITLE" nil nil newline
)
98 (:subauthor
"SUBAUTHOR" nil nil newline
)
99 (:texinfo-dircat
"TEXINFO_DIR_CATEGORY" nil nil t
)
100 (:texinfo-dirtitle
"TEXINFO_DIR_TITLE" nil nil t
)
101 (:texinfo-dirdesc
"TEXINFO_DIR_DESC" nil nil t
)
102 (:texinfo-printed-title
"TEXINFO_PRINTED_TITLE" nil nil t
)
104 (:texinfo-classes nil nil org-texinfo-classes
)
105 (:texinfo-format-headline-function nil nil org-texinfo-format-headline-function
)
106 (:texinfo-node-description-column nil nil org-texinfo-node-description-column
)
107 (:texinfo-active-timestamp-format nil nil org-texinfo-active-timestamp-format
)
108 (:texinfo-inactive-timestamp-format nil nil org-texinfo-inactive-timestamp-format
)
109 (:texinfo-diary-timestamp-format nil nil org-texinfo-diary-timestamp-format
)
110 (:texinfo-link-with-unknown-path-format nil nil org-texinfo-link-with-unknown-path-format
)
111 (:texinfo-tables-verbatim nil nil org-texinfo-tables-verbatim
)
112 (:texinfo-table-scientific-notation nil nil org-texinfo-table-scientific-notation
)
113 (:texinfo-def-table-markup nil nil org-texinfo-def-table-markup
)
114 (:texinfo-text-markup-alist nil nil org-texinfo-text-markup-alist
)
115 (:texinfo-format-drawer-function nil nil org-texinfo-format-drawer-function
)
116 (:texinfo-format-inlinetask-function nil nil org-texinfo-format-inlinetask-function
)))
120 ;;; User Configurable Variables
122 (defgroup org-export-texinfo nil
123 "Options for exporting Org mode files to Texinfo."
124 :tag
"Org Export Texinfo"
126 :package-version
'(Org .
"8.0")
131 (defcustom org-texinfo-coding-system nil
132 "Default document encoding for Texinfo output.
134 If `nil' it will default to `buffer-file-coding-system'."
135 :group
'org-export-texinfo
136 :type
'coding-system
)
138 (defcustom org-texinfo-default-class
"info"
139 "The default Texinfo class."
140 :group
'org-export-texinfo
141 :type
'(string :tag
"Texinfo class"))
143 (defcustom org-texinfo-classes
145 "@documentencoding AUTO\n@documentlanguage AUTO"
146 ("@chapter %s" .
"@unnumbered %s")
147 ("@section %s" .
"@unnumberedsec %s")
148 ("@subsection %s" .
"@unnumberedsubsec %s")
149 ("@subsubsection %s" .
"@unnumberedsubsubsec %s")))
150 "Alist of Texinfo classes and associated header and structure.
151 If #+TEXINFO_CLASS is set in the buffer, use its value and the
152 associated information. Here is the structure of each cell:
156 \(numbered-section . unnumbered-section)
163 The header string is inserted in the header of the generated
164 document, right after \"@setfilename\" and \"@settitle\"
167 If it contains the special string
169 \"@documentencoding AUTO\"
171 \"AUTO\" will be replaced with an appropriate coding system. See
172 `org-texinfo-coding-system' for more information. Likewise, if
173 the string contains the special string
175 \"@documentlanguage AUTO\"
177 \"AUTO\" will be replaced with the language defined in the
178 buffer, through #+LANGUAGE keyword, or globally, with
179 `org-export-default-language', which see.
182 The sectioning structure
183 ------------------------
185 The sectioning structure of the class is given by the elements
186 following the header string. For each sectioning level, a number
187 of strings is specified. A %s formatter is mandatory in each
188 section string and will be replaced by the title of the section.
190 Instead of a list of sectioning commands, you can also specify
191 a function name. That function will be called with two
192 parameters, the reduced) level of the headline, and a predicate
193 non-nil when the headline should be numbered. It must return
194 a format string in which the section title will be added."
195 :group
'org-export-texinfo
197 :package-version
'(Org .
"8.2")
199 (list (string :tag
"Texinfo class")
200 (string :tag
"Texinfo header")
201 (repeat :tag
"Levels" :inline t
204 (string :tag
" numbered")
205 (string :tag
"unnumbered"))
206 (function :tag
"Hook computing sectioning"))))))
210 (defcustom org-texinfo-format-headline-function
211 'org-texinfo-format-headline-default-function
212 "Function to format headline text.
214 This function will be called with 5 arguments:
215 TODO the todo keyword (string or nil).
216 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
217 PRIORITY the priority of the headline (integer or nil)
218 TEXT the main headline text (string).
219 TAGS the tags as a list of strings (list of strings or nil).
221 The function result will be used in the section format string."
222 :group
'org-export-texinfo
225 :package-version
'(Org .
"8.3"))
227 ;;;; Node listing (menu)
229 (defcustom org-texinfo-node-description-column
32
230 "Column at which to start the description in the node listings.
231 If a node title is greater than this length, the description will
232 be placed after the end of the title."
233 :group
'org-export-texinfo
238 (defcustom org-texinfo-active-timestamp-format
"@emph{%s}"
239 "A printf format string to be applied to active timestamps."
240 :group
'org-export-texinfo
243 (defcustom org-texinfo-inactive-timestamp-format
"@emph{%s}"
244 "A printf format string to be applied to inactive timestamps."
245 :group
'org-export-texinfo
248 (defcustom org-texinfo-diary-timestamp-format
"@emph{%s}"
249 "A printf format string to be applied to diary timestamps."
250 :group
'org-export-texinfo
255 (defcustom org-texinfo-link-with-unknown-path-format
"@indicateurl{%s}"
256 "Format string for links with unknown path type."
257 :group
'org-export-texinfo
262 (defcustom org-texinfo-tables-verbatim nil
263 "When non-nil, tables are exported verbatim."
264 :group
'org-export-texinfo
267 (defcustom org-texinfo-table-scientific-notation
"%s\\,(%s)"
268 "Format string to display numbers in scientific notation.
269 The format should have \"%s\" twice, for mantissa and exponent
270 \(i.e. \"%s\\\\times10^{%s}\").
272 When nil, no transformation is made."
273 :group
'org-export-texinfo
275 (string :tag
"Format string")
276 (const :tag
"No formatting" nil
)))
278 (defcustom org-texinfo-def-table-markup
"@samp"
279 "Default setting for @table environments."
280 :group
'org-export-texinfo
285 (defcustom org-texinfo-text-markup-alist
'((bold .
"@strong{%s}")
287 (italic .
"@emph{%s}")
290 "Alist of Texinfo expressions to convert text markup.
292 The key must be a symbol among `bold', `italic' and `comment'.
293 The value is a formatting string to wrap fontified text with.
295 Value can also be set to the following symbols: `verb' and
296 `code'. For the former, Org will use \"@verb\" to
297 create a format string and select a delimiter character that
298 isn't in the string. For the latter, Org will use \"@code\"
299 to typeset and try to protect special characters.
301 If no association can be found for a given markup, text will be
303 :group
'org-export-texinfo
305 :options
'(bold code italic verbatim comment
))
309 (defcustom org-texinfo-format-drawer-function
310 (lambda (name contents
) contents
)
311 "Function called to format a drawer in Texinfo code.
313 The function must accept two parameters:
314 NAME the drawer name, like \"LOGBOOK\"
315 CONTENTS the contents of the drawer.
317 The function should return the string to be exported.
319 The default function simply returns the value of CONTENTS."
320 :group
'org-export-texinfo
322 :package-version
'(Org .
"8.2")
327 (defcustom org-texinfo-format-inlinetask-function
328 'org-texinfo-format-inlinetask-default-function
329 "Function called to format an inlinetask in Texinfo code.
331 The function must accept six parameters:
332 TODO the todo keyword, as a string
333 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
334 PRIORITY the inlinetask priority, as a string
335 NAME the inlinetask name, as a string.
336 TAGS the inlinetask tags, as a list of strings.
337 CONTENTS the contents of the inlinetask, as a string.
339 The function should return the string to be exported."
340 :group
'org-export-texinfo
345 (defcustom org-texinfo-info-process
'("makeinfo %f")
346 "Commands to process a Texinfo file to an INFO file.
347 This is list of strings, each of them will be given to the shell
348 as a command. %f in the command will be replaced by the full
349 file name, %b by the file base name (i.e without extension) and
350 %o by the base directory of the file."
351 :group
'org-export-texinfo
352 :type
'(repeat :tag
"Shell command sequence"
353 (string :tag
"Shell command")))
355 (defcustom org-texinfo-logfiles-extensions
356 '("aux" "toc" "cp" "fn" "ky" "pg" "tp" "vr")
357 "The list of file extensions to consider as Texinfo logfiles.
358 The logfiles will be remove if `org-texinfo-remove-logfiles' is
360 :group
'org-export-texinfo
361 :type
'(repeat (string :tag
"Extension")))
363 (defcustom org-texinfo-remove-logfiles t
364 "Non-nil means remove the logfiles produced by compiling a Texinfo file.
365 By default, logfiles are files with these extensions: .aux, .toc,
366 .cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove,
367 set `org-texinfo-logfiles-extensions'."
368 :group
'org-export-latex
373 (defconst org-texinfo-max-toc-depth
4
374 "Maximum depth for creation of detailed menu listings.
375 Beyond this depth, Texinfo will not recognize the nodes and will
376 cause errors. Left as a constant in case this value ever
379 (defconst org-texinfo-supported-coding-systems
380 '("US-ASCII" "UTF-8" "ISO-8859-15" "ISO-8859-1" "ISO-8859-2" "koi8-r" "koi8-u")
381 "List of coding systems supported by Texinfo, as strings.
382 Specified coding system will be matched against these strings.
383 If two strings share the same prefix (e.g. \"ISO-8859-1\" and
384 \"ISO-8859-15\"), the most specific one has to be listed first.")
387 ;;; Internal Functions
389 (defun org-texinfo-filter-section-blank-lines (headline back-end info
)
390 "Filter controlling number of blank lines after a section."
391 (let ((blanks (make-string 2 ?
\n)))
392 (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline
)))
394 (defun org-texinfo--normalize-headlines (tree back-end info
)
395 "Normalize headlines in TREE.
397 BACK-END is the symbol specifying back-end used for export. INFO
398 is a plist used as a communication channel.
400 Make sure every headline in TREE contains a section, since those
401 are required to install a menu. Also put exactly one blank line
402 at the end of each section.
405 (org-element-map tree
'headline
407 (org-element-put-property hl
:post-blank
1)
408 (let ((contents (org-element-contents hl
)))
410 (let ((first (org-element-map contents
'(headline section
)
412 (unless (eq (org-element-type first
) 'section
)
413 (apply #'org-element-set-contents
415 (cons `(section (:parent
,hl
)) contents
)))))))
419 (defun org-texinfo--find-verb-separator (s)
420 "Return a character not used in string S.
421 This is used to choose a separator for constructs like \\verb."
422 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
423 (loop for c across ll
424 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
425 return
(char-to-string c
))))
427 (defun org-texinfo--text-markup (text markup info
)
428 "Format TEXT depending on MARKUP text markup.
429 INFO is a plist used as a communication channel. See
430 `org-texinfo-text-markup-alist' for details."
431 (let ((fmt (cdr (assq markup org-texinfo-text-markup-alist
))))
433 ;; No format string: Return raw text.
436 (let ((separator (org-texinfo--find-verb-separator text
)))
437 (concat "@verb{" separator text separator
"}")))
442 (while (string-match "[@{}]" text
)
443 (setq char
(match-string 0 text
))
444 (if (> (match-beginning 0) 0)
445 (setq rtn
(concat rtn
(substring text
0 (match-beginning 0)))))
446 (setq text
(substring text
(1+ (match-beginning 0))))
447 (setq char
(concat "@" char
)
448 rtn
(concat rtn char
)))
449 (setq text
(concat rtn text
)
452 ;; Else use format string.
453 (t (format fmt text
)))))
455 (defun org-texinfo--get-node (blob info
)
456 "Return node or anchor associated to BLOB.
457 BLOB is an element or object. INFO is a plist used as
458 a communication channel. The function guarantees the node or
459 anchor name is unique."
460 (let ((cache (plist-get info
:texinfo-node-cache
)))
461 (or (cdr (assq blob cache
))
463 (org-texinfo--sanitize-node
464 (case (org-element-type blob
)
466 (org-export-data (org-export-get-alt-title blob info
) info
))
467 ((radio-target target
) (org-element-property :value blob
))
468 (otherwise (or (org-element-property :name blob
) ""))))))
469 ;; Ensure NAME is unique.
470 (while (rassoc name cache
) (setq name
(concat name
"x")))
471 (plist-put info
:texinfo-node-cache
(cons (cons blob name
) cache
))
476 (defun org-texinfo--sanitize-node (title)
477 "Bend string TITLE to node line requirements.
478 Trim string and collapse multiple whitespace characters as they
479 are not significant. Also remove the following characters: @
481 (replace-regexp-in-string
483 (replace-regexp-in-string
484 "\\`(\\(.*)\\)" "[\\1"
485 (org-trim (replace-regexp-in-string "[ \t]\\{2,\\}" " " title
)))))
487 ;;;; Content sanitizing
489 (defun org-texinfo--sanitize-content (text)
490 "Escape special characters in string TEXT.
491 Special characters are: @ { }"
492 (replace-regexp-in-string "[@{}]" "@\\&" text
))
496 (defun org-texinfo-template (contents info
)
497 "Return complete document string after Texinfo conversion.
498 CONTENTS is the transcoded contents string. INFO is a plist
499 holding export options."
500 (let ((title (org-export-data (plist-get info
:title
) info
))
501 ;; Copying data is the contents of the first headline in
502 ;; parse tree with a non-nil copying property.
503 (copying (org-element-map (plist-get info
:parse-tree
) 'headline
505 (and (org-not-nil (org-element-property :COPYING hl
))
506 (org-element-contents hl
)))
509 "\\input texinfo @c -*- texinfo -*-\n"
510 "@c %**start of header\n"
511 (let ((file (or (plist-get info
:texinfo-filename
)
512 (let ((f (plist-get info
:output-file
)))
513 (and f
(concat (file-name-sans-extension f
) ".info"))))))
514 (and file
(format "@setfilename %s\n" file
)))
515 (format "@settitle %s\n" title
)
516 ;; Insert class-defined header.
517 (org-element-normalize-string
518 (let ((header (nth 1 (assoc (plist-get info
:texinfo-class
)
519 org-texinfo-classes
)))
521 (catch 'coding-system
522 (let ((case-fold-search t
)
523 (name (symbol-name (or org-texinfo-coding-system
524 buffer-file-coding-system
))))
525 (dolist (system org-texinfo-supported-coding-systems
"UTF-8")
526 (when (org-string-match-p (regexp-quote system
) name
)
527 (throw 'coding-system system
))))))
528 (language (plist-get info
:language
))
529 (case-fold-search nil
))
530 ;; Auto coding system.
531 (replace-regexp-in-string
532 "^@documentencoding \\(AUTO\\)$"
534 (replace-regexp-in-string
535 "^@documentlanguage \\(AUTO\\)$" language header t nil
1) t nil
1)))
536 ;; Additional header options set by #+TEXINFO_HEADER.
537 (let ((texinfo-header (plist-get info
:texinfo-header
)))
538 (and texinfo-header
(org-element-normalize-string texinfo-header
)))
539 "@c %**end of header\n\n"
540 ;; Additional options set by #+TEXINFO_POST_HEADER.
541 (let ((texinfo-post-header (plist-get info
:texinfo-post-header
)))
542 (and texinfo-post-header
543 (org-element-normalize-string texinfo-post-header
)))
546 (format "@copying\n%s@end copying\n\n"
547 (org-element-normalize-string
548 (org-export-data copying info
))))
549 ;; Info directory information. Only supply if both title and
550 ;; category are provided.
551 (let ((dircat (plist-get info
:texinfo-dircat
))
553 (let ((title (plist-get info
:texinfo-dirtitle
)))
555 (string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title
)
556 (format "* %s." (match-string 1 title
))))))
557 (when (and dircat dirtitle
)
558 (concat "@dircategory " dircat
"\n"
561 (let ((desc (plist-get info
:texinfo-dirdesc
)))
562 (cond ((not desc
) nil
)
563 ((org-string-match-p "\\.$" desc
) desc
)
564 (t (concat desc
"."))))))
565 (if dirdesc
(format "%-23s %s" dirtitle dirdesc
) dirtitle
))
567 "@end direntry\n\n")))
571 (when (plist-get info
:with-title
)
572 (format "@title %s\n" (or (plist-get info
:texinfo-printed-title
) title
))
573 (let ((subtitle (plist-get info
:subtitle
)))
575 (org-element-normalize-string
576 (replace-regexp-in-string "^" "@subtitle " subtitle
)))))
577 (when (plist-get info
:with-author
)
580 (let ((author (org-string-nw-p
581 (org-export-data (plist-get info
:author
) info
)))
582 (email (and (plist-get info
:with-email
)
584 (org-export-data (plist-get info
:email
) info
)))))
585 (cond ((and author email
)
586 (format "@author %s (@email{%s})\n" author email
))
587 (author (format "@author %s\n" author
))
588 (email (format "@author @email{%s}\n" email
))))
590 (let ((subauthor (plist-get info
:subauthor
)))
592 (org-element-normalize-string
593 (replace-regexp-in-string "^" "@author " subauthor
))))))
594 (and copying
"@page\n@vskip 0pt plus 1filll\n@insertcopying\n")
596 ;; Table of contents.
597 (and (plist-get info
:with-toc
) "@contents\n\n")
598 ;; Configure Top Node when not for Tex
601 (format "@top %s\n" title
)
602 (and copying
"@insertcopying\n")
605 (org-texinfo-make-menu (plist-get info
:parse-tree
) info
'master
)
610 (case (plist-get info
:with-creator
)
612 (comment (format "@c %s\n" (plist-get info
:creator
)))
613 (otherwise (concat (plist-get info
:creator
) "\n")))
619 ;;; Transcode Functions
623 (defun org-texinfo-bold (bold contents info
)
624 "Transcode BOLD from Org to Texinfo.
625 CONTENTS is the text with bold markup. INFO is a plist holding
626 contextual information."
627 (org-texinfo--text-markup contents
'bold info
))
631 (defun org-texinfo-center-block (center-block contents info
)
632 "Transcode a CENTER-BLOCK element from Org to Texinfo.
633 CONTENTS holds the contents of the block. INFO is a plist used
634 as a communication channel."
639 (defun org-texinfo-clock (clock contents info
)
640 "Transcode a CLOCK element from Org to Texinfo.
641 CONTENTS is nil. INFO is a plist holding contextual
645 (format "@strong{%s} " org-clock-string
)
646 (format (plist-get info
:texinfo-inactive-timestamp-format
)
647 (concat (org-timestamp-translate (org-element-property :value clock
))
648 (let ((time (org-element-property :duration clock
)))
649 (and time
(format " (%s)" time
)))))
654 (defun org-texinfo-code (code contents info
)
655 "Transcode a CODE object from Org to Texinfo.
656 CONTENTS is nil. INFO is a plist used as a communication
658 (org-texinfo--text-markup (org-element-property :value code
) 'code info
))
662 (defun org-texinfo-drawer (drawer contents info
)
663 "Transcode a DRAWER element from Org to Texinfo.
664 CONTENTS holds the contents of the block. INFO is a plist
665 holding contextual information."
666 (let* ((name (org-element-property :drawer-name drawer
))
667 (output (funcall (plist-get info
:texinfo-format-drawer-function
)
673 (defun org-texinfo-dynamic-block (dynamic-block contents info
)
674 "Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
675 CONTENTS holds the contents of the block. INFO is a plist
676 holding contextual information."
681 (defun org-texinfo-entity (entity contents info
)
682 "Transcode an ENTITY object from Org to Texinfo.
683 CONTENTS are the definition itself. INFO is a plist holding
684 contextual information."
685 (let ((ent (org-element-property :latex entity
)))
686 (if (org-element-property :latex-math-p entity
) (format "@math{%s}" ent
) ent
)))
690 (defun org-texinfo-example-block (example-block contents info
)
691 "Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
692 CONTENTS is nil. INFO is a plist holding contextual
694 (format "@verbatim\n%s@end verbatim"
695 (org-export-format-code-default example-block info
)))
699 (defun org-texinfo-export-block (export-block contents info
)
700 "Transcode a EXPORT-BLOCK element from Org to Texinfo.
701 CONTENTS is nil. INFO is a plist holding contextual information."
702 (when (string= (org-element-property :type export-block
) "TEXINFO")
703 (org-remove-indentation (org-element-property :value export-block
))))
707 (defun org-texinfo-export-snippet (export-snippet contents info
)
708 "Transcode a EXPORT-SNIPPET object from Org to Texinfo.
709 CONTENTS is nil. INFO is a plist holding contextual information."
710 (when (eq (org-export-snippet-backend export-snippet
) 'texinfo
)
711 (org-element-property :value export-snippet
)))
715 (defun org-texinfo-fixed-width (fixed-width contents info
)
716 "Transcode a FIXED-WIDTH element from Org to Texinfo.
717 CONTENTS is nil. INFO is a plist holding contextual information."
718 (format "@example\n%s\n@end example"
719 (org-remove-indentation
720 (org-texinfo--sanitize-content
721 (org-element-property :value fixed-width
)))))
723 ;;;; Footnote Reference
725 (defun org-texinfo-footnote-reference (footnote contents info
)
726 "Create a footnote reference for FOOTNOTE.
728 FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
729 plist holding contextual information."
730 (let ((def (org-export-get-footnote-definition footnote info
)))
731 (format "@footnote{%s}"
732 (org-trim (org-export-data def info
)))))
736 (defun org-texinfo-headline (headline contents info
)
737 "Transcode a HEADLINE element from Org to Texinfo.
738 CONTENTS holds the contents of the headline. INFO is a plist
739 holding contextual information."
740 (let* ((class (plist-get info
:texinfo-class
))
741 (level (org-export-get-relative-level headline info
))
742 (numberedp (org-export-numbered-headline-p headline info
))
743 (class-sectioning (assoc class
(plist-get info
:texinfo-classes
)))
744 ;; Find the index type, if any.
745 (index (org-element-property :INDEX headline
))
746 ;; Create node info, to insert it before section formatting.
747 ;; Use custom menu title if present.
748 (node (format "@node %s\n" (org-texinfo--get-node headline info
)))
749 ;; Section formatting will set two placeholders: one for the
750 ;; title and the other for the contents.
752 (if (org-not-nil (org-element-property :APPENDIX headline
))
754 (let ((sec (if (and (symbolp (nth 2 class-sectioning
))
755 (fboundp (nth 2 class-sectioning
)))
756 (funcall (nth 2 class-sectioning
) level numberedp
)
757 (nth (1+ level
) class-sectioning
))))
759 ;; No section available for that LEVEL.
761 ;; Section format directly returned by a function.
763 ;; (numbered-section . unnumbered-section)
764 ((not (consp (cdr sec
)))
765 (concat (if (or index
(not numberedp
)) (cdr sec
) (car sec
))
768 (and (plist-get info
:with-todo-keywords
)
769 (let ((todo (org-element-property :todo-keyword headline
)))
770 (and todo
(org-export-data todo info
)))))
771 (todo-type (and todo
(org-element-property :todo-type headline
)))
772 (tags (and (plist-get info
:with-tags
)
773 (org-export-get-tags headline info
)))
774 (priority (and (plist-get info
:with-priority
)
775 (org-element-property :priority headline
)))
776 (text (org-export-data (org-element-property :title headline
) info
))
777 (full-text (funcall (plist-get info
:texinfo-format-headline-function
)
778 todo todo-type priority text tags
))
779 (contents (if (org-string-nw-p contents
) (concat "\n" contents
) "")))
781 ;; Case 1: This is a footnote section: ignore it.
782 ((org-element-property :footnote-section-p headline
) nil
)
783 ;; Case 2: This is the `copying' section: ignore it
784 ;; This is used elsewhere.
785 ((org-not-nil (org-element-property :COPYING headline
)) nil
)
786 ;; Case 3: An index. If it matches one of the known indexes,
787 ;; print it as such following the contents, otherwise
788 ;; print the contents and leave the index up to the user.
795 (and (member index
'("cp" "fn" "ky" "pg" "tp" "vr"))
796 (concat "\n@printindex " index
))))))
797 ;; Case 4: This is a deep sub-tree: export it as a list item.
798 ;; Also export as items headlines for which no section
799 ;; format has been found.
800 ((or (not section-fmt
) (org-export-low-level-p headline info
))
801 ;; Build the real contents of the sub-tree.
802 (concat (and (org-export-first-sibling-p headline info
)
803 (format "@%s\n" (if numberedp
'enumerate
'itemize
)))
804 "@item\n" full-text
"\n"
806 (if (org-export-last-sibling-p headline info
)
807 (format "@end %s" (if numberedp
'enumerate
'itemize
))
809 ;; Case 5: Standard headline. Export it as a section.
810 (t (concat node
(format section-fmt full-text contents
))))))
812 (defun org-texinfo-format-headline-default-function
813 (todo todo-type priority text tags
)
814 "Default format function for a headline.
815 See `org-texinfo-format-headline-function' for details."
816 (concat (when todo
(format "@strong{%s} " todo
))
817 (when priority
(format "@emph{#%s} " priority
))
819 (when tags
(format " :%s:" (mapconcat 'identity tags
":")))))
821 ;;;; Inline Src Block
823 (defun org-texinfo-inline-src-block (inline-src-block contents info
)
824 "Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
825 CONTENTS holds the contents of the item. INFO is a plist holding
826 contextual information."
827 (let* ((code (org-element-property :value inline-src-block
))
828 (separator (org-texinfo--find-verb-separator code
)))
829 (concat "@verb{" separator code separator
"}")))
833 (defun org-texinfo-inlinetask (inlinetask contents info
)
834 "Transcode an INLINETASK element from Org to Texinfo.
835 CONTENTS holds the contents of the block. INFO is a plist
836 holding contextual information."
837 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
838 (todo (and (plist-get info
:with-todo-keywords
)
839 (let ((todo (org-element-property :todo-keyword inlinetask
)))
840 (and todo
(org-export-data todo info
)))))
841 (todo-type (org-element-property :todo-type inlinetask
))
842 (tags (and (plist-get info
:with-tags
)
843 (org-export-get-tags inlinetask info
)))
844 (priority (and (plist-get info
:with-priority
)
845 (org-element-property :priority inlinetask
))))
846 (funcall (plist-get info
:texinfo-format-inlinetask-function
)
847 todo todo-type priority title tags contents
)))
849 (defun org-texinfo-format-inlinetask-default-function
850 (todo todo-type priority title tags contents
)
851 "Default format function for a inlinetasks.
852 See `org-texinfo-format-inlinetask-function' for details."
854 (concat (when todo
(format "@strong{%s} " todo
))
855 (when priority
(format "#%c " priority
))
857 (when tags
(format ":%s:" (mapconcat #'identity tags
":"))))))
858 (format "@center %s\n\n%s\n" full-title contents
)))
862 (defun org-texinfo-italic (italic contents info
)
863 "Transcode ITALIC from Org to Texinfo.
864 CONTENTS is the text with italic markup. INFO is a plist holding
865 contextual information."
866 (org-texinfo--text-markup contents
'italic info
))
870 (defun org-texinfo-item (item contents info
)
871 "Transcode an ITEM element from Org to Texinfo.
872 CONTENTS holds the contents of the item. INFO is a plist holding
873 contextual information."
874 (format "@item%s\n%s"
875 (let ((tag (org-element-property :tag item
)))
876 (if tag
(concat " " (org-export-data tag info
)) ""))
881 (defun org-texinfo-keyword (keyword contents info
)
882 "Transcode a KEYWORD element from Org to Texinfo.
883 CONTENTS is nil. INFO is a plist holding contextual information."
884 (let ((key (org-element-property :key keyword
))
885 (value (org-element-property :value keyword
)))
887 ((string= key
"TEXINFO") value
)
888 ((string= key
"CINDEX") (format "@cindex %s" value
))
889 ((string= key
"FINDEX") (format "@findex %s" value
))
890 ((string= key
"KINDEX") (format "@kindex %s" value
))
891 ((string= key
"PINDEX") (format "@pindex %s" value
))
892 ((string= key
"TINDEX") (format "@tindex %s" value
))
893 ((string= key
"VINDEX") (format "@vindex %s" value
)))))
897 (defun org-texinfo-line-break (line-break contents info
)
898 "Transcode a LINE-BREAK object from Org to Texinfo.
899 CONTENTS is nil. INFO is a plist holding contextual information."
904 (defun org-texinfo-link (link desc info
)
905 "Transcode a LINK object from Org to Texinfo.
907 DESC is the description part of the link, or the empty string.
908 INFO is a plist holding contextual information. See
910 (let* ((type (org-element-property :type link
))
911 (raw-path (org-element-property :path link
))
912 ;; Ensure DESC really exists, or set it to nil.
913 (desc (and (not (string= desc
"")) desc
))
915 ((member type
'("http" "https" "ftp"))
916 (concat type
":" raw-path
))
917 ((and (string= type
"file") (file-name-absolute-p raw-path
))
918 (concat "file:" raw-path
))
921 ((org-export-custom-protocol-maybe link desc info
))
922 ((equal type
"radio")
923 (let ((destination (org-export-resolve-radio-link link info
)))
924 (if (not destination
) desc
925 (format "@ref{%s,,%s}"
926 (org-texinfo--get-node destination info
)
928 ((member type
'("custom-id" "id" "fuzzy"))
930 (if (equal type
"fuzzy")
931 (org-export-resolve-fuzzy-link link info
)
932 (org-export-resolve-id-link link info
))))
933 (case (org-element-type destination
)
935 (format org-texinfo-link-with-unknown-path-format
936 (org-texinfo--sanitize-content path
)))
937 ;; Id link points to an external file.
939 (if desc
(format "@uref{file://%s,%s}" destination desc
)
940 (format "@uref{file://%s}" destination
)))
942 (format "@ref{%s,%s}"
943 (org-texinfo--get-node destination info
)
946 ((org-export-numbered-headline-p destination info
)
948 (org-element-property :title destination
) info
))
952 (org-export-get-headline-number destination info
) ".")))))
956 (if (and (eq (org-element-type destination
) 'headline
)
957 (not (org-export-numbered-headline-p
960 (org-element-property :title destination
) info
))
961 (let ((n (org-export-get-ordinal destination info
)))
965 (t (mapconcat #'number-to-string n
".")))))))
967 (format "@ref{%s,,%s}"
968 (org-texinfo--get-node destination info
)
971 (let* ((info-path (split-string path
"[:#]"))
972 (info-manual (car info-path
))
973 (info-node (or (cadr info-path
) "top"))
974 (title (or desc
"")))
975 (format "@ref{%s,%s,,%s,}" info-node title info-manual
)))
976 ((string= type
"mailto")
978 (concat (org-texinfo--sanitize-content path
)
979 (and desc
(concat "," desc
)))))
980 ;; External link with a description part.
981 ((and path desc
) (format "@uref{%s,%s}" path desc
))
982 ;; External link without a description part.
983 (path (format "@uref{%s}" path
))
984 ;; No path, only description. Try to do something useful.
986 (format (plist-get info
:texinfo-link-with-unknown-path-format
) desc
)))))
991 (defun org-texinfo-make-menu (scope info
&optional master
)
992 "Create the menu for inclusion in the Texinfo document.
994 SCOPE is a headline or a full parse tree. INFO is the
995 communication channel, as a plist.
997 When optional argument MASTER is non-nil, generate a master menu,
998 including detailed node listing."
999 (let ((menu (org-texinfo--build-menu scope info
)))
1000 (when (org-string-nw-p menu
)
1001 (org-element-normalize-string
1003 "@menu\n%s@end menu"
1007 (org-texinfo--build-menu
1009 (let ((toc-depth (plist-get info
:with-toc
)))
1010 (if (wholenump toc-depth
) toc-depth
1011 org-texinfo-max-toc-depth
)))))
1012 (when (org-string-nw-p detailmenu
)
1013 (concat "\n@detailmenu\n"
1014 "--- The Detailed Node Listing ---\n\n"
1016 "@end detailmenu\n"))))))))))
1018 (defun org-texinfo--build-menu (scope info
&optional level
)
1019 "Build menu for entries within SCOPE.
1020 SCOPE is a headline or a full parse tree. INFO is a plist
1021 containing contextual information. When optional argument LEVEL
1022 is an integer, build the menu recursively, down to this depth."
1025 (org-texinfo--format-entries (org-texinfo--menu-entries scope info
) info
))
1028 (org-element-normalize-string
1031 (let ((entries (org-texinfo--menu-entries h info
)))
1034 (format "%s\n\n%s\n"
1035 (org-export-data (org-export-get-alt-title h info
) info
)
1036 (org-texinfo--format-entries entries info
))
1037 (org-texinfo--build-menu h info
(1- level
))))))
1038 (org-texinfo--menu-entries scope info
) "")))))
1040 (defun org-texinfo--format-entries (entries info
)
1041 "Format all direct menu entries in SCOPE, as a string.
1042 SCOPE is either a headline or a full Org document. INFO is
1043 a plist containing contextual information."
1044 (org-element-normalize-string
1047 (let* ((title (org-export-data
1048 (org-export-get-alt-title h info
) info
))
1049 (node (org-texinfo--get-node h info
))
1050 (entry (concat "* " title
":"
1051 (if (string= title node
) ":"
1052 (concat " " node
". "))))
1053 (desc (org-element-property :DESCRIPTION h
)))
1054 (if (not desc
) entry
1055 (format (format "%%-%ds %%s" org-texinfo-node-description-column
)
1059 (defun org-texinfo--menu-entries (scope info
)
1060 "List direct children in SCOPE needing a menu entry.
1061 SCOPE is a headline or a full parse tree. INFO is a plist
1062 holding contextual information."
1063 (let* ((cache (or (plist-get info
:texinfo-entries-cache
)
1064 (plist-get (plist-put info
:texinfo-entries-cache
1065 (make-hash-table :test
#'eq
))
1066 :texinfo-entries-cache
)))
1067 (cached-entries (gethash scope cache
'no-cache
)))
1068 (if (not (eq cached-entries
'no-cache
)) cached-entries
1070 (org-element-map (org-element-contents scope
) 'headline
1072 (and (not (org-not-nil (org-element-property :COPYING h
)))
1073 (not (org-element-property :footnote-section-p h
))
1074 (not (org-export-low-level-p h info
))
1081 (defun org-texinfo-node-property (node-property contents info
)
1082 "Transcode a NODE-PROPERTY element from Org to Texinfo.
1083 CONTENTS is nil. INFO is a plist holding contextual
1086 (org-element-property :key node-property
)
1087 (let ((value (org-element-property :value node-property
)))
1088 (if value
(concat " " value
) ""))))
1092 (defun org-texinfo-paragraph (paragraph contents info
)
1093 "Transcode a PARAGRAPH element from Org to Texinfo.
1094 CONTENTS is the contents of the paragraph, as a string. INFO is
1095 the plist used as a communication channel."
1100 (defun org-texinfo-plain-list (plain-list contents info
)
1101 "Transcode a PLAIN-LIST element from Org to Texinfo.
1102 CONTENTS is the contents of the list. INFO is a plist holding
1103 contextual information."
1104 (let* ((attr (org-export-read-attribute :attr_texinfo plain-list
))
1105 (indic (or (plist-get attr
:indic
)
1106 (plist-get info
:texinfo-def-table-markup
)))
1107 (table-type (plist-get attr
:table-type
))
1108 (type (org-element-property :type plain-list
))
1110 ((eq type
'ordered
) "enumerate")
1111 ((eq type
'unordered
) "itemize")
1112 ((member table-type
'("ftable" "vtable")) table-type
)
1114 (format "@%s\n%s@end %s"
1115 (if (eq type
'descriptive
) (concat list-type
" " indic
) list-type
)
1121 (defun org-texinfo-plain-text (text info
)
1122 "Transcode a TEXT string from Org to Texinfo.
1123 TEXT is the string to transcode. INFO is a plist holding
1124 contextual information."
1125 ;; First protect @, { and }.
1126 (let ((output (org-texinfo--sanitize-content text
)))
1127 ;; Activate smart quotes. Be sure to provide original TEXT string
1128 ;; since OUTPUT may have been modified.
1129 (when (plist-get info
:with-smart-quotes
)
1131 (org-export-activate-smart-quotes output
:texinfo info text
)))
1132 ;; LaTeX into @LaTeX{} and TeX into @TeX{}
1133 (let ((case-fold-search nil
)
1135 (while (string-match "\\(\\(?:La\\)?TeX\\)" output start
)
1136 (setq output
(replace-match
1137 (format "@%s{}" (match-string 1 output
)) nil t output
)
1138 start
(match-end 0))))
1139 ;; Convert special strings.
1140 (when (plist-get info
:with-special-strings
)
1141 (while (string-match (regexp-quote "...") output
)
1142 (setq output
(replace-match "@dots{}" nil t output
))))
1143 ;; Handle break preservation if required.
1144 (when (plist-get info
:preserve-breaks
)
1145 (setq output
(replace-regexp-in-string
1146 "\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output
)))
1152 (defun org-texinfo-planning (planning contents info
)
1153 "Transcode a PLANNING element from Org to Texinfo.
1154 CONTENTS is nil. INFO is a plist holding contextual
1162 (let ((closed (org-element-property :closed planning
)))
1165 (format "@strong{%s} " org-closed-string
)
1166 (format (plist-get info
:texinfo-inactive-timestamp-format
)
1167 (org-timestamp-translate closed
)))))
1168 (let ((deadline (org-element-property :deadline planning
)))
1171 (format "@strong{%s} " org-deadline-string
)
1172 (format (plist-get info
:texinfo-active-timestamp-format
)
1173 (org-timestamp-translate deadline
)))))
1174 (let ((scheduled (org-element-property :scheduled planning
)))
1177 (format "@strong{%s} " org-scheduled-string
)
1178 (format (plist-get info
:texinfo-active-timestamp-format
)
1179 (org-timestamp-translate scheduled
)))))))
1183 ;;;; Property Drawer
1185 (defun org-texinfo-property-drawer (property-drawer contents info
)
1186 "Transcode a PROPERTY-DRAWER element from Org to Texinfo.
1187 CONTENTS holds the contents of the drawer. INFO is a plist
1188 holding contextual information."
1189 (and (org-string-nw-p contents
)
1190 (format "@verbatim\n%s@end verbatim" contents
)))
1194 (defun org-texinfo-quote-block (quote-block contents info
)
1195 "Transcode a QUOTE-BLOCK element from Org to Texinfo.
1196 CONTENTS holds the contents of the block. INFO is a plist
1197 holding contextual information."
1198 (let* ((title (org-element-property :name quote-block
))
1199 (start-quote (concat "@quotation"
1201 (format " %s" title
)))))
1202 (format "%s\n%s@end quotation" start-quote contents
)))
1206 (defun org-texinfo-radio-target (radio-target text info
)
1207 "Transcode a RADIO-TARGET object from Org to Texinfo.
1208 TEXT is the text of the target. INFO is a plist holding
1209 contextual information."
1210 (format "@anchor{%s}%s"
1211 (org-export-solidify-link-text
1212 (org-element-property :value radio-target
))
1217 (defun org-texinfo-section (section contents info
)
1218 "Transcode a SECTION element from Org to Texinfo.
1219 CONTENTS holds the contents of the section. INFO is a plist
1220 holding contextual information."
1222 (let ((parent (org-export-get-parent-headline section
)))
1223 (and parent
(org-texinfo-make-menu parent info
)))))
1227 (defun org-texinfo-special-block (special-block contents info
)
1228 "Transcode a SPECIAL-BLOCK element from Org to Texinfo.
1229 CONTENTS holds the contents of the block. INFO is a plist used
1230 as a communication channel."
1231 (let ((type (org-element-property :type special-block
)))
1232 (format "@%s\n%s@end %s" type contents type
)))
1236 (defun org-texinfo-src-block (src-block contents info
)
1237 "Transcode a SRC-BLOCK element from Org to Texinfo.
1238 CONTENTS holds the contents of the item. INFO is a plist holding
1239 contextual information."
1240 (let ((lispp (org-string-match-p "lisp"
1241 (org-element-property :language src-block
)))
1242 (code (org-texinfo--sanitize-content
1243 (org-export-format-code-default src-block info
))))
1244 (format (if lispp
"@lisp\n%s@end lisp" "@example\n%s@end example") code
)))
1246 ;;;; Statistics Cookie
1248 (defun org-texinfo-statistics-cookie (statistics-cookie contents info
)
1249 "Transcode a STATISTICS-COOKIE object from Org to Texinfo.
1250 CONTENTS is nil. INFO is a plist holding contextual information."
1251 (org-element-property :value statistics-cookie
))
1255 (defun org-texinfo-subscript (subscript contents info
)
1256 "Transcode a SUBSCRIPT object from Org to Texinfo.
1257 CONTENTS is the contents of the object. INFO is a plist holding
1258 contextual information."
1259 (format "@math{_%s}" contents
))
1263 (defun org-texinfo-superscript (superscript contents info
)
1264 "Transcode a SUPERSCRIPT object from Org to Texinfo.
1265 CONTENTS is the contents of the object. INFO is a plist holding
1266 contextual information."
1267 (format "@math{^%s}" contents
))
1271 (defun org-texinfo-table (table contents info
)
1272 "Transcode a TABLE element from Org to Texinfo.
1273 CONTENTS is the contents of the table. INFO is a plist holding
1274 contextual information."
1275 (if (eq (org-element-property :type table
) 'table.el
)
1276 (format "@verbatim\n%s@end verbatim"
1277 (org-element-normalize-string
1278 (org-element-property :value table
)))
1279 (let* ((col-width (org-export-read-attribute :attr_texinfo table
:columns
))
1281 (if col-width
(format "@columnfractions %s" col-width
)
1282 (org-texinfo-table-column-widths table info
))))
1283 (format "@multitable %s\n%s@end multitable"
1287 (defun org-texinfo-table-column-widths (table info
)
1288 "Determine the largest table cell in each column to process alignment.
1289 TABLE is the table element to transcode. INFO is a plist used as
1290 a communication channel."
1291 (let ((widths (make-vector (cdr (org-export-table-dimensions table info
)) 0)))
1292 (org-element-map table
'table-row
1295 (org-element-map row
'table-cell
1297 ;; Length of the cell in the original buffer is only an
1298 ;; approximation of the length of the cell in the
1299 ;; output. It can sometimes fail (e.g. it considers
1300 ;; "/a/" being larger than "ab").
1301 (let ((w (- (org-element-property :contents-end cell
)
1302 (org-element-property :contents-begin cell
))))
1303 (aset widths idx
(max w
(aref widths idx
))))
1307 (format "{%s}" (mapconcat (lambda (w) (make-string w ?a
)) widths
"} {"))))
1311 (defun org-texinfo-table-cell (table-cell contents info
)
1312 "Transcode a TABLE-CELL element from Org to Texinfo.
1313 CONTENTS is the cell contents. INFO is a plist used as
1314 a communication channel."
1316 (let ((scientific-notation
1317 (plist-get info
:texinfo-table-scientific-notation
)))
1320 (string-match orgtbl-exp-regexp contents
))
1321 ;; Use appropriate format string for scientific notation.
1322 (format scientific-notation
1323 (match-string 1 contents
)
1324 (match-string 2 contents
))
1326 (when (org-export-get-next-element table-cell info
) "\n@tab ")))
1330 (defun org-texinfo-table-row (table-row contents info
)
1331 "Transcode a TABLE-ROW element from Org to Texinfo.
1332 CONTENTS is the contents of the row. INFO is a plist used as
1333 a communication channel."
1334 ;; Rules are ignored since table separators are deduced from
1335 ;; borders of the current row.
1336 (when (eq (org-element-property :type table-row
) 'standard
)
1338 (if (and (= 1 (org-export-table-row-group table-row info
))
1339 (org-export-table-has-header-p
1340 (org-export-get-parent-table table-row
) info
))
1343 (concat rowgroup-tag contents
"\n"))))
1347 (defun org-texinfo-target (target contents info
)
1348 "Transcode a TARGET object from Org to Texinfo.
1349 CONTENTS is nil. INFO is a plist holding contextual
1351 (format "@anchor{%s}"
1352 (org-export-solidify-link-text (org-element-property :value target
))))
1356 (defun org-texinfo-timestamp (timestamp contents info
)
1357 "Transcode a TIMESTAMP object from Org to Texinfo.
1358 CONTENTS is nil. INFO is a plist holding contextual
1360 (let ((value (org-texinfo-plain-text
1361 (org-timestamp-translate timestamp
) info
)))
1362 (case (org-element-property :type timestamp
)
1363 ((active active-range
)
1364 (format (plist-get info
:texinfo-active-timestamp-format
) value
))
1365 ((inactive inactive-range
)
1366 (format (plist-get info
:texinfo-inactive-timestamp-format
) value
))
1367 (t (format (plist-get info
:texinfo-diary-timestamp-format
) value
)))))
1371 (defun org-texinfo-verbatim (verbatim contents info
)
1372 "Transcode a VERBATIM object from Org to Texinfo.
1373 CONTENTS is nil. INFO is a plist used as a communication
1375 (org-texinfo--text-markup
1376 (org-element-property :value verbatim
) 'verbatim info
))
1380 (defun org-texinfo-verse-block (verse-block contents info
)
1381 "Transcode a VERSE-BLOCK element from Org to Texinfo.
1382 CONTENTS is verse block contents. INFO is a plist holding
1383 contextual information."
1384 (format "@display\n%s@end display" contents
))
1387 ;;; Interactive functions
1389 (defun org-texinfo-export-to-texinfo
1390 (&optional async subtreep visible-only body-only ext-plist
)
1391 "Export current buffer to a Texinfo file.
1393 If narrowing is active in the current buffer, only export its
1396 If a region is active, export that region.
1398 A non-nil optional argument ASYNC means the process should happen
1399 asynchronously. The resulting file should be accessible through
1400 the `org-export-stack' interface.
1402 When optional argument SUBTREEP is non-nil, export the sub-tree
1403 at point, extracting information from the headline properties
1406 When optional argument VISIBLE-ONLY is non-nil, don't export
1407 contents of hidden elements.
1409 When optional argument BODY-ONLY is non-nil, only write code
1410 between \"\\begin{document}\" and \"\\end{document}\".
1412 EXT-PLIST, when provided, is a property list with external
1413 parameters overriding Org default settings, but still inferior to
1414 file-local settings.
1416 Return output file's name."
1418 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1419 (org-export-coding-system org-texinfo-coding-system
))
1420 (org-export-to-file 'texinfo outfile
1421 async subtreep visible-only body-only ext-plist
)))
1423 (defun org-texinfo-export-to-info
1424 (&optional async subtreep visible-only body-only ext-plist
)
1425 "Export current buffer to Texinfo then process through to INFO.
1427 If narrowing is active in the current buffer, only export its
1430 If a region is active, export that region.
1432 A non-nil optional argument ASYNC means the process should happen
1433 asynchronously. The resulting file should be accessible through
1434 the `org-export-stack' interface.
1436 When optional argument SUBTREEP is non-nil, export the sub-tree
1437 at point, extracting information from the headline properties
1440 When optional argument VISIBLE-ONLY is non-nil, don't export
1441 contents of hidden elements.
1443 When optional argument BODY-ONLY is non-nil, only write code
1444 between \"\\begin{document}\" and \"\\end{document}\".
1446 EXT-PLIST, when provided, is a property list with external
1447 parameters overriding Org default settings, but still inferior to
1448 file-local settings.
1450 When optional argument PUB-DIR is set, use it as the publishing
1453 Return INFO file's name."
1455 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1456 (org-export-coding-system org-texinfo-coding-system
))
1457 (org-export-to-file 'texinfo outfile
1458 async subtreep visible-only body-only ext-plist
1459 (lambda (file) (org-texinfo-compile file
)))))
1462 (defun org-texinfo-publish-to-texinfo (plist filename pub-dir
)
1463 "Publish an org file to Texinfo.
1465 FILENAME is the filename of the Org file to be published. PLIST
1466 is the property list for the given project. PUB-DIR is the
1467 publishing directory.
1469 Return output file name."
1470 (org-publish-org-to 'texinfo filename
".texi" plist pub-dir
))
1473 (defun org-texinfo-convert-region-to-texinfo ()
1474 "Assume the current region has org-mode syntax, and convert it to Texinfo.
1475 This can be used in any buffer. For example, you can write an
1476 itemized list in org-mode syntax in an Texinfo buffer and use
1477 this command to convert it."
1479 (org-export-replace-region-by 'texinfo
))
1481 (defun org-texinfo-compile (file)
1482 "Compile a texinfo file.
1484 FILE is the name of the file being compiled. Processing is
1485 done through the command specified in `org-texinfo-info-process'.
1487 Return INFO file name or an error if it couldn't be produced."
1488 (let* ((base-name (file-name-sans-extension (file-name-nondirectory file
)))
1489 (full-name (file-truename file
))
1490 (out-dir (file-name-directory file
))
1491 ;; Properly set working directory for compilation.
1492 (default-directory (if (file-name-absolute-p file
)
1493 (file-name-directory full-name
)
1496 (message (format "Processing Texinfo file %s..." file
))
1497 (save-window-excursion
1498 ;; Replace %b, %f and %o with appropriate values in each command
1499 ;; before applying it. Output is redirected to "*Org INFO
1500 ;; Texinfo Output*" buffer.
1501 (let ((outbuf (get-buffer-create "*Org INFO Texinfo Output*")))
1502 (dolist (command org-texinfo-info-process
)
1504 (replace-regexp-in-string
1505 "%b" (shell-quote-argument base-name
)
1506 (replace-regexp-in-string
1507 "%f" (shell-quote-argument full-name
)
1508 (replace-regexp-in-string
1509 "%o" (shell-quote-argument out-dir
) command t t
) t t
) t t
)
1511 ;; Collect standard errors from output buffer.
1512 (setq errors
(org-texinfo-collect-errors outbuf
)))
1513 (let ((infofile (concat out-dir base-name
".info")))
1514 ;; Check for process failure. Provide collected errors if
1516 (if (not (file-exists-p infofile
))
1517 (error (concat (format "INFO file %s wasn't produced" infofile
)
1518 (when errors
(concat ": " errors
))))
1519 ;; Else remove log files, when specified, and signal end of
1520 ;; process to user, along with any error encountered.
1521 (when org-texinfo-remove-logfiles
1522 (dolist (ext org-texinfo-logfiles-extensions
)
1523 (let ((file (concat out-dir base-name
"." ext
)))
1524 (when (file-exists-p file
) (delete-file file
)))))
1525 (message (concat "Process completed"
1526 (if (not errors
) "."
1527 (concat " with errors: " errors
)))))
1528 ;; Return output file name.
1531 (defun org-texinfo-collect-errors (buffer)
1532 "Collect some kind of errors from \"makeinfo\" command output.
1534 BUFFER is the buffer containing output.
1536 Return collected error types as a string, or nil if there was
1538 (with-current-buffer buffer
1540 (goto-char (point-min))
1541 ;; Find final "makeinfo" run.
1543 (let ((case-fold-search t
)
1545 (when (save-excursion
1546 (re-search-forward "perhaps incorrect sectioning?" nil t
))
1547 (setq errors
(concat errors
" [incorrect sectioning]")))
1548 (when (save-excursion
1549 (re-search-forward "missing close brace" nil t
))
1550 (setq errors
(concat errors
" [syntax error]")))
1551 (when (save-excursion
1552 (re-search-forward "Unknown command" nil t
))
1553 (setq errors
(concat errors
" [undefined @command]")))
1554 (when (save-excursion
1555 (re-search-forward "No matching @end" nil t
))
1556 (setq errors
(concat errors
" [block incomplete]")))
1557 (when (save-excursion
1558 (re-search-forward "requires a sectioning" nil t
))
1559 (setq errors
(concat errors
" [invalid section command]")))
1560 (when (save-excursion
1561 (re-search-forward "\\[unexpected\]" nil t
))
1562 (setq errors
(concat errors
" [unexpected error]")))
1563 (when (save-excursion
1564 (re-search-forward "misplaced " nil t
))
1565 (setq errors
(concat errors
" [syntax error]")))
1566 (and (org-string-nw-p errors
) (org-trim errors
)))))))
1569 (provide 'ox-texinfo
)
1572 ;; generated-autoload-file: "org-loaddefs.el"
1575 ;;; ox-texinfo.el ends here