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 beginning and the end of each section.
420 (org-element-map tree
'headline
422 (org-element-put-property hl
:pre-blank
1)
423 (org-element-put-property hl
:post-blank
1)
424 (let ((contents (org-element-contents hl
)))
426 (let ((first (org-element-map contents
'(headline section
)
428 (unless (eq (org-element-type first
) 'section
)
429 (org-element-set-contents
430 hl
(cons `(section (:parent
,hl
)) contents
)))))))
434 (defun org-texinfo--find-verb-separator (s)
435 "Return a character not used in string S.
436 This is used to choose a separator for constructs like \\verb."
437 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
438 (loop for c across ll
439 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
440 return
(char-to-string c
))))
442 (defun org-texinfo--text-markup (text markup
)
443 "Format TEXT depending on MARKUP text markup.
444 See `org-texinfo-text-markup-alist' for details."
445 (let ((fmt (cdr (assq markup org-texinfo-text-markup-alist
))))
447 ;; No format string: Return raw text.
450 (let ((separator (org-texinfo--find-verb-separator text
)))
451 (concat "@verb{" separator text separator
"}")))
456 (while (string-match "[@{}]" text
)
457 (setq char
(match-string 0 text
))
458 (if (> (match-beginning 0) 0)
459 (setq rtn
(concat rtn
(substring text
0 (match-beginning 0)))))
460 (setq text
(substring text
(1+ (match-beginning 0))))
461 (setq char
(concat "@" char
)
462 rtn
(concat rtn char
)))
463 (setq text
(concat rtn text
)
466 ;; Else use format string.
467 (t (format fmt text
)))))
469 (defun org-texinfo--get-node (headline info
)
470 "Return node entry associated to HEADLINE.
471 INFO is a plist used as a communication channel. The function
472 guarantees the node name is unique."
473 (let ((cache (plist-get info
:texinfo-node-cache
)))
474 (or (cdr (assq headline cache
))
475 (let ((name (org-texinfo--sanitize-node
477 (org-export-get-alt-title headline info
) info
))))
478 ;; Ensure NAME is unique.
479 (while (rassoc name cache
) (setq name
(concat name
"x")))
480 (plist-put info
:texinfo-node-cache
(cons (cons headline name
) cache
))
485 (defun org-texinfo--sanitize-node (title)
486 "Bend string TITLE to node line requirements.
487 Trim string and collapse multiple whitespace characters as they
488 are not significant. Also remove the following characters: @
491 (replace-regexp-in-string
493 (replace-regexp-in-string
494 "\\`(\\(.*)\\)" "[\\1"
495 (replace-regexp-in-string "[ \t]\\{2,\\}" " " title
)))))
497 ;;;; Content sanitizing
499 (defun org-texinfo--sanitize-content (text)
500 "Escape special characters in string TEXT.
501 Special characters are: @ { }"
502 (replace-regexp-in-string "\\\([@{}]\\\)" "@\\1" text
))
506 (defun org-texinfo-template (contents info
)
507 "Return complete document string after Texinfo conversion.
508 CONTENTS is the transcoded contents string. INFO is a plist
509 holding export options."
510 (let ((title (org-export-data (plist-get info
:title
) info
))
511 ;; Copying data is the contents of the first headline in
512 ;; parse tree with a non-nil copying property.
513 (copying (org-element-map (plist-get info
:parse-tree
) 'headline
515 (and (org-not-nil (org-element-property :COPYING hl
))
516 (org-element-contents hl
)))
519 "\\input texinfo @c -*- texinfo -*-\n"
520 "@c %**start of header\n"
521 (let ((file (or (plist-get info
:texinfo-filename
)
522 (let ((f (plist-get info
:output-file
)))
523 (and f
(concat (file-name-sans-extension f
) ".info"))))))
524 (and file
(format "@setfilename %s\n" file
)))
525 (format "@settitle %s\n" title
)
526 ;; Insert class-defined header.
527 (org-element-normalize-string
528 (let ((header (nth 1 (assoc (plist-get info
:texinfo-class
)
529 org-texinfo-classes
)))
531 (catch 'coding-system
532 (let ((case-fold-search t
)
533 (name (symbol-name (or org-texinfo-coding-system
534 buffer-file-coding-system
))))
535 (dolist (system org-texinfo-supported-coding-systems
"UTF-8")
536 (when (org-string-match-p (regexp-quote system
) name
)
537 (throw 'coding-system system
))))))
538 (language (plist-get info
:language
))
539 (case-fold-search nil
))
540 ;; Auto coding system.
541 (replace-regexp-in-string
542 "^@documentencoding \\(AUTO\\)$"
544 (replace-regexp-in-string
545 "^@documentlanguage \\(AUTO\\)$" language header nil nil
1)
547 ;; Additional header options set by #+TEXINFO_HEADER.
548 (let ((texinfo-header (plist-get info
:texinfo-header
)))
549 (and texinfo-header
(org-element-normalize-string texinfo-header
)))
550 "@c %**end of header\n\n"
551 ;; Additional options set by #+TEXINFO_POST_HEADER.
552 (let ((texinfo-post-header (plist-get info
:texinfo-post-header
)))
553 (and texinfo-post-header
554 (org-element-normalize-string texinfo-post-header
)))
557 (format "@copying\n%s@end copying\n\n"
558 (org-element-normalize-string
559 (org-export-data copying info
))))
560 ;; Info directory information. Only supply if both title and
561 ;; category are provided.
562 (let ((dircat (plist-get info
:texinfo-dircat
))
564 (let ((title (plist-get info
:texinfo-dirtitle
)))
566 (string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title
)
567 (format "* %s." (match-string 1 title
))))))
568 (when (and dircat dirtitle
)
569 (concat "@dircategory " dircat
"\n"
572 (let ((desc (plist-get info
:texinfo-dirdesc
)))
573 (cond ((not desc
) nil
)
574 ((org-string-match-p "\\.$" desc
) desc
)
575 (t (concat desc
"."))))))
576 (if dirdesc
(format "%-23s %s" dirtitle dirdesc
) dirtitle
))
578 "@end direntry\n\n")))
582 (format "@title %s\n" (or (plist-get info
:texinfo-printed-title
) title
))
583 (let ((subtitle (plist-get info
:subtitle
)))
585 (org-element-normalize-string
586 (replace-regexp-in-string "^" "@subtitle " subtitle
))))
587 (when (plist-get info
:with-author
)
590 (let ((author (org-string-nw-p
591 (org-export-data (plist-get info
:author
) info
)))
592 (email (and (plist-get info
:with-email
)
594 (org-export-data (plist-get info
:email
) info
)))))
595 (cond ((and author email
)
596 (format "@author %s (@email{%s})\n" author email
))
597 (author (format "@author %s\n" author
))
598 (email (format "@author @email{%s}\n" email
))))
600 (let ((subauthor (plist-get info
:subauthor
)))
602 (org-element-normalize-string
603 (replace-regexp-in-string "^" "@author " subauthor
))))))
604 (and copying
"@page\n@vskip 0pt plus 1filll\n@insertcopying\n")
606 ;; Table of contents.
607 (and (plist-get info
:with-toc
) "@contents\n\n")
608 ;; Configure Top Node when not for Tex
611 (format "@top %s\n" title
)
612 (and copying
"@insertcopying\n")
615 (org-texinfo-make-menu (plist-get info
:parse-tree
) info
'master
)
620 (case (plist-get info
:with-creator
)
622 (comment (format "@c %s\n" (plist-get info
:creator
)))
623 (otherwise (concat (plist-get info
:creator
) "\n")))
629 ;;; Transcode Functions
633 (defun org-texinfo-bold (bold contents info
)
634 "Transcode BOLD from Org to Texinfo.
635 CONTENTS is the text with bold markup. INFO is a plist holding
636 contextual information."
637 (org-texinfo--text-markup contents
'bold
))
641 (defun org-texinfo-center-block (center-block contents info
)
642 "Transcode a CENTER-BLOCK element from Org to Texinfo.
643 CONTENTS holds the contents of the block. INFO is a plist used
644 as a communication channel."
649 (defun org-texinfo-clock (clock contents info
)
650 "Transcode a CLOCK element from Org to Texinfo.
651 CONTENTS is nil. INFO is a plist holding contextual
655 (format "@strong{%s} " org-clock-string
)
656 (format org-texinfo-inactive-timestamp-format
657 (concat (org-translate-time
658 (org-element-property :raw-value
659 (org-element-property :value clock
)))
660 (let ((time (org-element-property :duration clock
)))
661 (and time
(format " (%s)" time
)))))
666 (defun org-texinfo-code (code contents info
)
667 "Transcode a CODE object from Org to Texinfo.
668 CONTENTS is nil. INFO is a plist used as a communication
670 (org-texinfo--text-markup (org-element-property :value code
) 'code
))
674 (defun org-texinfo-drawer (drawer contents info
)
675 "Transcode a DRAWER element from Org to Texinfo.
676 CONTENTS holds the contents of the block. INFO is a plist
677 holding contextual information."
678 (let* ((name (org-element-property :drawer-name drawer
))
679 (output (funcall org-texinfo-format-drawer-function
685 (defun org-texinfo-dynamic-block (dynamic-block contents info
)
686 "Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
687 CONTENTS holds the contents of the block. INFO is a plist
688 holding contextual information."
693 (defun org-texinfo-entity (entity contents info
)
694 "Transcode an ENTITY object from Org to Texinfo.
695 CONTENTS are the definition itself. INFO is a plist holding
696 contextual information."
697 (let ((ent (org-element-property :latex entity
)))
698 (if (org-element-property :latex-math-p entity
) (format "@math{%s}" ent
) ent
)))
702 (defun org-texinfo-example-block (example-block contents info
)
703 "Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
704 CONTENTS is nil. INFO is a plist holding contextual
706 (format "@verbatim\n%s@end verbatim"
707 (org-export-format-code-default example-block info
)))
711 (defun org-texinfo-export-block (export-block contents info
)
712 "Transcode a EXPORT-BLOCK element from Org to Texinfo.
713 CONTENTS is nil. INFO is a plist holding contextual information."
714 (when (string= (org-element-property :type export-block
) "TEXINFO")
715 (org-remove-indentation (org-element-property :value export-block
))))
719 (defun org-texinfo-export-snippet (export-snippet contents info
)
720 "Transcode a EXPORT-SNIPPET object from Org to Texinfo.
721 CONTENTS is nil. INFO is a plist holding contextual information."
722 (when (eq (org-export-snippet-backend export-snippet
) 'texinfo
)
723 (org-element-property :value export-snippet
)))
727 (defun org-texinfo-fixed-width (fixed-width contents info
)
728 "Transcode a FIXED-WIDTH element from Org to Texinfo.
729 CONTENTS is nil. INFO is a plist holding contextual information."
730 (format "@example\n%s\n@end example"
731 (org-remove-indentation
732 (org-texinfo--sanitize-content
733 (org-element-property :value fixed-width
)))))
735 ;;;; Footnote Reference
737 (defun org-texinfo-footnote-reference (footnote contents info
)
738 "Create a footnote reference for FOOTNOTE.
740 FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
741 plist holding contextual information."
742 (let ((def (org-export-get-footnote-definition footnote info
)))
743 (format "@footnote{%s}"
744 (org-trim (org-export-data def info
)))))
748 (defun org-texinfo-headline (headline contents info
)
749 "Transcode a HEADLINE element from Org to Texinfo.
750 CONTENTS holds the contents of the headline. INFO is a plist
751 holding contextual information."
752 (let* ((class (plist-get info
:texinfo-class
))
753 (level (org-export-get-relative-level headline info
))
754 (numberedp (org-export-numbered-headline-p headline info
))
755 (class-sectioning (assoc class org-texinfo-classes
))
756 ;; Find the index type, if any.
757 (index (org-element-property :INDEX headline
))
758 ;; Create node info, to insert it before section formatting.
759 ;; Use custom menu title if present.
760 (node (format "@node %s\n" (org-texinfo--get-node headline info
)))
761 ;; Section formatting will set two placeholders: one for the
762 ;; title and the other for the contents.
764 (if (org-not-nil (org-element-property :APPENDIX headline
))
766 (let ((sec (if (and (symbolp (nth 2 class-sectioning
))
767 (fboundp (nth 2 class-sectioning
)))
768 (funcall (nth 2 class-sectioning
) level numberedp
)
769 (nth (1+ level
) class-sectioning
))))
771 ;; No section available for that LEVEL.
773 ;; Section format directly returned by a function.
775 ;; (numbered-section . unnumbered-section)
776 ((not (consp (cdr sec
)))
777 (concat (if (or index
(not numberedp
)) (cdr sec
) (car sec
))
780 (and (plist-get info
:with-todo-keywords
)
781 (let ((todo (org-element-property :todo-keyword headline
)))
782 (and todo
(org-export-data todo info
)))))
783 (todo-type (and todo
(org-element-property :todo-type headline
)))
784 (tags (and (plist-get info
:with-tags
)
785 (org-export-get-tags headline info
)))
786 (priority (and (plist-get info
:with-priority
)
787 (org-element-property :priority headline
)))
788 ;; Retrieve headline text for structuring command.
789 (text (org-export-data (org-element-property :title headline
) info
))
790 ;; Create the headline text along with a no-tag version. The
791 ;; latter is required to remove tags from table of contents.
792 (full-text (if (not (eq org-texinfo-format-headline-function
'ignore
))
793 ;; User-defined formatting function.
794 (funcall org-texinfo-format-headline-function
795 todo todo-type priority text tags
)
796 ;; Default formatting.
799 (format "@strong{%s} " todo
))
800 (when priority
(format "@emph{#%s} " priority
))
804 (mapconcat 'identity tags
":"))))))
806 (if (not (eq org-texinfo-format-headline-function
'ignore
))
807 ;; User-defined formatting function.
808 (funcall org-texinfo-format-headline-function
809 todo todo-type priority text nil
)
810 ;; Default formatting.
812 (when todo
(format "@strong{%s} " todo
))
813 (when priority
(format "@emph{#%c} " priority
))
816 (make-string (org-element-property :pre-blank headline
) ?
\n)))
818 ;; Case 1: This is a footnote section: ignore it.
819 ((org-element-property :footnote-section-p headline
) nil
)
820 ;; Case 2: This is the `copying' section: ignore it
821 ;; This is used elsewhere.
822 ((org-not-nil (org-element-property :COPYING headline
)) nil
)
823 ;; Case 3: An index. If it matches one of the known indexes,
824 ;; print it as such following the contents, otherwise
825 ;; print the contents and leave the index up to the user.
831 (concat pre-blanks contents
(and (org-string-nw-p contents
) "\n")
832 (if (member index
'("cp" "fn" "ky" "pg" "tp" "vr"))
833 (concat "@printindex " index
))))))
834 ;; Case 4: This is a deep sub-tree: export it as a list item.
835 ;; Also export as items headlines for which no section
836 ;; format has been found.
837 ((or (not section-fmt
) (org-export-low-level-p headline info
))
838 ;; Build the real contents of the sub-tree.
839 (let ((low-level-body
841 ;; If the headline is the first sibling, start a list.
842 (when (org-export-first-sibling-p headline info
)
843 (format "@%s\n" (if numberedp
'enumerate
'itemize
)))
845 "@item\n" full-text
"\n" pre-blanks contents
)))
846 ;; If headline is not the last sibling simply return
847 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before any
849 (if (not (org-export-last-sibling-p headline info
)) low-level-body
850 (replace-regexp-in-string
852 (format "\n@end %s" (if numberedp
'enumerate
'itemize
))
854 ;; Case 5: Standard headline. Export it as a section.
859 (if (eq (plist-get info
:with-tags
) 'not-in-toc
) full-text-no-tag
864 ;;;; Inline Src Block
866 (defun org-texinfo-inline-src-block (inline-src-block contents info
)
867 "Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
868 CONTENTS holds the contents of the item. INFO is a plist holding
869 contextual information."
870 (let* ((code (org-element-property :value inline-src-block
))
871 (separator (org-texinfo--find-verb-separator code
)))
872 (concat "@verb{" separator code separator
"}")))
876 (defun org-texinfo-inlinetask (inlinetask contents info
)
877 "Transcode an INLINETASK element from Org to Texinfo.
878 CONTENTS holds the contents of the block. INFO is a plist
879 holding contextual information."
880 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
881 (todo (and (plist-get info
:with-todo-keywords
)
882 (let ((todo (org-element-property :todo-keyword inlinetask
)))
883 (and todo
(org-export-data todo info
)))))
884 (todo-type (org-element-property :todo-type inlinetask
))
885 (tags (and (plist-get info
:with-tags
)
886 (org-export-get-tags inlinetask info
)))
887 (priority (and (plist-get info
:with-priority
)
888 (org-element-property :priority inlinetask
))))
889 ;; If `org-texinfo-format-inlinetask-function' is provided, call it
890 ;; with appropriate arguments.
891 (if (not (eq org-texinfo-format-inlinetask-function
'ignore
))
892 (funcall org-texinfo-format-inlinetask-function
893 todo todo-type priority title tags contents
)
894 ;; Otherwise, use a default template.
897 (when todo
(format "@strong{%s} " todo
))
898 (when priority
(format "#%c " priority
))
900 (when tags
(format ":%s:"
901 (mapconcat 'identity tags
":"))))))
902 (format (concat "@center %s\n\n"
905 full-title contents
)))))
909 (defun org-texinfo-italic (italic contents info
)
910 "Transcode ITALIC from Org to Texinfo.
911 CONTENTS is the text with italic markup. INFO is a plist holding
912 contextual information."
913 (org-texinfo--text-markup contents
'italic
))
917 (defun org-texinfo-item (item contents info
)
918 "Transcode an ITEM element from Org to Texinfo.
919 CONTENTS holds the contents of the item. INFO is a plist holding
920 contextual information."
921 (format "@item%s\n%s"
922 (let ((tag (org-element-property :tag item
)))
923 (if tag
(concat " " (org-export-data tag info
)) ""))
928 (defun org-texinfo-keyword (keyword contents info
)
929 "Transcode a KEYWORD element from Org to Texinfo.
930 CONTENTS is nil. INFO is a plist holding contextual information."
931 (let ((key (org-element-property :key keyword
))
932 (value (org-element-property :value keyword
)))
934 ((string= key
"TEXINFO") value
)
935 ((string= key
"CINDEX") (format "@cindex %s" value
))
936 ((string= key
"FINDEX") (format "@findex %s" value
))
937 ((string= key
"KINDEX") (format "@kindex %s" value
))
938 ((string= key
"PINDEX") (format "@pindex %s" value
))
939 ((string= key
"TINDEX") (format "@tindex %s" value
))
940 ((string= key
"VINDEX") (format "@vindex %s" value
)))))
944 (defun org-texinfo-line-break (line-break contents info
)
945 "Transcode a LINE-BREAK object from Org to Texinfo.
946 CONTENTS is nil. INFO is a plist holding contextual information."
951 (defun org-texinfo-link (link desc info
)
952 "Transcode a LINK object from Org to Texinfo.
954 DESC is the description part of the link, or the empty string.
955 INFO is a plist holding contextual information. See
957 (let* ((type (org-element-property :type link
))
958 (raw-path (org-element-property :path link
))
959 ;; Ensure DESC really exists, or set it to nil.
960 (desc (and (not (string= desc
"")) desc
))
962 ((member type
'("http" "https" "ftp"))
963 (concat type
":" raw-path
))
964 ((and (string= type
"file") (file-name-absolute-p raw-path
))
965 (concat "file:" raw-path
))
967 (email (if (string= type
"mailto")
968 (let ((text (replace-regexp-in-string
970 (concat text
(if desc
(concat "," desc
))))))
973 ;; Links pointing to a headline: Find destination and build
974 ;; appropriate referencing command.
975 ((member type
'("custom-id" "id"))
976 (let ((destination (org-export-resolve-id-link link info
)))
977 (case (org-element-type destination
)
978 ;; Id link points to an external file.
980 (if desc
(format "@uref{file://%s,%s}" destination desc
)
981 (format "@uref{file://%s}" destination
)))
982 ;; LINK points to a headline. Use the headline as the NODE target
984 (format "@ref{%s,%s}"
985 (org-texinfo--get-node destination info
)
988 (let ((path (org-export-solidify-link-text path
)))
989 (if (not desc
) (format "@ref{%s}" path
)
990 (format "@ref{%s,,%s}" path desc
)))))))
991 ((member type
'("info"))
992 (let* ((info-path (split-string path
"[:#]"))
993 (info-manual (car info-path
))
994 (info-node (or (cadr info-path
) "top"))
995 (title (or desc
"")))
996 (format "@ref{%s,%s,,%s,}" info-node title info-manual
)))
997 ((member type
'("fuzzy"))
998 (let ((destination (org-export-resolve-fuzzy-link link info
)))
999 (case (org-element-type destination
)
1000 ;; Id link points to an external file.
1002 (if desc
(format "@uref{file://%s,%s}" destination desc
)
1003 (format "@uref{file://%s}" destination
)))
1004 ;; LINK points to a headline. Use the headline as the NODE target
1006 (format "@ref{%s,%s}"
1007 (org-texinfo--get-node destination info
)
1010 (let ((path (org-export-solidify-link-text path
)))
1011 (if (not desc
) (format "@ref{%s}" path
)
1012 (format "@ref{%s,,%s}" path desc
)))))))
1013 ;; Special case for email addresses
1015 (format "@email{%s}" email
))
1016 ;; External link with a description part.
1017 ((and path desc
) (format "@uref{%s,%s}" path desc
))
1018 ;; External link without a description part.
1019 (path (format "@uref{%s}" path
))
1020 ;; No path, only description. Try to do something useful.
1021 (t (format org-texinfo-link-with-unknown-path-format desc
)))))
1026 (defun org-texinfo-make-menu (scope info
&optional master
)
1027 "Create the menu for inclusion in the Texinfo document.
1029 SCOPE is a headline or a full parse tree. INFO is the
1030 communication channel, as a plist.
1032 When optional argument MASTER is non-nil, generate a master menu,
1033 including detailed node listing."
1034 (let ((menu (org-texinfo--build-menu scope info
)))
1035 (when (org-string-nw-p menu
)
1036 (org-element-normalize-string
1038 "@menu\n%s@end menu"
1042 (org-texinfo--build-menu
1044 (let ((toc-depth (plist-get info
:with-toc
)))
1045 (if (wholenump toc-depth
) toc-depth
1046 org-texinfo-max-toc-depth
)))))
1047 (when (org-string-nw-p detailmenu
)
1048 (concat "\n@detailmenu\n"
1049 "--- The Detailed Node Listing ---\n\n"
1051 "@end detailmenu\n"))))))))))
1053 (defun org-texinfo--build-menu (scope info
&optional level
)
1054 "Build menu for entries within SCOPE.
1055 SCOPE is a headline or a full parse tree. INFO is a plist
1056 containing contextual information. When optional argument LEVEL
1057 is an integer, build the menu recursively, down to this depth."
1060 (org-texinfo--format-entries (org-texinfo--menu-entries scope info
) info
))
1063 (org-element-normalize-string
1066 (let ((entries (org-texinfo--menu-entries h info
)))
1069 (format "%s\n\n%s\n"
1070 (org-export-data (org-export-get-alt-title h info
) info
)
1071 (org-texinfo--format-entries entries info
))
1072 (org-texinfo--build-menu h info
(1- level
))))))
1073 (org-texinfo--menu-entries scope info
) "")))))
1075 (defun org-texinfo--format-entries (entries info
)
1076 "Format all direct menu entries in SCOPE, as a string.
1077 SCOPE is either a headline or a full Org document. INFO is
1078 a plist containing contextual information."
1079 (org-element-normalize-string
1082 (let* ((title (org-export-data
1083 (org-export-get-alt-title h info
) info
))
1084 (node (org-texinfo--get-node h info
))
1085 (entry (concat "* " title
":"
1086 (if (string= title node
) ":"
1087 (concat " " node
". "))))
1088 (desc (org-element-property :DESCRIPTION h
)))
1089 (if (not desc
) entry
1090 (format (format "%%-%ds %%s" org-texinfo-node-description-column
)
1094 (defun org-texinfo--menu-entries (scope info
)
1095 "List direct children in SCOPE needing a menu entry.
1096 SCOPE is a headline or a full parse tree. INFO is a plist
1097 holding contextual information."
1098 (let* ((cache (or (plist-get info
:texinfo-entries-cache
)
1099 (plist-get (plist-put info
:texinfo-entries-cache
1100 (make-hash-table :test
#'eq
))
1101 :texinfo-entries-cache
)))
1102 (cached-entries (gethash scope cache
'no-cache
)))
1103 (if (not (eq cached-entries
'no-cache
)) cached-entries
1105 (org-element-map (org-element-contents scope
) 'headline
1107 (and (not (org-not-nil (org-element-property :COPYING h
)))
1108 (not (org-element-property :footnote-section-p h
))
1109 (not (org-export-low-level-p h info
))
1116 (defun org-texinfo-paragraph (paragraph contents info
)
1117 "Transcode a PARAGRAPH element from Org to Texinfo.
1118 CONTENTS is the contents of the paragraph, as a string. INFO is
1119 the plist used as a communication channel."
1124 (defun org-texinfo-plain-list (plain-list contents info
)
1125 "Transcode a PLAIN-LIST element from Org to Texinfo.
1126 CONTENTS is the contents of the list. INFO is a plist holding
1127 contextual information."
1128 (let* ((attr (org-export-read-attribute :attr_texinfo plain-list
))
1129 (indic (or (plist-get attr
:indic
) org-texinfo-def-table-markup
))
1130 (table-type (plist-get attr
:table-type
))
1131 (type (org-element-property :type plain-list
))
1133 ((eq type
'ordered
) "enumerate")
1134 ((eq type
'unordered
) "itemize")
1135 ((member table-type
'("ftable" "vtable")) table-type
)
1137 (format "@%s\n%s@end %s"
1138 (if (eq type
'descriptive
) (concat list-type
" " indic
) list-type
)
1144 (defun org-texinfo-plain-text (text info
)
1145 "Transcode a TEXT string from Org to Texinfo.
1146 TEXT is the string to transcode. INFO is a plist holding
1147 contextual information."
1148 ;; First protect @, { and }.
1149 (let ((output (org-texinfo--sanitize-content text
)))
1150 ;; Activate smart quotes. Be sure to provide original TEXT string
1151 ;; since OUTPUT may have been modified.
1152 (when (plist-get info
:with-smart-quotes
)
1154 (org-export-activate-smart-quotes output
:texinfo info text
)))
1155 ;; LaTeX into @LaTeX{} and TeX into @TeX{}
1156 (let ((case-fold-search nil
)
1158 (while (string-match "\\(\\(?:La\\)?TeX\\)" output start
)
1159 (setq output
(replace-match
1160 (format "@%s{}" (match-string 1 output
)) nil t output
)
1161 start
(match-end 0))))
1162 ;; Convert special strings.
1163 (when (plist-get info
:with-special-strings
)
1164 (while (string-match (regexp-quote "...") output
)
1165 (setq output
(replace-match "@dots{}" nil t output
))))
1166 ;; Handle break preservation if required.
1167 (when (plist-get info
:preserve-breaks
)
1168 (setq output
(replace-regexp-in-string
1169 "\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output
)))
1175 (defun org-texinfo-planning (planning contents info
)
1176 "Transcode a PLANNING element from Org to Texinfo.
1177 CONTENTS is nil. INFO is a plist holding contextual
1185 (let ((closed (org-element-property :closed planning
)))
1188 (format "@strong{%s} " org-closed-string
)
1189 (format org-texinfo-inactive-timestamp-format
1191 (org-element-property :raw-value closed
))))))
1192 (let ((deadline (org-element-property :deadline planning
)))
1195 (format "@strong{%s} " org-deadline-string
)
1196 (format org-texinfo-active-timestamp-format
1198 (org-element-property :raw-value deadline
))))))
1199 (let ((scheduled (org-element-property :scheduled planning
)))
1202 (format "@strong{%s} " org-scheduled-string
)
1203 (format org-texinfo-active-timestamp-format
1205 (org-element-property :raw-value scheduled
))))))))
1209 ;;;; Property Drawer
1211 (defun org-texinfo-property-drawer (property-drawer contents info
)
1212 "Transcode a PROPERTY-DRAWER element from Org to Texinfo.
1213 CONTENTS is nil. INFO is a plist holding contextual
1215 ;; The property drawer isn't exported but we want separating blank
1216 ;; lines nonetheless.
1221 (defun org-texinfo-quote-block (quote-block contents info
)
1222 "Transcode a QUOTE-BLOCK element from Org to Texinfo.
1223 CONTENTS holds the contents of the block. INFO is a plist
1224 holding contextual information."
1225 (let* ((title (org-element-property :name quote-block
))
1226 (start-quote (concat "@quotation"
1228 (format " %s" title
)))))
1229 (format "%s\n%s@end quotation" start-quote contents
)))
1233 (defun org-texinfo-quote-section (quote-section contents info
)
1234 "Transcode a QUOTE-SECTION element from Org to Texinfo.
1235 CONTENTS is nil. INFO is a plist holding contextual information."
1236 (let ((value (org-remove-indentation
1237 (org-element-property :value quote-section
))))
1238 (when value
(format "@verbatim\n%s@end verbatim" value
))))
1242 (defun org-texinfo-radio-target (radio-target text info
)
1243 "Transcode a RADIO-TARGET object from Org to Texinfo.
1244 TEXT is the text of the target. INFO is a plist holding
1245 contextual information."
1246 (format "@anchor{%s}%s"
1247 (org-export-solidify-link-text
1248 (org-element-property :value radio-target
))
1253 (defun org-texinfo-section (section contents info
)
1254 "Transcode a SECTION element from Org to Texinfo.
1255 CONTENTS holds the contents of the section. INFO is a plist
1256 holding contextual information."
1258 (let ((parent (org-export-get-parent-headline section
)))
1259 (and parent
(org-texinfo-make-menu parent info
)))))
1263 (defun org-texinfo-special-block (special-block contents info
)
1264 "Transcode a SPECIAL-BLOCK element from Org to Texinfo.
1265 CONTENTS holds the contents of the block. INFO is a plist used
1266 as a communication channel."
1271 (defun org-texinfo-src-block (src-block contents info
)
1272 "Transcode a SRC-BLOCK element from Org to Texinfo.
1273 CONTENTS holds the contents of the item. INFO is a plist holding
1274 contextual information."
1275 (let* ((lang (org-element-property :language src-block
))
1276 (lisp-p (string-match-p "lisp" lang
))
1277 (src-contents (org-texinfo--sanitize-content
1278 (org-export-format-code-default src-block info
))))
1280 ;; Case 1. Lisp Block
1282 (format "@lisp\n%s@end lisp"
1284 ;; Case 2. Other blocks
1286 (format "@example\n%s@end example"
1289 ;;;; Statistics Cookie
1291 (defun org-texinfo-statistics-cookie (statistics-cookie contents info
)
1292 "Transcode a STATISTICS-COOKIE object from Org to Texinfo.
1293 CONTENTS is nil. INFO is a plist holding contextual information."
1294 (org-element-property :value statistics-cookie
))
1298 (defun org-texinfo-subscript (subscript contents info
)
1299 "Transcode a SUBSCRIPT object from Org to Texinfo.
1300 CONTENTS is the contents of the object. INFO is a plist holding
1301 contextual information."
1302 (format "@math{_%s}" contents
))
1306 (defun org-texinfo-superscript (superscript contents info
)
1307 "Transcode a SUPERSCRIPT object from Org to Texinfo.
1308 CONTENTS is the contents of the object. INFO is a plist holding
1309 contextual information."
1310 (format "@math{^%s}" contents
))
1314 (defun org-texinfo-table (table contents info
)
1315 "Transcode a TABLE element from Org to Texinfo.
1316 CONTENTS is the contents of the table. INFO is a plist holding
1317 contextual information."
1318 (if (eq (org-element-property :type table
) 'table.el
)
1319 (format "@verbatim\n%s@end verbatim"
1320 (org-element-normalize-string
1321 (org-element-property :value table
)))
1322 (let* ((col-width (org-export-read-attribute :attr_texinfo table
:columns
))
1324 (if col-width
(format "@columnfractions %s" col-width
)
1325 (org-texinfo-table-column-widths table info
))))
1326 (format "@multitable %s\n%s@end multitable"
1330 (defun org-texinfo-table-column-widths (table info
)
1331 "Determine the largest table cell in each column to process alignment.
1332 TABLE is the table element to transcode. INFO is a plist used as
1333 a communication channel."
1334 (let ((widths (make-vector (cdr (org-export-table-dimensions table info
)) 0)))
1335 (org-element-map table
'table-row
1338 (org-element-map row
'table-cell
1340 ;; Length of the cell in the original buffer is only an
1341 ;; approximation of the length of the cell in the
1342 ;; output. It can sometimes fail (e.g. it considers
1343 ;; "/a/" being larger than "ab").
1344 (let ((w (- (org-element-property :contents-end cell
)
1345 (org-element-property :contents-begin cell
))))
1346 (aset widths idx
(max w
(aref widths idx
))))
1350 (format "{%s}" (mapconcat (lambda (w) (make-string w ?a
)) widths
"} {"))))
1354 (defun org-texinfo-table-cell (table-cell contents info
)
1355 "Transcode a TABLE-CELL element from Org to Texinfo.
1356 CONTENTS is the cell contents. INFO is a plist used as
1357 a communication channel."
1358 (concat (if (and contents
1359 org-texinfo-table-scientific-notation
1360 (string-match orgtbl-exp-regexp contents
))
1361 ;; Use appropriate format string for scientific
1363 (format org-texinfo-table-scientific-notation
1364 (match-string 1 contents
)
1365 (match-string 2 contents
))
1367 (when (org-export-get-next-element table-cell info
) "\n@tab ")))
1371 (defun org-texinfo-table-row (table-row contents info
)
1372 "Transcode a TABLE-ROW element from Org to Texinfo.
1373 CONTENTS is the contents of the row. INFO is a plist used as
1374 a communication channel."
1375 ;; Rules are ignored since table separators are deduced from
1376 ;; borders of the current row.
1377 (when (eq (org-element-property :type table-row
) 'standard
)
1379 (if (and (= 1 (org-export-table-row-group table-row info
))
1380 (org-export-table-has-header-p
1381 (org-export-get-parent-table table-row
) info
))
1384 (concat rowgroup-tag contents
"\n"))))
1388 (defun org-texinfo-target (target contents info
)
1389 "Transcode a TARGET object from Org to Texinfo.
1390 CONTENTS is nil. INFO is a plist holding contextual
1392 (format "@anchor{%s}"
1393 (org-export-solidify-link-text (org-element-property :value target
))))
1397 (defun org-texinfo-timestamp (timestamp contents info
)
1398 "Transcode a TIMESTAMP object from Org to Texinfo.
1399 CONTENTS is nil. INFO is a plist holding contextual
1401 (let ((value (org-texinfo-plain-text
1402 (org-timestamp-translate timestamp
) info
)))
1403 (case (org-element-property :type timestamp
)
1404 ((active active-range
)
1405 (format org-texinfo-active-timestamp-format value
))
1406 ((inactive inactive-range
)
1407 (format org-texinfo-inactive-timestamp-format value
))
1408 (t (format org-texinfo-diary-timestamp-format value
)))))
1412 (defun org-texinfo-verbatim (verbatim contents info
)
1413 "Transcode a VERBATIM object from Org to Texinfo.
1414 CONTENTS is nil. INFO is a plist used as a communication
1416 (org-texinfo--text-markup (org-element-property :value verbatim
) 'verbatim
))
1420 (defun org-texinfo-verse-block (verse-block contents info
)
1421 "Transcode a VERSE-BLOCK element from Org to Texinfo.
1422 CONTENTS is verse block contents. INFO is a plist holding
1423 contextual information."
1424 (format "@display\n%s@end display" contents
))
1427 ;;; Interactive functions
1429 (defun org-texinfo-export-to-texinfo
1430 (&optional async subtreep visible-only body-only ext-plist
)
1431 "Export current buffer to a Texinfo file.
1433 If narrowing is active in the current buffer, only export its
1436 If a region is active, export that region.
1438 A non-nil optional argument ASYNC means the process should happen
1439 asynchronously. The resulting file should be accessible through
1440 the `org-export-stack' interface.
1442 When optional argument SUBTREEP is non-nil, export the sub-tree
1443 at point, extracting information from the headline properties
1446 When optional argument VISIBLE-ONLY is non-nil, don't export
1447 contents of hidden elements.
1449 When optional argument BODY-ONLY is non-nil, only write code
1450 between \"\\begin{document}\" and \"\\end{document}\".
1452 EXT-PLIST, when provided, is a property list with external
1453 parameters overriding Org default settings, but still inferior to
1454 file-local settings.
1456 Return output file's name."
1458 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1459 (org-export-coding-system `,org-texinfo-coding-system
))
1460 (org-export-to-file 'texinfo outfile
1461 async subtreep visible-only body-only ext-plist
)))
1463 (defun org-texinfo-export-to-info
1464 (&optional async subtreep visible-only body-only ext-plist
)
1465 "Export current buffer to Texinfo then process through to INFO.
1467 If narrowing is active in the current buffer, only export its
1470 If a region is active, export that region.
1472 A non-nil optional argument ASYNC means the process should happen
1473 asynchronously. The resulting file should be accessible through
1474 the `org-export-stack' interface.
1476 When optional argument SUBTREEP is non-nil, export the sub-tree
1477 at point, extracting information from the headline properties
1480 When optional argument VISIBLE-ONLY is non-nil, don't export
1481 contents of hidden elements.
1483 When optional argument BODY-ONLY is non-nil, only write code
1484 between \"\\begin{document}\" and \"\\end{document}\".
1486 EXT-PLIST, when provided, is a property list with external
1487 parameters overriding Org default settings, but still inferior to
1488 file-local settings.
1490 When optional argument PUB-DIR is set, use it as the publishing
1493 Return INFO file's name."
1495 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1496 (org-export-coding-system `,org-texinfo-coding-system
))
1497 (org-export-to-file 'texinfo outfile
1498 async subtreep visible-only body-only ext-plist
1499 (lambda (file) (org-texinfo-compile file
)))))
1502 (defun org-texinfo-publish-to-texinfo (plist filename pub-dir
)
1503 "Publish an org file to Texinfo.
1505 FILENAME is the filename of the Org file to be published. PLIST
1506 is the property list for the given project. PUB-DIR is the
1507 publishing directory.
1509 Return output file name."
1510 (org-publish-org-to 'texinfo filename
".texi" plist pub-dir
))
1513 (defun org-texinfo-convert-region-to-texinfo ()
1514 "Assume the current region has org-mode syntax, and convert it to Texinfo.
1515 This can be used in any buffer. For example, you can write an
1516 itemized list in org-mode syntax in an Texinfo buffer and use
1517 this command to convert it."
1519 (org-export-replace-region-by 'texinfo
))
1521 (defun org-texinfo-compile (file)
1522 "Compile a texinfo file.
1524 FILE is the name of the file being compiled. Processing is
1525 done through the command specified in `org-texinfo-info-process'.
1527 Return INFO file name or an error if it couldn't be produced."
1528 (let* ((base-name (file-name-sans-extension (file-name-nondirectory file
)))
1529 (full-name (file-truename file
))
1530 (out-dir (file-name-directory file
))
1531 ;; Properly set working directory for compilation.
1532 (default-directory (if (file-name-absolute-p file
)
1533 (file-name-directory full-name
)
1536 (message (format "Processing Texinfo file %s..." file
))
1537 (save-window-excursion
1538 ;; Replace %b, %f and %o with appropriate values in each command
1539 ;; before applying it. Output is redirected to "*Org INFO
1540 ;; Texinfo Output*" buffer.
1541 (let ((outbuf (get-buffer-create "*Org INFO Texinfo Output*")))
1542 (dolist (command org-texinfo-info-process
)
1544 (replace-regexp-in-string
1545 "%b" (shell-quote-argument base-name
)
1546 (replace-regexp-in-string
1547 "%f" (shell-quote-argument full-name
)
1548 (replace-regexp-in-string
1549 "%o" (shell-quote-argument out-dir
) command t t
) t t
) t t
)
1551 ;; Collect standard errors from output buffer.
1552 (setq errors
(org-texinfo-collect-errors outbuf
)))
1553 (let ((infofile (concat out-dir base-name
".info")))
1554 ;; Check for process failure. Provide collected errors if
1556 (if (not (file-exists-p infofile
))
1557 (error (concat (format "INFO file %s wasn't produced" infofile
)
1558 (when errors
(concat ": " errors
))))
1559 ;; Else remove log files, when specified, and signal end of
1560 ;; process to user, along with any error encountered.
1561 (when org-texinfo-remove-logfiles
1562 (dolist (ext org-texinfo-logfiles-extensions
)
1563 (let ((file (concat out-dir base-name
"." ext
)))
1564 (when (file-exists-p file
) (delete-file file
)))))
1565 (message (concat "Process completed"
1566 (if (not errors
) "."
1567 (concat " with errors: " errors
)))))
1568 ;; Return output file name.
1571 (defun org-texinfo-collect-errors (buffer)
1572 "Collect some kind of errors from \"makeinfo\" command output.
1574 BUFFER is the buffer containing output.
1576 Return collected error types as a string, or nil if there was
1578 (with-current-buffer buffer
1580 (goto-char (point-min))
1581 ;; Find final "makeinfo" run.
1583 (let ((case-fold-search t
)
1585 (when (save-excursion
1586 (re-search-forward "perhaps incorrect sectioning?" nil t
))
1587 (setq errors
(concat errors
" [incorrect sectioning]")))
1588 (when (save-excursion
1589 (re-search-forward "missing close brace" nil t
))
1590 (setq errors
(concat errors
" [syntax error]")))
1591 (when (save-excursion
1592 (re-search-forward "Unknown command" nil t
))
1593 (setq errors
(concat errors
" [undefined @command]")))
1594 (when (save-excursion
1595 (re-search-forward "No matching @end" nil t
))
1596 (setq errors
(concat errors
" [block incomplete]")))
1597 (when (save-excursion
1598 (re-search-forward "requires a sectioning" nil t
))
1599 (setq errors
(concat errors
" [invalid section command]")))
1600 (when (save-excursion
1601 (re-search-forward "\\[unexpected\]" nil t
))
1602 (setq errors
(concat errors
" [unexpected error]")))
1603 (when (save-excursion
1604 (re-search-forward "misplaced " nil t
))
1605 (setq errors
(concat errors
" [syntax error]")))
1606 (and (org-string-nw-p errors
) (org-trim errors
)))))))
1609 (provide 'ox-texinfo
)
1612 ;; generated-autoload-file: "org-loaddefs.el"
1615 ;;; ox-texinfo.el ends here