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 ;; This library implements a Texinfo back-end for Org generic
29 ;; M-: (org-export-to-buffer 'texinfo "*Test Texinfo*") RET
31 ;; in an Org mode buffer then switch to the buffer to see the Texinfo
32 ;; export. See ox.el for more details on how this exporter works.
35 ;; It introduces nine new buffer keywords: "TEXINFO_CLASS",
36 ;; "TEXINFO_FILENAME", "TEXINFO_HEADER", "TEXINFO_POST_HEADER",
37 ;; "TEXINFO_DIR_CATEGORY", "TEXINFO_DIR_TITLE", "TEXINFO_DIR_DESC"
38 ;; "SUBTITLE" and "SUBAUTHOR".
41 ;; It introduces 1 new headline property keywords:
42 ;; "TEXINFO_MENU_TITLE" for optional menu titles.
44 ;; To include inline code snippets (for example for generating @kbd{}
45 ;; and @key{} commands), the following export-snippet keys are
51 ;; You can add them for export snippets via any of the below:
53 ;; (add-to-list 'org-export-snippet-translation-alist
54 ;; '("info" . "texinfo"))
59 (eval-when-compile (require 'cl
))
62 (defvar orgtbl-exp-regexp
)
68 (org-export-define-backend 'texinfo
69 '((bold . org-texinfo-bold
)
70 (center-block . org-texinfo-center-block
)
71 (clock . org-texinfo-clock
)
72 (code . org-texinfo-code
)
73 (comment .
(lambda (&rest args
) ""))
74 (comment-block .
(lambda (&rest args
) ""))
75 (drawer . org-texinfo-drawer
)
76 (dynamic-block . org-texinfo-dynamic-block
)
77 (entity . org-texinfo-entity
)
78 (example-block . org-texinfo-example-block
)
79 (export-block . org-texinfo-export-block
)
80 (export-snippet . org-texinfo-export-snippet
)
81 (fixed-width . org-texinfo-fixed-width
)
82 (footnote-definition . org-texinfo-footnote-definition
)
83 (footnote-reference . org-texinfo-footnote-reference
)
84 (headline . org-texinfo-headline
)
85 (inline-src-block . org-texinfo-inline-src-block
)
86 (inlinetask . org-texinfo-inlinetask
)
87 (italic . org-texinfo-italic
)
88 (item . org-texinfo-item
)
89 (keyword . org-texinfo-keyword
)
90 (line-break . org-texinfo-line-break
)
91 (link . org-texinfo-link
)
92 (paragraph . org-texinfo-paragraph
)
93 (plain-list . org-texinfo-plain-list
)
94 (plain-text . org-texinfo-plain-text
)
95 (planning . org-texinfo-planning
)
96 (property-drawer . org-texinfo-property-drawer
)
97 (quote-block . org-texinfo-quote-block
)
98 (quote-section . org-texinfo-quote-section
)
99 (radio-target . org-texinfo-radio-target
)
100 (section . org-texinfo-section
)
101 (special-block . org-texinfo-special-block
)
102 (src-block . org-texinfo-src-block
)
103 (statistics-cookie . org-texinfo-statistics-cookie
)
104 (subscript . org-texinfo-subscript
)
105 (superscript . org-texinfo-superscript
)
106 (table . org-texinfo-table
)
107 (table-cell . org-texinfo-table-cell
)
108 (table-row . org-texinfo-table-row
)
109 (target . org-texinfo-target
)
110 (template . org-texinfo-template
)
111 (timestamp . org-texinfo-timestamp
)
112 (verbatim . org-texinfo-verbatim
)
113 (verse-block . org-texinfo-verse-block
))
114 :export-block
"TEXINFO"
116 '((:filter-headline . org-texinfo-filter-section-blank-lines
)
117 (:filter-section . org-texinfo-filter-section-blank-lines
))
119 '(?i
"Export to Texinfo"
120 ((?t
"As TEXI file" org-texinfo-export-to-texinfo
)
121 (?i
"As INFO file" org-texinfo-export-to-info
)))
123 '((:texinfo-filename
"TEXINFO_FILENAME" nil org-texinfo-filename t
)
124 (:texinfo-class
"TEXINFO_CLASS" nil org-texinfo-default-class t
)
125 (:texinfo-header
"TEXINFO_HEADER" nil nil newline
)
126 (:texinfo-post-header
"TEXINFO_POST_HEADER" nil nil newline
)
127 (:subtitle
"SUBTITLE" nil nil newline
)
128 (:subauthor
"SUBAUTHOR" nil nil newline
)
129 (:texinfo-dircat
"TEXINFO_DIR_CATEGORY" nil nil t
)
130 (:texinfo-dirtitle
"TEXINFO_DIR_TITLE" nil nil t
)
131 (:texinfo-dirdesc
"TEXINFO_DIR_DESC" nil nil t
)))
135 ;;; User Configurable Variables
137 (defgroup org-export-texinfo nil
138 "Options for exporting Org mode files to Texinfo."
139 :tag
"Org Export Texinfo"
141 :package-version
'(Org .
"8.0")
146 (defcustom org-texinfo-filename
""
147 "Default filename for Texinfo output."
148 :group
'org-export-texinfo
149 :type
'(string :tag
"Export Filename"))
151 (defcustom org-texinfo-coding-system nil
152 "Default document encoding for Texinfo output.
154 If `nil' it will default to `buffer-file-coding-system'."
155 :group
'org-export-texinfo
156 :type
'coding-system
)
158 (defcustom org-texinfo-default-class
"info"
159 "The default Texinfo class."
160 :group
'org-export-texinfo
161 :type
'(string :tag
"Texinfo class"))
163 (defcustom org-texinfo-classes
165 "\\input texinfo @c -*- texinfo -*-"
166 ("@chapter %s" .
"@unnumbered %s")
167 ("@section %s" .
"@unnumberedsec %s")
168 ("@subsection %s" .
"@unnumberedsubsec %s")
169 ("@subsubsection %s" .
"@unnumberedsubsubsec %s")))
170 "Alist of Texinfo classes and associated header and structure.
171 If #+Texinfo_CLASS is set in the buffer, use its value and the
172 associated information. Here is the structure of each cell:
176 \(numbered-section . unnumbered-section\)
179 The sectioning structure
180 ------------------------
182 The sectioning structure of the class is given by the elements
183 following the header string. For each sectioning level, a number
184 of strings is specified. A %s formatter is mandatory in each
185 section string and will be replaced by the title of the section.
187 Instead of a list of sectioning commands, you can also specify
188 a function name. That function will be called with two
189 parameters, the \(reduced) level of the headline, and a predicate
190 non-nil when the headline should be numbered. It must return
191 a format string in which the section title will be added."
192 :group
'org-export-texinfo
194 (list (string :tag
"Texinfo class")
195 (string :tag
"Texinfo header")
196 (repeat :tag
"Levels" :inline t
199 (string :tag
" numbered")
200 (string :tag
"unnumbered"))
201 (function :tag
"Hook computing sectioning"))))))
205 (defcustom org-texinfo-format-headline-function
'ignore
206 "Function to format headline text.
208 This function will be called with 5 arguments:
209 TODO the todo keyword (string or nil).
210 TODO-TYPE the type of todo (symbol: `todo', `done', nil)
211 PRIORITY the priority of the headline (integer or nil)
212 TEXT the main headline text (string).
213 TAGS the tags as a list of strings (list of strings or nil).
215 The function result will be used in the section format string.
217 As an example, one could set the variable to the following, in
218 order to reproduce the default set-up:
220 \(defun org-texinfo-format-headline (todo todo-type priority text tags)
221 \"Default format function for a headline.\"
223 \(format \"\\\\textbf{\\\\textsc{\\\\textsf{%s}}} \" todo))
225 \(format \"\\\\framebox{\\\\#%c} \" priority))
228 \(format \"\\\\hfill{}\\\\textsc{%s}\"
229 \(mapconcat 'identity tags \":\"))))"
230 :group
'org-export-texinfo
233 ;;; Node listing (menu)
235 (defcustom org-texinfo-node-description-column
32
236 "Column at which to start the description in the node listings.
237 If a node title is greater than this length, the description will
238 be placed after the end of the title."
239 :group
'org-export-texinfo
244 ;; Footnotes are inserted directly
248 (defcustom org-texinfo-active-timestamp-format
"@emph{%s}"
249 "A printf format string to be applied to active timestamps."
250 :group
'org-export-texinfo
253 (defcustom org-texinfo-inactive-timestamp-format
"@emph{%s}"
254 "A printf format string to be applied to inactive timestamps."
255 :group
'org-export-texinfo
258 (defcustom org-texinfo-diary-timestamp-format
"@emph{%s}"
259 "A printf format string to be applied to diary timestamps."
260 :group
'org-export-texinfo
265 (defcustom org-texinfo-link-with-unknown-path-format
"@indicateurl{%s}"
266 "Format string for links with unknown path type."
267 :group
'org-export-texinfo
272 (defcustom org-texinfo-tables-verbatim nil
273 "When non-nil, tables are exported verbatim."
274 :group
'org-export-texinfo
277 (defcustom org-texinfo-table-scientific-notation
"%s\\,(%s)"
278 "Format string to display numbers in scientific notation.
279 The format should have \"%s\" twice, for mantissa and exponent
280 \(i.e. \"%s\\\\times10^{%s}\").
282 When nil, no transformation is made."
283 :group
'org-export-texinfo
285 (string :tag
"Format string")
286 (const :tag
"No formatting" nil
)))
288 (defcustom org-texinfo-def-table-markup
"@samp"
289 "Default setting for @table environments."
290 :group
'org-export-texinfo
295 (defcustom org-texinfo-text-markup-alist
'((bold .
"@strong{%s}")
297 (italic .
"@emph{%s}")
300 "Alist of Texinfo expressions to convert text markup.
302 The key must be a symbol among `bold', `italic' and `comment'.
303 The value is a formatting string to wrap fontified text with.
305 Value can also be set to the following symbols: `verb' and
306 `code'. For the former, Org will use \"@verb\" to
307 create a format string and select a delimiter character that
308 isn't in the string. For the latter, Org will use \"@code\"
309 to typeset and try to protect special characters.
311 If no association can be found for a given markup, text will be
313 :group
'org-export-texinfo
315 :options
'(bold code italic verbatim comment
))
319 (defcustom org-texinfo-format-drawer-function
320 (lambda (name contents
) contents
)
321 "Function called to format a drawer in Texinfo code.
323 The function must accept two parameters:
324 NAME the drawer name, like \"LOGBOOK\"
325 CONTENTS the contents of the drawer.
327 The function should return the string to be exported.
329 The default function simply returns the value of CONTENTS."
330 :group
'org-export-texinfo
332 :package-version
'(Org .
"8.2")
337 (defcustom org-texinfo-format-inlinetask-function
'ignore
338 "Function called to format an inlinetask in Texinfo code.
340 The function must accept six parameters:
341 TODO the todo keyword, as a string
342 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
343 PRIORITY the inlinetask priority, as a string
344 NAME the inlinetask name, as a string.
345 TAGS the inlinetask tags, as a list of strings.
346 CONTENTS the contents of the inlinetask, as a string.
348 The function should return the string to be exported.
350 For example, the variable could be set to the following function
351 in order to mimic default behavior:
353 \(defun org-texinfo-format-inlinetask \(todo type priority name tags contents\)
354 \"Format an inline task element for Texinfo export.\"
358 \(format \"@strong{%s} \" todo))
359 \(when priority (format \"#%c \" priority))
363 \(mapconcat 'identity tags \":\")))))
364 \(format (concat \"@center %s\n\n\"
367 full-title contents))"
368 :group
'org-export-texinfo
373 ;; Src Blocks are example blocks, except for LISP
377 (defcustom org-texinfo-info-process
379 "Commands to process a Texinfo file to an INFO file.
380 This is list of strings, each of them will be given to the shell
381 as a command. %f in the command will be replaced by the full
382 file name, %b by the file base name \(i.e without extension) and
383 %o by the base directory of the file."
384 :group
'org-export-texinfo
385 :type
'(repeat :tag
"Shell command sequence"
386 (string :tag
"Shell command")))
388 (defcustom org-texinfo-logfiles-extensions
389 '("aux" "toc" "cp" "fn" "ky" "pg" "tp" "vr")
390 "The list of file extensions to consider as Texinfo logfiles.
391 The logfiles will be remove if `org-texinfo-remove-logfiles' is
393 :group
'org-export-texinfo
394 :type
'(repeat (string :tag
"Extension")))
396 (defcustom org-texinfo-remove-logfiles t
397 "Non-nil means remove the logfiles produced by compiling a Texinfo file.
398 By default, logfiles are files with these extensions: .aux, .toc,
399 .cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove,
400 set `org-texinfo-logfiles-extensions'."
401 :group
'org-export-latex
406 (defconst org-texinfo-max-toc-depth
4
407 "Maximum depth for creation of detailed menu listings. Beyond
408 this depth Texinfo will not recognize the nodes and will cause
409 errors. Left as a constant in case this value ever changes.")
411 (defconst org-texinfo-supported-coding-systems
412 '("US-ASCII" "UTF-8" "ISO-8859-15" "ISO-8859-1" "ISO-8859-2" "koi8-r" "koi8-u")
413 "List of coding systems supported by Texinfo, as strings.
414 Specified coding system will be matched against these strings.
415 If two strings share the same prefix (e.g. \"ISO-8859-1\" and
416 \"ISO-8859-15\"), the most specific one has to be listed first.")
419 ;;; Internal Functions
421 (defun org-texinfo-filter-section-blank-lines (headline back-end info
)
422 "Filter controlling number of blank lines after a section."
423 (let ((blanks (make-string 2 ?
\n)))
424 (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline
)))
426 (defun org-texinfo--find-verb-separator (s)
427 "Return a character not used in string S.
428 This is used to choose a separator for constructs like \\verb."
429 (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
430 (loop for c across ll
431 when
(not (string-match (regexp-quote (char-to-string c
)) s
))
432 return
(char-to-string c
))))
434 (defun org-texinfo--make-option-string (options)
435 "Return a comma separated string of keywords and values.
436 OPTIONS is an alist where the key is the options keyword as
437 a string, and the value a list containing the keyword value, or
439 (mapconcat (lambda (pair)
441 (when (> (length (second pair
)) 0)
442 (concat "=" (second pair
)))))
446 (defun org-texinfo--text-markup (text markup
)
447 "Format TEXT depending on MARKUP text markup.
448 See `org-texinfo-text-markup-alist' for details."
449 (let ((fmt (cdr (assq markup org-texinfo-text-markup-alist
))))
451 ;; No format string: Return raw text.
454 (let ((separator (org-texinfo--find-verb-separator text
)))
455 (concat "@verb{" separator text separator
"}")))
460 (while (string-match "[@{}]" text
)
461 (setq char
(match-string 0 text
))
462 (if (> (match-beginning 0) 0)
463 (setq rtn
(concat rtn
(substring text
0 (match-beginning 0)))))
464 (setq text
(substring text
(1+ (match-beginning 0))))
465 (setq char
(concat "@" char
)
466 rtn
(concat rtn char
)))
467 (setq text
(concat rtn text
)
470 ;; Else use format string.
471 (t (format fmt text
)))))
473 (defun org-texinfo--get-node (headline info
)
474 "Return node entry associated to HEADLINE.
475 INFO is a plist used as a communication channel."
476 (let ((menu-title (org-export-get-alt-title headline info
)))
477 (org-texinfo--sanitize-menu
478 (replace-regexp-in-string
480 (if menu-title
(org-export-data menu-title info
)
481 (org-texinfo--sanitize-headline
482 (org-element-property :title headline
) info
))))))
484 ;;; Headline sanitizing
486 (defun org-texinfo--sanitize-headline (headline info
)
487 "Remove all formatting from the text of a headline for use in
488 node and menu listing."
490 (org-texinfo--sanitize-headline-contents headline info
) " "))
492 (defun org-texinfo--sanitize-headline-contents (headline info
)
493 "Retrieve the content of the headline.
495 Any content that can contain further formatting is checked
496 recursively, to ensure that nested content is also properly
498 (loop for contents in headline append
502 (list (replace-regexp-in-string " $" "" contents
)))
503 ;; Is exported as-is (value)
504 ((org-element-map contents
'(verbatim code
)
505 (lambda (value) (org-element-property :value value
)) info
))
506 ;; Has content and recurse into the content
507 ((org-element-contents contents
)
508 (org-texinfo--sanitize-headline-contents
509 (org-element-contents contents
) info
)))))
513 (defun org-texinfo--sanitize-menu (title)
514 "Remove invalid characters from TITLE for use in menus and
517 Based on Texinfo specifications, the following must be removed:
519 (replace-regexp-in-string "[@{}():,.]" "" title
))
521 ;;; Content sanitizing
523 (defun org-texinfo--sanitize-content (text)
524 "Ensure characters are properly escaped when used in headlines or blocks.
526 Escape characters are: @ { }"
527 (replace-regexp-in-string "\\\([@{}]\\\)" "@\\1" text
))
531 (defun org-texinfo--build-menu (tree level info
&optional detailed
)
532 "Create the @menu/@end menu information from TREE at headline
535 TREE contains the parse-tree to work with, either of the entire
536 document or of a specific parent headline. LEVEL indicates what
537 level of headlines to look at when generating the menu. INFO is
538 a plist containing contextual information.
540 Detailed determines whether to build a single level of menu, or
541 recurse into all children as well."
542 (let ((menu (org-texinfo--generate-menu-list tree level info
))
546 ;; Looping is done within the menu generation.
547 (setq text-menu
(org-texinfo--generate-detailed menu level info
)))
549 (setq text-menu
(org-texinfo--generate-menu-items menu info
))))
551 (setq output
(org-texinfo--format-menu text-menu
))
552 (mapconcat 'identity output
"\n"))))
554 (defun org-texinfo--generate-detailed (menu level info
)
555 "Generate a detailed listing of all subheadings within MENU starting at LEVEL.
557 MENU is the parse-tree to work with. LEVEL is the starting level
558 for the menu headlines and from which recursion occurs. INFO is
559 a plist containing contextual information."
561 (let ((max-depth (min org-texinfo-max-toc-depth
562 (plist-get info
:headline-levels
))))
563 (when (> max-depth level
)
564 (loop for headline in menu append
565 (let* ((title (org-texinfo--menu-headlines headline info
))
566 ;; Create list of menu entries for the next level
567 (sublist (org-texinfo--generate-menu-list
568 headline
(1+ level
) info
))
569 ;; Generate the menu items for that level. If
570 ;; there are none omit that heading completely,
571 ;; otherwise join the title to it's related entries.
572 (submenu (if (org-texinfo--generate-menu-items sublist info
)
574 (org-texinfo--generate-menu-items sublist info
))
576 ;; Start the process over the next level down.
577 (recursion (org-texinfo--generate-detailed sublist
(1+ level
) info
)))
578 (setq recursion
(append submenu recursion
))
581 (defun org-texinfo--generate-menu-list (tree level info
)
582 "Generate the list of headlines that are within a given level
583 of the tree for further formatting.
585 TREE is the parse-tree containing the headlines. LEVEL is the
586 headline level to generate a list of. INFO is a plist holding
587 contextual information."
588 (org-element-map tree
'headline
590 (and (= (org-export-get-relative-level head info
) level
)
591 ;; Do not take note of footnotes or copying headlines.
592 (not (org-element-property :COPYING head
))
593 (not (org-element-property :footnote-section-p head
))
598 (defun org-texinfo--generate-menu-items (items info
)
599 "Generate a list of headline information from the listing ITEMS.
601 ITEMS is a list of the headlines to be converted into entries.
602 INFO is a plist containing contextual information.
604 Returns a list containing the following information from each
605 headline: length, title, description. This is used to format the
606 menu using `org-texinfo--format-menu'."
607 (loop for headline in items collect
608 (let* ((menu-title (org-texinfo--sanitize-menu
610 (org-export-get-alt-title headline info
)
612 (title (org-texinfo--sanitize-menu
613 (org-texinfo--sanitize-headline
614 (org-element-property :title headline
) info
)))
615 (descr (org-export-data
616 (org-element-property :DESCRIPTION headline
)
618 (menu-entry (if (string= "" menu-title
) title menu-title
))
619 (len (length menu-entry
))
620 (output (list len menu-entry descr
)))
623 (defun org-texinfo--menu-headlines (headline info
)
624 "Retrieve the title from HEADLINE.
626 INFO is a plist holding contextual information.
628 Return the headline as a list of (length title description) with
629 length of -1 and nil description. This is used in
630 `org-texinfo--format-menu' to identify headlines as opposed to
632 (let ((title (org-export-data
633 (org-element-property :title headline
) info
)))
634 (list -
1 title
'nil
)))
636 (defun org-texinfo--format-menu (text-menu)
637 "Format the TEXT-MENU items to be properly printed in the menu.
639 Each entry in the menu should be provided as (length title
642 Headlines in the detailed menu are given length -1 to ensure they
643 are never confused with other entries. They also have no
646 Other menu items are output as:
649 With the spacing between :: and description based on the length
650 of the longest menu entry."
654 (mapcar (lambda (name)
655 (let* ((title (nth 1 name
))
657 (length (nth 0 name
))
659 ;;6 is "* " ":: " for inserted text
662 org-texinfo-node-description-column
664 (spacing (- column length
)
667 (concat "* " title
":: "
668 (make-string spacing ?\s
)
671 (concat "\n" title
"\n"))))
677 (defun org-texinfo-template (contents info
)
678 "Return complete document string after Texinfo conversion.
679 CONTENTS is the transcoded contents string. INFO is a plist
680 holding export options."
681 (let* ((title (org-export-data (plist-get info
:title
) info
))
682 (info-filename (or (plist-get info
:texinfo-filename
)
683 (file-name-nondirectory
684 (org-export-output-file-name ".info"))))
685 (author (org-export-data (plist-get info
:author
) info
))
686 (lang (org-export-data (plist-get info
:language
) info
))
687 (texinfo-header (plist-get info
:texinfo-header
))
688 (texinfo-post-header (plist-get info
:texinfo-post-header
))
689 (subtitle (plist-get info
:subtitle
))
690 (subauthor (plist-get info
:subauthor
))
691 (class (plist-get info
:texinfo-class
))
692 (header (nth 1 (assoc class org-texinfo-classes
)))
694 (org-element-map (plist-get info
:parse-tree
) 'headline
695 (lambda (hl) (and (org-element-property :COPYING hl
) hl
)) info t
))
696 (menu (org-texinfo-make-menu info
'main
))
697 (detail-menu (org-texinfo-make-menu info
'detailed
)))
701 "@c %**start of header\n"
702 ;; Filename and Title
703 "@setfilename " info-filename
"\n"
704 "@settitle " title
"\n"
707 "@documentencoding %s\n"
708 (catch 'coding-system
709 (let ((case-fold-search t
)
710 (name (symbol-name (or org-texinfo-coding-system
711 buffer-file-coding-system
))))
712 (dolist (system org-texinfo-supported-coding-systems
"UTF-8")
713 (when (org-string-match-p (regexp-quote system
) name
)
714 (throw 'coding-system system
))))))
716 (format "@documentlanguage %s\n" lang
)
718 "@c Version and Contact Info\n"
719 "@set AUTHOR " author
"\n"
721 ;; Additional Header Options set by `#+TEXINFO_HEADER
727 "@c %**end of header\n"
731 ;; Additional Header Options set by #+TEXINFO_POST_HEADER
732 (if texinfo-post-header
739 ;; Only export the content of the headline, do not need the
741 (org-export-data (nth 2 copying
) info
)
744 ;; Info directory information. Only supply if both title and
745 ;; category are provided.
746 (let ((dircat (plist-get info
:texinfo-dircat
))
747 ;; Make sure title ends with a full stop.
749 (let ((title (plist-get info
:texinfo-dirtitle
)))
751 (string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title
)
752 (format "* %s." (match-string 1 title
))))))
753 (when (and dircat dirtitle
)
754 (concat "@dircategory " dircat
"\n"
757 (let ((desc (plist-get info
:texinfo-dirdesc
)))
758 (cond ((not desc
) nil
)
759 ((org-string-match-p "\\.$" desc
) desc
)
760 (t (concat desc
"."))))))
761 (if dirdesc
(format "%-23s %s" dirtitle dirdesc
) dirtitle
))
763 "@end direntry\n\n")))
766 "@title " title
"\n\n"
768 (concat "@subtitle " subtitle
"\n"))
769 "@author " author
"\n"
771 (concat subauthor
"\n"))
773 "@c The following two commands start the copyright page.\n"
775 "@vskip 0pt plus 1filll\n"
778 "@c Output the table of contents at the beginning.\n"
781 ;; Configure Top Node when not for Tex
784 "@top " title
" Manual\n"
788 ;; Do not output menus if they are empty
796 (concat "@detailmenu\n"
797 " --- The Detailed Node Listing ---\n"
800 "@end detailmenu\n"))
808 (let ((creator-info (plist-get info
:with-creator
)))
810 ((not creator-info
) "")
811 ((eq creator-info
'comment
)
812 (format "@c %s\n" (plist-get info
:creator
)))
813 (t (concat (plist-get info
:creator
) "\n"))))
819 ;;; Transcode Functions
823 (defun org-texinfo-bold (bold contents info
)
824 "Transcode BOLD from Org to Texinfo.
825 CONTENTS is the text with bold markup. INFO is a plist holding
826 contextual information."
827 (org-texinfo--text-markup contents
'bold
))
831 (defun org-texinfo-center-block (center-block contents info
)
832 "Transcode a CENTER-BLOCK element from Org to Texinfo.
833 CONTENTS holds the contents of the block. INFO is a plist used
834 as a communication channel."
839 (defun org-texinfo-clock (clock contents info
)
840 "Transcode a CLOCK element from Org to Texinfo.
841 CONTENTS is nil. INFO is a plist holding contextual
845 (format "@strong{%s} " org-clock-string
)
846 (format org-texinfo-inactive-timestamp-format
847 (concat (org-translate-time
848 (org-element-property :raw-value
849 (org-element-property :value clock
)))
850 (let ((time (org-element-property :duration clock
)))
851 (and time
(format " (%s)" time
)))))
856 (defun org-texinfo-code (code contents info
)
857 "Transcode a CODE object from Org to Texinfo.
858 CONTENTS is nil. INFO is a plist used as a communication
860 (org-texinfo--text-markup (org-element-property :value code
) 'code
))
864 (defun org-texinfo-drawer (drawer contents info
)
865 "Transcode a DRAWER element from Org to Texinfo.
866 CONTENTS holds the contents of the block. INFO is a plist
867 holding contextual information."
868 (let* ((name (org-element-property :drawer-name drawer
))
869 (output (funcall org-texinfo-format-drawer-function
875 (defun org-texinfo-dynamic-block (dynamic-block contents info
)
876 "Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
877 CONTENTS holds the contents of the block. INFO is a plist
878 holding contextual information. See `org-export-data'."
883 (defun org-texinfo-entity (entity contents info
)
884 "Transcode an ENTITY object from Org to Texinfo.
885 CONTENTS are the definition itself. INFO is a plist holding
886 contextual information."
887 (let ((ent (org-element-property :latex entity
)))
888 (if (org-element-property :latex-math-p entity
) (format "@math{%s}" ent
) ent
)))
892 (defun org-texinfo-example-block (example-block contents info
)
893 "Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
894 CONTENTS is nil. INFO is a plist holding contextual
896 (format "@verbatim\n%s@end verbatim"
897 (org-export-format-code-default example-block info
)))
901 (defun org-texinfo-export-block (export-block contents info
)
902 "Transcode a EXPORT-BLOCK element from Org to Texinfo.
903 CONTENTS is nil. INFO is a plist holding contextual information."
904 (when (string= (org-element-property :type export-block
) "TEXINFO")
905 (org-remove-indentation (org-element-property :value export-block
))))
909 (defun org-texinfo-export-snippet (export-snippet contents info
)
910 "Transcode a EXPORT-SNIPPET object from Org to Texinfo.
911 CONTENTS is nil. INFO is a plist holding contextual information."
912 (when (eq (org-export-snippet-backend export-snippet
) 'texinfo
)
913 (org-element-property :value export-snippet
)))
917 (defun org-texinfo-fixed-width (fixed-width contents info
)
918 "Transcode a FIXED-WIDTH element from Org to Texinfo.
919 CONTENTS is nil. INFO is a plist holding contextual information."
920 (format "@example\n%s\n@end example"
921 (org-remove-indentation
922 (org-texinfo--sanitize-content
923 (org-element-property :value fixed-width
)))))
925 ;;; Footnote Reference
928 (defun org-texinfo-footnote-reference (footnote contents info
)
929 "Create a footnote reference for FOOTNOTE.
931 FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
932 plist holding contextual information."
933 (let ((def (org-export-get-footnote-definition footnote info
)))
934 (format "@footnote{%s}"
935 (org-trim (org-export-data def info
)))))
939 (defun org-texinfo-headline (headline contents info
)
940 "Transcode a HEADLINE element from Org to Texinfo.
941 CONTENTS holds the contents of the headline. INFO is a plist
942 holding contextual information."
943 (let* ((class (plist-get info
:texinfo-class
))
944 (level (org-export-get-relative-level headline info
))
945 (numberedp (org-export-numbered-headline-p headline info
))
946 (class-sectioning (assoc class org-texinfo-classes
))
947 ;; Find the index type, if any
948 (index (org-element-property :INDEX headline
))
949 ;; Check if it is an appendix
950 (appendix (org-element-property :APPENDIX headline
))
951 ;; Retrieve headline text
952 (text (org-texinfo--sanitize-headline
953 (org-element-property :title headline
) info
))
954 ;; Create node info, to insert it before section formatting.
955 ;; Use custom menu title if present
956 (node (format "@node %s\n" (org-texinfo--get-node headline info
)))
957 ;; Menus must be generated with first child, otherwise they
958 ;; will not nest properly
959 (menu (let* ((first (org-export-first-sibling-p headline info
))
960 (parent (org-export-get-parent-headline headline
))
961 (title (org-texinfo--sanitize-headline
962 (org-element-property :title parent
) info
))
964 (tree (plist-get info
:parse-tree
)))
966 (org-element-map (plist-get info
:parse-tree
) 'headline
968 (if (member title
(org-element-property :title ref
))
971 (setq listing
(org-texinfo--build-menu
972 (car heading
) level info
))
974 (setq listing
(replace-regexp-in-string
977 "\n@menu\n%s\n@end menu\n\n" listing
))
979 ;; Section formatting will set two placeholders: one for the
980 ;; title and the other for the contents.
982 (let ((sec (if (and (symbolp (nth 2 class-sectioning
))
983 (fboundp (nth 2 class-sectioning
)))
984 (funcall (nth 2 class-sectioning
) level numberedp
)
985 (nth (1+ level
) class-sectioning
))))
987 ;; No section available for that LEVEL.
989 ;; Section format directly returned by a function.
991 ;; (numbered-section . unnumbered-section)
992 ((not (consp (cdr sec
)))
994 ;;If an index, always unnumbered
996 (concat menu node
(cdr sec
) "\n%s"))
998 (concat menu node
(replace-regexp-in-string
1002 ;; Otherwise number as needed.
1006 (if numberedp
#'car
#'cdr
) sec
) "\n%s")))))))
1008 (and (plist-get info
:with-todo-keywords
)
1009 (let ((todo (org-element-property :todo-keyword headline
)))
1010 (and todo
(org-export-data todo info
)))))
1011 (todo-type (and todo
(org-element-property :todo-type headline
)))
1012 (tags (and (plist-get info
:with-tags
)
1013 (org-export-get-tags headline info
)))
1014 (priority (and (plist-get info
:with-priority
)
1015 (org-element-property :priority headline
)))
1016 ;; Create the headline text along with a no-tag version. The
1017 ;; latter is required to remove tags from table of contents.
1018 (full-text (org-texinfo--sanitize-content
1019 (if (not (eq org-texinfo-format-headline-function
'ignore
))
1020 ;; User-defined formatting function.
1021 (funcall org-texinfo-format-headline-function
1022 todo todo-type priority text tags
)
1023 ;; Default formatting.
1026 (format "@strong{%s} " todo
))
1027 (when priority
(format "@emph{#%s} " priority
))
1031 (mapconcat 'identity tags
":")))))))
1033 (org-texinfo--sanitize-content
1034 (if (not (eq org-texinfo-format-headline-function
'ignore
))
1035 ;; User-defined formatting function.
1036 (funcall org-texinfo-format-headline-function
1037 todo todo-type priority text nil
)
1038 ;; Default formatting.
1040 (when todo
(format "@strong{%s} " todo
))
1041 (when priority
(format "@emph{#%c} " priority
))
1044 (make-string (org-element-property :pre-blank headline
) 10)))
1046 ;; Case 1: This is a footnote section: ignore it.
1047 ((org-element-property :footnote-section-p headline
) nil
)
1048 ;; Case 2: This is the `copying' section: ignore it
1049 ;; This is used elsewhere.
1050 ((org-element-property :COPYING headline
) nil
)
1051 ;; Case 3: An index. If it matches one of the known indexes,
1052 ;; print it as such following the contents, otherwise
1053 ;; print the contents and leave the index up to the user.
1056 section-fmt full-text
1057 (concat pre-blanks contents
"\n"
1058 (if (member index
'("cp" "fn" "ky" "pg" "tp" "vr"))
1059 (concat "@printindex " index
)))))
1060 ;; Case 4: This is a deep sub-tree: export it as a list item.
1061 ;; Also export as items headlines for which no section
1062 ;; format has been found.
1063 ((or (not section-fmt
) (org-export-low-level-p headline info
))
1064 ;; Build the real contents of the sub-tree.
1065 (let ((low-level-body
1067 ;; If the headline is the first sibling, start a list.
1068 (when (org-export-first-sibling-p headline info
)
1069 (format "@%s\n" (if numberedp
'enumerate
'itemize
)))
1071 "@item\n" full-text
"\n" pre-blanks contents
)))
1072 ;; If headline is not the last sibling simply return
1073 ;; LOW-LEVEL-BODY. Otherwise, also close the list, before any
1075 (if (not (org-export-last-sibling-p headline info
)) low-level-body
1076 (replace-regexp-in-string
1078 (format "\n@end %s" (if numberedp
'enumerate
'itemize
))
1080 ;; Case 5: Standard headline. Export it as a section.
1083 ((not (and tags
(eq (plist-get info
:with-tags
) 'not-in-toc
)))
1084 ;; Regular section. Use specified format string.
1085 (format (replace-regexp-in-string "%]" "%%]" section-fmt
) full-text
1086 (concat pre-blanks contents
)))
1087 ((string-match "\\`@\\(.*?\\){" section-fmt
)
1088 ;; If tags should be removed from table of contents, insert
1089 ;; title without tags as an alternative heading in sectioning
1091 (format (replace-match (concat (match-string 1 section-fmt
) "[%s]")
1092 nil nil section-fmt
1)
1093 ;; Replace square brackets with parenthesis since
1094 ;; square brackets are not supported in optional
1096 (replace-regexp-in-string
1098 (replace-regexp-in-string
1102 (concat pre-blanks contents
)))
1104 ;; Impossible to add an alternative heading. Fallback to
1105 ;; regular sectioning format string.
1106 (format (replace-regexp-in-string "%]" "%%]" section-fmt
) full-text
1107 (concat pre-blanks contents
))))))))
1109 ;;; Inline Src Block
1111 (defun org-texinfo-inline-src-block (inline-src-block contents info
)
1112 "Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
1113 CONTENTS holds the contents of the item. INFO is a plist holding
1114 contextual information."
1115 (let* ((code (org-element-property :value inline-src-block
))
1116 (separator (org-texinfo--find-verb-separator code
)))
1117 (concat "@verb{" separator code separator
"}")))
1121 (defun org-texinfo-inlinetask (inlinetask contents info
)
1122 "Transcode an INLINETASK element from Org to Texinfo.
1123 CONTENTS holds the contents of the block. INFO is a plist
1124 holding contextual information."
1125 (let ((title (org-export-data (org-element-property :title inlinetask
) info
))
1126 (todo (and (plist-get info
:with-todo-keywords
)
1127 (let ((todo (org-element-property :todo-keyword inlinetask
)))
1128 (and todo
(org-export-data todo info
)))))
1129 (todo-type (org-element-property :todo-type inlinetask
))
1130 (tags (and (plist-get info
:with-tags
)
1131 (org-export-get-tags inlinetask info
)))
1132 (priority (and (plist-get info
:with-priority
)
1133 (org-element-property :priority inlinetask
))))
1134 ;; If `org-texinfo-format-inlinetask-function' is provided, call it
1135 ;; with appropriate arguments.
1136 (if (not (eq org-texinfo-format-inlinetask-function
'ignore
))
1137 (funcall org-texinfo-format-inlinetask-function
1138 todo todo-type priority title tags contents
)
1139 ;; Otherwise, use a default template.
1142 (when todo
(format "@strong{%s} " todo
))
1143 (when priority
(format "#%c " priority
))
1145 (when tags
(format ":%s:"
1146 (mapconcat 'identity tags
":"))))))
1147 (format (concat "@center %s\n\n"
1150 full-title contents
)))))
1154 (defun org-texinfo-italic (italic contents info
)
1155 "Transcode ITALIC from Org to Texinfo.
1156 CONTENTS is the text with italic markup. INFO is a plist holding
1157 contextual information."
1158 (org-texinfo--text-markup contents
'italic
))
1162 (defun org-texinfo-item (item contents info
)
1163 "Transcode an ITEM element from Org to Texinfo.
1164 CONTENTS holds the contents of the item. INFO is a plist holding
1165 contextual information."
1166 (let* ((tag (org-element-property :tag item
))
1167 (desc (org-export-data tag info
)))
1168 (concat "\n@item " (if tag desc
) "\n"
1169 (and contents
(org-trim contents
)) "\n")))
1173 (defun org-texinfo-keyword (keyword contents info
)
1174 "Transcode a KEYWORD element from Org to Texinfo.
1175 CONTENTS is nil. INFO is a plist holding contextual information."
1176 (let ((key (org-element-property :key keyword
))
1177 (value (org-element-property :value keyword
)))
1179 ((string= key
"TEXINFO") value
)
1180 ((string= key
"CINDEX") (format "@cindex %s" value
))
1181 ((string= key
"FINDEX") (format "@findex %s" value
))
1182 ((string= key
"KINDEX") (format "@kindex %s" value
))
1183 ((string= key
"PINDEX") (format "@pindex %s" value
))
1184 ((string= key
"TINDEX") (format "@tindex %s" value
))
1185 ((string= key
"VINDEX") (format "@vindex %s" value
)))))
1189 (defun org-texinfo-line-break (line-break contents info
)
1190 "Transcode a LINE-BREAK object from Org to Texinfo.
1191 CONTENTS is nil. INFO is a plist holding contextual information."
1196 (defun org-texinfo-link (link desc info
)
1197 "Transcode a LINK object from Org to Texinfo.
1199 DESC is the description part of the link, or the empty string.
1200 INFO is a plist holding contextual information. See
1202 (let* ((type (org-element-property :type link
))
1203 (raw-path (org-element-property :path link
))
1204 ;; Ensure DESC really exists, or set it to nil.
1205 (desc (and (not (string= desc
"")) desc
))
1207 ((member type
'("http" "https" "ftp"))
1208 (concat type
":" raw-path
))
1209 ((and (string= type
"file") (file-name-absolute-p raw-path
))
1210 (concat "file:" raw-path
))
1212 (email (if (string= type
"mailto")
1213 (let ((text (replace-regexp-in-string
1214 "@" "@@" raw-path
)))
1215 (concat text
(if desc
(concat "," desc
))))))
1218 ;; Links pointing to a headline: Find destination and build
1219 ;; appropriate referencing command.
1220 ((member type
'("custom-id" "id"))
1221 (let ((destination (org-export-resolve-id-link link info
)))
1222 (case (org-element-type destination
)
1223 ;; Id link points to an external file.
1225 (if desc
(format "@uref{file://%s,%s}" destination desc
)
1226 (format "@uref{file://%s}" destination
)))
1227 ;; LINK points to a headline. Use the headline as the NODE target
1229 (format "@ref{%s,%s}"
1230 (org-texinfo--get-node destination info
)
1233 (let ((path (org-export-solidify-link-text path
)))
1234 (if (not desc
) (format "@ref{%s}" path
)
1235 (format "@ref{%s,,%s}" path desc
)))))))
1236 ((member type
'("info"))
1237 (let* ((info-path (split-string path
"[:#]"))
1238 (info-manual (car info-path
))
1239 (info-node (or (cadr info-path
) "top"))
1240 (title (or desc
"")))
1241 (format "@ref{%s,%s,,%s,}" info-node title info-manual
)))
1242 ((member type
'("fuzzy"))
1243 (let ((destination (org-export-resolve-fuzzy-link link info
)))
1244 (case (org-element-type destination
)
1245 ;; Id link points to an external file.
1247 (if desc
(format "@uref{file://%s,%s}" destination desc
)
1248 (format "@uref{file://%s}" destination
)))
1249 ;; LINK points to a headline. Use the headline as the NODE target
1251 (format "@ref{%s,%s}"
1252 (org-texinfo--get-node destination info
)
1255 (let ((path (org-export-solidify-link-text path
)))
1256 (if (not desc
) (format "@ref{%s}" path
)
1257 (format "@ref{%s,,%s}" path desc
)))))))
1258 ;; Special case for email addresses
1260 (format "@email{%s}" email
))
1261 ;; External link with a description part.
1262 ((and path desc
) (format "@uref{%s,%s}" path desc
))
1263 ;; External link without a description part.
1264 (path (format "@uref{%s}" path
))
1265 ;; No path, only description. Try to do something useful.
1266 (t (format org-texinfo-link-with-unknown-path-format desc
)))))
1271 (defun org-texinfo-make-menu (info level
)
1272 "Create the menu for inclusion in the texifo document.
1274 INFO is the parsed buffer that contains the headlines. LEVEL
1275 determines whether to make the main menu, or the detailed menu.
1277 This is only used for generating the primary menu. In-Node menus
1278 are generated directly."
1279 (let ((parse (plist-get info
:parse-tree
)))
1281 ;; Generate the main menu
1282 ((eq level
'main
) (org-texinfo--build-menu parse
1 info
))
1283 ;; Generate the detailed (recursive) menu
1284 ((eq level
'detailed
)
1285 ;; Requires recursion
1286 ;;(org-texinfo--build-detailed-menu parse top info)
1287 (org-texinfo--build-menu parse
1 info
'detailed
)))))
1291 (defun org-texinfo-paragraph (paragraph contents info
)
1292 "Transcode a PARAGRAPH element from Org to Texinfo.
1293 CONTENTS is the contents of the paragraph, as a string. INFO is
1294 the plist used as a communication channel."
1299 (defun org-texinfo-plain-list (plain-list contents info
)
1300 "Transcode a PLAIN-LIST element from Org to Texinfo.
1301 CONTENTS is the contents of the list. INFO is a plist holding
1302 contextual information."
1303 (let* ((attr (org-export-read-attribute :attr_texinfo plain-list
))
1304 (indic (or (plist-get attr
:indic
)
1305 org-texinfo-def-table-markup
))
1306 (type (org-element-property :type plain-list
))
1307 (table-type (plist-get attr
:table-type
))
1308 ;; Ensure valid texinfo table type.
1309 (table-type (if (member table-type
'("ftable" "vtable")) table-type
1312 ((eq type
'ordered
) "enumerate")
1313 ((eq type
'unordered
) "itemize")
1314 ((eq type
'descriptive
) table-type
))))
1315 (format "@%s%s\n@end %s"
1316 (if (eq type
'descriptive
)
1317 (concat list-type
" " indic
)
1324 (defun org-texinfo-plain-text (text info
)
1325 "Transcode a TEXT string from Org to Texinfo.
1326 TEXT is the string to transcode. INFO is a plist holding
1327 contextual information."
1328 ;; First protect @, { and }.
1329 (let ((output (org-texinfo--sanitize-content text
)))
1330 ;; Activate smart quotes. Be sure to provide original TEXT string
1331 ;; since OUTPUT may have been modified.
1332 (when (plist-get info
:with-smart-quotes
)
1334 (org-export-activate-smart-quotes output
:texinfo info text
)))
1335 ;; LaTeX into @LaTeX{} and TeX into @TeX{}
1336 (let ((case-fold-search nil
)
1338 (while (string-match "\\(\\(?:La\\)?TeX\\)" output start
)
1339 (setq output
(replace-match
1340 (format "@%s{}" (match-string 1 output
)) nil t output
)
1341 start
(match-end 0))))
1342 ;; Convert special strings.
1343 (when (plist-get info
:with-special-strings
)
1344 (while (string-match (regexp-quote "...") output
)
1345 (setq output
(replace-match "@dots{}" nil t output
))))
1346 ;; Handle break preservation if required.
1347 (when (plist-get info
:preserve-breaks
)
1348 (setq output
(replace-regexp-in-string
1349 "\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output
)))
1355 (defun org-texinfo-planning (planning contents info
)
1356 "Transcode a PLANNING element from Org to Texinfo.
1357 CONTENTS is nil. INFO is a plist holding contextual
1365 (let ((closed (org-element-property :closed planning
)))
1368 (format "@strong{%s} " org-closed-string
)
1369 (format org-texinfo-inactive-timestamp-format
1371 (org-element-property :raw-value closed
))))))
1372 (let ((deadline (org-element-property :deadline planning
)))
1375 (format "@strong{%s} " org-deadline-string
)
1376 (format org-texinfo-active-timestamp-format
1378 (org-element-property :raw-value deadline
))))))
1379 (let ((scheduled (org-element-property :scheduled planning
)))
1382 (format "@strong{%s} " org-scheduled-string
)
1383 (format org-texinfo-active-timestamp-format
1385 (org-element-property :raw-value scheduled
))))))))
1391 (defun org-texinfo-property-drawer (property-drawer contents info
)
1392 "Transcode a PROPERTY-DRAWER element from Org to Texinfo.
1393 CONTENTS is nil. INFO is a plist holding contextual
1395 ;; The property drawer isn't exported but we want separating blank
1396 ;; lines nonetheless.
1401 (defun org-texinfo-quote-block (quote-block contents info
)
1402 "Transcode a QUOTE-BLOCK element from Org to Texinfo.
1403 CONTENTS holds the contents of the block. INFO is a plist
1404 holding contextual information."
1405 (let* ((title (org-element-property :name quote-block
))
1406 (start-quote (concat "@quotation"
1408 (format " %s" title
)))))
1409 (format "%s\n%s@end quotation" start-quote contents
)))
1413 (defun org-texinfo-quote-section (quote-section contents info
)
1414 "Transcode a QUOTE-SECTION element from Org to Texinfo.
1415 CONTENTS is nil. INFO is a plist holding contextual information."
1416 (let ((value (org-remove-indentation
1417 (org-element-property :value quote-section
))))
1418 (when value
(format "@verbatim\n%s@end verbatim" value
))))
1422 (defun org-texinfo-radio-target (radio-target text info
)
1423 "Transcode a RADIO-TARGET object from Org to Texinfo.
1424 TEXT is the text of the target. INFO is a plist holding
1425 contextual information."
1426 (format "@anchor{%s}%s"
1427 (org-export-solidify-link-text
1428 (org-element-property :value radio-target
))
1433 (defun org-texinfo-section (section contents info
)
1434 "Transcode a SECTION element from Org to Texinfo.
1435 CONTENTS holds the contents of the section. INFO is a plist
1436 holding contextual information."
1441 (defun org-texinfo-special-block (special-block contents info
)
1442 "Transcode a SPECIAL-BLOCK element from Org to Texinfo.
1443 CONTENTS holds the contents of the block. INFO is a plist used
1444 as a communication channel."
1449 (defun org-texinfo-src-block (src-block contents info
)
1450 "Transcode a SRC-BLOCK element from Org to Texinfo.
1451 CONTENTS holds the contents of the item. INFO is a plist holding
1452 contextual information."
1453 (let* ((lang (org-element-property :language src-block
))
1454 (lisp-p (string-match-p "lisp" lang
))
1455 (src-contents (org-texinfo--sanitize-content
1456 (org-export-format-code-default src-block info
))))
1458 ;; Case 1. Lisp Block
1460 (format "@lisp\n%s@end lisp"
1462 ;; Case 2. Other blocks
1464 (format "@example\n%s@end example"
1467 ;;; Statistics Cookie
1469 (defun org-texinfo-statistics-cookie (statistics-cookie contents info
)
1470 "Transcode a STATISTICS-COOKIE object from Org to Texinfo.
1471 CONTENTS is nil. INFO is a plist holding contextual information."
1472 (org-element-property :value statistics-cookie
))
1476 (defun org-texinfo-subscript (subscript contents info
)
1477 "Transcode a SUBSCRIPT object from Org to Texinfo.
1478 CONTENTS is the contents of the object. INFO is a plist holding
1479 contextual information."
1480 (format "@math{_%s}" contents
))
1484 (defun org-texinfo-superscript (superscript contents info
)
1485 "Transcode a SUPERSCRIPT object from Org to Texinfo.
1486 CONTENTS is the contents of the object. INFO is a plist holding
1487 contextual information."
1488 (format "@math{^%s}" contents
))
1492 ;; `org-texinfo-table' is the entry point for table transcoding. It
1493 ;; takes care of tables with a "verbatim" attribute. Otherwise, it
1494 ;; delegates the job to either `org-texinfo-table--table.el-table' or
1495 ;; `org-texinfo-table--org-table' functions, depending of the type of
1498 ;; `org-texinfo-table--align-string' is a subroutine used to build
1499 ;; alignment string for Org tables.
1501 (defun org-texinfo-table (table contents info
)
1502 "Transcode a TABLE element from Org to Texinfo.
1503 CONTENTS is the contents of the table. INFO is a plist holding
1504 contextual information."
1506 ;; Case 1: verbatim table.
1507 ((or org-texinfo-tables-verbatim
1508 (let ((attr (mapconcat 'identity
1509 (org-element-property :attr_latex table
)
1511 (and attr
(string-match "\\<verbatim\\>" attr
))))
1512 (format "@verbatim \n%s\n@end verbatim"
1513 ;; Re-create table, without affiliated keywords.
1515 (org-element-interpret-data
1516 `(table nil
,@(org-element-contents table
))))))
1517 ;; Case 2: table.el table. Convert it using appropriate tools.
1518 ((eq (org-element-property :type table
) 'table.el
)
1519 (org-texinfo-table--table.el-table table contents info
))
1520 ;; Case 3: Standard table.
1521 (t (org-texinfo-table--org-table table contents info
))))
1523 (defun org-texinfo-table-column-widths (table info
)
1524 "Determine the largest table cell in each column to process alignment.
1526 TABLE is the table element to transcode. INFO is a plist used as
1527 a communication channel."
1528 (let* ((rows (org-element-map table
'table-row
'identity info
))
1529 (collected (loop for row in rows collect
1530 (org-element-map row
'table-cell
'identity info
)))
1531 (number-cells (length (car collected
)))
1533 (loop for row in collected do
1534 (push (mapcar (lambda (ref)
1535 (let* ((start (org-element-property :contents-begin ref
))
1536 (end (org-element-property :contents-end ref
))
1537 (length (- end start
)))
1538 length
)) row
) cells
))
1539 (setq cells
(org-remove-if 'null cells
))
1540 (push (loop for count from
0 to
(- number-cells
1) collect
1541 (loop for item in cells collect
1542 (nth count item
))) counts
)
1543 (mapconcat (lambda (size)
1544 (make-string size ?a
)) (mapcar (lambda (ref)
1545 (apply 'max
`(,@ref
))) (car counts
))
1548 (defun org-texinfo-table--org-table (table contents info
)
1549 "Return appropriate Texinfo code for an Org table.
1551 TABLE is the table type element to transcode. CONTENTS is its
1552 contents, as a string. INFO is a plist used as a communication
1555 This function assumes TABLE has `org' as its `:type' attribute."
1556 (let* ((attr (org-export-read-attribute :attr_texinfo table
))
1557 (col-width (plist-get attr
:columns
))
1558 (columns (if col-width
1559 (format "@columnfractions %s"
1562 (org-texinfo-table-column-widths
1564 ;; Prepare the final format string for the table.
1569 (format "@multitable %s\n%s@end multitable"
1573 (defun org-texinfo-table--table.el-table
(table contents info
)
1576 Rather than return an invalid table, nothing is returned."
1581 (defun org-texinfo-table-cell (table-cell contents info
)
1582 "Transcode a TABLE-CELL element from Org to Texinfo.
1583 CONTENTS is the cell contents. INFO is a plist used as
1584 a communication channel."
1585 (concat (if (and contents
1586 org-texinfo-table-scientific-notation
1587 (string-match orgtbl-exp-regexp contents
))
1588 ;; Use appropriate format string for scientific
1590 (format org-texinfo-table-scientific-notation
1591 (match-string 1 contents
)
1592 (match-string 2 contents
))
1594 (when (org-export-get-next-element table-cell info
) "\n@tab ")))
1598 (defun org-texinfo-table-row (table-row contents info
)
1599 "Transcode a TABLE-ROW element from Org to Texinfo.
1600 CONTENTS is the contents of the row. INFO is a plist used as
1601 a communication channel."
1602 ;; Rules are ignored since table separators are deduced from
1603 ;; borders of the current row.
1604 (when (eq (org-element-property :type table-row
) 'standard
)
1607 ;; Case 1: Belongs to second or subsequent rowgroup.
1608 ((not (= 1 (org-export-table-row-group table-row info
)))
1610 ;; Case 2: Row is from first rowgroup. Table has >=1 rowgroups.
1611 ((org-export-table-has-header-p
1612 (org-export-get-parent-table table-row
) info
)
1614 ;; Case 3: Row is from first and only row group.
1616 (when (eq (org-element-property :type table-row
) 'standard
)
1617 (concat rowgroup-tag contents
"\n")))))
1621 (defun org-texinfo-target (target contents info
)
1622 "Transcode a TARGET object from Org to Texinfo.
1623 CONTENTS is nil. INFO is a plist holding contextual
1625 (format "@anchor{%s}"
1626 (org-export-solidify-link-text (org-element-property :value target
))))
1630 (defun org-texinfo-timestamp (timestamp contents info
)
1631 "Transcode a TIMESTAMP object from Org to Texinfo.
1632 CONTENTS is nil. INFO is a plist holding contextual
1634 (let ((value (org-texinfo-plain-text
1635 (org-timestamp-translate timestamp
) info
)))
1636 (case (org-element-property :type timestamp
)
1637 ((active active-range
)
1638 (format org-texinfo-active-timestamp-format value
))
1639 ((inactive inactive-range
)
1640 (format org-texinfo-inactive-timestamp-format value
))
1641 (t (format org-texinfo-diary-timestamp-format value
)))))
1645 (defun org-texinfo-verbatim (verbatim contents info
)
1646 "Transcode a VERBATIM object from Org to Texinfo.
1647 CONTENTS is nil. INFO is a plist used as a communication
1649 (org-texinfo--text-markup (org-element-property :value verbatim
) 'verbatim
))
1653 (defun org-texinfo-verse-block (verse-block contents info
)
1654 "Transcode a VERSE-BLOCK element from Org to Texinfo.
1655 CONTENTS is verse block contents. INFO is a plist holding
1656 contextual information."
1657 ;; In a verse environment, add a line break to each newline
1658 ;; character and change each white space at beginning of a line
1659 ;; into a space of 1 em. Also change each blank line with
1660 ;; a vertical space of 1 em.
1662 (setq contents
(replace-regexp-in-string
1663 "^ *\\\\\\\\$" "\\\\vspace*{1em}"
1664 (replace-regexp-in-string
1665 "\\(\\\\\\\\\\)?[ \t]*\n" " \\\\\\\\\n" contents
)))
1666 (while (string-match "^[ \t]+" contents
)
1667 (let ((new-str (format "\\hspace*{%dem}"
1668 (length (match-string 0 contents
)))))
1669 (setq contents
(replace-match new-str nil t contents
))))
1670 (format "\\begin{verse}\n%s\\end{verse}" contents
)))
1673 ;;; Interactive functions
1675 (defun org-texinfo-export-to-texinfo
1676 (&optional async subtreep visible-only body-only ext-plist
)
1677 "Export current buffer to a Texinfo file.
1679 If narrowing is active in the current buffer, only export its
1682 If a region is active, export that region.
1684 A non-nil optional argument ASYNC means the process should happen
1685 asynchronously. The resulting file should be accessible through
1686 the `org-export-stack' interface.
1688 When optional argument SUBTREEP is non-nil, export the sub-tree
1689 at point, extracting information from the headline properties
1692 When optional argument VISIBLE-ONLY is non-nil, don't export
1693 contents of hidden elements.
1695 When optional argument BODY-ONLY is non-nil, only write code
1696 between \"\\begin{document}\" and \"\\end{document}\".
1698 EXT-PLIST, when provided, is a property list with external
1699 parameters overriding Org default settings, but still inferior to
1700 file-local settings.
1702 Return output file's name."
1704 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1705 (org-export-coding-system `,org-texinfo-coding-system
))
1706 (org-export-to-file 'texinfo outfile
1707 async subtreep visible-only body-only ext-plist
)))
1709 (defun org-texinfo-export-to-info
1710 (&optional async subtreep visible-only body-only ext-plist
)
1711 "Export current buffer to Texinfo then process through to INFO.
1713 If narrowing is active in the current buffer, only export its
1716 If a region is active, export that region.
1718 A non-nil optional argument ASYNC means the process should happen
1719 asynchronously. The resulting file should be accessible through
1720 the `org-export-stack' interface.
1722 When optional argument SUBTREEP is non-nil, export the sub-tree
1723 at point, extracting information from the headline properties
1726 When optional argument VISIBLE-ONLY is non-nil, don't export
1727 contents of hidden elements.
1729 When optional argument BODY-ONLY is non-nil, only write code
1730 between \"\\begin{document}\" and \"\\end{document}\".
1732 EXT-PLIST, when provided, is a property list with external
1733 parameters overriding Org default settings, but still inferior to
1734 file-local settings.
1736 When optional argument PUB-DIR is set, use it as the publishing
1739 Return INFO file's name."
1741 (let ((outfile (org-export-output-file-name ".texi" subtreep
))
1742 (org-export-coding-system `,org-texinfo-coding-system
))
1743 (org-export-to-file 'texinfo outfile
1744 async subtreep visible-only body-only ext-plist
1745 (lambda (file) (org-texinfo-compile file
)))))
1748 (defun org-texinfo-publish-to-texinfo (plist filename pub-dir
)
1749 "Publish an org file to Texinfo.
1751 FILENAME is the filename of the Org file to be published. PLIST
1752 is the property list for the given project. PUB-DIR is the
1753 publishing directory.
1755 Return output file name."
1756 (org-publish-org-to 'texinfo filename
".texi" plist pub-dir
))
1759 (defun org-texinfo-convert-region-to-texinfo ()
1760 "Assume the current region has org-mode syntax, and convert it to Texinfo.
1761 This can be used in any buffer. For example, you can write an
1762 itemized list in org-mode syntax in an Texinfo buffer and use
1763 this command to convert it."
1765 (org-export-replace-region-by 'texinfo
))
1767 (defun org-texinfo-compile (file)
1768 "Compile a texinfo file.
1770 FILE is the name of the file being compiled. Processing is
1771 done through the command specified in `org-texinfo-info-process'.
1773 Return INFO file name or an error if it couldn't be produced."
1774 (let* ((base-name (file-name-sans-extension (file-name-nondirectory file
)))
1775 (full-name (file-truename file
))
1776 (out-dir (file-name-directory file
))
1777 ;; Properly set working directory for compilation.
1778 (default-directory (if (file-name-absolute-p file
)
1779 (file-name-directory full-name
)
1782 (message (format "Processing Texinfo file %s..." file
))
1783 (save-window-excursion
1785 ;; A function is provided: Apply it.
1786 ((functionp org-texinfo-info-process
)
1787 (funcall org-texinfo-info-process
(shell-quote-argument file
)))
1788 ;; A list is provided: Replace %b, %f and %o with appropriate
1789 ;; values in each command before applying it. Output is
1790 ;; redirected to "*Org INFO Texinfo Output*" buffer.
1791 ((consp org-texinfo-info-process
)
1792 (let ((outbuf (get-buffer-create "*Org INFO Texinfo Output*")))
1796 (replace-regexp-in-string
1797 "%b" (shell-quote-argument base-name
)
1798 (replace-regexp-in-string
1799 "%f" (shell-quote-argument full-name
)
1800 (replace-regexp-in-string
1801 "%o" (shell-quote-argument out-dir
) command t t
) t t
) t t
)
1803 org-texinfo-info-process
)
1804 ;; Collect standard errors from output buffer.
1805 (setq errors
(org-texinfo-collect-errors outbuf
))))
1806 (t (error "No valid command to process to Info")))
1807 (let ((infofile (concat out-dir base-name
".info")))
1808 ;; Check for process failure. Provide collected errors if
1810 (if (not (file-exists-p infofile
))
1811 (error (concat (format "INFO file %s wasn't produced" infofile
)
1812 (when errors
(concat ": " errors
))))
1813 ;; Else remove log files, when specified, and signal end of
1814 ;; process to user, along with any error encountered.
1815 (when org-texinfo-remove-logfiles
1816 (dolist (ext org-texinfo-logfiles-extensions
)
1817 (let ((file (concat out-dir base-name
"." ext
)))
1818 (when (file-exists-p file
) (delete-file file
)))))
1819 (message (concat "Process completed"
1820 (if (not errors
) "."
1821 (concat " with errors: " errors
)))))
1822 ;; Return output file name.
1825 (defun org-texinfo-collect-errors (buffer)
1826 "Collect some kind of errors from \"makeinfo\" command output.
1828 BUFFER is the buffer containing output.
1830 Return collected error types as a string, or nil if there was
1832 (with-current-buffer buffer
1834 (goto-char (point-min))
1835 ;; Find final "makeinfo" run.
1837 (let ((case-fold-search t
)
1839 (when (save-excursion
1840 (re-search-forward "perhaps incorrect sectioning?" nil t
))
1841 (setq errors
(concat errors
" [incorrect sectioning]")))
1842 (when (save-excursion
1843 (re-search-forward "missing close brace" nil t
))
1844 (setq errors
(concat errors
" [syntax error]")))
1845 (when (save-excursion
1846 (re-search-forward "Unknown command" nil t
))
1847 (setq errors
(concat errors
" [undefined @command]")))
1848 (when (save-excursion
1849 (re-search-forward "No matching @end" nil t
))
1850 (setq errors
(concat errors
" [block incomplete]")))
1851 (when (save-excursion
1852 (re-search-forward "requires a sectioning" nil t
))
1853 (setq errors
(concat errors
" [invalid section command]")))
1854 (when (save-excursion
1855 (re-search-forward "\\[unexpected\]" nil t
))
1856 (setq errors
(concat errors
" [unexpected error]")))
1857 (when (save-excursion
1858 (re-search-forward "misplaced " nil t
))
1859 (setq errors
(concat errors
" [syntax error]")))
1860 (and (org-string-nw-p errors
) (org-trim errors
)))))))
1863 (provide 'ox-texinfo
)
1866 ;; generated-autoload-file: "org-loaddefs.el"
1869 ;;; ox-texinfo.el ends here