ox-texinfo.el 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692
  1. ;;; ox-texinfo.el --- Texinfo Back-End for Org Export Engine -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
  3. ;; Author: Jonathan Leech-Pepin <jonathan.leechpepin at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This file is part of GNU Emacs.
  6. ;; GNU Emacs is free software: you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation, either version 3 of the License, or
  9. ;; (at your option) any later version.
  10. ;; GNU Emacs is distributed in the hope that it will be useful,
  11. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. ;; GNU General Public License for more details.
  14. ;; You should have received a copy of the GNU General Public License
  15. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;;
  18. ;; See Org manual for details.
  19. ;;; Code:
  20. (require 'cl-lib)
  21. (require 'ox)
  22. (defvar orgtbl-exp-regexp)
  23. ;;; Define Back-End
  24. (org-export-define-backend 'texinfo
  25. '((bold . org-texinfo-bold)
  26. (center-block . org-texinfo-center-block)
  27. (clock . org-texinfo-clock)
  28. (code . org-texinfo-code)
  29. (drawer . org-texinfo-drawer)
  30. (dynamic-block . org-texinfo-dynamic-block)
  31. (entity . org-texinfo-entity)
  32. (example-block . org-texinfo-example-block)
  33. (export-block . org-texinfo-export-block)
  34. (export-snippet . org-texinfo-export-snippet)
  35. (fixed-width . org-texinfo-fixed-width)
  36. (footnote-definition . org-texinfo-footnote-definition)
  37. (footnote-reference . org-texinfo-footnote-reference)
  38. (headline . org-texinfo-headline)
  39. (inline-src-block . org-texinfo-inline-src-block)
  40. (inlinetask . org-texinfo-inlinetask)
  41. (italic . org-texinfo-italic)
  42. (item . org-texinfo-item)
  43. (keyword . org-texinfo-keyword)
  44. (line-break . org-texinfo-line-break)
  45. (link . org-texinfo-link)
  46. (node-property . org-texinfo-node-property)
  47. (paragraph . org-texinfo-paragraph)
  48. (plain-list . org-texinfo-plain-list)
  49. (plain-text . org-texinfo-plain-text)
  50. (planning . org-texinfo-planning)
  51. (property-drawer . org-texinfo-property-drawer)
  52. (quote-block . org-texinfo-quote-block)
  53. (radio-target . org-texinfo-radio-target)
  54. (section . org-texinfo-section)
  55. (special-block . org-texinfo-special-block)
  56. (src-block . org-texinfo-src-block)
  57. (statistics-cookie . org-texinfo-statistics-cookie)
  58. (strike-through . org-texinfo-strike-through)
  59. (subscript . org-texinfo-subscript)
  60. (superscript . org-texinfo-superscript)
  61. (table . org-texinfo-table)
  62. (table-cell . org-texinfo-table-cell)
  63. (table-row . org-texinfo-table-row)
  64. (target . org-texinfo-target)
  65. (template . org-texinfo-template)
  66. (timestamp . org-texinfo-timestamp)
  67. (underline . org-texinfo-underline)
  68. (verbatim . org-texinfo-verbatim)
  69. (verse-block . org-texinfo-verse-block))
  70. :filters-alist
  71. '((:filter-headline . org-texinfo--filter-section-blank-lines)
  72. (:filter-parse-tree . org-texinfo--normalize-headlines)
  73. (:filter-section . org-texinfo--filter-section-blank-lines)
  74. (:filter-final-output . org-texinfo--untabify))
  75. :menu-entry
  76. '(?i "Export to Texinfo"
  77. ((?t "As TEXI file" org-texinfo-export-to-texinfo)
  78. (?i "As INFO file" org-texinfo-export-to-info)
  79. (?o "As INFO file and open"
  80. (lambda (a s v b)
  81. (if a (org-texinfo-export-to-info t s v b)
  82. (org-open-file (org-texinfo-export-to-info nil s v b)))))))
  83. :options-alist
  84. '((:texinfo-filename "TEXINFO_FILENAME" nil nil t)
  85. (:texinfo-class "TEXINFO_CLASS" nil org-texinfo-default-class t)
  86. (:texinfo-header "TEXINFO_HEADER" nil nil newline)
  87. (:texinfo-post-header "TEXINFO_POST_HEADER" nil nil newline)
  88. (:subtitle "SUBTITLE" nil nil parse)
  89. (:subauthor "SUBAUTHOR" nil nil newline)
  90. (:texinfo-dircat "TEXINFO_DIR_CATEGORY" nil nil t)
  91. (:texinfo-dirtitle "TEXINFO_DIR_TITLE" nil nil t)
  92. (:texinfo-dirdesc "TEXINFO_DIR_DESC" nil nil t)
  93. (:texinfo-printed-title "TEXINFO_PRINTED_TITLE" nil nil t)
  94. ;; Other variables.
  95. (:texinfo-classes nil nil org-texinfo-classes)
  96. (:texinfo-format-headline-function nil nil org-texinfo-format-headline-function)
  97. (:texinfo-node-description-column nil nil org-texinfo-node-description-column)
  98. (:texinfo-active-timestamp-format nil nil org-texinfo-active-timestamp-format)
  99. (:texinfo-inactive-timestamp-format nil nil org-texinfo-inactive-timestamp-format)
  100. (:texinfo-diary-timestamp-format nil nil org-texinfo-diary-timestamp-format)
  101. (:texinfo-link-with-unknown-path-format nil nil org-texinfo-link-with-unknown-path-format)
  102. (:texinfo-tables-verbatim nil nil org-texinfo-tables-verbatim)
  103. (:texinfo-table-scientific-notation nil nil org-texinfo-table-scientific-notation)
  104. (:texinfo-table-default-markup nil nil org-texinfo-table-default-markup)
  105. (:texinfo-text-markup-alist nil nil org-texinfo-text-markup-alist)
  106. (:texinfo-format-drawer-function nil nil org-texinfo-format-drawer-function)
  107. (:texinfo-format-inlinetask-function nil nil org-texinfo-format-inlinetask-function)))
  108. ;;; User Configurable Variables
  109. (defgroup org-export-texinfo nil
  110. "Options for exporting Org mode files to Texinfo."
  111. :tag "Org Export Texinfo"
  112. :version "24.4"
  113. :package-version '(Org . "8.0")
  114. :group 'org-export)
  115. ;;;; Preamble
  116. (defcustom org-texinfo-coding-system nil
  117. "Default document encoding for Texinfo output.
  118. If nil it will default to `buffer-file-coding-system'."
  119. :group 'org-export-texinfo
  120. :type 'coding-system)
  121. (defcustom org-texinfo-default-class "info"
  122. "The default Texinfo class."
  123. :group 'org-export-texinfo
  124. :type '(string :tag "Texinfo class"))
  125. (defcustom org-texinfo-classes
  126. '(("info"
  127. "@documentencoding AUTO\n@documentlanguage AUTO"
  128. ("@chapter %s" "@unnumbered %s" "@chapheading %s" "@appendix %s")
  129. ("@section %s" "@unnumberedsec %s" "@heading %s" "@appendixsec %s")
  130. ("@subsection %s" "@unnumberedsubsec %s" "@subheading %s"
  131. "@appendixsubsec %s")
  132. ("@subsubsection %s" "@unnumberedsubsubsec %s" "@subsubheading %s"
  133. "@appendixsubsubsec %s")))
  134. "Alist of Texinfo classes and associated header and structure.
  135. If #+TEXINFO_CLASS is set in the buffer, use its value and the
  136. associated information. Here is the structure of a class
  137. definition:
  138. (class-name
  139. header-string
  140. (numbered-1 unnumbered-1 unnumbered-no-toc-1 appendix-1)
  141. (numbered-2 unnumbered-2 unnumbered-no-toc-2 appendix-2)
  142. ...)
  143. The header string
  144. -----------------
  145. The header string is inserted in the header of the generated
  146. document, right after \"@setfilename\" and \"@settitle\"
  147. commands.
  148. If it contains the special string
  149. \"@documentencoding AUTO\"
  150. \"AUTO\" will be replaced with an appropriate coding system. See
  151. `org-texinfo-coding-system' for more information. Likewise, if
  152. the string contains the special string
  153. \"@documentlanguage AUTO\"
  154. \"AUTO\" will be replaced with the language defined in the
  155. buffer, through #+LANGUAGE keyword, or globally, with
  156. `org-export-default-language', which see.
  157. The sectioning structure
  158. ------------------------
  159. The sectioning structure of the class is given by the elements
  160. following the header string. For each sectioning level, a number
  161. of strings is specified. A %s formatter is mandatory in each
  162. section string and will be replaced by the title of the section."
  163. :group 'org-export-texinfo
  164. :version "27.1"
  165. :package-version '(Org . "9.2")
  166. :type '(repeat
  167. (list (string :tag "Texinfo class")
  168. (string :tag "Texinfo header")
  169. (repeat :tag "Levels" :inline t
  170. (choice
  171. (list :tag "Heading"
  172. (string :tag " numbered")
  173. (string :tag " unnumbered")
  174. (string :tag "unnumbered-no-toc")
  175. (string :tag " appendix")))))))
  176. ;;;; Headline
  177. (defcustom org-texinfo-format-headline-function
  178. 'org-texinfo-format-headline-default-function
  179. "Function to format headline text.
  180. This function will be called with 5 arguments:
  181. TODO the todo keyword (string or nil).
  182. TODO-TYPE the type of todo (symbol: `todo', `done', nil)
  183. PRIORITY the priority of the headline (integer or nil)
  184. TEXT the main headline text (string).
  185. TAGS the tags as a list of strings (list of strings or nil).
  186. The function result will be used in the section format string."
  187. :group 'org-export-texinfo
  188. :type 'function
  189. :version "26.1"
  190. :package-version '(Org . "8.3"))
  191. ;;;; Node listing (menu)
  192. (defcustom org-texinfo-node-description-column 32
  193. "Column at which to start the description in the node listings.
  194. If a node title is greater than this length, the description will
  195. be placed after the end of the title."
  196. :group 'org-export-texinfo
  197. :type 'integer)
  198. ;;;; Timestamps
  199. (defcustom org-texinfo-active-timestamp-format "@emph{%s}"
  200. "A printf format string to be applied to active timestamps."
  201. :group 'org-export-texinfo
  202. :type 'string)
  203. (defcustom org-texinfo-inactive-timestamp-format "@emph{%s}"
  204. "A printf format string to be applied to inactive timestamps."
  205. :group 'org-export-texinfo
  206. :type 'string)
  207. (defcustom org-texinfo-diary-timestamp-format "@emph{%s}"
  208. "A printf format string to be applied to diary timestamps."
  209. :group 'org-export-texinfo
  210. :type 'string)
  211. ;;;; Links
  212. (defcustom org-texinfo-link-with-unknown-path-format "@indicateurl{%s}"
  213. "Format string for links with unknown path type."
  214. :group 'org-export-texinfo
  215. :type 'string)
  216. ;;;; Tables
  217. (defcustom org-texinfo-tables-verbatim nil
  218. "When non-nil, tables are exported verbatim."
  219. :group 'org-export-texinfo
  220. :type 'boolean)
  221. (defcustom org-texinfo-table-scientific-notation "%s\\,(%s)"
  222. "Format string to display numbers in scientific notation.
  223. The format should have \"%s\" twice, for mantissa and exponent
  224. \(i.e. \"%s\\\\times10^{%s}\").
  225. When nil, no transformation is made."
  226. :group 'org-export-texinfo
  227. :type '(choice
  228. (string :tag "Format string")
  229. (const :tag "No formatting" nil)))
  230. (defcustom org-texinfo-table-default-markup "@asis"
  231. "Default markup for first column in two-column tables.
  232. This should an indicating command, e.g., \"@code\", \"@kbd\" or
  233. \"@samp\".
  234. It can be overridden locally using the \":indic\" attribute."
  235. :group 'org-export-texinfo
  236. :type 'string
  237. :version "26.1"
  238. :package-version '(Org . "9.1")
  239. :safe #'stringp)
  240. ;;;; Text markup
  241. (defcustom org-texinfo-text-markup-alist '((bold . "@strong{%s}")
  242. (code . code)
  243. (italic . "@emph{%s}")
  244. (verbatim . samp))
  245. "Alist of Texinfo expressions to convert text markup.
  246. The key must be a symbol among `bold', `code', `italic',
  247. `strike-through', `underscore' and `verbatim'. The value is
  248. a formatting string to wrap fontified text with.
  249. Value can also be set to the following symbols: `verb', `samp'
  250. and `code'. With the first one, Org uses \"@verb\" to create
  251. a format string and selects a delimiter character that isn't in
  252. the string. For the other two, Org uses \"@samp\" or \"@code\"
  253. to typeset and protects special characters.
  254. When no association is found for a given markup, text is returned
  255. as-is."
  256. :group 'org-export-texinfo
  257. :version "26.1"
  258. :package-version '(Org . "9.1")
  259. :type 'alist
  260. :options '(bold code italic strike-through underscore verbatim))
  261. ;;;; Drawers
  262. (defcustom org-texinfo-format-drawer-function (lambda (_name contents) contents)
  263. "Function called to format a drawer in Texinfo code.
  264. The function must accept two parameters:
  265. NAME the drawer name, like \"LOGBOOK\"
  266. CONTENTS the contents of the drawer.
  267. The function should return the string to be exported.
  268. The default function simply returns the value of CONTENTS."
  269. :group 'org-export-texinfo
  270. :version "24.4"
  271. :package-version '(Org . "8.2")
  272. :type 'function)
  273. ;;;; Inlinetasks
  274. (defcustom org-texinfo-format-inlinetask-function
  275. 'org-texinfo-format-inlinetask-default-function
  276. "Function called to format an inlinetask in Texinfo code.
  277. The function must accept six parameters:
  278. TODO the todo keyword, as a string
  279. TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
  280. PRIORITY the inlinetask priority, as a string
  281. NAME the inlinetask name, as a string.
  282. TAGS the inlinetask tags, as a list of strings.
  283. CONTENTS the contents of the inlinetask, as a string.
  284. The function should return the string to be exported."
  285. :group 'org-export-texinfo
  286. :type 'function)
  287. ;;;; Compilation
  288. (defcustom org-texinfo-info-process '("makeinfo --no-split %f")
  289. "Commands to process a Texinfo file to an INFO file.
  290. This is a list of strings, each of them will be given to the
  291. shell as a command. %f in the command will be replaced by the
  292. relative file name, %F by the absolute file name, %b by the file
  293. base name (i.e. without directory and extension parts), %o by the
  294. base directory of the file and %O by the absolute file name of
  295. the output file."
  296. :group 'org-export-texinfo
  297. :version "26.1"
  298. :package-version '(Org . "9.1")
  299. :type '(repeat :tag "Shell command sequence"
  300. (string :tag "Shell command")))
  301. (defcustom org-texinfo-logfiles-extensions
  302. '("aux" "toc" "cp" "fn" "ky" "pg" "tp" "vr")
  303. "The list of file extensions to consider as Texinfo logfiles.
  304. The logfiles will be remove if `org-texinfo-remove-logfiles' is
  305. non-nil."
  306. :group 'org-export-texinfo
  307. :type '(repeat (string :tag "Extension")))
  308. (defcustom org-texinfo-remove-logfiles t
  309. "Non-nil means remove the logfiles produced by compiling a Texinfo file.
  310. By default, logfiles are files with these extensions: .aux, .toc,
  311. .cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove,
  312. set `org-texinfo-logfiles-extensions'."
  313. :group 'org-export-latex
  314. :type 'boolean)
  315. ;;; Constants
  316. (defconst org-texinfo-max-toc-depth 4
  317. "Maximum depth for creation of detailed menu listings.
  318. Beyond this depth, Texinfo will not recognize the nodes and will
  319. cause errors. Left as a constant in case this value ever
  320. changes.")
  321. (defconst org-texinfo-supported-coding-systems
  322. '("US-ASCII" "UTF-8" "ISO-8859-15" "ISO-8859-1" "ISO-8859-2" "koi8-r" "koi8-u")
  323. "List of coding systems supported by Texinfo, as strings.
  324. Specified coding system will be matched against these strings.
  325. If two strings share the same prefix (e.g. \"ISO-8859-1\" and
  326. \"ISO-8859-15\"), the most specific one has to be listed first.")
  327. (defconst org-texinfo-inline-image-rules
  328. (list (cons "file"
  329. (regexp-opt '("eps" "pdf" "png" "jpg" "jpeg" "gif" "svg"))))
  330. "Rules characterizing image files that can be inlined.")
  331. ;;; Internal Functions
  332. (defun org-texinfo--untabify (s _backend _info)
  333. "Remove TAB characters in string S."
  334. (replace-regexp-in-string "\t" (make-string tab-width ?\s) s))
  335. (defun org-texinfo--filter-section-blank-lines (headline _backend _info)
  336. "Filter controlling number of blank lines after a section."
  337. (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" "\n\n" headline))
  338. (defun org-texinfo--normalize-headlines (tree _backend info)
  339. "Normalize headlines in TREE.
  340. BACK-END is the symbol specifying back-end used for export. INFO
  341. is a plist used as a communication channel.
  342. Make sure every headline in TREE contains a section, since those
  343. are required to install a menu. Also put exactly one blank line
  344. at the end of each section.
  345. Return new tree."
  346. (org-element-map tree 'headline
  347. (lambda (hl)
  348. (org-element-put-property hl :post-blank 1)
  349. (let ((contents (org-element-contents hl)))
  350. (when contents
  351. (let ((first (org-element-map contents '(headline section)
  352. #'identity info t)))
  353. (unless (eq (org-element-type first) 'section)
  354. (apply #'org-element-set-contents
  355. hl
  356. (cons `(section (:parent ,hl)) contents)))))))
  357. info)
  358. tree)
  359. (defun org-texinfo--find-verb-separator (s)
  360. "Return a character not used in string S.
  361. This is used to choose a separator for constructs like \\verb."
  362. (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
  363. (cl-loop for c across ll
  364. when (not (string-match (regexp-quote (char-to-string c)) s))
  365. return (char-to-string c))))
  366. (defun org-texinfo--text-markup (text markup _info)
  367. "Format TEXT depending on MARKUP text markup.
  368. INFO is a plist used as a communication channel. See
  369. `org-texinfo-text-markup-alist' for details."
  370. (pcase (cdr (assq markup org-texinfo-text-markup-alist))
  371. (`nil text) ;no markup: return raw text
  372. (`code (format "@code{%s}" (org-texinfo--sanitize-content text)))
  373. (`samp (format "@samp{%s}" (org-texinfo--sanitize-content text)))
  374. (`verb
  375. (let ((separator (org-texinfo--find-verb-separator text)))
  376. (format "@verb{%s%s%s}" separator text separator)))
  377. ;; Else use format string.
  378. (fmt (format fmt text))))
  379. (defun org-texinfo--get-node (datum info)
  380. "Return node or anchor associated to DATUM.
  381. DATUM is a headline, a radio-target or a target. INFO is a plist
  382. used as a communication channel. The function guarantees the
  383. node or anchor name is unique."
  384. (let ((cache (plist-get info :texinfo-node-cache)))
  385. (or (cdr (assq datum cache))
  386. (let* ((salt 0)
  387. (basename
  388. (org-texinfo--sanitize-node
  389. (pcase (org-element-type datum)
  390. (`headline
  391. (org-texinfo--sanitize-title
  392. (org-export-get-alt-title datum info) info))
  393. (`radio-target
  394. (org-texinfo--sanitize-title
  395. (org-element-contents datum) info))
  396. (`target
  397. (org-export-data (org-element-property :value datum) info))
  398. (type
  399. (error "Cannot generate node name for type: %S" type)))))
  400. (name basename))
  401. ;; Ensure NAME is unique and not reserved node name "Top".
  402. (while (or (equal name "Top") (rassoc name cache))
  403. (setq name (concat basename (format " (%d)" (cl-incf salt)))))
  404. (plist-put info :texinfo-node-cache (cons (cons datum name) cache))
  405. name))))
  406. (defun org-texinfo--sanitize-node (title)
  407. "Bend string TITLE to node line requirements.
  408. Trim string and collapse multiple whitespace characters as they
  409. are not significant. Replace leading left parenthesis, when
  410. followed by a right parenthesis, with a square bracket. Remove
  411. periods, commas and colons."
  412. (org-trim
  413. (replace-regexp-in-string
  414. "[ \t]+" " "
  415. (replace-regexp-in-string
  416. "[:,.]" ""
  417. (replace-regexp-in-string "\\`(\\(.*?)\\)" "[\\1" title)))))
  418. (defun org-texinfo--sanitize-title (title info)
  419. "Make TITLE suitable as a section name.
  420. TITLE is a string or a secondary string. INFO is the current
  421. export state, as a plist."
  422. (org-export-data-with-backend
  423. title (org-export-toc-entry-backend 'texinfo) info))
  424. (defun org-texinfo--sanitize-content (text)
  425. "Escape special characters in string TEXT.
  426. Special characters are: @ { }"
  427. (replace-regexp-in-string "[@{}]" "@\\&" text))
  428. (defun org-texinfo--wrap-float (value info &optional type label caption short)
  429. "Wrap string VALUE within a @float command.
  430. INFO is the current export state, as a plist. TYPE is float
  431. type, as a string. LABEL is the cross reference label for the
  432. float, as a string. CAPTION and SHORT are, respectively, the
  433. caption and shortcaption used for the float, as secondary
  434. strings (e.g., returned by `org-export-get-caption')."
  435. (let* ((backend
  436. (org-export-toc-entry-backend 'texinfo
  437. (cons 'footnote-reference
  438. (lambda (f c i) (org-export-with-backend 'texinfo f c i)))))
  439. (short-backend
  440. (org-export-toc-entry-backend 'texinfo
  441. '(inline-src-block . ignore)
  442. '(verbatim . ignore)))
  443. (short-str
  444. (if (and short caption)
  445. (format "@shortcaption{%s}\n"
  446. (org-export-data-with-backend short short-backend info))
  447. ""))
  448. (caption-str
  449. (if (or short caption)
  450. (format "@caption{%s}\n"
  451. (org-export-data-with-backend
  452. (or caption short)
  453. (if (equal short-str "") short-backend backend)
  454. info))
  455. "")))
  456. (format "@float %s%s\n%s\n%s%s@end float"
  457. type (if label (concat "," label) "") value caption-str short-str)))
  458. ;;; Template
  459. (defun org-texinfo-template (contents info)
  460. "Return complete document string after Texinfo conversion.
  461. CONTENTS is the transcoded contents string. INFO is a plist
  462. holding export options."
  463. (let ((title (org-export-data (plist-get info :title) info))
  464. ;; Copying data is the contents of the first headline in
  465. ;; parse tree with a non-nil copying property.
  466. (copying (org-element-map (plist-get info :parse-tree) 'headline
  467. (lambda (hl)
  468. (and (org-not-nil (org-element-property :COPYING hl))
  469. (org-element-contents hl)))
  470. info t)))
  471. (concat
  472. "\\input texinfo @c -*- texinfo -*-\n"
  473. "@c %**start of header\n"
  474. (let ((file (or (plist-get info :texinfo-filename)
  475. (let ((f (plist-get info :output-file)))
  476. (and f (concat (file-name-sans-extension f) ".info"))))))
  477. (and file (format "@setfilename %s\n" file)))
  478. (format "@settitle %s\n" title)
  479. ;; Insert class-defined header.
  480. (org-element-normalize-string
  481. (let ((header (nth 1 (assoc (plist-get info :texinfo-class)
  482. org-texinfo-classes)))
  483. (coding
  484. (catch 'coding-system
  485. (let ((case-fold-search t)
  486. (name (symbol-name (or org-texinfo-coding-system
  487. buffer-file-coding-system))))
  488. (dolist (system org-texinfo-supported-coding-systems "UTF-8")
  489. (when (string-match-p (regexp-quote system) name)
  490. (throw 'coding-system system))))))
  491. (language (plist-get info :language))
  492. (case-fold-search nil))
  493. ;; Auto coding system.
  494. (replace-regexp-in-string
  495. "^@documentencoding \\(AUTO\\)$"
  496. coding
  497. (replace-regexp-in-string
  498. "^@documentlanguage \\(AUTO\\)$" language header t nil 1) t nil 1)))
  499. ;; Additional header options set by #+TEXINFO_HEADER.
  500. (let ((texinfo-header (plist-get info :texinfo-header)))
  501. (and texinfo-header (org-element-normalize-string texinfo-header)))
  502. "@c %**end of header\n\n"
  503. ;; Additional options set by #+TEXINFO_POST_HEADER.
  504. (let ((texinfo-post-header (plist-get info :texinfo-post-header)))
  505. (and texinfo-post-header
  506. (org-element-normalize-string texinfo-post-header)))
  507. ;; Copying.
  508. (and copying
  509. (format "@copying\n%s@end copying\n\n"
  510. (org-element-normalize-string
  511. (org-export-data copying info))))
  512. ;; Info directory information. Only supply if both title and
  513. ;; category are provided.
  514. (let ((dircat (plist-get info :texinfo-dircat))
  515. (dirtitle
  516. (let ((title (plist-get info :texinfo-dirtitle)))
  517. (and title
  518. (string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title)
  519. (format "* %s." (match-string 1 title))))))
  520. (when (and dircat dirtitle)
  521. (concat "@dircategory " dircat "\n"
  522. "@direntry\n"
  523. (let ((dirdesc
  524. (let ((desc (plist-get info :texinfo-dirdesc)))
  525. (cond ((not desc) nil)
  526. ((string-suffix-p "." desc) desc)
  527. (t (concat desc "."))))))
  528. (if dirdesc (format "%-23s %s" dirtitle dirdesc) dirtitle))
  529. "\n"
  530. "@end direntry\n\n")))
  531. ;; Title
  532. "@finalout\n"
  533. "@titlepage\n"
  534. (when (plist-get info :with-title)
  535. (concat
  536. (format "@title %s\n"
  537. (or (plist-get info :texinfo-printed-title) title ""))
  538. (let ((subtitle (plist-get info :subtitle)))
  539. (when subtitle
  540. (format "@subtitle %s\n"
  541. (org-export-data subtitle info))))))
  542. (when (plist-get info :with-author)
  543. (concat
  544. ;; Primary author.
  545. (let ((author (org-string-nw-p
  546. (org-export-data (plist-get info :author) info)))
  547. (email (and (plist-get info :with-email)
  548. (org-string-nw-p
  549. (org-export-data (plist-get info :email) info)))))
  550. (cond ((and author email)
  551. (format "@author %s (@email{%s})\n" author email))
  552. (author (format "@author %s\n" author))
  553. (email (format "@author @email{%s}\n" email))))
  554. ;; Other authors.
  555. (let ((subauthor (plist-get info :subauthor)))
  556. (and subauthor
  557. (org-element-normalize-string
  558. (replace-regexp-in-string "^" "@author " subauthor))))))
  559. (and copying "@page\n@vskip 0pt plus 1filll\n@insertcopying\n")
  560. "@end titlepage\n\n"
  561. ;; Table of contents.
  562. (and (plist-get info :with-toc) "@contents\n\n")
  563. ;; Configure Top Node when not for TeX. Also include contents
  564. ;; from the first section of the document.
  565. "@ifnottex\n"
  566. "@node Top\n"
  567. (format "@top %s\n" title)
  568. (let* ((first-section
  569. (org-element-map (plist-get info :parse-tree) 'section
  570. #'identity info t '(headline)))
  571. (top-contents
  572. (org-export-data (org-element-contents first-section) info)))
  573. (and (org-string-nw-p top-contents) (concat "\n" top-contents)))
  574. "@end ifnottex\n\n"
  575. ;; Menu.
  576. (org-texinfo-make-menu (plist-get info :parse-tree) info 'master)
  577. "\n"
  578. ;; Document's body.
  579. contents "\n"
  580. ;; Creator.
  581. (and (plist-get info :with-creator)
  582. (concat (plist-get info :creator) "\n"))
  583. ;; Document end.
  584. "@bye")))
  585. ;;; Transcode Functions
  586. ;;;; Bold
  587. (defun org-texinfo-bold (_bold contents info)
  588. "Transcode BOLD from Org to Texinfo.
  589. CONTENTS is the text with bold markup. INFO is a plist holding
  590. contextual information."
  591. (org-texinfo--text-markup contents 'bold info))
  592. ;;;; Center Block
  593. (defun org-texinfo-center-block (_center-block contents _info)
  594. "Transcode a CENTER-BLOCK element from Org to Texinfo.
  595. CONTENTS holds the contents of the block. INFO is a plist used
  596. as a communication channel."
  597. contents)
  598. ;;;; Clock
  599. (defun org-texinfo-clock (clock _contents info)
  600. "Transcode a CLOCK element from Org to Texinfo.
  601. CONTENTS is nil. INFO is a plist holding contextual
  602. information."
  603. (concat
  604. "@noindent"
  605. (format "@strong{%s} " org-clock-string)
  606. (format (plist-get info :texinfo-inactive-timestamp-format)
  607. (concat (org-timestamp-translate (org-element-property :value clock))
  608. (let ((time (org-element-property :duration clock)))
  609. (and time (format " (%s)" time)))))
  610. "@*"))
  611. ;;;; Code
  612. (defun org-texinfo-code (code _contents info)
  613. "Transcode a CODE object from Org to Texinfo.
  614. CONTENTS is nil. INFO is a plist used as a communication
  615. channel."
  616. (org-texinfo--text-markup (org-element-property :value code) 'code info))
  617. ;;;; Drawer
  618. (defun org-texinfo-drawer (drawer contents info)
  619. "Transcode a DRAWER element from Org to Texinfo.
  620. CONTENTS holds the contents of the block. INFO is a plist
  621. holding contextual information."
  622. (let* ((name (org-element-property :drawer-name drawer))
  623. (output (funcall (plist-get info :texinfo-format-drawer-function)
  624. name contents)))
  625. output))
  626. ;;;; Dynamic Block
  627. (defun org-texinfo-dynamic-block (_dynamic-block contents _info)
  628. "Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
  629. CONTENTS holds the contents of the block. INFO is a plist
  630. holding contextual information."
  631. contents)
  632. ;;;; Entity
  633. (defun org-texinfo-entity (entity _contents _info)
  634. "Transcode an ENTITY object from Org to Texinfo."
  635. ;; Since there is not specific Texinfo entry in entities, use
  636. ;; Texinfo-specific commands whenever possible, and fallback to
  637. ;; UTF-8 otherwise.
  638. (pcase (org-element-property :name entity)
  639. ("AElig" "@AE{}")
  640. ("aelig" "@ae{}")
  641. ((or "bull" "bullet") "@bullet{}")
  642. ("copy" "@copyright{}")
  643. ("deg" "@textdegree{}")
  644. ((or "dots" "hellip") "@dots{}")
  645. ("equiv" "@equiv{}")
  646. ((or "euro" "EUR") "@euro{}")
  647. ((or "ge" "geq") "@geq{}")
  648. ("laquo" "@guillemetleft{}")
  649. ("iexcl" "@exclamdown{}")
  650. ("imath" "@dotless{i}")
  651. ("iquest" "@questiondown{}")
  652. ("jmath" "@dotless{j}")
  653. ((or "le" "leq") "@leq{}")
  654. ("lsaquo" "@guilsinglleft{}")
  655. ("mdash" "---")
  656. ("minus" "@minus{}")
  657. ("nbsp" "@tie{}")
  658. ("ndash" "--")
  659. ("OElig" "@OE{}")
  660. ("oelig" "@oe{}")
  661. ("ordf" "@ordf{}")
  662. ("ordm" "@ordm{}")
  663. ("pound" "@pound{}")
  664. ("raquo" "@guillemetright{}")
  665. ((or "rArr" "Rightarrow") "@result{}")
  666. ("reg" "@registeredsymbol{}")
  667. ((or "rightarrow" "to" "rarr") "@arrow{}")
  668. ("rsaquo" "@guilsinglright{}")
  669. ("thorn" "@th{}")
  670. ("THORN" "@TH{}")
  671. ((and (pred (string-prefix-p "_")) name) ;spacing entities
  672. (format "@w{%s}" (substring name 1)))
  673. (_ (org-element-property :utf-8 entity))))
  674. ;;;; Example Block
  675. (defun org-texinfo-example-block (example-block _contents info)
  676. "Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
  677. CONTENTS is nil. INFO is a plist holding contextual
  678. information."
  679. (format "@example\n%s@end example"
  680. (org-texinfo--sanitize-content
  681. (org-export-format-code-default example-block info))))
  682. ;;; Export Block
  683. (defun org-texinfo-export-block (export-block _contents _info)
  684. "Transcode a EXPORT-BLOCK element from Org to Texinfo.
  685. CONTENTS is nil. INFO is a plist holding contextual information."
  686. (when (string= (org-element-property :type export-block) "TEXINFO")
  687. (org-remove-indentation (org-element-property :value export-block))))
  688. ;;; Export Snippet
  689. (defun org-texinfo-export-snippet (export-snippet _contents _info)
  690. "Transcode a EXPORT-SNIPPET object from Org to Texinfo.
  691. CONTENTS is nil. INFO is a plist holding contextual information."
  692. (when (eq (org-export-snippet-backend export-snippet) 'texinfo)
  693. (org-element-property :value export-snippet)))
  694. ;;;; Fixed Width
  695. (defun org-texinfo-fixed-width (fixed-width _contents _info)
  696. "Transcode a FIXED-WIDTH element from Org to Texinfo.
  697. CONTENTS is nil. INFO is a plist holding contextual information."
  698. (format "@example\n%s@end example"
  699. (org-remove-indentation
  700. (org-texinfo--sanitize-content
  701. (org-element-property :value fixed-width)))))
  702. ;;;; Footnote Reference
  703. (defun org-texinfo-footnote-reference (footnote _contents info)
  704. "Create a footnote reference for FOOTNOTE.
  705. FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
  706. plist holding contextual information."
  707. (let ((def (org-export-get-footnote-definition footnote info)))
  708. (format "@footnote{%s}"
  709. (org-trim (org-export-data def info)))))
  710. ;;;; Headline
  711. (defun org-texinfo-headline (headline contents info)
  712. "Transcode a HEADLINE element from Org to Texinfo.
  713. CONTENTS holds the contents of the headline. INFO is a plist
  714. holding contextual information."
  715. (cond
  716. ((org-element-property :footnote-section-p headline) nil)
  717. ((org-not-nil (org-export-get-node-property :COPYING headline t)) nil)
  718. (t
  719. (let* ((index (let ((i (org-export-get-node-property :INDEX headline t)))
  720. (and (member i '("cp" "fn" "ky" "pg" "tp" "vr")) i)))
  721. (numbered? (org-export-numbered-headline-p headline info))
  722. (notoc? (org-export-excluded-from-toc-p headline info))
  723. (command
  724. (and
  725. (not (org-export-low-level-p headline info))
  726. (let ((class (plist-get info :texinfo-class)))
  727. (pcase (assoc class (plist-get info :texinfo-classes))
  728. (`(,_ ,_ . ,sections)
  729. (pcase (nth (1- (org-export-get-relative-level headline info))
  730. sections)
  731. (`(,numbered ,unnumbered ,unnumbered-no-toc ,appendix)
  732. (cond
  733. ((org-not-nil
  734. (org-export-get-node-property :APPENDIX headline t))
  735. appendix)
  736. (numbered? numbered)
  737. (index unnumbered)
  738. (notoc? unnumbered-no-toc)
  739. (t unnumbered)))
  740. (`nil nil)
  741. (_ (user-error "Invalid Texinfo class specification: %S"
  742. class))))
  743. (_ (user-error "Unknown Texinfo class: %S" class))))))
  744. (todo
  745. (and (plist-get info :with-todo-keywords)
  746. (let ((todo (org-element-property :todo-keyword headline)))
  747. (and todo (org-export-data todo info)))))
  748. (todo-type (and todo (org-element-property :todo-type headline)))
  749. (tags (and (plist-get info :with-tags)
  750. (org-export-get-tags headline info)))
  751. (priority (and (plist-get info :with-priority)
  752. (org-element-property :priority headline)))
  753. (text (org-texinfo--sanitize-title
  754. (org-element-property :title headline) info))
  755. (full-text
  756. (funcall (plist-get info :texinfo-format-headline-function)
  757. todo todo-type priority text tags))
  758. (contents
  759. (concat "\n"
  760. (if (org-string-nw-p contents) (concat "\n" contents) "")
  761. (and index (format "\n@printindex %s\n" index)))))
  762. (if (not command)
  763. (concat (and (org-export-first-sibling-p headline info)
  764. (format "@%s\n" (if numbered? 'enumerate 'itemize)))
  765. "@item\n" full-text "\n"
  766. contents
  767. (if (org-export-last-sibling-p headline info)
  768. (format "@end %s" (if numbered? 'enumerate 'itemize))
  769. "\n"))
  770. (concat
  771. ;; Even if HEADLINE is using @subheading and al., leave an
  772. ;; anchor so cross-references in the Org document still work.
  773. (format (if notoc? "@anchor{%s}\n" "@node %s\n")
  774. (org-texinfo--get-node headline info))
  775. (format command full-text)
  776. contents))))))
  777. (defun org-texinfo-format-headline-default-function
  778. (todo _todo-type priority text tags)
  779. "Default format function for a headline.
  780. See `org-texinfo-format-headline-function' for details."
  781. (concat (when todo (format "@strong{%s} " todo))
  782. (when priority (format "@emph{#%s} " priority))
  783. text
  784. (when tags (format " :%s:" (mapconcat 'identity tags ":")))))
  785. ;;;; Inline Src Block
  786. (defun org-texinfo-inline-src-block (inline-src-block _contents _info)
  787. "Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
  788. CONTENTS holds the contents of the item. INFO is a plist holding
  789. contextual information."
  790. (format "@code{%s}"
  791. (org-texinfo--sanitize-content
  792. (org-element-property :value inline-src-block))))
  793. ;;;; Inlinetask
  794. (defun org-texinfo-inlinetask (inlinetask contents info)
  795. "Transcode an INLINETASK element from Org to Texinfo.
  796. CONTENTS holds the contents of the block. INFO is a plist
  797. holding contextual information."
  798. (let ((title (org-export-data (org-element-property :title inlinetask) info))
  799. (todo (and (plist-get info :with-todo-keywords)
  800. (let ((todo (org-element-property :todo-keyword inlinetask)))
  801. (and todo (org-export-data todo info)))))
  802. (todo-type (org-element-property :todo-type inlinetask))
  803. (tags (and (plist-get info :with-tags)
  804. (org-export-get-tags inlinetask info)))
  805. (priority (and (plist-get info :with-priority)
  806. (org-element-property :priority inlinetask))))
  807. (funcall (plist-get info :texinfo-format-inlinetask-function)
  808. todo todo-type priority title tags contents)))
  809. (defun org-texinfo-format-inlinetask-default-function
  810. (todo _todo-type priority title tags contents)
  811. "Default format function for a inlinetasks.
  812. See `org-texinfo-format-inlinetask-function' for details."
  813. (let ((full-title
  814. (concat (when todo (format "@strong{%s} " todo))
  815. (when priority (format "#%c " priority))
  816. title
  817. (when tags (format ":%s:" (mapconcat #'identity tags ":"))))))
  818. (format "@center %s\n\n%s\n" full-title contents)))
  819. ;;;; Italic
  820. (defun org-texinfo-italic (_italic contents info)
  821. "Transcode ITALIC from Org to Texinfo.
  822. CONTENTS is the text with italic markup. INFO is a plist holding
  823. contextual information."
  824. (org-texinfo--text-markup contents 'italic info))
  825. ;;;; Item
  826. (defun org-texinfo-item (item contents info)
  827. "Transcode an ITEM element from Org to Texinfo.
  828. CONTENTS holds the contents of the item. INFO is a plist holding
  829. contextual information."
  830. (let* ((tag (org-element-property :tag item))
  831. (split (org-string-nw-p
  832. (org-export-read-attribute :attr_texinfo
  833. (org-element-property :parent item)
  834. :sep)))
  835. (items (and tag
  836. (let ((tag (org-export-data tag info)))
  837. (if split
  838. (split-string tag (regexp-quote split) t "[ \t\n]+")
  839. (list tag))))))
  840. (format "%s\n%s"
  841. (pcase items
  842. (`nil "@item")
  843. (`(,item) (concat "@item " item))
  844. (`(,item . ,items)
  845. (concat "@item " item "\n"
  846. (mapconcat (lambda (i) (concat "@itemx " i))
  847. items
  848. "\n"))))
  849. (or contents ""))))
  850. ;;;; Keyword
  851. (defun org-texinfo-keyword (keyword _contents info)
  852. "Transcode a KEYWORD element from Org to Texinfo.
  853. CONTENTS is nil. INFO is a plist holding contextual information."
  854. (let ((value (org-element-property :value keyword)))
  855. (pcase (org-element-property :key keyword)
  856. ("TEXINFO" value)
  857. ("CINDEX" (format "@cindex %s" value))
  858. ("FINDEX" (format "@findex %s" value))
  859. ("KINDEX" (format "@kindex %s" value))
  860. ("PINDEX" (format "@pindex %s" value))
  861. ("TINDEX" (format "@tindex %s" value))
  862. ("VINDEX" (format "@vindex %s" value))
  863. ("TOC"
  864. (cond ((string-match-p "\\<tables\\>" value)
  865. (concat "@listoffloats "
  866. (org-export-translate "Table" :utf-8 info)))
  867. ((string-match-p "\\<listings\\>" value)
  868. (concat "@listoffloats "
  869. (org-export-translate "Listing" :utf-8 info))))))))
  870. ;;;; Line Break
  871. (defun org-texinfo-line-break (_line-break _contents _info)
  872. "Transcode a LINE-BREAK object from Org to Texinfo.
  873. CONTENTS is nil. INFO is a plist holding contextual information."
  874. "@*\n")
  875. ;;;; Link
  876. (defun org-texinfo--@ref (datum description info)
  877. "Return @ref command for element or object DATUM.
  878. DESCRIPTION is the printed name of the section, as a string, or
  879. nil."
  880. (let ((node-name (org-texinfo--get-node datum info))
  881. ;; Sanitize DESCRIPTION for cross-reference use. In
  882. ;; particular, remove colons as they seem to cause pain (even
  883. ;; within @asis{...}) to the Texinfo reader.
  884. (title (and description
  885. (replace-regexp-in-string
  886. "[ \t]*:+" ""
  887. (replace-regexp-in-string "," "@comma{}" description)))))
  888. (if (or (not title) (equal title node-name))
  889. (format "@ref{%s}" node-name)
  890. (format "@ref{%s, , %s}" node-name title))))
  891. (defun org-texinfo-link (link desc info)
  892. "Transcode a LINK object from Org to Texinfo.
  893. DESC is the description part of the link, or the empty string.
  894. INFO is a plist holding contextual information. See
  895. `org-export-data'."
  896. (let* ((type (org-element-property :type link))
  897. (raw-path (org-element-property :path link))
  898. ;; Ensure DESC really exists, or set it to nil.
  899. (desc (and (not (string= desc "")) desc))
  900. (path (cond
  901. ((member type '("http" "https" "ftp"))
  902. (concat type ":" raw-path))
  903. ((string= type "file") (org-export-file-uri raw-path))
  904. (t raw-path))))
  905. (cond
  906. ((org-export-custom-protocol-maybe link desc 'texinfo))
  907. ((org-export-inline-image-p link org-texinfo-inline-image-rules)
  908. (org-texinfo--inline-image link info))
  909. ((equal type "radio")
  910. (let ((destination (org-export-resolve-radio-link link info)))
  911. (if (not destination) desc
  912. (org-texinfo--@ref destination desc info))))
  913. ((member type '("custom-id" "id" "fuzzy"))
  914. (let ((destination
  915. (if (equal type "fuzzy")
  916. (org-export-resolve-fuzzy-link link info)
  917. (org-export-resolve-id-link link info))))
  918. (pcase (org-element-type destination)
  919. (`nil
  920. (format org-texinfo-link-with-unknown-path-format
  921. (org-texinfo--sanitize-content path)))
  922. ;; Id link points to an external file.
  923. (`plain-text
  924. (if desc (format "@uref{file://%s,%s}" destination desc)
  925. (format "@uref{file://%s}" destination)))
  926. ((or `headline
  927. ;; Targets within headlines cannot be turned into
  928. ;; @anchor{}, so we refer to the headline parent
  929. ;; directly.
  930. (and `target
  931. (guard (eq 'headline
  932. (org-element-type
  933. (org-element-property :parent destination))))))
  934. (let ((headline (org-element-lineage destination '(headline) t)))
  935. (org-texinfo--@ref headline desc info)))
  936. (_ (org-texinfo--@ref destination desc info)))))
  937. ((string= type "mailto")
  938. (format "@email{%s}"
  939. (concat (org-texinfo--sanitize-content path)
  940. (and desc (concat ", " desc)))))
  941. ;; External link with a description part.
  942. ((and path desc) (format "@uref{%s, %s}" path desc))
  943. ;; External link without a description part.
  944. (path (format "@uref{%s}" path))
  945. ;; No path, only description. Try to do something useful.
  946. (t
  947. (format (plist-get info :texinfo-link-with-unknown-path-format) desc)))))
  948. (defun org-texinfo--inline-image (link info)
  949. "Return Texinfo code for an inline image.
  950. LINK is the link pointing to the inline image. INFO is the
  951. current state of the export, as a plist."
  952. (let* ((parent (org-export-get-parent-element link))
  953. (label (and (org-element-property :name parent)
  954. (org-texinfo--get-node parent info)))
  955. (caption (org-export-get-caption parent))
  956. (shortcaption (org-export-get-caption parent t))
  957. (path (org-element-property :path link))
  958. (filename
  959. (file-name-sans-extension
  960. (if (file-name-absolute-p path) (expand-file-name path) path)))
  961. (extension (file-name-extension path))
  962. (attributes (org-export-read-attribute :attr_texinfo parent))
  963. (height (or (plist-get attributes :height) ""))
  964. (width (or (plist-get attributes :width) ""))
  965. (alt (or (plist-get attributes :alt) ""))
  966. (image (format "@image{%s,%s,%s,%s,%s}"
  967. filename width height alt extension)))
  968. (cond ((or caption shortcaption)
  969. (org-texinfo--wrap-float image
  970. info
  971. (org-export-translate "Figure" :utf-8 info)
  972. label
  973. caption
  974. shortcaption))
  975. (label (concat "@anchor{" label "}\n" image))
  976. (t image))))
  977. ;;;; Menu
  978. (defun org-texinfo-make-menu (scope info &optional master)
  979. "Create the menu for inclusion in the Texinfo document.
  980. SCOPE is a headline or a full parse tree. INFO is the
  981. communication channel, as a plist.
  982. When optional argument MASTER is non-nil, generate a master menu,
  983. including detailed node listing."
  984. (let ((menu (org-texinfo--build-menu scope info)))
  985. (when (org-string-nw-p menu)
  986. (org-element-normalize-string
  987. (format
  988. "@menu\n%s@end menu"
  989. (concat menu
  990. (when master
  991. (let ((detailmenu
  992. (org-texinfo--build-menu
  993. scope info
  994. (let ((toc-depth (plist-get info :with-toc)))
  995. (if (wholenump toc-depth) toc-depth
  996. org-texinfo-max-toc-depth)))))
  997. (when (org-string-nw-p detailmenu)
  998. (concat "\n@detailmenu\n"
  999. "--- The Detailed Node Listing ---\n\n"
  1000. detailmenu
  1001. "@end detailmenu\n"))))))))))
  1002. (defun org-texinfo--build-menu (scope info &optional level)
  1003. "Build menu for entries within SCOPE.
  1004. SCOPE is a headline or a full parse tree. INFO is a plist
  1005. containing contextual information. When optional argument LEVEL
  1006. is an integer, build the menu recursively, down to this depth."
  1007. (cond
  1008. ((not level)
  1009. (org-texinfo--format-entries (org-texinfo--menu-entries scope info) info))
  1010. ((zerop level) "\n")
  1011. (t
  1012. (mapconcat
  1013. (lambda (h)
  1014. (let ((entries (org-texinfo--menu-entries h info)))
  1015. (when entries
  1016. (concat
  1017. (format "%s\n\n%s\n"
  1018. (org-export-data (org-export-get-alt-title h info) info)
  1019. (org-texinfo--format-entries entries info))
  1020. (org-texinfo--build-menu h info (1- level))))))
  1021. (org-texinfo--menu-entries scope info)
  1022. ""))))
  1023. (defun org-texinfo--format-entries (entries info)
  1024. "Format all direct menu entries in SCOPE, as a string.
  1025. SCOPE is either a headline or a full Org document. INFO is
  1026. a plist containing contextual information."
  1027. (org-element-normalize-string
  1028. (mapconcat
  1029. (lambda (h)
  1030. (let* ((title
  1031. ;; Colons are used as a separator between title and node
  1032. ;; name. Remove them.
  1033. (replace-regexp-in-string
  1034. "[ \t]+:+" ""
  1035. (org-texinfo--sanitize-title
  1036. (org-export-get-alt-title h info) info)))
  1037. (node (org-texinfo--get-node h info))
  1038. (entry (concat "* " title ":"
  1039. (if (string= title node) ":"
  1040. (concat " " node ". "))))
  1041. (desc (org-element-property :DESCRIPTION h)))
  1042. (if (not desc) entry
  1043. (format (format "%%-%ds %%s" org-texinfo-node-description-column)
  1044. entry desc))))
  1045. entries "\n")))
  1046. (defun org-texinfo--menu-entries (scope info)
  1047. "List direct children in SCOPE needing a menu entry.
  1048. SCOPE is a headline or a full parse tree. INFO is a plist
  1049. holding contextual information."
  1050. (let* ((cache (or (plist-get info :texinfo-entries-cache)
  1051. (plist-get (plist-put info :texinfo-entries-cache
  1052. (make-hash-table :test #'eq))
  1053. :texinfo-entries-cache)))
  1054. (cached-entries (gethash scope cache 'no-cache)))
  1055. (if (not (eq cached-entries 'no-cache)) cached-entries
  1056. (puthash scope
  1057. (cl-remove-if
  1058. (lambda (h)
  1059. (org-not-nil (org-export-get-node-property :COPYING h t)))
  1060. (org-export-collect-headlines info 1 scope))
  1061. cache))))
  1062. ;;;; Node Property
  1063. (defun org-texinfo-node-property (node-property _contents _info)
  1064. "Transcode a NODE-PROPERTY element from Org to Texinfo.
  1065. CONTENTS is nil. INFO is a plist holding contextual
  1066. information."
  1067. (format "%s:%s"
  1068. (org-element-property :key node-property)
  1069. (let ((value (org-element-property :value node-property)))
  1070. (if value (concat " " value) ""))))
  1071. ;;;; Paragraph
  1072. (defun org-texinfo-paragraph (_paragraph contents _info)
  1073. "Transcode a PARAGRAPH element from Org to Texinfo.
  1074. CONTENTS is the contents of the paragraph, as a string. INFO is
  1075. the plist used as a communication channel."
  1076. contents)
  1077. ;;;; Plain List
  1078. (defun org-texinfo-plain-list (plain-list contents info)
  1079. "Transcode a PLAIN-LIST element from Org to Texinfo.
  1080. CONTENTS is the contents of the list. INFO is a plist holding
  1081. contextual information."
  1082. (let* ((attr (org-export-read-attribute :attr_texinfo plain-list))
  1083. (indic (let ((i (or (plist-get attr :indic)
  1084. (plist-get info :texinfo-table-default-markup))))
  1085. ;; Allow indicating commands with missing @ sign.
  1086. (if (string-prefix-p "@" i) i (concat "@" i))))
  1087. (table-type (plist-get attr :table-type))
  1088. (type (org-element-property :type plain-list))
  1089. (list-type (cond
  1090. ((eq type 'ordered) "enumerate")
  1091. ((eq type 'unordered) "itemize")
  1092. ((member table-type '("ftable" "vtable")) table-type)
  1093. (t "table"))))
  1094. (format "@%s\n%s@end %s"
  1095. (if (eq type 'descriptive) (concat list-type " " indic) list-type)
  1096. contents
  1097. list-type)))
  1098. ;;;; Plain Text
  1099. (defun org-texinfo-plain-text (text info)
  1100. "Transcode a TEXT string from Org to Texinfo.
  1101. TEXT is the string to transcode. INFO is a plist holding
  1102. contextual information."
  1103. ;; First protect @, { and }.
  1104. (let ((output (org-texinfo--sanitize-content text)))
  1105. ;; Activate smart quotes. Be sure to provide original TEXT string
  1106. ;; since OUTPUT may have been modified.
  1107. (when (plist-get info :with-smart-quotes)
  1108. (setq output
  1109. (org-export-activate-smart-quotes output :texinfo info text)))
  1110. ;; LaTeX into @LaTeX{} and TeX into @TeX{}
  1111. (let ((case-fold-search nil))
  1112. (setq output (replace-regexp-in-string "\\(?:La\\)?TeX" "@\\&{}" output)))
  1113. ;; Convert special strings.
  1114. (when (plist-get info :with-special-strings)
  1115. (setq output
  1116. (replace-regexp-in-string
  1117. "\\.\\.\\." "@dots{}"
  1118. (replace-regexp-in-string "\\\\-" "@-" output))))
  1119. ;; Handle break preservation if required.
  1120. (when (plist-get info :preserve-breaks)
  1121. (setq output (replace-regexp-in-string
  1122. "\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output)))
  1123. ;; Return value.
  1124. output))
  1125. ;;;; Planning
  1126. (defun org-texinfo-planning (planning _contents info)
  1127. "Transcode a PLANNING element from Org to Texinfo.
  1128. CONTENTS is nil. INFO is a plist holding contextual
  1129. information."
  1130. (concat
  1131. "@noindent"
  1132. (mapconcat
  1133. 'identity
  1134. (delq nil
  1135. (list
  1136. (let ((closed (org-element-property :closed planning)))
  1137. (when closed
  1138. (concat
  1139. (format "@strong{%s} " org-closed-string)
  1140. (format (plist-get info :texinfo-inactive-timestamp-format)
  1141. (org-timestamp-translate closed)))))
  1142. (let ((deadline (org-element-property :deadline planning)))
  1143. (when deadline
  1144. (concat
  1145. (format "@strong{%s} " org-deadline-string)
  1146. (format (plist-get info :texinfo-active-timestamp-format)
  1147. (org-timestamp-translate deadline)))))
  1148. (let ((scheduled (org-element-property :scheduled planning)))
  1149. (when scheduled
  1150. (concat
  1151. (format "@strong{%s} " org-scheduled-string)
  1152. (format (plist-get info :texinfo-active-timestamp-format)
  1153. (org-timestamp-translate scheduled)))))))
  1154. " ")
  1155. "@*"))
  1156. ;;;; Property Drawer
  1157. (defun org-texinfo-property-drawer (_property-drawer contents _info)
  1158. "Transcode a PROPERTY-DRAWER element from Org to Texinfo.
  1159. CONTENTS holds the contents of the drawer. INFO is a plist
  1160. holding contextual information."
  1161. (and (org-string-nw-p contents)
  1162. (format "@verbatim\n%s@end verbatim" contents)))
  1163. ;;;; Quote Block
  1164. (defun org-texinfo-quote-block (quote-block contents _info)
  1165. "Transcode a QUOTE-BLOCK element from Org to Texinfo.
  1166. CONTENTS holds the contents of the block. INFO is a plist
  1167. holding contextual information."
  1168. (let* ((title (org-element-property :name quote-block))
  1169. (start-quote (concat "@quotation"
  1170. (if title
  1171. (format " %s" title)))))
  1172. (format "%s\n%s@end quotation" start-quote contents)))
  1173. ;;;; Radio Target
  1174. (defun org-texinfo-radio-target (radio-target text info)
  1175. "Transcode a RADIO-TARGET object from Org to Texinfo.
  1176. TEXT is the text of the target. INFO is a plist holding
  1177. contextual information."
  1178. (format "@anchor{%s}%s"
  1179. (org-texinfo--get-node radio-target info)
  1180. text))
  1181. ;;;; Section
  1182. (defun org-texinfo-section (section contents info)
  1183. "Transcode a SECTION element from Org to Texinfo.
  1184. CONTENTS holds the contents of the section. INFO is a plist
  1185. holding contextual information."
  1186. (let ((parent (org-export-get-parent-headline section)))
  1187. (when parent ;first section is handled in `org-texinfo-template'
  1188. (org-trim
  1189. (concat contents
  1190. "\n"
  1191. (and (not (org-export-excluded-from-toc-p parent info))
  1192. (org-texinfo-make-menu parent info)))))))
  1193. ;;;; Special Block
  1194. (defun org-texinfo-special-block (special-block contents _info)
  1195. "Transcode a SPECIAL-BLOCK element from Org to Texinfo.
  1196. CONTENTS holds the contents of the block. INFO is a plist used
  1197. as a communication channel."
  1198. (let ((opt (org-export-read-attribute :attr_texinfo special-block :options))
  1199. (type (org-element-property :type special-block)))
  1200. (format "@%s%s\n%s@end %s"
  1201. type
  1202. (if opt (concat " " opt) "")
  1203. (or contents "")
  1204. type)))
  1205. ;;;; Src Block
  1206. (defun org-texinfo-src-block (src-block _contents info)
  1207. "Transcode a SRC-BLOCK element from Org to Texinfo.
  1208. CONTENTS holds the contents of the item. INFO is a plist holding
  1209. contextual information."
  1210. (let* ((lisp (string-match-p "lisp"
  1211. (org-element-property :language src-block)))
  1212. (code (org-texinfo--sanitize-content
  1213. (org-export-format-code-default src-block info)))
  1214. (value (format
  1215. (if lisp "@lisp\n%s@end lisp" "@example\n%s@end example")
  1216. code))
  1217. (caption (org-export-get-caption src-block))
  1218. (shortcaption (org-export-get-caption src-block t)))
  1219. (if (not (or caption shortcaption)) value
  1220. (org-texinfo--wrap-float value
  1221. info
  1222. (org-export-translate "Listing" :utf-8 info)
  1223. (org-texinfo--get-node src-block info)
  1224. caption
  1225. shortcaption))))
  1226. ;;;; Statistics Cookie
  1227. (defun org-texinfo-statistics-cookie (statistics-cookie _contents _info)
  1228. "Transcode a STATISTICS-COOKIE object from Org to Texinfo.
  1229. CONTENTS is nil. INFO is a plist holding contextual information."
  1230. (org-element-property :value statistics-cookie))
  1231. ;;;; Strike-through
  1232. (defun org-texinfo-strike-through (_strike-through contents info)
  1233. "Transcode STRIKE-THROUGH from Org to Texinfo.
  1234. CONTENTS is the text with strike-through markup. INFO is a plist
  1235. holding contextual information."
  1236. (org-texinfo--text-markup contents 'strike-through info))
  1237. ;;;; Subscript
  1238. (defun org-texinfo-subscript (_subscript contents _info)
  1239. "Transcode a SUBSCRIPT object from Org to Texinfo.
  1240. CONTENTS is the contents of the object. INFO is a plist holding
  1241. contextual information."
  1242. (format "@math{_%s}" contents))
  1243. ;;;; Superscript
  1244. (defun org-texinfo-superscript (_superscript contents _info)
  1245. "Transcode a SUPERSCRIPT object from Org to Texinfo.
  1246. CONTENTS is the contents of the object. INFO is a plist holding
  1247. contextual information."
  1248. (format "@math{^%s}" contents))
  1249. ;;;; Table
  1250. (defun org-texinfo-table (table contents info)
  1251. "Transcode a TABLE element from Org to Texinfo.
  1252. CONTENTS is the contents of the table. INFO is a plist holding
  1253. contextual information."
  1254. (if (eq (org-element-property :type table) 'table.el)
  1255. (format "@verbatim\n%s@end verbatim"
  1256. (org-element-normalize-string
  1257. (org-element-property :value table)))
  1258. (let* ((col-width (org-export-read-attribute :attr_texinfo table :columns))
  1259. (columns
  1260. (if col-width (format "@columnfractions %s" col-width)
  1261. (org-texinfo-table-column-widths table info)))
  1262. (caption (org-export-get-caption table))
  1263. (shortcaption (org-export-get-caption table t))
  1264. (table-str (format "@multitable %s\n%s@end multitable"
  1265. columns
  1266. contents)))
  1267. (if (not (or caption shortcaption)) table-str
  1268. (org-texinfo--wrap-float table-str
  1269. info
  1270. (org-export-translate "Table" :utf-8 info)
  1271. (org-texinfo--get-node table info)
  1272. caption
  1273. shortcaption)))))
  1274. (defun org-texinfo-table-column-widths (table info)
  1275. "Determine the largest table cell in each column to process alignment.
  1276. TABLE is the table element to transcode. INFO is a plist used as
  1277. a communication channel."
  1278. (let ((widths (make-vector (cdr (org-export-table-dimensions table info)) 0)))
  1279. (org-element-map table 'table-row
  1280. (lambda (row)
  1281. (let ((idx 0))
  1282. (org-element-map row 'table-cell
  1283. (lambda (cell)
  1284. ;; Length of the cell in the original buffer is only an
  1285. ;; approximation of the length of the cell in the
  1286. ;; output. It can sometimes fail (e.g. it considers
  1287. ;; "/a/" being larger than "ab").
  1288. (let ((w (- (org-element-property :contents-end cell)
  1289. (org-element-property :contents-begin cell))))
  1290. (aset widths idx (max w (aref widths idx))))
  1291. (cl-incf idx))
  1292. info)))
  1293. info)
  1294. (format "{%s}" (mapconcat (lambda (w) (make-string w ?a)) widths "} {"))))
  1295. ;;;; Table Cell
  1296. (defun org-texinfo-table-cell (table-cell contents info)
  1297. "Transcode a TABLE-CELL element from Org to Texinfo.
  1298. CONTENTS is the cell contents. INFO is a plist used as
  1299. a communication channel."
  1300. (concat
  1301. (let ((scientific-notation
  1302. (plist-get info :texinfo-table-scientific-notation)))
  1303. (if (and contents
  1304. scientific-notation
  1305. (string-match orgtbl-exp-regexp contents))
  1306. ;; Use appropriate format string for scientific notation.
  1307. (format scientific-notation
  1308. (match-string 1 contents)
  1309. (match-string 2 contents))
  1310. contents))
  1311. (when (org-export-get-next-element table-cell info) "\n@tab ")))
  1312. ;;;; Table Row
  1313. (defun org-texinfo-table-row (table-row contents info)
  1314. "Transcode a TABLE-ROW element from Org to Texinfo.
  1315. CONTENTS is the contents of the row. INFO is a plist used as
  1316. a communication channel."
  1317. ;; Rules are ignored since table separators are deduced from
  1318. ;; borders of the current row.
  1319. (when (eq (org-element-property :type table-row) 'standard)
  1320. (let ((rowgroup-tag
  1321. (if (and (= 1 (org-export-table-row-group table-row info))
  1322. (org-export-table-has-header-p
  1323. (org-export-get-parent-table table-row) info))
  1324. "@headitem "
  1325. "@item ")))
  1326. (concat rowgroup-tag contents "\n"))))
  1327. ;;;; Target
  1328. (defun org-texinfo-target (target _contents info)
  1329. "Transcode a TARGET object from Org to Texinfo.
  1330. CONTENTS is nil. INFO is a plist holding contextual
  1331. information."
  1332. (format "@anchor{%s}" (org-texinfo--get-node target info)))
  1333. ;;;; Timestamp
  1334. (defun org-texinfo-timestamp (timestamp _contents info)
  1335. "Transcode a TIMESTAMP object from Org to Texinfo.
  1336. CONTENTS is nil. INFO is a plist holding contextual
  1337. information."
  1338. (let ((value (org-texinfo-plain-text
  1339. (org-timestamp-translate timestamp) info)))
  1340. (pcase (org-element-property :type timestamp)
  1341. ((or `active `active-range)
  1342. (format (plist-get info :texinfo-active-timestamp-format) value))
  1343. ((or `inactive `inactive-range)
  1344. (format (plist-get info :texinfo-inactive-timestamp-format) value))
  1345. (_ (format (plist-get info :texinfo-diary-timestamp-format) value)))))
  1346. ;;;; Underline
  1347. (defun org-texinfo-underline (_underline contents info)
  1348. "Transcode UNDERLINE from Org to Texinfo.
  1349. CONTENTS is the text with underline markup. INFO is a plist
  1350. holding contextual information."
  1351. (org-texinfo--text-markup contents 'underline info))
  1352. ;;;; Verbatim
  1353. (defun org-texinfo-verbatim (verbatim _contents info)
  1354. "Transcode a VERBATIM object from Org to Texinfo.
  1355. CONTENTS is nil. INFO is a plist used as a communication
  1356. channel."
  1357. (org-texinfo--text-markup
  1358. (org-element-property :value verbatim) 'verbatim info))
  1359. ;;;; Verse Block
  1360. (defun org-texinfo-verse-block (_verse-block contents _info)
  1361. "Transcode a VERSE-BLOCK element from Org to Texinfo.
  1362. CONTENTS is verse block contents. INFO is a plist holding
  1363. contextual information."
  1364. (format "@display\n%s@end display" contents))
  1365. ;;; Interactive functions
  1366. ;;;###autoload
  1367. (defun org-texinfo-export-to-texinfo
  1368. (&optional async subtreep visible-only body-only ext-plist)
  1369. "Export current buffer to a Texinfo file.
  1370. If narrowing is active in the current buffer, only export its
  1371. narrowed part.
  1372. If a region is active, export that region.
  1373. A non-nil optional argument ASYNC means the process should happen
  1374. asynchronously. The resulting file should be accessible through
  1375. the `org-export-stack' interface.
  1376. When optional argument SUBTREEP is non-nil, export the sub-tree
  1377. at point, extracting information from the headline properties
  1378. first.
  1379. When optional argument VISIBLE-ONLY is non-nil, don't export
  1380. contents of hidden elements.
  1381. When optional argument BODY-ONLY is non-nil, only write code
  1382. between \"\\begin{document}\" and \"\\end{document}\".
  1383. EXT-PLIST, when provided, is a property list with external
  1384. parameters overriding Org default settings, but still inferior to
  1385. file-local settings.
  1386. Return output file's name."
  1387. (interactive)
  1388. (let ((outfile (org-export-output-file-name ".texi" subtreep))
  1389. (org-export-coding-system org-texinfo-coding-system))
  1390. (org-export-to-file 'texinfo outfile
  1391. async subtreep visible-only body-only ext-plist)))
  1392. ;;;###autoload
  1393. (defun org-texinfo-export-to-info
  1394. (&optional async subtreep visible-only body-only ext-plist)
  1395. "Export current buffer to Texinfo then process through to INFO.
  1396. If narrowing is active in the current buffer, only export its
  1397. narrowed part.
  1398. If a region is active, export that region.
  1399. A non-nil optional argument ASYNC means the process should happen
  1400. asynchronously. The resulting file should be accessible through
  1401. the `org-export-stack' interface.
  1402. When optional argument SUBTREEP is non-nil, export the sub-tree
  1403. at point, extracting information from the headline properties
  1404. first.
  1405. When optional argument VISIBLE-ONLY is non-nil, don't export
  1406. contents of hidden elements.
  1407. When optional argument BODY-ONLY is non-nil, only write code
  1408. between \"\\begin{document}\" and \"\\end{document}\".
  1409. EXT-PLIST, when provided, is a property list with external
  1410. parameters overriding Org default settings, but still inferior to
  1411. file-local settings.
  1412. When optional argument PUB-DIR is set, use it as the publishing
  1413. directory.
  1414. Return INFO file's name."
  1415. (interactive)
  1416. (let ((outfile (org-export-output-file-name ".texi" subtreep))
  1417. (org-export-coding-system org-texinfo-coding-system))
  1418. (org-export-to-file 'texinfo outfile
  1419. async subtreep visible-only body-only ext-plist
  1420. (lambda (file) (org-texinfo-compile file)))))
  1421. ;;;###autoload
  1422. (defun org-texinfo-publish-to-texinfo (plist filename pub-dir)
  1423. "Publish an org file to Texinfo.
  1424. FILENAME is the filename of the Org file to be published. PLIST
  1425. is the property list for the given project. PUB-DIR is the
  1426. publishing directory.
  1427. Return output file name."
  1428. (org-publish-org-to 'texinfo filename ".texi" plist pub-dir))
  1429. ;;;###autoload
  1430. (defun org-texinfo-convert-region-to-texinfo ()
  1431. "Assume the current region has Org syntax, and convert it to Texinfo.
  1432. This can be used in any buffer. For example, you can write an
  1433. itemized list in Org syntax in an Texinfo buffer and use this
  1434. command to convert it."
  1435. (interactive)
  1436. (org-export-replace-region-by 'texinfo))
  1437. (defun org-texinfo-compile (file)
  1438. "Compile a texinfo file.
  1439. FILE is the name of the file being compiled. Processing is done
  1440. through the command specified in `org-texinfo-info-process',
  1441. which see. Output is redirected to \"*Org INFO Texinfo Output*\"
  1442. buffer.
  1443. Return INFO file name or an error if it couldn't be produced."
  1444. (message "Processing Texinfo file %s..." file)
  1445. (let* ((log-name "*Org INFO Texinfo Output*")
  1446. (log (get-buffer-create log-name))
  1447. (output
  1448. (org-compile-file file org-texinfo-info-process "info"
  1449. (format "See %S for details" log-name)
  1450. log)))
  1451. (when org-texinfo-remove-logfiles
  1452. (let ((base (file-name-sans-extension output)))
  1453. (dolist (ext org-texinfo-logfiles-extensions)
  1454. (let ((file (concat base "." ext)))
  1455. (when (file-exists-p file) (delete-file file))))))
  1456. (message "Process completed.")
  1457. output))
  1458. (provide 'ox-texinfo)
  1459. ;; Local variables:
  1460. ;; generated-autoload-file: "org-loaddefs.el"
  1461. ;; End:
  1462. ;;; ox-texinfo.el ends here