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 (paragraph . org-texinfo-paragraph
)
62 (plain-list . org-texinfo-plain-list
)
63 (plain-text . org-texinfo-plain-text
)
64 (planning . org-texinfo-planning
)
65 (property-drawer . org-texinfo-property-drawer
)
66 (quote-block . org-texinfo-quote-block
)
67 (quote-section . org-texinfo-quote-section
)
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
)))
106 ;;; User Configurable Variables
108 (defgroup org-export-texinfo nil
109 "Options for exporting Org mode files to Texinfo."
110 :tag
"Org Export Texinfo"
112 :package-version
'(Org .
"8.0")
117 (defcustom org-texinfo-coding-system nil
118 "Default document encoding for Texinfo output.
120 If `nil' it will default to `buffer-file-coding-system'."
121 :group
'org-export-texinfo
122 :type
'coding-system
)
124 (defcustom org-texinfo-default-class
"info"
125 "The default Texinfo class."
126 :group
'org-export-texinfo
127 :type
'(string :tag
"Texinfo class"))
129 (defcustom org-texinfo-classes
131 "@documentencoding AUTO\n@documentlanguage AUTO"
132 ("@chapter %s" .
"@unnumbered %s")
133 ("@section %s" .
"@unnumberedsec %s")
134 ("@subsection %s" .
"@unnumberedsubsec %s")
135 ("@subsubsection %s" .
"@unnumberedsubsubsec %s")))
136 "Alist of Texinfo classes and associated header and structure.
137 If #+TEXINFO_CLASS is set in the buffer, use its value and the
138 associated information. Here is the structure of each cell:
142 \(numbered-section . unnumbered-section)
149 The header string is inserted in the header of the generated
150 document, right after \"@setfilename\" and \"@settitle\"
153 If it contains the special string
155 \"@documentencoding AUTO\"
157 \"AUTO\" will be replaced with an appropriate coding system. See
158 `org-texinfo-coding-system' for more information. Likewise, if
159 the string contains the special string
161 \"@documentlanguage AUTO\"
163 \"AUTO\" will be replaced with the language defined in the
164 buffer, through #+LANGUAGE keyword, or globally, with
165 `org-export-default-language', which see.
168 The sectioning structure
169 ------------------------
171 The sectioning structure of the class is given by the elements
172 following the header string. For each sectioning level, a number
173 of strings is specified. A %s formatter is mandatory in each
174 section string and will be replaced by the title of the section.
176 Instead of a list of sectioning commands, you can also specify
177 a function name. That function will be called with two
178 parameters, the reduced) level of the headline, and a predicate
179 non-nil when the headline should be numbered. It must return
180 a format string in which the section title will be added."
181 :group
'org-export-texinfo
183 :package-version
'(Org .
"8.2")
185 (list (string :tag
"Texinfo class")
186 (string :tag
"Texinfo header")
187 (repeat :tag
"Levels" :inline t
190 (string :tag
" numbered")
191 (string :tag
"unnumbered"))
192 (function :tag
"Hook computing sectioning"))))))
196 (defcustom org-texinfo-format-headline-function
'ignore
197 "Function to format headline text.
199 This function will be called with 5 arguments:
200 TODO the todo keyword (string or nil).
201 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
202 PRIORITY the priority of the headline (integer or nil)
203 TEXT the main headline text (string).
204 TAGS the tags as a list of strings (list of strings or nil).
206 The function result will be used in the section format string.
208 As an example, one could set the variable to the following, in
209 order to reproduce the default set-up:
211 \(defun org-texinfo-format-headline (todo todo-type priority text tags)
212 \"Default format function for a headline.\"
214 \(format \"\\\\textbf{\\\\textsc{\\\\textsf{%s}}} \" todo))
216 \(format \"\\\\framebox{\\\\#%c} \" priority))
219 \(format \"\\\\hfill{}\\\\textsc{%s}\"
220 \(mapconcat 'identity tags \":\"))))"
221 :group
'org-export-texinfo
224 ;;;; Node listing (menu)
226 (defcustom org-texinfo-node-description-column
32
227 "Column at which to start the description in the node listings.
228 If a node title is greater than this length, the description will
229 be placed after the end of the title."
230 :group
'org-export-texinfo
235 (defcustom org-texinfo-active-timestamp-format
"@emph{%s}"
236 "A printf format string to be applied to active timestamps."
237 :group
'org-export-texinfo
240 (defcustom org-texinfo-inactive-timestamp-format
"@emph{%s}"
241 "A printf format string to be applied to inactive timestamps."
242 :group
'org-export-texinfo
245 (defcustom org-texinfo-diary-timestamp-format
"@emph{%s}"
246 "A printf format string to be applied to diary timestamps."
247 :group
'org-export-texinfo
252 (defcustom org-texinfo-link-with-unknown-path-format
"@indicateurl{%s}"
253 "Format string for links with unknown path type."
254 :group
'org-export-texinfo
259 (defcustom org-texinfo-tables-verbatim nil
260 "When non-nil, tables are exported verbatim."
261 :group
'org-export-texinfo
264 (defcustom org-texinfo-table-scientific-notation
"%s\\,(%s)"
265 "Format string to display numbers in scientific notation.
266 The format should have \"%s\" twice, for mantissa and exponent
267 \(i.e. \"%s\\\\times10^{%s}\").
269 When nil, no transformation is made."
270 :group
'org-export-texinfo
272 (string :tag
"Format string")
273 (const :tag
"No formatting" nil
)))
275 (defcustom org-texinfo-def-table-markup
"@samp"
276 "Default setting for @table environments."
277 :group
'org-export-texinfo
282 (defcustom org-texinfo-text-markup-alist
'((bold .
"@strong{%s}")
284 (italic .
"@emph{%s}")
287 "Alist of Texinfo expressions to convert text markup.
289 The key must be a symbol among `bold', `italic' and `comment'.
290 The value is a formatting string to wrap fontified text with.
292 Value can also be set to the following symbols: `verb' and
293 `code'. For the former, Org will use \"@verb\" to
294 create a format string and select a delimiter character that
295 isn't in the string. For the latter, Org will use \"@code\"
296 to typeset and try to protect special characters.
298 If no association can be found for a given markup, text will be
300 :group
'org-export-texinfo
302 :options
'(bold code italic verbatim comment
))
306 (defcustom org-texinfo-format-drawer-function
307 (lambda (name contents
) contents
)
308 "Function called to format a drawer in Texinfo code.
310 The function must accept two parameters:
311 NAME the drawer name, like \"LOGBOOK\"
312 CONTENTS the contents of the drawer.
314 The function should return the string to be exported.
316 The default function simply returns the value of CONTENTS."
317 :group
'org-export-texinfo
319 :package-version
'(Org .
"8.2")
324 (defcustom org-texinfo-format-inlinetask-function
'ignore
325 "Function called to format an inlinetask in Texinfo code.
327 The function must accept six parameters:
328 TODO the todo keyword, as a string
329 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
330 PRIORITY the inlinetask priority, as a string
331 NAME the inlinetask name, as a string.
332 TAGS the inlinetask tags, as a list of strings.
333 CONTENTS the contents of the inlinetask, as a string.
335 The function should return the string to be exported.
337 For example, the variable could be set to the following function
338 in order to mimic default behavior:
340 \(defun org-texinfo-format-inlinetask \(todo type priority name tags contents\)
341 \"Format an inline task element for Texinfo export.\"
345 \(format \"@strong{%s} \" todo))
346 \(when priority (format \"#%c \" priority))
350 \(mapconcat 'identity tags \":\")))))
351 \(format (concat \"@center %s\n\n\"
354 full-title contents))"
355 :group
'org-export-texinfo
360 (defcustom org-texinfo-info-process
'("makeinfo %f")
361 "Commands to process a Texinfo file to an INFO file.
362 This is list of strings, each of them will be given to the shell
363 as a command. %f in the command will be replaced by the full
364 file name, %b by the file base name (i.e without extension) and
365 %o by the base directory of the file."
366 :group
'org-export-texinfo
367 :type
'(repeat :tag
"Shell command sequence"
368 (string :tag
"Shell command")))
370 (defcustom org-texinfo-logfiles-extensions
371 '("aux" "toc" "cp" "fn" "ky" "pg" "tp" "vr")
372 "The list of file extensions to consider as Texinfo logfiles.
373 The logfiles will be remove if `org-texinfo-remove-logfiles' is
375 :group
'org-export-texinfo
376 :type
'(repeat (string :tag
"Extension")))
378 (defcustom org-texinfo-remove-logfiles t
379 "Non-nil means remove the logfiles produced by compiling a Texinfo file.
380 By default, logfiles are files with these extensions: .aux, .toc,
381 .cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove,
382 set `org-texinfo-logfiles-extensions'."
383 :group
'org-export-latex
388 (defconst org-texinfo-max-toc-depth
4
389 "Maximum depth for creation of detailed menu listings.
390 Beyond this depth, Texinfo will not recognize the nodes and will
391 cause errors. Left as a constant in case this value ever
394 (defconst org-texinfo-supported-coding-systems
395 '("US-ASCII" "UTF-8" "ISO-8859-15" "ISO-8859-1" "ISO-8859-2" "koi8-r" "koi8-u")
396 "List of coding systems supported by Texinfo, as strings.
397 Specified coding system will be matched against these strings.
398 If two strings share the same prefix (e.g. \"ISO-8859-1\" and
399 \"ISO-8859-15\"), the most specific one has to be listed first.")
402 ;;; Internal Functions
404 (defun org-texinfo-filter-section-blank-lines (headline back-end info
)
405 "Filter controlling number of blank lines after a section."
406 (let ((blanks (make-string 2 ?
\n)))
407 (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline
)))
409 (defun org-texinfo--normalize-headlines (tree back-end info
)
410 "Normalize headlines in TREE.
412 BACK-END is the symbol specifying back-end used for export. INFO
413 is a plist used as a communication channel.
415 Make sure every headline in TREE contains a section, since those
416 are required to install a menu. Also put exactly one blank line
417 at the end of each section.
420 (org-element-map tree
'headline
422 (org-element-put-property hl
:post-blank
1)
423 (let ((contents (org-element-contents hl
)))
425 (let ((first (org-element-map contents
'(headline section
)
427 (unless (eq (org-element-type first
) 'section
)
428 (org-element-set-contents
429 hl
(cons `(section (:parent
,hl
)) contents
)))))))
433 (defun org-texinfo--find-verb-separator (s)
434 "Return a character not used in string S.
435 This is used to choose a separator for constructs like \\verb."
436 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
437 (loop for c across ll
438 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
439 return
(char-to-string c
))))
441 (defun org-texinfo--text-markup (text markup
)
442 "Format TEXT depending on MARKUP text markup.
443 See `org-texinfo-text-markup-alist' for details."
444 (let ((fmt (cdr (assq markup org-texinfo-text-markup-alist
))))
446 ;; No format string: Return raw text.
449 (let ((separator (org-texinfo--find-verb-separator text
)))
450 (concat "@verb{" separator text separator
"}")))
455 (while (string-match "[@{}]" text
)
456 (setq char
(match-string 0 text
))
457 (if (> (match-beginning 0) 0)
458 (setq rtn
(concat rtn
(substring text
0 (match-beginning 0)))))
459 (setq text
(substring text
(1+ (match-beginning 0))))
460 (setq char
(concat "@" char
)
461 rtn
(concat rtn char
)))
462 (setq text
(concat rtn text
)
465 ;; Else use format string.
466 (t (format fmt text
)))))
468 (defun org-texinfo--get-node (headline info
)
469 "Return node entry associated to HEADLINE.
470 INFO is a plist used as a communication channel. The function
471 guarantees the node name is unique."
472 (let ((cache (plist-get info
:texinfo-node-cache
)))
473 (or (cdr (assq headline cache
))
474 (let ((name (org-texinfo--sanitize-node
476 (org-export-get-alt-title headline info
) info
))))
477 ;; Ensure NAME is unique.
478 (while (rassoc name cache
) (setq name
(concat name
"x")))
479 (plist-put info
:texinfo-node-cache
(cons (cons headline name
) cache
))
484 (defun org-texinfo--sanitize-node (title)
485 "Bend string TITLE to node line requirements.
486 Trim string and collapse multiple whitespace characters as they
487 are not significant. Also remove the following characters: @
489 (replace-regexp-in-string
491 (replace-regexp-in-string
492 "\\`(\\(.*)\\)" "[\\1"
493 (org-trim (replace-regexp-in-string "[ \t]\\{2,\\}" " " title
)))))
495 ;;;; Content sanitizing
497 (defun org-texinfo--sanitize-content (text)
498 "Escape special characters in string TEXT.
499 Special characters are: @ { }"
500 (replace-regexp-in-string "\\\([@{}]\\\)" "@\\1" text
))
504 (defun org-texinfo-template (contents info
)
505 "Return complete document string after Texinfo conversion.
506 CONTENTS is the transcoded contents string. INFO is a plist
507 holding export options."
508 (let ((title (org-export-data (plist-get info
:title
) info
))
509 ;; Copying data is the contents of the first headline in
510 ;; parse tree with a non-nil copying property.
511 (copying (org-element-map (plist-get info
:parse-tree
) 'headline
513 (and (org-not-nil (org-element-property :COPYING hl
))
514 (org-element-contents hl
)))
517 "\\input texinfo @c -*- texinfo -*-\n"
518 "@c %**start of header\n"
519 (let ((file (or (plist-get info
:texinfo-filename
)
520 (let ((f (plist-get info
:output-file
)))
521 (and f
(concat (file-name-sans-extension f
) ".info"))))))
522 (and file
(format "@setfilename %s\n" file
)))
523 (format "@settitle %s\n" title
)
524 ;; Insert class-defined header.
525 (org-element-normalize-string
526 (let ((header (nth 1 (assoc (plist-get info
:texinfo-class
)
527 org-texinfo-classes
)))
529 (catch 'coding-system
530 (let ((case-fold-search t
)
531 (name (symbol-name (or org-texinfo-coding-system
532 buffer-file-coding-system
))))
533 (dolist (system org-texinfo-supported-coding-systems
"UTF-8")
534 (when (org-string-match-p (regexp-quote system
) name
)
535 (throw 'coding-system system
))))))
536 (language (plist-get info
:language
))
537 (case-fold-search nil
))
538 ;; Auto coding system.
539 (replace-regexp-in-string
540 "^@documentencoding \\(AUTO\\)$"
542 (replace-regexp-in-string
543 "^@documentlanguage \\(AUTO\\)$" language header nil nil
1)
545 ;; Additional header options set by #+TEXINFO_HEADER.
546 (let ((texinfo-header (plist-get info
:texinfo-header
)))
547 (and texinfo-header
(org-element-normalize-string texinfo-header
)))
548 "@c %**end of header\n\n"
549 ;; Additional options set by #+TEXINFO_POST_HEADER.
550 (let ((texinfo-post-header (plist-get info
:texinfo-post-header
)))
551 (and texinfo-post-header
552 (org-element-normalize-string texinfo-post-header
)))
555 (format "@copying\n%s@end copying\n\n"
556 (org-element-normalize-string
557 (org-export-data copying info
))))
558 ;; Info directory information. Only supply if both title and
559 ;; category are provided.
560 (let ((dircat (plist-get info
:texinfo-dircat
))
562 (let ((title (plist-get info
:texinfo-dirtitle
)))
564 (string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title
)
565 (format "* %s." (match-string 1 title
))))))
566 (when (and dircat dirtitle
)
567 (concat "@dircategory " dircat
"\n"
570 (let ((desc (plist-get info
:texinfo-dirdesc
)))
571 (cond ((not desc
) nil
)
572 ((org-string-match-p "\\.$" desc
) desc
)
573 (t (concat desc
"."))))))
574 (if dirdesc
(format "%-23s %s" dirtitle dirdesc
) dirtitle
))
576 "@end direntry\n\n")))
580 (format "@title %s\n" (or (plist-get info
:texinfo-printed-title
) title
))
581 (let ((subtitle (plist-get info
:subtitle
)))
583 (org-element-normalize-string
584 (replace-regexp-in-string "^" "@subtitle " subtitle
))))
585 (when (plist-get info
:with-author
)
588 (let ((author (org-string-nw-p
589 (org-export-data (plist-get info
:author
) info
)))
590 (email (and (plist-get info
:with-email
)
592 (org-export-data (plist-get info
:email
) info
)))))
593 (cond ((and author email
)
594 (format "@author %s (@email{%s})\n" author email
))
595 (author (format "@author %s\n" author
))
596 (email (format "@author @email{%s}\n" email
))))
598 (let ((subauthor (plist-get info
:subauthor
)))
600 (org-element-normalize-string
601 (replace-regexp-in-string "^" "@author " subauthor
))))))
602 (and copying
"@page\n@vskip 0pt plus 1filll\n@insertcopying\n")
604 ;; Table of contents.
605 (and (plist-get info
:with-toc
) "@contents\n\n")
606 ;; Configure Top Node when not for Tex
609 (format "@top %s\n" title
)
610 (and copying
"@insertcopying\n")
613 (org-texinfo-make-menu (plist-get info
:parse-tree
) info
'master
)
618 (case (plist-get info
:with-creator
)
620 (comment (format "@c %s\n" (plist-get info
:creator
)))
621 (otherwise (concat (plist-get info
:creator
) "\n")))
627 ;;; Transcode Functions
631 (defun org-texinfo-bold (bold contents info
)
632 "Transcode BOLD from Org to Texinfo.
633 CONTENTS is the text with bold markup. INFO is a plist holding
634 contextual information."
635 (org-texinfo--text-markup contents
'bold
))
639 (defun org-texinfo-center-block (center-block contents info
)
640 "Transcode a CENTER-BLOCK element from Org to Texinfo.
641 CONTENTS holds the contents of the block. INFO is a plist used
642 as a communication channel."
647 (defun org-texinfo-clock (clock contents info
)
648 "Transcode a CLOCK element from Org to Texinfo.
649 CONTENTS is nil. INFO is a plist holding contextual
653 (format "@strong{%s} " org-clock-string
)
654 (format org-texinfo-inactive-timestamp-format
655 (concat (org-translate-time
656 (org-element-property :raw-value
657 (org-element-property :value clock
)))
658 (let ((time (org-element-property :duration clock
)))
659 (and time
(format " (%s)" time
)))))
664 (defun org-texinfo-code (code contents info
)
665 "Transcode a CODE object from Org to Texinfo.
666 CONTENTS is nil. INFO is a plist used as a communication
668 (org-texinfo--text-markup (org-element-property :value code
) 'code
))
672 (defun org-texinfo-drawer (drawer contents info
)
673 "Transcode a DRAWER element from Org to Texinfo.
674 CONTENTS holds the contents of the block. INFO is a plist
675 holding contextual information."
676 (let* ((name (org-element-property :drawer-name drawer
))
677 (output (funcall org-texinfo-format-drawer-function
683 (defun org-texinfo-dynamic-block (dynamic-block contents info
)
684 "Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
685 CONTENTS holds the contents of the block. INFO is a plist
686 holding contextual information."
691 (defun org-texinfo-entity (entity contents info
)
692 "Transcode an ENTITY object from Org to Texinfo.
693 CONTENTS are the definition itself. INFO is a plist holding
694 contextual information."
695 (let ((ent (org-element-property :latex entity
)))
696 (if (org-element-property :latex-math-p entity
) (format "@math{%s}" ent
) ent
)))
700 (defun org-texinfo-example-block (example-block contents info
)
701 "Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
702 CONTENTS is nil. INFO is a plist holding contextual
704 (format "@verbatim\n%s@end verbatim"
705 (org-export-format-code-default example-block info
)))
709 (defun org-texinfo-export-block (export-block contents info
)
710 "Transcode a EXPORT-BLOCK element from Org to Texinfo.
711 CONTENTS is nil. INFO is a plist holding contextual information."
712 (when (string= (org-element-property :type export-block
) "TEXINFO")
713 (org-remove-indentation (org-element-property :value export-block
))))
717 (defun org-texinfo-export-snippet (export-snippet contents info
)
718 "Transcode a EXPORT-SNIPPET object from Org to Texinfo.
719 CONTENTS is nil. INFO is a plist holding contextual information."
720 (when (eq (org-export-snippet-backend export-snippet
) 'texinfo
)
721 (org-element-property :value export-snippet
)))
725 (defun org-texinfo-fixed-width (fixed-width contents info
)
726 "Transcode a FIXED-WIDTH element from Org to Texinfo.
727 CONTENTS is nil. INFO is a plist holding contextual information."
728 (format "@example\n%s\n@end example"
729 (org-remove-indentation
730 (org-texinfo--sanitize-content
731 (org-element-property :value fixed-width
)))))
733 ;;;; Footnote Reference
735 (defun org-texinfo-footnote-reference (footnote contents info
)
736 "Create a footnote reference for FOOTNOTE.
738 FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
739 plist holding contextual information."
740 (let ((def (org-export-get-footnote-definition footnote info
)))
741 (format "@footnote{%s}"
742 (org-trim (org-export-data def info
)))))
746 (defun org-texinfo-headline (headline contents info
)
747 "Transcode a HEADLINE element from Org to Texinfo.
748 CONTENTS holds the contents of the headline. INFO is a plist
749 holding contextual information."
750 (let* ((class (plist-get info
:texinfo-class
))
751 (level (org-export-get-relative-level headline info
))
752 (numberedp (org-export-numbered-headline-p headline info
))
753 (class-sectioning (assoc class org-texinfo-classes
))
754 ;; Find the index type, if any.
755 (index (org-element-property :INDEX headline
))
756 ;; Create node info, to insert it before section formatting.
757 ;; Use custom menu title if present.
758 (node (format "@node %s\n" (org-texinfo--get-node headline info
)))
759 ;; Section formatting will set two placeholders: one for the
760 ;; title and the other for the contents.
762 (if (org-not-nil (org-element-property :APPENDIX headline
))
764 (let ((sec (if (and (symbolp (nth 2 class-sectioning
))
765 (fboundp (nth 2 class-sectioning
)))
766 (funcall (nth 2 class-sectioning
) level numberedp
)
767 (nth (1+ level
) class-sectioning
))))
769 ;; No section available for that LEVEL.
771 ;; Section format directly returned by a function.
773 ;; (numbered-section . unnumbered-section)
774 ((not (consp (cdr sec
)))
775 (concat (if (or index
(not numberedp
)) (cdr sec
) (car sec
))
778 (and (plist-get info
:with-todo-keywords
)
779 (let ((todo (org-element-property :todo-keyword headline
)))
780 (and todo
(org-export-data todo info
)))))
781 (todo-type (and todo
(org-element-property :todo-type headline
)))
782 (tags (and (plist-get info
:with-tags
)
783 (org-export-get-tags headline info
)))
784 (priority (and (plist-get info
:with-priority
)
785 (org-element-property :priority headline
)))
786 (text (org-export-data (org-element-property :title headline
) info
))
787 (full-text (if (not (eq org-texinfo-format-headline-function
'ignore
))
788 ;; User-defined formatting function.
789 (funcall org-texinfo-format-headline-function
790 todo todo-type priority text tags
)
791 ;; Default formatting.
794 (format "@strong{%s} " todo
))
795 (when priority
(format "@emph{#%s} " priority
))
799 (mapconcat 'identity tags
":"))))))
800 (contents (if (org-string-nw-p contents
) (concat "\n" contents
) "")))
802 ;; Case 1: This is a footnote section: ignore it.
803 ((org-element-property :footnote-section-p headline
) nil
)
804 ;; Case 2: This is the `copying' section: ignore it
805 ;; This is used elsewhere.
806 ((org-not-nil (org-element-property :COPYING headline
)) nil
)
807 ;; Case 3: An index. If it matches one of the known indexes,
808 ;; print it as such following the contents, otherwise
809 ;; print the contents and leave the index up to the user.
816 (and (member index
'("cp" "fn" "ky" "pg" "tp" "vr"))
817 (concat "\n@printindex " index
))))))
818 ;; Case 4: This is a deep sub-tree: export it as a list item.
819 ;; Also export as items headlines for which no section
820 ;; format has been found.
821 ((or (not section-fmt
) (org-export-low-level-p headline info
))
822 ;; Build the real contents of the sub-tree.
823 (concat (and (org-export-first-sibling-p headline info
)
824 (format "@%s\n" (if numberedp
'enumerate
'itemize
)))
825 "@item\n" full-text
"\n"
827 (if (org-export-last-sibling-p headline info
)
828 (format "@end %s" (if numberedp
'enumerate
'itemize
))
830 ;; Case 5: Standard headline. Export it as a section.
831 (t (concat node
(format section-fmt full-text contents
))))))
833 ;;;; Inline Src Block
835 (defun org-texinfo-inline-src-block (inline-src-block contents info
)
836 "Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
837 CONTENTS holds the contents of the item. INFO is a plist holding
838 contextual information."
839 (let* ((code (org-element-property :value inline-src-block
))
840 (separator (org-texinfo--find-verb-separator code
)))
841 (concat "@verb{" separator code separator
"}")))
845 (defun org-texinfo-inlinetask (inlinetask contents info
)
846 "Transcode an INLINETASK element from Org to Texinfo.
847 CONTENTS holds the contents of the block. INFO is a plist
848 holding contextual information."
849 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
850 (todo (and (plist-get info
:with-todo-keywords
)
851 (let ((todo (org-element-property :todo-keyword inlinetask
)))
852 (and todo
(org-export-data todo info
)))))
853 (todo-type (org-element-property :todo-type inlinetask
))
854 (tags (and (plist-get info
:with-tags
)
855 (org-export-get-tags inlinetask info
)))
856 (priority (and (plist-get info
:with-priority
)
857 (org-element-property :priority inlinetask
))))
858 ;; If `org-texinfo-format-inlinetask-function' is provided, call it
859 ;; with appropriate arguments.
860 (if (not (eq org-texinfo-format-inlinetask-function
'ignore
))
861 (funcall org-texinfo-format-inlinetask-function
862 todo todo-type priority title tags contents
)
863 ;; Otherwise, use a default template.
866 (when todo
(format "@strong{%s} " todo
))
867 (when priority
(format "#%c " priority
))
869 (when tags
(format ":%s:"
870 (mapconcat 'identity tags
":"))))))
871 (format (concat "@center %s\n\n"
874 full-title contents
)))))
878 (defun org-texinfo-italic (italic contents info
)
879 "Transcode ITALIC from Org to Texinfo.
880 CONTENTS is the text with italic markup. INFO is a plist holding
881 contextual information."
882 (org-texinfo--text-markup contents
'italic
))
886 (defun org-texinfo-item (item contents info
)
887 "Transcode an ITEM element from Org to Texinfo.
888 CONTENTS holds the contents of the item. INFO is a plist holding
889 contextual information."
890 (format "@item%s\n%s"
891 (let ((tag (org-element-property :tag item
)))
892 (if tag
(concat " " (org-export-data tag info
)) ""))
897 (defun org-texinfo-keyword (keyword contents info
)
898 "Transcode a KEYWORD element from Org to Texinfo.
899 CONTENTS is nil. INFO is a plist holding contextual information."
900 (let ((key (org-element-property :key keyword
))
901 (value (org-element-property :value keyword
)))
903 ((string= key
"TEXINFO") value
)
904 ((string= key
"CINDEX") (format "@cindex %s" value
))
905 ((string= key
"FINDEX") (format "@findex %s" value
))
906 ((string= key
"KINDEX") (format "@kindex %s" value
))
907 ((string= key
"PINDEX") (format "@pindex %s" value
))
908 ((string= key
"TINDEX") (format "@tindex %s" value
))
909 ((string= key
"VINDEX") (format "@vindex %s" value
)))))
913 (defun org-texinfo-line-break (line-break contents info
)
914 "Transcode a LINE-BREAK object from Org to Texinfo.
915 CONTENTS is nil. INFO is a plist holding contextual information."
920 (defun org-texinfo-link (link desc info
)
921 "Transcode a LINK object from Org to Texinfo.
923 DESC is the description part of the link, or the empty string.
924 INFO is a plist holding contextual information. See
926 (let* ((type (org-element-property :type link
))
927 (raw-path (org-element-property :path link
))
928 ;; Ensure DESC really exists, or set it to nil.
929 (desc (and (not (string= desc
"")) desc
))
931 ((member type
'("http" "https" "ftp"))
932 (concat type
":" raw-path
))
933 ((and (string= type
"file") (file-name-absolute-p raw-path
))
934 (concat "file:" raw-path
))
936 (email (if (string= type
"mailto")
937 (let ((text (replace-regexp-in-string
939 (concat text
(if desc
(concat "," desc
))))))
942 ;; Links pointing to a headline: Find destination and build
943 ;; appropriate referencing command.
944 ((member type
'("custom-id" "id"))
945 (let ((destination (org-export-resolve-id-link link info
)))
946 (case (org-element-type destination
)
947 ;; Id link points to an external file.
949 (if desc
(format "@uref{file://%s,%s}" destination desc
)
950 (format "@uref{file://%s}" destination
)))
951 ;; LINK points to a headline. Use the headline as the NODE target
953 (format "@ref{%s,%s}"
954 (org-texinfo--get-node destination info
)
957 (let ((path (org-export-solidify-link-text path
)))
958 (if (not desc
) (format "@ref{%s}" path
)
959 (format "@ref{%s,,%s}" path desc
)))))))
960 ((member type
'("info"))
961 (let* ((info-path (split-string path
"[:#]"))
962 (info-manual (car info-path
))
963 (info-node (or (cadr info-path
) "top"))
964 (title (or desc
"")))
965 (format "@ref{%s,%s,,%s,}" info-node title info-manual
)))
966 ((member type
'("fuzzy"))
967 (let ((destination (org-export-resolve-fuzzy-link link info
)))
968 (case (org-element-type destination
)
969 ;; Id link points to an external file.
971 (if desc
(format "@uref{file://%s,%s}" destination desc
)
972 (format "@uref{file://%s}" destination
)))
973 ;; LINK points to a headline. Use the headline as the NODE target
975 (format "@ref{%s,%s}"
976 (org-texinfo--get-node destination info
)
979 (let ((path (org-export-solidify-link-text path
)))
980 (if (not desc
) (format "@ref{%s}" path
)
981 (format "@ref{%s,,%s}" path desc
)))))))
982 ;; Special case for email addresses
984 (format "@email{%s}" email
))
985 ;; External link with a description part.
986 ((and path desc
) (format "@uref{%s,%s}" path desc
))
987 ;; External link without a description part.
988 (path (format "@uref{%s}" path
))
989 ;; No path, only description. Try to do something useful.
990 (t (format org-texinfo-link-with-unknown-path-format desc
)))))
995 (defun org-texinfo-make-menu (scope info
&optional master
)
996 "Create the menu for inclusion in the Texinfo document.
998 SCOPE is a headline or a full parse tree. INFO is the
999 communication channel, as a plist.
1001 When optional argument MASTER is non-nil, generate a master menu,
1002 including detailed node listing."
1003 (let ((menu (org-texinfo--build-menu scope info
)))
1004 (when (org-string-nw-p menu
)
1005 (org-element-normalize-string
1007 "@menu\n%s@end menu"
1011 (org-texinfo--build-menu
1013 (let ((toc-depth (plist-get info
:with-toc
)))
1014 (if (wholenump toc-depth
) toc-depth
1015 org-texinfo-max-toc-depth
)))))
1016 (when (org-string-nw-p detailmenu
)
1017 (concat "\n@detailmenu\n"
1018 "--- The Detailed Node Listing ---\n\n"
1020 "@end detailmenu\n"))))))))))
1022 (defun org-texinfo--build-menu (scope info
&optional level
)
1023 "Build menu for entries within SCOPE.
1024 SCOPE is a headline or a full parse tree. INFO is a plist
1025 containing contextual information. When optional argument LEVEL
1026 is an integer, build the menu recursively, down to this depth."
1029 (org-texinfo--format-entries (org-texinfo--menu-entries scope info
) info
))
1032 (org-element-normalize-string
1035 (let ((entries (org-texinfo--menu-entries h info
)))
1038 (format "%s\n\n%s\n"
1039 (org-export-data (org-export-get-alt-title h info
) info
)
1040 (org-texinfo--format-entries entries info
))
1041 (org-texinfo--build-menu h info
(1- level
))))))
1042 (org-texinfo--menu-entries scope info
) "")))))
1044 (defun org-texinfo--format-entries (entries info
)
1045 "Format all direct menu entries in SCOPE, as a string.
1046 SCOPE is either a headline or a full Org document. INFO is
1047 a plist containing contextual information."
1048 (org-element-normalize-string
1051 (let* ((title (org-export-data
1052 (org-export-get-alt-title h info
) info
))
1053 (node (org-texinfo--get-node h info
))
1054 (entry (concat "* " title
":"
1055 (if (string= title node
) ":"
1056 (concat " " node
". "))))
1057 (desc (org-element-property :DESCRIPTION h
)))
1058 (if (not desc
) entry
1059 (format (format "%%-%ds %%s" org-texinfo-node-description-column
)
1063 (defun org-texinfo--menu-entries (scope info
)
1064 "List direct children in SCOPE needing a menu entry.
1065 SCOPE is a headline or a full parse tree. INFO is a plist
1066 holding contextual information."
1067 (let* ((cache (or (plist-get info
:texinfo-entries-cache
)
1068 (plist-get (plist-put info
:texinfo-entries-cache
1069 (make-hash-table :test
#'eq
))
1070 :texinfo-entries-cache
)))
1071 (cached-entries (gethash scope cache
'no-cache
)))
1072 (if (not (eq cached-entries
'no-cache
)) cached-entries
1074 (org-element-map (org-element-contents scope
) 'headline
1076 (and (not (org-not-nil (org-element-property :COPYING h
)))
1077 (not (org-element-property :footnote-section-p h
))
1078 (not (org-export-low-level-p h info
))
1085 (defun org-texinfo-paragraph (paragraph contents info
)
1086 "Transcode a PARAGRAPH element from Org to Texinfo.
1087 CONTENTS is the contents of the paragraph, as a string. INFO is
1088 the plist used as a communication channel."
1093 (defun org-texinfo-plain-list (plain-list contents info
)
1094 "Transcode a PLAIN-LIST element from Org to Texinfo.
1095 CONTENTS is the contents of the list. INFO is a plist holding
1096 contextual information."
1097 (let* ((attr (org-export-read-attribute :attr_texinfo plain-list
))
1098 (indic (or (plist-get attr
:indic
) org-texinfo-def-table-markup
))
1099 (table-type (plist-get attr
:table-type
))
1100 (type (org-element-property :type plain-list
))
1102 ((eq type
'ordered
) "enumerate")
1103 ((eq type
'unordered
) "itemize")
1104 ((member table-type
'("ftable" "vtable")) table-type
)
1106 (format "@%s\n%s@end %s"
1107 (if (eq type
'descriptive
) (concat list-type
" " indic
) list-type
)
1113 (defun org-texinfo-plain-text (text info
)
1114 "Transcode a TEXT string from Org to Texinfo.
1115 TEXT is the string to transcode. INFO is a plist holding
1116 contextual information."
1117 ;; First protect @, { and }.
1118 (let ((output (org-texinfo--sanitize-content text
)))
1119 ;; Activate smart quotes. Be sure to provide original TEXT string
1120 ;; since OUTPUT may have been modified.
1121 (when (plist-get info
:with-smart-quotes
)
1123 (org-export-activate-smart-quotes output
:texinfo info text
)))
1124 ;; LaTeX into @LaTeX{} and TeX into @TeX{}
1125 (let ((case-fold-search nil
)
1127 (while (string-match "\\(\\(?:La\\)?TeX\\)" output start
)
1128 (setq output
(replace-match
1129 (format "@%s{}" (match-string 1 output
)) nil t output
)
1130 start
(match-end 0))))
1131 ;; Convert special strings.
1132 (when (plist-get info
:with-special-strings
)
1133 (while (string-match (regexp-quote "...") output
)
1134 (setq output
(replace-match "@dots{}" nil t output
))))
1135 ;; Handle break preservation if required.
1136 (when (plist-get info
:preserve-breaks
)
1137 (setq output
(replace-regexp-in-string
1138 "\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output
)))
1144 (defun org-texinfo-planning (planning contents info
)
1145 "Transcode a PLANNING element from Org to Texinfo.
1146 CONTENTS is nil. INFO is a plist holding contextual
1154 (let ((closed (org-element-property :closed planning
)))
1157 (format "@strong{%s} " org-closed-string
)
1158 (format org-texinfo-inactive-timestamp-format
1160 (org-element-property :raw-value closed
))))))
1161 (let ((deadline (org-element-property :deadline planning
)))
1164 (format "@strong{%s} " org-deadline-string
)
1165 (format org-texinfo-active-timestamp-format
1167 (org-element-property :raw-value deadline
))))))
1168 (let ((scheduled (org-element-property :scheduled planning
)))
1171 (format "@strong{%s} " org-scheduled-string
)
1172 (format org-texinfo-active-timestamp-format
1174 (org-element-property :raw-value scheduled
))))))))
1178 ;;;; Property Drawer
1180 (defun org-texinfo-property-drawer (property-drawer contents info
)
1181 "Transcode a PROPERTY-DRAWER element from Org to Texinfo.
1182 CONTENTS is nil. INFO is a plist holding contextual
1184 ;; The property drawer isn't exported but we want separating blank
1185 ;; lines nonetheless.
1190 (defun org-texinfo-quote-block (quote-block contents info
)
1191 "Transcode a QUOTE-BLOCK element from Org to Texinfo.
1192 CONTENTS holds the contents of the block. INFO is a plist
1193 holding contextual information."
1194 (let* ((title (org-element-property :name quote-block
))
1195 (start-quote (concat "@quotation"
1197 (format " %s" title
)))))
1198 (format "%s\n%s@end quotation" start-quote contents
)))
1202 (defun org-texinfo-quote-section (quote-section contents info
)
1203 "Transcode a QUOTE-SECTION element from Org to Texinfo.
1204 CONTENTS is nil. INFO is a plist holding contextual information."
1205 (let ((value (org-remove-indentation
1206 (org-element-property :value quote-section
))))
1207 (when value
(format "@verbatim\n%s@end verbatim" value
))))
1211 (defun org-texinfo-radio-target (radio-target text info
)
1212 "Transcode a RADIO-TARGET object from Org to Texinfo.
1213 TEXT is the text of the target. INFO is a plist holding
1214 contextual information."
1215 (format "@anchor{%s}%s"
1216 (org-export-solidify-link-text
1217 (org-element-property :value radio-target
))
1222 (defun org-texinfo-section (section contents info
)
1223 "Transcode a SECTION element from Org to Texinfo.
1224 CONTENTS holds the contents of the section. INFO is a plist
1225 holding contextual information."
1227 (let ((parent (org-export-get-parent-headline section
)))
1228 (and parent
(org-texinfo-make-menu parent info
)))))
1232 (defun org-texinfo-special-block (special-block contents info
)
1233 "Transcode a SPECIAL-BLOCK element from Org to Texinfo.
1234 CONTENTS holds the contents of the block. INFO is a plist used
1235 as a communication channel."
1240 (defun org-texinfo-src-block (src-block contents info
)
1241 "Transcode a SRC-BLOCK element from Org to Texinfo.
1242 CONTENTS holds the contents of the item. INFO is a plist holding
1243 contextual information."
1244 (let ((lispp (org-string-match-p "lisp"
1245 (org-element-property :language src-block
)))
1246 (code (org-texinfo--sanitize-content
1247 (org-export-format-code-default src-block info
))))
1248 (format (if lispp
"@lisp\n%s@end lisp" "@example\n%s@end example") code
)))
1250 ;;;; Statistics Cookie
1252 (defun org-texinfo-statistics-cookie (statistics-cookie contents info
)
1253 "Transcode a STATISTICS-COOKIE object from Org to Texinfo.
1254 CONTENTS is nil. INFO is a plist holding contextual information."
1255 (org-element-property :value statistics-cookie
))
1259 (defun org-texinfo-subscript (subscript contents info
)
1260 "Transcode a SUBSCRIPT object from Org to Texinfo.
1261 CONTENTS is the contents of the object. INFO is a plist holding
1262 contextual information."
1263 (format "@math{_%s}" contents
))
1267 (defun org-texinfo-superscript (superscript contents info
)
1268 "Transcode a SUPERSCRIPT object from Org to Texinfo.
1269 CONTENTS is the contents of the object. INFO is a plist holding
1270 contextual information."
1271 (format "@math{^%s}" contents
))
1275 (defun org-texinfo-table (table contents info
)
1276 "Transcode a TABLE element from Org to Texinfo.
1277 CONTENTS is the contents of the table. INFO is a plist holding
1278 contextual information."
1279 (if (eq (org-element-property :type table
) 'table.el
)
1280 (format "@verbatim\n%s@end verbatim"
1281 (org-element-normalize-string
1282 (org-element-property :value table
)))
1283 (let* ((col-width (org-export-read-attribute :attr_texinfo table
:columns
))
1285 (if col-width
(format "@columnfractions %s" col-width
)
1286 (org-texinfo-table-column-widths table info
))))
1287 (format "@multitable %s\n%s@end multitable"
1291 (defun org-texinfo-table-column-widths (table info
)
1292 "Determine the largest table cell in each column to process alignment.
1293 TABLE is the table element to transcode. INFO is a plist used as
1294 a communication channel."
1295 (let ((widths (make-vector (cdr (org-export-table-dimensions table info
)) 0)))
1296 (org-element-map table
'table-row
1299 (org-element-map row
'table-cell
1301 ;; Length of the cell in the original buffer is only an
1302 ;; approximation of the length of the cell in the
1303 ;; output. It can sometimes fail (e.g. it considers
1304 ;; "/a/" being larger than "ab").
1305 (let ((w (- (org-element-property :contents-end cell
)
1306 (org-element-property :contents-begin cell
))))
1307 (aset widths idx
(max w
(aref widths idx
))))
1311 (format "{%s}" (mapconcat (lambda (w) (make-string w ?a
)) widths
"} {"))))
1315 (defun org-texinfo-table-cell (table-cell contents info
)
1316 "Transcode a TABLE-CELL element from Org to Texinfo.
1317 CONTENTS is the cell contents. INFO is a plist used as
1318 a communication channel."
1319 (concat (if (and contents
1320 org-texinfo-table-scientific-notation
1321 (string-match orgtbl-exp-regexp contents
))
1322 ;; Use appropriate format string for scientific
1324 (format org-texinfo-table-scientific-notation
1325 (match-string 1 contents
)
1326 (match-string 2 contents
))
1328 (when (org-export-get-next-element table-cell info
) "\n@tab ")))
1332 (defun org-texinfo-table-row (table-row contents info
)
1333 "Transcode a TABLE-ROW element from Org to Texinfo.
1334 CONTENTS is the contents of the row. INFO is a plist used as
1335 a communication channel."
1336 ;; Rules are ignored since table separators are deduced from
1337 ;; borders of the current row.
1338 (when (eq (org-element-property :type table-row
) 'standard
)
1340 (if (and (= 1 (org-export-table-row-group table-row info
))
1341 (org-export-table-has-header-p
1342 (org-export-get-parent-table table-row
) info
))
1345 (concat rowgroup-tag contents
"\n"))))
1349 (defun org-texinfo-target (target contents info
)
1350 "Transcode a TARGET object from Org to Texinfo.
1351 CONTENTS is nil. INFO is a plist holding contextual
1353 (format "@anchor{%s}"
1354 (org-export-solidify-link-text (org-element-property :value target
))))
1358 (defun org-texinfo-timestamp (timestamp contents info
)
1359 "Transcode a TIMESTAMP object from Org to Texinfo.
1360 CONTENTS is nil. INFO is a plist holding contextual
1362 (let ((value (org-texinfo-plain-text
1363 (org-timestamp-translate timestamp
) info
)))
1364 (case (org-element-property :type timestamp
)
1365 ((active active-range
)
1366 (format org-texinfo-active-timestamp-format value
))
1367 ((inactive inactive-range
)
1368 (format org-texinfo-inactive-timestamp-format value
))
1369 (t (format org-texinfo-diary-timestamp-format value
)))))
1373 (defun org-texinfo-verbatim (verbatim contents info
)
1374 "Transcode a VERBATIM object from Org to Texinfo.
1375 CONTENTS is nil. INFO is a plist used as a communication
1377 (org-texinfo--text-markup (org-element-property :value verbatim
) 'verbatim
))
1381 (defun org-texinfo-verse-block (verse-block contents info
)
1382 "Transcode a VERSE-BLOCK element from Org to Texinfo.
1383 CONTENTS is verse block contents. INFO is a plist holding
1384 contextual information."
1385 (format "@display\n%s@end display" contents
))
1388 ;;; Interactive functions
1390 (defun org-texinfo-export-to-texinfo
1391 (&optional async subtreep visible-only body-only ext-plist
)
1392 "Export current buffer to a Texinfo file.
1394 If narrowing is active in the current buffer, only export its
1397 If a region is active, export that region.
1399 A non-nil optional argument ASYNC means the process should happen
1400 asynchronously. The resulting file should be accessible through
1401 the `org-export-stack' interface.
1403 When optional argument SUBTREEP is non-nil, export the sub-tree
1404 at point, extracting information from the headline properties
1407 When optional argument VISIBLE-ONLY is non-nil, don't export
1408 contents of hidden elements.
1410 When optional argument BODY-ONLY is non-nil, only write code
1411 between \"\\begin{document}\" and \"\\end{document}\".
1413 EXT-PLIST, when provided, is a property list with external
1414 parameters overriding Org default settings, but still inferior to
1415 file-local settings.
1417 Return output file's name."
1419 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1420 (org-export-coding-system `,org-texinfo-coding-system
))
1421 (org-export-to-file 'texinfo outfile
1422 async subtreep visible-only body-only ext-plist
)))
1424 (defun org-texinfo-export-to-info
1425 (&optional async subtreep visible-only body-only ext-plist
)
1426 "Export current buffer to Texinfo then process through to INFO.
1428 If narrowing is active in the current buffer, only export its
1431 If a region is active, export that region.
1433 A non-nil optional argument ASYNC means the process should happen
1434 asynchronously. The resulting file should be accessible through
1435 the `org-export-stack' interface.
1437 When optional argument SUBTREEP is non-nil, export the sub-tree
1438 at point, extracting information from the headline properties
1441 When optional argument VISIBLE-ONLY is non-nil, don't export
1442 contents of hidden elements.
1444 When optional argument BODY-ONLY is non-nil, only write code
1445 between \"\\begin{document}\" and \"\\end{document}\".
1447 EXT-PLIST, when provided, is a property list with external
1448 parameters overriding Org default settings, but still inferior to
1449 file-local settings.
1451 When optional argument PUB-DIR is set, use it as the publishing
1454 Return INFO file's name."
1456 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1457 (org-export-coding-system `,org-texinfo-coding-system
))
1458 (org-export-to-file 'texinfo outfile
1459 async subtreep visible-only body-only ext-plist
1460 (lambda (file) (org-texinfo-compile file
)))))
1463 (defun org-texinfo-publish-to-texinfo (plist filename pub-dir
)
1464 "Publish an org file to Texinfo.
1466 FILENAME is the filename of the Org file to be published. PLIST
1467 is the property list for the given project. PUB-DIR is the
1468 publishing directory.
1470 Return output file name."
1471 (org-publish-org-to 'texinfo filename
".texi" plist pub-dir
))
1474 (defun org-texinfo-convert-region-to-texinfo ()
1475 "Assume the current region has org-mode syntax, and convert it to Texinfo.
1476 This can be used in any buffer. For example, you can write an
1477 itemized list in org-mode syntax in an Texinfo buffer and use
1478 this command to convert it."
1480 (org-export-replace-region-by 'texinfo
))
1482 (defun org-texinfo-compile (file)
1483 "Compile a texinfo file.
1485 FILE is the name of the file being compiled. Processing is
1486 done through the command specified in `org-texinfo-info-process'.
1488 Return INFO file name or an error if it couldn't be produced."
1489 (let* ((base-name (file-name-sans-extension (file-name-nondirectory file
)))
1490 (full-name (file-truename file
))
1491 (out-dir (file-name-directory file
))
1492 ;; Properly set working directory for compilation.
1493 (default-directory (if (file-name-absolute-p file
)
1494 (file-name-directory full-name
)
1497 (message (format "Processing Texinfo file %s..." file
))
1498 (save-window-excursion
1499 ;; Replace %b, %f and %o with appropriate values in each command
1500 ;; before applying it. Output is redirected to "*Org INFO
1501 ;; Texinfo Output*" buffer.
1502 (let ((outbuf (get-buffer-create "*Org INFO Texinfo Output*")))
1503 (dolist (command org-texinfo-info-process
)
1505 (replace-regexp-in-string
1506 "%b" (shell-quote-argument base-name
)
1507 (replace-regexp-in-string
1508 "%f" (shell-quote-argument full-name
)
1509 (replace-regexp-in-string
1510 "%o" (shell-quote-argument out-dir
) command t t
) t t
) t t
)
1512 ;; Collect standard errors from output buffer.
1513 (setq errors
(org-texinfo-collect-errors outbuf
)))
1514 (let ((infofile (concat out-dir base-name
".info")))
1515 ;; Check for process failure. Provide collected errors if
1517 (if (not (file-exists-p infofile
))
1518 (error (concat (format "INFO file %s wasn't produced" infofile
)
1519 (when errors
(concat ": " errors
))))
1520 ;; Else remove log files, when specified, and signal end of
1521 ;; process to user, along with any error encountered.
1522 (when org-texinfo-remove-logfiles
1523 (dolist (ext org-texinfo-logfiles-extensions
)
1524 (let ((file (concat out-dir base-name
"." ext
)))
1525 (when (file-exists-p file
) (delete-file file
)))))
1526 (message (concat "Process completed"
1527 (if (not errors
) "."
1528 (concat " with errors: " errors
)))))
1529 ;; Return output file name.
1532 (defun org-texinfo-collect-errors (buffer)
1533 "Collect some kind of errors from \"makeinfo\" command output.
1535 BUFFER is the buffer containing output.
1537 Return collected error types as a string, or nil if there was
1539 (with-current-buffer buffer
1541 (goto-char (point-min))
1542 ;; Find final "makeinfo" run.
1544 (let ((case-fold-search t
)
1546 (when (save-excursion
1547 (re-search-forward "perhaps incorrect sectioning?" nil t
))
1548 (setq errors
(concat errors
" [incorrect sectioning]")))
1549 (when (save-excursion
1550 (re-search-forward "missing close brace" nil t
))
1551 (setq errors
(concat errors
" [syntax error]")))
1552 (when (save-excursion
1553 (re-search-forward "Unknown command" nil t
))
1554 (setq errors
(concat errors
" [undefined @command]")))
1555 (when (save-excursion
1556 (re-search-forward "No matching @end" nil t
))
1557 (setq errors
(concat errors
" [block incomplete]")))
1558 (when (save-excursion
1559 (re-search-forward "requires a sectioning" nil t
))
1560 (setq errors
(concat errors
" [invalid section command]")))
1561 (when (save-excursion
1562 (re-search-forward "\\[unexpected\]" nil t
))
1563 (setq errors
(concat errors
" [unexpected error]")))
1564 (when (save-excursion
1565 (re-search-forward "misplaced " nil t
))
1566 (setq errors
(concat errors
" [syntax error]")))
1567 (and (org-string-nw-p errors
) (org-trim errors
)))))))
1570 (provide 'ox-texinfo
)
1573 ;; generated-autoload-file: "org-loaddefs.el"
1576 ;;; ox-texinfo.el ends here