2015-11-05 18:11:00 -05:00
|
|
|
|
;;; ox-texinfo.el --- Texinfo Back-End for Org Export Engine -*- lexical-binding: t; -*-
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2016-01-09 17:12:03 -05:00
|
|
|
|
;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Author: Jonathan Leech-Pepin <jonathan.leechpepin at gmail dot com>
|
|
|
|
|
;; Keywords: outlines, hypermedia, calendar, wp
|
2013-02-23 03:56:24 -05:00
|
|
|
|
|
2013-02-23 02:59:23 -05:00
|
|
|
|
;; This file is part of GNU Emacs.
|
2013-02-23 03:56:24 -05:00
|
|
|
|
|
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
2013-02-23 03:56:24 -05:00
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
2013-02-23 03:56:24 -05:00
|
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
;;
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;; See Org manual for details.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
|
|
(eval-when-compile (require 'cl))
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(require 'ox)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
(defvar orgtbl-exp-regexp)
|
|
|
|
|
|
2012-09-09 07:08:52 -04:00
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
;;; Define Back-End
|
|
|
|
|
|
2013-03-19 11:24:40 -04:00
|
|
|
|
(org-export-define-backend 'texinfo
|
|
|
|
|
'((bold . org-texinfo-bold)
|
|
|
|
|
(center-block . org-texinfo-center-block)
|
|
|
|
|
(clock . org-texinfo-clock)
|
|
|
|
|
(code . org-texinfo-code)
|
|
|
|
|
(drawer . org-texinfo-drawer)
|
|
|
|
|
(dynamic-block . org-texinfo-dynamic-block)
|
|
|
|
|
(entity . org-texinfo-entity)
|
|
|
|
|
(example-block . org-texinfo-example-block)
|
2014-09-08 05:57:27 -04:00
|
|
|
|
(export-block . org-texinfo-export-block)
|
2013-03-19 11:24:40 -04:00
|
|
|
|
(export-snippet . org-texinfo-export-snippet)
|
|
|
|
|
(fixed-width . org-texinfo-fixed-width)
|
|
|
|
|
(footnote-definition . org-texinfo-footnote-definition)
|
|
|
|
|
(footnote-reference . org-texinfo-footnote-reference)
|
|
|
|
|
(headline . org-texinfo-headline)
|
|
|
|
|
(inline-src-block . org-texinfo-inline-src-block)
|
|
|
|
|
(inlinetask . org-texinfo-inlinetask)
|
|
|
|
|
(italic . org-texinfo-italic)
|
|
|
|
|
(item . org-texinfo-item)
|
|
|
|
|
(keyword . org-texinfo-keyword)
|
|
|
|
|
(line-break . org-texinfo-line-break)
|
|
|
|
|
(link . org-texinfo-link)
|
2013-09-25 15:27:29 -04:00
|
|
|
|
(node-property . org-texinfo-node-property)
|
2013-03-19 11:24:40 -04:00
|
|
|
|
(paragraph . org-texinfo-paragraph)
|
|
|
|
|
(plain-list . org-texinfo-plain-list)
|
|
|
|
|
(plain-text . org-texinfo-plain-text)
|
|
|
|
|
(planning . org-texinfo-planning)
|
|
|
|
|
(property-drawer . org-texinfo-property-drawer)
|
|
|
|
|
(quote-block . org-texinfo-quote-block)
|
|
|
|
|
(radio-target . org-texinfo-radio-target)
|
|
|
|
|
(section . org-texinfo-section)
|
|
|
|
|
(special-block . org-texinfo-special-block)
|
|
|
|
|
(src-block . org-texinfo-src-block)
|
|
|
|
|
(statistics-cookie . org-texinfo-statistics-cookie)
|
|
|
|
|
(subscript . org-texinfo-subscript)
|
|
|
|
|
(superscript . org-texinfo-superscript)
|
|
|
|
|
(table . org-texinfo-table)
|
|
|
|
|
(table-cell . org-texinfo-table-cell)
|
|
|
|
|
(table-row . org-texinfo-table-row)
|
|
|
|
|
(target . org-texinfo-target)
|
|
|
|
|
(template . org-texinfo-template)
|
|
|
|
|
(timestamp . org-texinfo-timestamp)
|
|
|
|
|
(verbatim . org-texinfo-verbatim)
|
|
|
|
|
(verse-block . org-texinfo-verse-block))
|
2012-09-09 07:08:52 -04:00
|
|
|
|
:filters-alist
|
2015-05-26 03:22:53 -04:00
|
|
|
|
'((:filter-headline . org-texinfo--filter-section-blank-lines)
|
2014-08-08 19:54:51 -04:00
|
|
|
|
(:filter-parse-tree . org-texinfo--normalize-headlines)
|
2015-05-26 03:22:53 -04:00
|
|
|
|
(:filter-section . org-texinfo--filter-section-blank-lines))
|
2012-09-09 07:08:52 -04:00
|
|
|
|
:menu-entry
|
2013-03-19 11:24:40 -04:00
|
|
|
|
'(?i "Export to Texinfo"
|
|
|
|
|
((?t "As TEXI file" org-texinfo-export-to-texinfo)
|
2015-05-25 17:55:00 -04:00
|
|
|
|
(?i "As INFO file" org-texinfo-export-to-info)
|
|
|
|
|
(?o "As INFO file and open"
|
|
|
|
|
(lambda (a s v b)
|
|
|
|
|
(if a (org-texinfo-export-to-info t s v b)
|
|
|
|
|
(org-open-file (org-texinfo-export-to-info nil s v b)))))))
|
2012-09-09 07:08:52 -04:00
|
|
|
|
:options-alist
|
2014-08-04 05:48:09 -04:00
|
|
|
|
'((:texinfo-filename "TEXINFO_FILENAME" nil nil t)
|
2013-03-19 11:24:40 -04:00
|
|
|
|
(:texinfo-class "TEXINFO_CLASS" nil org-texinfo-default-class t)
|
|
|
|
|
(:texinfo-header "TEXINFO_HEADER" nil nil newline)
|
|
|
|
|
(:texinfo-post-header "TEXINFO_POST_HEADER" nil nil newline)
|
ox: Add #+SUBTITLE property in some backends
* ox-texinfo.el (texinfo, org-texinfo-template): Parse subtitle.
* ox-s5.el (org-s5-title-slide-template):
* ox-deck.el (org-deck-title-slide-template):
* ox-odt.el (odt, org-odt-template):
* ox-latex.el (latex, org-latex-template):
* ox-html.el (html, org-html-format-spec, org-html-template):
* ox-ascii.el (ascii, org-ascii-template--document-title):
* ox-beamer.el (beamer, org-beamer-template): Support #+SUBTITLE.
* ox-html.el (org-html-postamble-format)
(org-html-preamble-format):
* ox-latex.el (org-latex-title-command)
(org-latex-hyperref-template): Update docstring.
* ox-html.el (org-html-style-default): New .subtitle css property.
* ox-beamer.el (org-beamer-subtitle-format):
* ox-latex.el (org-latex-subtitle-format)
(org-latex-subtitle-separate): New variable.
* org.texi (ASCII/Latin-1/UTF-8 export)
(Beamer specific export settings)
(HTML Specific export settings)
(@LaTeX{} specific export settings, CSS support)
(ODT specific export settings)
(Texinfo specific export settings, Document preamble)
(Publishing options, Publishing options): Document #+SUBTITLE.
The patch adds a #+SUBTITLE keyword to ox-ascii, ox-latex, ox-html and
ox-odt.
2015-03-01 16:09:19 -05:00
|
|
|
|
(:subtitle "SUBTITLE" nil nil parse)
|
2013-03-19 11:24:40 -04:00
|
|
|
|
(:subauthor "SUBAUTHOR" nil nil newline)
|
|
|
|
|
(:texinfo-dircat "TEXINFO_DIR_CATEGORY" nil nil t)
|
|
|
|
|
(:texinfo-dirtitle "TEXINFO_DIR_TITLE" nil nil t)
|
2014-05-21 03:06:59 -04:00
|
|
|
|
(:texinfo-dirdesc "TEXINFO_DIR_DESC" nil nil t)
|
2014-08-08 16:07:45 -04:00
|
|
|
|
(:texinfo-printed-title "TEXINFO_PRINTED_TITLE" nil nil t)
|
2014-05-21 03:06:59 -04:00
|
|
|
|
;; Other variables.
|
|
|
|
|
(:texinfo-classes nil nil org-texinfo-classes)
|
|
|
|
|
(:texinfo-format-headline-function nil nil org-texinfo-format-headline-function)
|
|
|
|
|
(:texinfo-node-description-column nil nil org-texinfo-node-description-column)
|
|
|
|
|
(:texinfo-active-timestamp-format nil nil org-texinfo-active-timestamp-format)
|
|
|
|
|
(:texinfo-inactive-timestamp-format nil nil org-texinfo-inactive-timestamp-format)
|
|
|
|
|
(:texinfo-diary-timestamp-format nil nil org-texinfo-diary-timestamp-format)
|
|
|
|
|
(:texinfo-link-with-unknown-path-format nil nil org-texinfo-link-with-unknown-path-format)
|
|
|
|
|
(:texinfo-tables-verbatim nil nil org-texinfo-tables-verbatim)
|
|
|
|
|
(:texinfo-table-scientific-notation nil nil org-texinfo-table-scientific-notation)
|
|
|
|
|
(:texinfo-def-table-markup nil nil org-texinfo-def-table-markup)
|
|
|
|
|
(:texinfo-text-markup-alist nil nil org-texinfo-text-markup-alist)
|
|
|
|
|
(:texinfo-format-drawer-function nil nil org-texinfo-format-drawer-function)
|
2014-07-28 09:14:53 -04:00
|
|
|
|
(:texinfo-format-inlinetask-function nil nil org-texinfo-format-inlinetask-function)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; User Configurable Variables
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defgroup org-export-texinfo nil
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Options for exporting Org mode files to Texinfo."
|
|
|
|
|
:tag "Org Export Texinfo"
|
2013-03-06 11:31:28 -05:00
|
|
|
|
:version "24.4"
|
|
|
|
|
:package-version '(Org . "8.0")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:group 'org-export)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Preamble
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-03-19 05:24:30 -04:00
|
|
|
|
(defcustom org-texinfo-coding-system nil
|
2013-04-23 09:25:46 -04:00
|
|
|
|
"Default document encoding for Texinfo output.
|
|
|
|
|
|
2015-05-21 13:04:45 -04:00
|
|
|
|
If nil it will default to `buffer-file-coding-system'."
|
2013-03-19 05:24:30 -04:00
|
|
|
|
:group 'org-export-texinfo
|
|
|
|
|
:type 'coding-system)
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-default-class "info"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"The default Texinfo class."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type '(string :tag "Texinfo class"))
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-classes
|
2012-08-15 16:00:20 -04:00
|
|
|
|
'(("info"
|
2014-08-04 05:47:40 -04:00
|
|
|
|
"@documentencoding AUTO\n@documentlanguage AUTO"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
("@chapter %s" . "@unnumbered %s")
|
|
|
|
|
("@section %s" . "@unnumberedsec %s")
|
|
|
|
|
("@subsection %s" . "@unnumberedsubsec %s")
|
|
|
|
|
("@subsubsection %s" . "@unnumberedsubsubsec %s")))
|
|
|
|
|
"Alist of Texinfo classes and associated header and structure.
|
2014-08-04 05:47:40 -04:00
|
|
|
|
If #+TEXINFO_CLASS is set in the buffer, use its value and the
|
2012-08-15 16:00:20 -04:00
|
|
|
|
associated information. Here is the structure of each cell:
|
|
|
|
|
|
2015-09-17 19:08:20 -04:00
|
|
|
|
(class-name
|
2012-08-15 16:00:20 -04:00
|
|
|
|
header-string
|
2015-09-17 19:08:20 -04:00
|
|
|
|
(numbered-section . unnumbered-section)
|
2014-08-04 05:47:40 -04:00
|
|
|
|
...)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The header string
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
The header string is inserted in the header of the generated
|
|
|
|
|
document, right after \"@setfilename\" and \"@settitle\"
|
|
|
|
|
commands.
|
|
|
|
|
|
|
|
|
|
If it contains the special string
|
|
|
|
|
|
|
|
|
|
\"@documentencoding AUTO\"
|
|
|
|
|
|
|
|
|
|
\"AUTO\" will be replaced with an appropriate coding system. See
|
|
|
|
|
`org-texinfo-coding-system' for more information. Likewise, if
|
|
|
|
|
the string contains the special string
|
|
|
|
|
|
|
|
|
|
\"@documentlanguage AUTO\"
|
|
|
|
|
|
|
|
|
|
\"AUTO\" will be replaced with the language defined in the
|
|
|
|
|
buffer, through #+LANGUAGE keyword, or globally, with
|
|
|
|
|
`org-export-default-language', which see.
|
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
The sectioning structure
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
The sectioning structure of the class is given by the elements
|
|
|
|
|
following the header string. For each sectioning level, a number
|
|
|
|
|
of strings is specified. A %s formatter is mandatory in each
|
|
|
|
|
section string and will be replaced by the title of the section.
|
|
|
|
|
|
|
|
|
|
Instead of a list of sectioning commands, you can also specify
|
|
|
|
|
a function name. That function will be called with two
|
2014-08-04 05:47:40 -04:00
|
|
|
|
parameters, the reduced) level of the headline, and a predicate
|
2012-08-15 16:00:20 -04:00
|
|
|
|
non-nil when the headline should be numbered. It must return
|
|
|
|
|
a format string in which the section title will be added."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2014-08-04 05:47:40 -04:00
|
|
|
|
:version "24.4"
|
|
|
|
|
:package-version '(Org . "8.2")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type '(repeat
|
|
|
|
|
(list (string :tag "Texinfo class")
|
|
|
|
|
(string :tag "Texinfo header")
|
|
|
|
|
(repeat :tag "Levels" :inline t
|
|
|
|
|
(choice
|
|
|
|
|
(cons :tag "Heading"
|
|
|
|
|
(string :tag " numbered")
|
|
|
|
|
(string :tag "unnumbered"))
|
|
|
|
|
(function :tag "Hook computing sectioning"))))))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Headline
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(defcustom org-texinfo-format-headline-function
|
|
|
|
|
'org-texinfo-format-headline-default-function
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Function to format headline text.
|
|
|
|
|
|
|
|
|
|
This function will be called with 5 arguments:
|
|
|
|
|
TODO the todo keyword (string or nil).
|
|
|
|
|
TODO-TYPE the type of todo (symbol: `todo', `done', nil)
|
|
|
|
|
PRIORITY the priority of the headline (integer or nil)
|
|
|
|
|
TEXT the main headline text (string).
|
|
|
|
|
TAGS the tags as a list of strings (list of strings or nil).
|
|
|
|
|
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
The function result will be used in the section format string."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
:type 'function
|
2014-10-24 05:56:09 -04:00
|
|
|
|
:version "25.1"
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
:package-version '(Org . "8.3"))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Node listing (menu)
|
2013-02-25 10:44:18 -05:00
|
|
|
|
|
|
|
|
|
(defcustom org-texinfo-node-description-column 32
|
2014-08-03 18:17:20 -04:00
|
|
|
|
"Column at which to start the description in the node listings.
|
2013-02-25 10:44:18 -05:00
|
|
|
|
If a node title is greater than this length, the description will
|
|
|
|
|
be placed after the end of the title."
|
|
|
|
|
:group 'org-export-texinfo
|
|
|
|
|
:type 'integer)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Timestamps
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-active-timestamp-format "@emph{%s}"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"A printf format string to be applied to active timestamps."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'string)
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-inactive-timestamp-format "@emph{%s}"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"A printf format string to be applied to inactive timestamps."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'string)
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-diary-timestamp-format "@emph{%s}"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"A printf format string to be applied to diary timestamps."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'string)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Links
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-link-with-unknown-path-format "@indicateurl{%s}"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Format string for links with unknown path type."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'string)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Tables
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-tables-verbatim nil
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"When non-nil, tables are exported verbatim."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'boolean)
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-table-scientific-notation "%s\\,(%s)"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Format string to display numbers in scientific notation.
|
|
|
|
|
The format should have \"%s\" twice, for mantissa and exponent
|
|
|
|
|
\(i.e. \"%s\\\\times10^{%s}\").
|
|
|
|
|
|
|
|
|
|
When nil, no transformation is made."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type '(choice
|
|
|
|
|
(string :tag "Format string")
|
2014-08-03 18:17:20 -04:00
|
|
|
|
(const :tag "No formatting" nil)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-def-table-markup "@samp"
|
2013-12-30 04:13:57 -05:00
|
|
|
|
"Default setting for @table environments."
|
|
|
|
|
:group 'org-export-texinfo
|
|
|
|
|
:type 'string)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Text markup
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defcustom org-texinfo-text-markup-alist '((bold . "@strong{%s}")
|
|
|
|
|
(code . code)
|
|
|
|
|
(italic . "@emph{%s}")
|
|
|
|
|
(verbatim . verb)
|
|
|
|
|
(comment . "@c %s"))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Alist of Texinfo expressions to convert text markup.
|
|
|
|
|
|
|
|
|
|
The key must be a symbol among `bold', `italic' and `comment'.
|
|
|
|
|
The value is a formatting string to wrap fontified text with.
|
|
|
|
|
|
|
|
|
|
Value can also be set to the following symbols: `verb' and
|
|
|
|
|
`code'. For the former, Org will use \"@verb\" to
|
|
|
|
|
create a format string and select a delimiter character that
|
|
|
|
|
isn't in the string. For the latter, Org will use \"@code\"
|
|
|
|
|
to typeset and try to protect special characters.
|
|
|
|
|
|
|
|
|
|
If no association can be found for a given markup, text will be
|
|
|
|
|
returned as-is."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'alist
|
|
|
|
|
:options '(bold code italic verbatim comment))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Drawers
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defcustom org-texinfo-format-drawer-function (lambda (_name contents) contents)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Function called to format a drawer in Texinfo code.
|
|
|
|
|
|
|
|
|
|
The function must accept two parameters:
|
|
|
|
|
NAME the drawer name, like \"LOGBOOK\"
|
|
|
|
|
CONTENTS the contents of the drawer.
|
|
|
|
|
|
|
|
|
|
The function should return the string to be exported.
|
|
|
|
|
|
2013-11-14 08:05:18 -05:00
|
|
|
|
The default function simply returns the value of CONTENTS."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2013-11-14 08:05:18 -05:00
|
|
|
|
:version "24.4"
|
2014-08-03 18:17:20 -04:00
|
|
|
|
:package-version '(Org . "8.2")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'function)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Inlinetasks
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(defcustom org-texinfo-format-inlinetask-function
|
|
|
|
|
'org-texinfo-format-inlinetask-default-function
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Function called to format an inlinetask in Texinfo code.
|
|
|
|
|
|
|
|
|
|
The function must accept six parameters:
|
|
|
|
|
TODO the todo keyword, as a string
|
|
|
|
|
TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
|
|
|
|
|
PRIORITY the inlinetask priority, as a string
|
|
|
|
|
NAME the inlinetask name, as a string.
|
|
|
|
|
TAGS the inlinetask tags, as a list of strings.
|
|
|
|
|
CONTENTS the contents of the inlinetask, as a string.
|
|
|
|
|
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
The function should return the string to be exported."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
:group 'org-export-texinfo
|
2012-08-15 16:00:20 -04:00
|
|
|
|
:type 'function)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Compilation
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-11 07:44:13 -04:00
|
|
|
|
(defcustom org-texinfo-info-process '("makeinfo %f")
|
2013-03-19 05:01:42 -04:00
|
|
|
|
"Commands to process a Texinfo file to an INFO file.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
This is list of strings, each of them will be given to the shell
|
|
|
|
|
as a command. %f in the command will be replaced by the full
|
2014-08-11 07:44:13 -04:00
|
|
|
|
file name, %b by the file base name (i.e without extension) and
|
2012-08-15 16:00:20 -04:00
|
|
|
|
%o by the base directory of the file."
|
|
|
|
|
:group 'org-export-texinfo
|
|
|
|
|
:type '(repeat :tag "Shell command sequence"
|
|
|
|
|
(string :tag "Shell command")))
|
|
|
|
|
|
2013-03-19 05:31:23 -04:00
|
|
|
|
(defcustom org-texinfo-logfiles-extensions
|
|
|
|
|
'("aux" "toc" "cp" "fn" "ky" "pg" "tp" "vr")
|
|
|
|
|
"The list of file extensions to consider as Texinfo logfiles.
|
|
|
|
|
The logfiles will be remove if `org-texinfo-remove-logfiles' is
|
|
|
|
|
non-nil."
|
|
|
|
|
:group 'org-export-texinfo
|
|
|
|
|
:type '(repeat (string :tag "Extension")))
|
|
|
|
|
|
|
|
|
|
(defcustom org-texinfo-remove-logfiles t
|
|
|
|
|
"Non-nil means remove the logfiles produced by compiling a Texinfo file.
|
|
|
|
|
By default, logfiles are files with these extensions: .aux, .toc,
|
|
|
|
|
.cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove,
|
|
|
|
|
set `org-texinfo-logfiles-extensions'."
|
|
|
|
|
:group 'org-export-latex
|
|
|
|
|
:type 'boolean)
|
|
|
|
|
|
2013-02-14 11:59:03 -05:00
|
|
|
|
;;; Constants
|
2014-08-06 17:53:42 -04:00
|
|
|
|
|
2013-02-14 11:59:03 -05:00
|
|
|
|
(defconst org-texinfo-max-toc-depth 4
|
2014-08-10 20:11:32 -04:00
|
|
|
|
"Maximum depth for creation of detailed menu listings.
|
|
|
|
|
Beyond this depth, Texinfo will not recognize the nodes and will
|
|
|
|
|
cause errors. Left as a constant in case this value ever
|
|
|
|
|
changes.")
|
2013-02-14 11:59:03 -05:00
|
|
|
|
|
2013-11-11 04:09:21 -05:00
|
|
|
|
(defconst org-texinfo-supported-coding-systems
|
|
|
|
|
'("US-ASCII" "UTF-8" "ISO-8859-15" "ISO-8859-1" "ISO-8859-2" "koi8-r" "koi8-u")
|
|
|
|
|
"List of coding systems supported by Texinfo, as strings.
|
|
|
|
|
Specified coding system will be matched against these strings.
|
|
|
|
|
If two strings share the same prefix (e.g. \"ISO-8859-1\" and
|
|
|
|
|
\"ISO-8859-15\"), the most specific one has to be listed first.")
|
|
|
|
|
|
2015-05-25 18:55:13 -04:00
|
|
|
|
(defconst org-texinfo-inline-image-rules
|
|
|
|
|
(list (cons "file"
|
|
|
|
|
(regexp-opt '("eps" "pdf" "png" "jpg" "jpeg" "gif" "svg"))))
|
|
|
|
|
"Rules characterizing image files that can be inlined.")
|
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
;;; Internal Functions
|
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo--filter-section-blank-lines (headline _backend _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Filter controlling number of blank lines after a section."
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" "\n\n" headline))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo--normalize-headlines (tree _backend info)
|
2014-08-08 19:54:51 -04:00
|
|
|
|
"Normalize headlines in TREE.
|
|
|
|
|
|
|
|
|
|
BACK-END is the symbol specifying back-end used for export. INFO
|
|
|
|
|
is a plist used as a communication channel.
|
|
|
|
|
|
|
|
|
|
Make sure every headline in TREE contains a section, since those
|
2014-08-08 20:01:18 -04:00
|
|
|
|
are required to install a menu. Also put exactly one blank line
|
2014-08-14 05:44:52 -04:00
|
|
|
|
at the end of each section.
|
2014-08-08 19:54:51 -04:00
|
|
|
|
|
|
|
|
|
Return new tree."
|
|
|
|
|
(org-element-map tree 'headline
|
|
|
|
|
(lambda (hl)
|
2014-08-08 20:01:18 -04:00
|
|
|
|
(org-element-put-property hl :post-blank 1)
|
2014-08-08 19:54:51 -04:00
|
|
|
|
(let ((contents (org-element-contents hl)))
|
|
|
|
|
(when contents
|
|
|
|
|
(let ((first (org-element-map contents '(headline section)
|
|
|
|
|
#'identity info t)))
|
|
|
|
|
(unless (eq (org-element-type first) 'section)
|
2014-08-14 08:08:16 -04:00
|
|
|
|
(apply #'org-element-set-contents
|
|
|
|
|
hl
|
|
|
|
|
(cons `(section (:parent ,hl)) contents)))))))
|
2014-08-08 19:54:51 -04:00
|
|
|
|
info)
|
|
|
|
|
tree)
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo--find-verb-separator (s)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Return a character not used in string S.
|
|
|
|
|
This is used to choose a separator for constructs like \\verb."
|
|
|
|
|
(let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
|
|
|
|
|
(loop for c across ll
|
|
|
|
|
when (not (string-match (regexp-quote (char-to-string c)) s))
|
|
|
|
|
return (char-to-string c))))
|
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo--text-markup (text markup _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Format TEXT depending on MARKUP text markup.
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
INFO is a plist used as a communication channel. See
|
|
|
|
|
`org-texinfo-text-markup-alist' for details."
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(pcase (cdr (assq markup org-texinfo-text-markup-alist))
|
|
|
|
|
;; No format string: Return raw text.
|
|
|
|
|
(`nil text)
|
|
|
|
|
(`verb
|
|
|
|
|
(let ((separator (org-texinfo--find-verb-separator text)))
|
|
|
|
|
(concat "@verb{" separator text separator "}")))
|
|
|
|
|
(`code
|
|
|
|
|
(format "@code{%s}" (replace-regexp-in-string "[@{}]" "@\\&" text)))
|
|
|
|
|
;; Else use format string.
|
|
|
|
|
(fmt (format fmt text))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-27 18:55:32 -04:00
|
|
|
|
(defun org-texinfo--get-node (blob info)
|
|
|
|
|
"Return node or anchor associated to BLOB.
|
|
|
|
|
BLOB is an element or object. INFO is a plist used as
|
|
|
|
|
a communication channel. The function guarantees the node or
|
|
|
|
|
anchor name is unique."
|
2014-08-10 17:10:57 -04:00
|
|
|
|
(let ((cache (plist-get info :texinfo-node-cache)))
|
2014-08-27 18:55:32 -04:00
|
|
|
|
(or (cdr (assq blob cache))
|
|
|
|
|
(let ((name
|
|
|
|
|
(org-texinfo--sanitize-node
|
2015-04-13 05:24:42 -04:00
|
|
|
|
(if (eq (org-element-type blob) 'headline)
|
|
|
|
|
(org-export-data (org-export-get-alt-title blob info) info)
|
|
|
|
|
(org-export-get-reference blob info)))))
|
2014-08-10 17:10:57 -04:00
|
|
|
|
;; Ensure NAME is unique.
|
|
|
|
|
(while (rassoc name cache) (setq name (concat name "x")))
|
2014-08-27 18:55:32 -04:00
|
|
|
|
(plist-put info :texinfo-node-cache (cons (cons blob name) cache))
|
2014-08-10 17:10:57 -04:00
|
|
|
|
name))))
|
2012-08-23 09:20:02 -04:00
|
|
|
|
|
2014-08-10 17:10:57 -04:00
|
|
|
|
(defun org-texinfo--sanitize-node (title)
|
|
|
|
|
"Bend string TITLE to node line requirements.
|
|
|
|
|
Trim string and collapse multiple whitespace characters as they
|
|
|
|
|
are not significant. Also remove the following characters: @
|
|
|
|
|
{ } ( ) : . ,"
|
2014-08-11 13:47:47 -04:00
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
"[:,.]" ""
|
2014-08-10 17:10:57 -04:00
|
|
|
|
(replace-regexp-in-string
|
2014-08-11 13:47:47 -04:00
|
|
|
|
"\\`(\\(.*)\\)" "[\\1"
|
|
|
|
|
(org-trim (replace-regexp-in-string "[ \t]\\{2,\\}" " " title)))))
|
2012-08-23 10:50:24 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo--sanitize-content (text)
|
2014-08-10 16:55:20 -04:00
|
|
|
|
"Escape special characters in string TEXT.
|
|
|
|
|
Special characters are: @ { }"
|
2014-08-27 18:55:32 -04:00
|
|
|
|
(replace-regexp-in-string "[@{}]" "@\\&" text))
|
2012-08-23 10:50:24 -04:00
|
|
|
|
|
2015-05-26 03:37:43 -04:00
|
|
|
|
(defun org-texinfo--wrap-float (value info &optional type label caption short)
|
|
|
|
|
"Wrap string VALUE within a @float command.
|
|
|
|
|
INFO is the current export state, as a plist. TYPE is float
|
|
|
|
|
type, as a string. LABEL is the cross reference label for the
|
|
|
|
|
float, as a string. CAPTION and SHORT are, respectively, the
|
|
|
|
|
caption and shortcaption used for the float, as secondary
|
|
|
|
|
strings (e.g., returned by `org-export-get-caption')."
|
|
|
|
|
(let* ((backend
|
|
|
|
|
(org-export-create-backend
|
|
|
|
|
:parent 'texinfo
|
|
|
|
|
:transcoders '((link . (lambda (object c i) c))
|
|
|
|
|
(radio-target . (lambda (object c i) c))
|
|
|
|
|
(target . ignore))))
|
|
|
|
|
(short-backend
|
|
|
|
|
(org-export-create-backend
|
|
|
|
|
:parent 'texinfo
|
|
|
|
|
:transcoders '((footnote-reference . ignore)
|
|
|
|
|
(inline-src-block . ignore)
|
|
|
|
|
(link . (lambda (object c i) c))
|
|
|
|
|
(radio-target . (lambda (object c i) c))
|
|
|
|
|
(target . ignore)
|
|
|
|
|
(verbatim . ignore))))
|
|
|
|
|
(short-str
|
|
|
|
|
(if (and short caption)
|
|
|
|
|
(format "@shortcaption{%s}\n"
|
|
|
|
|
(org-export-data-with-backend short short-backend info))
|
|
|
|
|
""))
|
|
|
|
|
(caption-str
|
|
|
|
|
(if (or short caption)
|
|
|
|
|
(format "@caption{%s}\n"
|
|
|
|
|
(org-export-data-with-backend
|
|
|
|
|
(or caption short)
|
|
|
|
|
(if (equal short-str "") short-backend backend)
|
|
|
|
|
info))
|
|
|
|
|
"")))
|
|
|
|
|
(format "@float %s%s\n%s\n%s%s@end float"
|
|
|
|
|
type (if label (concat "," label) "") value caption-str short-str)))
|
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;;; Template
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-template (contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Return complete document string after Texinfo conversion.
|
|
|
|
|
CONTENTS is the transcoded contents string. INFO is a plist
|
|
|
|
|
holding export options."
|
2014-08-05 04:52:14 -04:00
|
|
|
|
(let ((title (org-export-data (plist-get info :title) info))
|
|
|
|
|
;; Copying data is the contents of the first headline in
|
|
|
|
|
;; parse tree with a non-nil copying property.
|
|
|
|
|
(copying (org-element-map (plist-get info :parse-tree) 'headline
|
|
|
|
|
(lambda (hl)
|
|
|
|
|
(and (org-not-nil (org-element-property :COPYING hl))
|
|
|
|
|
(org-element-contents hl)))
|
|
|
|
|
info t)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(concat
|
2014-08-04 05:47:40 -04:00
|
|
|
|
"\\input texinfo @c -*- texinfo -*-\n"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"@c %**start of header\n"
|
2014-08-04 05:48:09 -04:00
|
|
|
|
(let ((file (or (plist-get info :texinfo-filename)
|
|
|
|
|
(let ((f (plist-get info :output-file)))
|
|
|
|
|
(and f (concat (file-name-sans-extension f) ".info"))))))
|
|
|
|
|
(and file (format "@setfilename %s\n" file)))
|
2014-08-03 19:17:47 -04:00
|
|
|
|
(format "@settitle %s\n" title)
|
2014-08-04 05:47:40 -04:00
|
|
|
|
;; Insert class-defined header.
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(let ((header (nth 1 (assoc (plist-get info :texinfo-class)
|
|
|
|
|
org-texinfo-classes)))
|
|
|
|
|
(coding
|
|
|
|
|
(catch 'coding-system
|
|
|
|
|
(let ((case-fold-search t)
|
|
|
|
|
(name (symbol-name (or org-texinfo-coding-system
|
|
|
|
|
buffer-file-coding-system))))
|
|
|
|
|
(dolist (system org-texinfo-supported-coding-systems "UTF-8")
|
|
|
|
|
(when (org-string-match-p (regexp-quote system) name)
|
|
|
|
|
(throw 'coding-system system))))))
|
|
|
|
|
(language (plist-get info :language))
|
|
|
|
|
(case-fold-search nil))
|
|
|
|
|
;; Auto coding system.
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
"^@documentencoding \\(AUTO\\)$"
|
|
|
|
|
coding
|
|
|
|
|
(replace-regexp-in-string
|
2014-08-19 17:35:08 -04:00
|
|
|
|
"^@documentlanguage \\(AUTO\\)$" language header t nil 1) t nil 1)))
|
2014-08-05 04:52:14 -04:00
|
|
|
|
;; Additional header options set by #+TEXINFO_HEADER.
|
|
|
|
|
(let ((texinfo-header (plist-get info :texinfo-header)))
|
|
|
|
|
(and texinfo-header (org-element-normalize-string texinfo-header)))
|
|
|
|
|
"@c %**end of header\n\n"
|
|
|
|
|
;; Additional options set by #+TEXINFO_POST_HEADER.
|
|
|
|
|
(let ((texinfo-post-header (plist-get info :texinfo-post-header)))
|
|
|
|
|
(and texinfo-post-header
|
|
|
|
|
(org-element-normalize-string texinfo-post-header)))
|
2014-08-03 19:10:10 -04:00
|
|
|
|
;; Copying.
|
|
|
|
|
(and copying
|
|
|
|
|
(format "@copying\n%s@end copying\n\n"
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(org-export-data copying info))))
|
2014-08-03 16:30:11 -04:00
|
|
|
|
;; Info directory information. Only supply if both title and
|
|
|
|
|
;; category are provided.
|
|
|
|
|
(let ((dircat (plist-get info :texinfo-dircat))
|
|
|
|
|
(dirtitle
|
|
|
|
|
(let ((title (plist-get info :texinfo-dirtitle)))
|
|
|
|
|
(and title
|
|
|
|
|
(string-match "^\\(?:\\* \\)?\\(.*?\\)\\(\\.\\)?$" title)
|
|
|
|
|
(format "* %s." (match-string 1 title))))))
|
|
|
|
|
(when (and dircat dirtitle)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(concat "@dircategory " dircat "\n"
|
|
|
|
|
"@direntry\n"
|
2014-08-03 16:30:11 -04:00
|
|
|
|
(let ((dirdesc
|
|
|
|
|
(let ((desc (plist-get info :texinfo-dirdesc)))
|
|
|
|
|
(cond ((not desc) nil)
|
|
|
|
|
((org-string-match-p "\\.$" desc) desc)
|
|
|
|
|
(t (concat desc "."))))))
|
|
|
|
|
(if dirdesc (format "%-23s %s" dirtitle dirdesc) dirtitle))
|
|
|
|
|
"\n"
|
|
|
|
|
"@end direntry\n\n")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Title
|
2014-08-05 04:52:14 -04:00
|
|
|
|
"@finalout\n"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"@titlepage\n"
|
ox: Optional export of title
* ox.el (org-export-with-title): New variable.
* ox (org-export-options-alist),
ox-ascii.el (org-ascii-template--document-title),
ox-beamer.el (org-beamer-template), ox-html.el (org-html-template),
ox-latex.el (org-latex-template), ox-man.el (org-man-template),
ox-odt.el (org-odt-template), ox-org.el (org-org-template),
ox-publish.el (org-publish-project-alist),
ox-texinfo.el (org-texinfo-template),
ox-groff.el (org-groff--mt-head): Use new variable.
* ox-koma-letter.el (org-koma-letter-use-title): Mark obsolete.
* test-ox.el (test-org-export/parse-option-keyword): Add :with-title.
* ORG-NEWS, org.texi: Mention org-export-with-title.
This is useful in e.g. ox-html where title can be set via
`org-html-preamble-template' or when using the {{{title}}}-macro.
2015-02-10 18:09:39 -05:00
|
|
|
|
(when (plist-get info :with-title)
|
2015-02-12 04:59:30 -05:00
|
|
|
|
(concat
|
|
|
|
|
(format "@title %s\n" (or (plist-get info :texinfo-printed-title) title ""))
|
|
|
|
|
(let ((subtitle (plist-get info :subtitle)))
|
ox: Add #+SUBTITLE property in some backends
* ox-texinfo.el (texinfo, org-texinfo-template): Parse subtitle.
* ox-s5.el (org-s5-title-slide-template):
* ox-deck.el (org-deck-title-slide-template):
* ox-odt.el (odt, org-odt-template):
* ox-latex.el (latex, org-latex-template):
* ox-html.el (html, org-html-format-spec, org-html-template):
* ox-ascii.el (ascii, org-ascii-template--document-title):
* ox-beamer.el (beamer, org-beamer-template): Support #+SUBTITLE.
* ox-html.el (org-html-postamble-format)
(org-html-preamble-format):
* ox-latex.el (org-latex-title-command)
(org-latex-hyperref-template): Update docstring.
* ox-html.el (org-html-style-default): New .subtitle css property.
* ox-beamer.el (org-beamer-subtitle-format):
* ox-latex.el (org-latex-subtitle-format)
(org-latex-subtitle-separate): New variable.
* org.texi (ASCII/Latin-1/UTF-8 export)
(Beamer specific export settings)
(HTML Specific export settings)
(@LaTeX{} specific export settings, CSS support)
(ODT specific export settings)
(Texinfo specific export settings, Document preamble)
(Publishing options, Publishing options): Document #+SUBTITLE.
The patch adds a #+SUBTITLE keyword to ox-ascii, ox-latex, ox-html and
ox-odt.
2015-03-01 16:09:19 -05:00
|
|
|
|
(when subtitle
|
|
|
|
|
(format "@subtitle %s\n"
|
|
|
|
|
(org-export-data subtitle info))))))
|
2014-08-03 19:02:41 -04:00
|
|
|
|
(when (plist-get info :with-author)
|
|
|
|
|
(concat
|
|
|
|
|
;; Primary author.
|
|
|
|
|
(let ((author (org-string-nw-p
|
|
|
|
|
(org-export-data (plist-get info :author) info)))
|
|
|
|
|
(email (and (plist-get info :with-email)
|
|
|
|
|
(org-string-nw-p
|
|
|
|
|
(org-export-data (plist-get info :email) info)))))
|
|
|
|
|
(cond ((and author email)
|
|
|
|
|
(format "@author %s (@email{%s})\n" author email))
|
|
|
|
|
(author (format "@author %s\n" author))
|
|
|
|
|
(email (format "@author @email{%s}\n" email))))
|
|
|
|
|
;; Other authors.
|
|
|
|
|
(let ((subauthor (plist-get info :subauthor)))
|
|
|
|
|
(and subauthor
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(replace-regexp-in-string "^" "@author " subauthor))))))
|
2014-08-03 19:10:10 -04:00
|
|
|
|
(and copying "@page\n@vskip 0pt plus 1filll\n@insertcopying\n")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"@end titlepage\n\n"
|
2014-08-03 19:12:45 -04:00
|
|
|
|
;; Table of contents.
|
|
|
|
|
(and (plist-get info :with-toc) "@contents\n\n")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Configure Top Node when not for Tex
|
|
|
|
|
"@ifnottex\n"
|
|
|
|
|
"@node Top\n"
|
2014-08-03 20:31:36 -04:00
|
|
|
|
(format "@top %s\n" title)
|
2014-08-03 19:10:10 -04:00
|
|
|
|
(and copying "@insertcopying\n")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"@end ifnottex\n\n"
|
2014-08-05 04:52:14 -04:00
|
|
|
|
;; Menu.
|
2014-08-08 19:54:51 -04:00
|
|
|
|
(org-texinfo-make-menu (plist-get info :parse-tree) info 'master)
|
|
|
|
|
"\n"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Document's body.
|
2014-08-05 04:52:14 -04:00
|
|
|
|
contents "\n"
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Creator.
|
2015-03-17 10:40:52 -04:00
|
|
|
|
(and (plist-get info :with-creator)
|
|
|
|
|
(concat (plist-get info :creator) "\n"))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Document end.
|
2014-08-05 04:52:14 -04:00
|
|
|
|
"@bye")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Transcode Functions
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Bold
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-bold (_bold contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode BOLD from Org to Texinfo.
|
|
|
|
|
CONTENTS is the text with bold markup. INFO is a plist holding
|
|
|
|
|
contextual information."
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(org-texinfo--text-markup contents 'bold info))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Center Block
|
2012-10-26 18:36:00 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-center-block (_center-block contents _info)
|
2012-10-26 18:36:00 -04:00
|
|
|
|
"Transcode a CENTER-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the block. INFO is a plist used
|
|
|
|
|
as a communication channel."
|
|
|
|
|
contents)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Clock
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-clock (clock _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a CLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual
|
|
|
|
|
information."
|
|
|
|
|
(concat
|
|
|
|
|
"@noindent"
|
|
|
|
|
(format "@strong{%s} " org-clock-string)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(format (plist-get info :texinfo-inactive-timestamp-format)
|
2014-12-03 11:09:43 -05:00
|
|
|
|
(concat (org-timestamp-translate (org-element-property :value clock))
|
2012-10-30 16:59:50 -04:00
|
|
|
|
(let ((time (org-element-property :duration clock)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(and time (format " (%s)" time)))))
|
|
|
|
|
"@*"))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Code
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-code (code _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a CODE object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist used as a communication
|
|
|
|
|
channel."
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(org-texinfo--text-markup (org-element-property :value code) 'code info))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Drawer
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-drawer (drawer contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a DRAWER element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the block. INFO is a plist
|
|
|
|
|
holding contextual information."
|
|
|
|
|
(let* ((name (org-element-property :drawer-name drawer))
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(output (funcall (plist-get info :texinfo-format-drawer-function)
|
2013-11-14 08:05:18 -05:00
|
|
|
|
name contents)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
output))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Dynamic Block
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-dynamic-block (_dynamic-block contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a DYNAMIC-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the block. INFO is a plist
|
2014-08-06 17:53:42 -04:00
|
|
|
|
holding contextual information."
|
2012-08-15 16:00:20 -04:00
|
|
|
|
contents)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Entity
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-entity (entity _contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode an ENTITY object from Org to Texinfo.
|
|
|
|
|
CONTENTS are the definition itself. INFO is a plist holding
|
|
|
|
|
contextual information."
|
|
|
|
|
(let ((ent (org-element-property :latex entity)))
|
|
|
|
|
(if (org-element-property :latex-math-p entity) (format "@math{%s}" ent) ent)))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Example Block
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-example-block (example-block _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode an EXAMPLE-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual
|
|
|
|
|
information."
|
|
|
|
|
(format "@verbatim\n%s@end verbatim"
|
|
|
|
|
(org-export-format-code-default example-block info)))
|
|
|
|
|
|
2014-09-08 05:57:27 -04:00
|
|
|
|
;;; Export Block
|
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-export-block (export-block _contents _info)
|
2014-09-08 05:57:27 -04:00
|
|
|
|
"Transcode a EXPORT-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual information."
|
|
|
|
|
(when (string= (org-element-property :type export-block) "TEXINFO")
|
|
|
|
|
(org-remove-indentation (org-element-property :value export-block))))
|
|
|
|
|
|
|
|
|
|
;;; Export Snippet
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-export-snippet (export-snippet _contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a EXPORT-SNIPPET object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual information."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(when (eq (org-export-snippet-backend export-snippet) 'texinfo)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(org-element-property :value export-snippet)))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Fixed Width
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-fixed-width (fixed-width _contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a FIXED-WIDTH element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual information."
|
|
|
|
|
(format "@example\n%s\n@end example"
|
|
|
|
|
(org-remove-indentation
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(org-texinfo--sanitize-content
|
2012-08-23 10:50:24 -04:00
|
|
|
|
(org-element-property :value fixed-width)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Footnote Reference
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-footnote-reference (footnote _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Create a footnote reference for FOOTNOTE.
|
|
|
|
|
|
|
|
|
|
FOOTNOTE is the footnote to define. CONTENTS is nil. INFO is a
|
|
|
|
|
plist holding contextual information."
|
|
|
|
|
(let ((def (org-export-get-footnote-definition footnote info)))
|
|
|
|
|
(format "@footnote{%s}"
|
|
|
|
|
(org-trim (org-export-data def info)))))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Headline
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-headline (headline contents info)
|
2013-02-23 07:47:44 -05:00
|
|
|
|
"Transcode a HEADLINE element from Org to Texinfo.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
CONTENTS holds the contents of the headline. INFO is a plist
|
|
|
|
|
holding contextual information."
|
|
|
|
|
(let* ((class (plist-get info :texinfo-class))
|
|
|
|
|
(level (org-export-get-relative-level headline info))
|
|
|
|
|
(numberedp (org-export-numbered-headline-p headline info))
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(class-sectioning (assoc class (plist-get info :texinfo-classes)))
|
2014-08-08 18:43:39 -04:00
|
|
|
|
;; Find the index type, if any.
|
2013-02-25 10:04:37 -05:00
|
|
|
|
(index (org-element-property :INDEX headline))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Create node info, to insert it before section formatting.
|
2014-08-08 18:43:39 -04:00
|
|
|
|
;; Use custom menu title if present.
|
2013-02-20 11:05:35 -05:00
|
|
|
|
(node (format "@node %s\n" (org-texinfo--get-node headline info)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Section formatting will set two placeholders: one for the
|
|
|
|
|
;; title and the other for the contents.
|
|
|
|
|
(section-fmt
|
2014-08-05 03:59:00 -04:00
|
|
|
|
(if (org-not-nil (org-element-property :APPENDIX headline))
|
2014-08-10 17:10:57 -04:00
|
|
|
|
"@appendix %s\n%s"
|
2014-08-05 03:59:00 -04:00
|
|
|
|
(let ((sec (if (and (symbolp (nth 2 class-sectioning))
|
|
|
|
|
(fboundp (nth 2 class-sectioning)))
|
|
|
|
|
(funcall (nth 2 class-sectioning) level numberedp)
|
|
|
|
|
(nth (1+ level) class-sectioning))))
|
2013-02-25 10:14:53 -05:00
|
|
|
|
(cond
|
2014-08-05 03:59:00 -04:00
|
|
|
|
;; No section available for that LEVEL.
|
|
|
|
|
((not sec) nil)
|
|
|
|
|
;; Section format directly returned by a function.
|
|
|
|
|
((stringp sec) sec)
|
|
|
|
|
;; (numbered-section . unnumbered-section)
|
|
|
|
|
((not (consp (cdr sec)))
|
2014-08-10 17:10:57 -04:00
|
|
|
|
(concat (if (or index (not numberedp)) (cdr sec) (car sec))
|
2014-08-05 03:59:00 -04:00
|
|
|
|
"\n%s"))))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(todo
|
|
|
|
|
(and (plist-get info :with-todo-keywords)
|
|
|
|
|
(let ((todo (org-element-property :todo-keyword headline)))
|
|
|
|
|
(and todo (org-export-data todo info)))))
|
|
|
|
|
(todo-type (and todo (org-element-property :todo-type headline)))
|
|
|
|
|
(tags (and (plist-get info :with-tags)
|
|
|
|
|
(org-export-get-tags headline info)))
|
|
|
|
|
(priority (and (plist-get info :with-priority)
|
|
|
|
|
(org-element-property :priority headline)))
|
2014-08-08 18:43:39 -04:00
|
|
|
|
(text (org-export-data (org-element-property :title headline) info))
|
2014-08-11 09:46:21 -04:00
|
|
|
|
(full-text (funcall (plist-get info :texinfo-format-headline-function)
|
|
|
|
|
todo todo-type priority text tags))
|
2014-08-14 05:44:52 -04:00
|
|
|
|
(contents (if (org-string-nw-p contents) (concat "\n" contents) "")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(cond
|
|
|
|
|
;; Case 1: This is a footnote section: ignore it.
|
|
|
|
|
((org-element-property :footnote-section-p headline) nil)
|
|
|
|
|
;; Case 2: This is the `copying' section: ignore it
|
|
|
|
|
;; This is used elsewhere.
|
2014-08-08 18:05:43 -04:00
|
|
|
|
((org-not-nil (org-element-property :COPYING headline)) nil)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Case 3: An index. If it matches one of the known indexes,
|
|
|
|
|
;; print it as such following the contents, otherwise
|
|
|
|
|
;; print the contents and leave the index up to the user.
|
|
|
|
|
(index
|
2014-08-10 17:10:57 -04:00
|
|
|
|
(concat node
|
|
|
|
|
(format
|
|
|
|
|
section-fmt
|
|
|
|
|
full-text
|
2014-08-14 05:44:52 -04:00
|
|
|
|
(concat contents
|
|
|
|
|
(and (member index '("cp" "fn" "ky" "pg" "tp" "vr"))
|
|
|
|
|
(concat "\n@printindex " index))))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Case 4: This is a deep sub-tree: export it as a list item.
|
|
|
|
|
;; Also export as items headlines for which no section
|
|
|
|
|
;; format has been found.
|
|
|
|
|
((or (not section-fmt) (org-export-low-level-p headline info))
|
|
|
|
|
;; Build the real contents of the sub-tree.
|
2014-08-14 05:44:52 -04:00
|
|
|
|
(concat (and (org-export-first-sibling-p headline info)
|
|
|
|
|
(format "@%s\n" (if numberedp 'enumerate 'itemize)))
|
|
|
|
|
"@item\n" full-text "\n"
|
|
|
|
|
contents
|
|
|
|
|
(if (org-export-last-sibling-p headline info)
|
|
|
|
|
(format "@end %s" (if numberedp 'enumerate 'itemize))
|
|
|
|
|
"\n")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Case 5: Standard headline. Export it as a section.
|
2014-08-14 05:44:52 -04:00
|
|
|
|
(t (concat node (format section-fmt full-text contents))))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(defun org-texinfo-format-headline-default-function
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(todo _todo-type priority text tags)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
"Default format function for a headline.
|
|
|
|
|
See `org-texinfo-format-headline-function' for details."
|
|
|
|
|
(concat (when todo (format "@strong{%s} " todo))
|
|
|
|
|
(when priority (format "@emph{#%s} " priority))
|
|
|
|
|
text
|
|
|
|
|
(when tags (format " :%s:" (mapconcat 'identity tags ":")))))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Inline Src Block
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-inline-src-block (inline-src-block _contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode an INLINE-SRC-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the item. INFO is a plist holding
|
|
|
|
|
contextual information."
|
|
|
|
|
(let* ((code (org-element-property :value inline-src-block))
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(separator (org-texinfo--find-verb-separator code)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(concat "@verb{" separator code separator "}")))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Inlinetask
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-inlinetask (inlinetask contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode an INLINETASK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the block. INFO is a plist
|
|
|
|
|
holding contextual information."
|
|
|
|
|
(let ((title (org-export-data (org-element-property :title inlinetask) info))
|
|
|
|
|
(todo (and (plist-get info :with-todo-keywords)
|
|
|
|
|
(let ((todo (org-element-property :todo-keyword inlinetask)))
|
|
|
|
|
(and todo (org-export-data todo info)))))
|
|
|
|
|
(todo-type (org-element-property :todo-type inlinetask))
|
|
|
|
|
(tags (and (plist-get info :with-tags)
|
|
|
|
|
(org-export-get-tags inlinetask info)))
|
|
|
|
|
(priority (and (plist-get info :with-priority)
|
|
|
|
|
(org-element-property :priority inlinetask))))
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(funcall (plist-get info :texinfo-format-inlinetask-function)
|
|
|
|
|
todo todo-type priority title tags contents)))
|
|
|
|
|
|
|
|
|
|
(defun org-texinfo-format-inlinetask-default-function
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(todo _todo-type priority title tags contents)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
"Default format function for a inlinetasks.
|
|
|
|
|
See `org-texinfo-format-inlinetask-function' for details."
|
|
|
|
|
(let ((full-title
|
|
|
|
|
(concat (when todo (format "@strong{%s} " todo))
|
|
|
|
|
(when priority (format "#%c " priority))
|
|
|
|
|
title
|
|
|
|
|
(when tags (format ":%s:" (mapconcat #'identity tags ":"))))))
|
|
|
|
|
(format "@center %s\n\n%s\n" full-title contents)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Italic
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-italic (_italic contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode ITALIC from Org to Texinfo.
|
|
|
|
|
CONTENTS is the text with italic markup. INFO is a plist holding
|
|
|
|
|
contextual information."
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(org-texinfo--text-markup contents 'italic info))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Item
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-item (item contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode an ITEM element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the item. INFO is a plist holding
|
|
|
|
|
contextual information."
|
2014-08-08 16:42:08 -04:00
|
|
|
|
(format "@item%s\n%s"
|
|
|
|
|
(let ((tag (org-element-property :tag item)))
|
|
|
|
|
(if tag (concat " " (org-export-data tag info)) ""))
|
|
|
|
|
(or contents "")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Keyword
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-keyword (keyword _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a KEYWORD element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual information."
|
|
|
|
|
(let ((key (org-element-property :key keyword))
|
|
|
|
|
(value (org-element-property :value keyword)))
|
|
|
|
|
(cond
|
|
|
|
|
((string= key "TEXINFO") value)
|
|
|
|
|
((string= key "CINDEX") (format "@cindex %s" value))
|
|
|
|
|
((string= key "FINDEX") (format "@findex %s" value))
|
|
|
|
|
((string= key "KINDEX") (format "@kindex %s" value))
|
|
|
|
|
((string= key "PINDEX") (format "@pindex %s" value))
|
|
|
|
|
((string= key "TINDEX") (format "@tindex %s" value))
|
2015-05-26 03:52:02 -04:00
|
|
|
|
((string= key "VINDEX") (format "@vindex %s" value))
|
|
|
|
|
((string= key "TOC")
|
|
|
|
|
(cond ((org-string-match-p "\\<tables\\>" value)
|
|
|
|
|
(concat "@listoffloats "
|
2015-05-26 04:02:36 -04:00
|
|
|
|
(org-export-translate "Table" :utf-8 info)))
|
|
|
|
|
((org-string-match-p "\\<listings\\>" value)
|
|
|
|
|
(concat "@listoffloats "
|
|
|
|
|
(org-export-translate "Listing" :utf-8 info))))))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Line Break
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-line-break (_line-break _contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a LINE-BREAK object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual information."
|
2012-12-12 16:48:06 -05:00
|
|
|
|
"@*\n")
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Link
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-link (link desc info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a LINK object from Org to Texinfo.
|
|
|
|
|
|
|
|
|
|
DESC is the description part of the link, or the empty string.
|
|
|
|
|
INFO is a plist holding contextual information. See
|
|
|
|
|
`org-export-data'."
|
|
|
|
|
(let* ((type (org-element-property :type link))
|
|
|
|
|
(raw-path (org-element-property :path link))
|
|
|
|
|
;; Ensure DESC really exists, or set it to nil.
|
|
|
|
|
(desc (and (not (string= desc "")) desc))
|
|
|
|
|
(path (cond
|
|
|
|
|
((member type '("http" "https" "ftp"))
|
2014-04-16 16:46:53 -04:00
|
|
|
|
(concat type ":" raw-path))
|
2015-04-20 06:37:13 -04:00
|
|
|
|
((string= type "file") (org-export-file-uri raw-path))
|
2015-01-04 15:54:41 -05:00
|
|
|
|
(t raw-path))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(cond
|
2015-02-24 09:54:01 -05:00
|
|
|
|
((org-export-custom-protocol-maybe link desc 'texinfo))
|
2015-05-25 18:55:13 -04:00
|
|
|
|
((org-export-inline-image-p link org-texinfo-inline-image-rules)
|
|
|
|
|
(org-texinfo--inline-image link info))
|
2014-08-27 18:55:32 -04:00
|
|
|
|
((equal type "radio")
|
|
|
|
|
(let ((destination (org-export-resolve-radio-link link info)))
|
|
|
|
|
(if (not destination) desc
|
|
|
|
|
(format "@ref{%s,,%s}"
|
|
|
|
|
(org-texinfo--get-node destination info)
|
|
|
|
|
desc))))
|
|
|
|
|
((member type '("custom-id" "id" "fuzzy"))
|
|
|
|
|
(let ((destination
|
|
|
|
|
(if (equal type "fuzzy")
|
|
|
|
|
(org-export-resolve-fuzzy-link link info)
|
|
|
|
|
(org-export-resolve-id-link link info))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(case (org-element-type destination)
|
2014-08-27 18:55:32 -04:00
|
|
|
|
((nil)
|
|
|
|
|
(format org-texinfo-link-with-unknown-path-format
|
|
|
|
|
(org-texinfo--sanitize-content path)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Id link points to an external file.
|
|
|
|
|
(plain-text
|
|
|
|
|
(if desc (format "@uref{file://%s,%s}" destination desc)
|
|
|
|
|
(format "@uref{file://%s}" destination)))
|
|
|
|
|
(headline
|
2012-12-14 09:43:27 -05:00
|
|
|
|
(format "@ref{%s,%s}"
|
2013-02-20 11:05:35 -05:00
|
|
|
|
(org-texinfo--get-node destination info)
|
2014-08-27 18:55:32 -04:00
|
|
|
|
(cond
|
|
|
|
|
(desc)
|
|
|
|
|
((org-export-numbered-headline-p destination info)
|
|
|
|
|
(mapconcat
|
|
|
|
|
#'number-to-string
|
2015-05-30 06:20:10 -04:00
|
|
|
|
(org-export-get-headline-number destination info) "."))
|
|
|
|
|
(t (org-export-data
|
|
|
|
|
(org-element-property :title destination) info)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(otherwise
|
2015-05-30 07:52:26 -04:00
|
|
|
|
(format "@ref{%s,,%s}"
|
|
|
|
|
(org-texinfo--get-node destination info)
|
|
|
|
|
(cond
|
|
|
|
|
(desc)
|
|
|
|
|
;; No description is provided: first try to
|
|
|
|
|
;; associate destination to a number.
|
|
|
|
|
((let ((n (org-export-get-ordinal destination info)))
|
|
|
|
|
(cond ((not n) nil)
|
|
|
|
|
((integerp n) n)
|
|
|
|
|
(t (mapconcat #'number-to-string n ".")))))
|
|
|
|
|
;; Then grab title of headline containing
|
|
|
|
|
;; DESTINATION.
|
|
|
|
|
((let ((h (org-element-lineage destination '(headline) t)))
|
|
|
|
|
(and h
|
|
|
|
|
(org-export-data
|
|
|
|
|
(org-element-property :title destination) info))))
|
|
|
|
|
;; Eventually, just return "Top" to refer to the
|
|
|
|
|
;; beginning of the info file.
|
|
|
|
|
(t "Top")))))))
|
2014-08-27 18:55:32 -04:00
|
|
|
|
((equal type "info")
|
2013-02-25 10:28:04 -05:00
|
|
|
|
(let* ((info-path (split-string path "[:#]"))
|
2012-12-13 08:38:31 -05:00
|
|
|
|
(info-manual (car info-path))
|
2015-05-30 06:29:50 -04:00
|
|
|
|
(info-node (or (cadr info-path) "Top"))
|
2012-12-13 08:38:31 -05:00
|
|
|
|
(title (or desc "")))
|
|
|
|
|
(format "@ref{%s,%s,,%s,}" info-node title info-manual)))
|
2014-08-27 18:55:32 -04:00
|
|
|
|
((string= type "mailto")
|
|
|
|
|
(format "@email{%s}"
|
|
|
|
|
(concat (org-texinfo--sanitize-content path)
|
|
|
|
|
(and desc (concat "," desc)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; External link with a description part.
|
|
|
|
|
((and path desc) (format "@uref{%s,%s}" path desc))
|
|
|
|
|
;; External link without a description part.
|
|
|
|
|
(path (format "@uref{%s}" path))
|
|
|
|
|
;; No path, only description. Try to do something useful.
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(t
|
|
|
|
|
(format (plist-get info :texinfo-link-with-unknown-path-format) desc)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-05-25 18:55:13 -04:00
|
|
|
|
(defun org-texinfo--inline-image (link info)
|
|
|
|
|
"Return Texinfo code for an inline image.
|
|
|
|
|
LINK is the link pointing to the inline image. INFO is the
|
|
|
|
|
current state of the export, as a plist."
|
|
|
|
|
(let* ((parent (org-export-get-parent-element link))
|
2015-05-29 05:27:10 -04:00
|
|
|
|
(label (and (org-element-property :name parent)
|
|
|
|
|
(org-texinfo--get-node parent info)))
|
2015-05-25 18:55:13 -04:00
|
|
|
|
(caption (org-export-get-caption parent))
|
|
|
|
|
(shortcaption (org-export-get-caption parent t))
|
2015-05-26 03:18:00 -04:00
|
|
|
|
(path (org-element-property :path link))
|
2015-05-25 18:55:13 -04:00
|
|
|
|
(filename
|
|
|
|
|
(file-name-sans-extension
|
2015-05-26 03:18:00 -04:00
|
|
|
|
(if (file-name-absolute-p path) (expand-file-name path) path)))
|
|
|
|
|
(extension (file-name-extension path))
|
2015-05-25 18:55:13 -04:00
|
|
|
|
(attributes (org-export-read-attribute :attr_texinfo parent))
|
|
|
|
|
(height (or (plist-get attributes :height) ""))
|
|
|
|
|
(width (or (plist-get attributes :width) ""))
|
|
|
|
|
(alt (or (plist-get attributes :alt) ""))
|
2015-05-26 03:18:00 -04:00
|
|
|
|
(image (format "@image{%s,%s,%s,%s,%s}"
|
|
|
|
|
filename width height alt extension)))
|
2015-05-29 05:27:10 -04:00
|
|
|
|
(cond ((or caption shortcaption)
|
|
|
|
|
(org-texinfo--wrap-float image
|
|
|
|
|
info
|
|
|
|
|
(org-export-translate "Figure" :utf-8 info)
|
|
|
|
|
label
|
|
|
|
|
caption
|
|
|
|
|
shortcaption))
|
|
|
|
|
(label (concat "@anchor{" label "}\n" image))
|
|
|
|
|
(t image))))
|
2015-05-25 18:55:13 -04:00
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Menu
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-08 19:54:51 -04:00
|
|
|
|
(defun org-texinfo-make-menu (scope info &optional master)
|
|
|
|
|
"Create the menu for inclusion in the Texinfo document.
|
|
|
|
|
|
|
|
|
|
SCOPE is a headline or a full parse tree. INFO is the
|
|
|
|
|
communication channel, as a plist.
|
|
|
|
|
|
|
|
|
|
When optional argument MASTER is non-nil, generate a master menu,
|
|
|
|
|
including detailed node listing."
|
|
|
|
|
(let ((menu (org-texinfo--build-menu scope info)))
|
|
|
|
|
(when (org-string-nw-p menu)
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(format
|
|
|
|
|
"@menu\n%s@end menu"
|
|
|
|
|
(concat menu
|
|
|
|
|
(when master
|
|
|
|
|
(let ((detailmenu
|
|
|
|
|
(org-texinfo--build-menu
|
|
|
|
|
scope info
|
|
|
|
|
(let ((toc-depth (plist-get info :with-toc)))
|
|
|
|
|
(if (wholenump toc-depth) toc-depth
|
|
|
|
|
org-texinfo-max-toc-depth)))))
|
|
|
|
|
(when (org-string-nw-p detailmenu)
|
|
|
|
|
(concat "\n@detailmenu\n"
|
|
|
|
|
"--- The Detailed Node Listing ---\n\n"
|
|
|
|
|
detailmenu
|
|
|
|
|
"@end detailmenu\n"))))))))))
|
|
|
|
|
|
|
|
|
|
(defun org-texinfo--build-menu (scope info &optional level)
|
|
|
|
|
"Build menu for entries within SCOPE.
|
|
|
|
|
SCOPE is a headline or a full parse tree. INFO is a plist
|
|
|
|
|
containing contextual information. When optional argument LEVEL
|
|
|
|
|
is an integer, build the menu recursively, down to this depth."
|
|
|
|
|
(cond
|
|
|
|
|
((not level)
|
|
|
|
|
(org-texinfo--format-entries (org-texinfo--menu-entries scope info) info))
|
|
|
|
|
((zerop level) nil)
|
|
|
|
|
(t
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(mapconcat
|
|
|
|
|
(lambda (h)
|
|
|
|
|
(let ((entries (org-texinfo--menu-entries h info)))
|
|
|
|
|
(when entries
|
|
|
|
|
(concat
|
|
|
|
|
(format "%s\n\n%s\n"
|
|
|
|
|
(org-export-data (org-export-get-alt-title h info) info)
|
|
|
|
|
(org-texinfo--format-entries entries info))
|
|
|
|
|
(org-texinfo--build-menu h info (1- level))))))
|
|
|
|
|
(org-texinfo--menu-entries scope info) "")))))
|
|
|
|
|
|
|
|
|
|
(defun org-texinfo--format-entries (entries info)
|
|
|
|
|
"Format all direct menu entries in SCOPE, as a string.
|
|
|
|
|
SCOPE is either a headline or a full Org document. INFO is
|
|
|
|
|
a plist containing contextual information."
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(mapconcat
|
|
|
|
|
(lambda (h)
|
|
|
|
|
(let* ((title (org-export-data
|
|
|
|
|
(org-export-get-alt-title h info) info))
|
|
|
|
|
(node (org-texinfo--get-node h info))
|
|
|
|
|
(entry (concat "* " title ":"
|
|
|
|
|
(if (string= title node) ":"
|
|
|
|
|
(concat " " node ". "))))
|
|
|
|
|
(desc (org-element-property :DESCRIPTION h)))
|
|
|
|
|
(if (not desc) entry
|
|
|
|
|
(format (format "%%-%ds %%s" org-texinfo-node-description-column)
|
|
|
|
|
entry desc))))
|
|
|
|
|
entries "\n")))
|
|
|
|
|
|
|
|
|
|
(defun org-texinfo--menu-entries (scope info)
|
|
|
|
|
"List direct children in SCOPE needing a menu entry.
|
|
|
|
|
SCOPE is a headline or a full parse tree. INFO is a plist
|
|
|
|
|
holding contextual information."
|
|
|
|
|
(let* ((cache (or (plist-get info :texinfo-entries-cache)
|
|
|
|
|
(plist-get (plist-put info :texinfo-entries-cache
|
|
|
|
|
(make-hash-table :test #'eq))
|
|
|
|
|
:texinfo-entries-cache)))
|
|
|
|
|
(cached-entries (gethash scope cache 'no-cache)))
|
|
|
|
|
(if (not (eq cached-entries 'no-cache)) cached-entries
|
|
|
|
|
(puthash scope
|
|
|
|
|
(org-element-map (org-element-contents scope) 'headline
|
|
|
|
|
(lambda (h)
|
|
|
|
|
(and (not (org-not-nil (org-element-property :COPYING h)))
|
|
|
|
|
(not (org-element-property :footnote-section-p h))
|
|
|
|
|
(not (org-export-low-level-p h info))
|
|
|
|
|
h))
|
|
|
|
|
info nil 'headline)
|
|
|
|
|
cache))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-09-25 15:27:29 -04:00
|
|
|
|
;;;; Node Property
|
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-node-property (node-property _contents _info)
|
2013-09-25 15:27:29 -04:00
|
|
|
|
"Transcode a NODE-PROPERTY element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual
|
|
|
|
|
information."
|
|
|
|
|
(format "%s:%s"
|
|
|
|
|
(org-element-property :key node-property)
|
|
|
|
|
(let ((value (org-element-property :value node-property)))
|
|
|
|
|
(if value (concat " " value) ""))))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Paragraph
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-paragraph (_paragraph contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a PARAGRAPH element from Org to Texinfo.
|
|
|
|
|
CONTENTS is the contents of the paragraph, as a string. INFO is
|
|
|
|
|
the plist used as a communication channel."
|
|
|
|
|
contents)
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Plain List
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-plain-list (plain-list contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a PLAIN-LIST element from Org to Texinfo.
|
|
|
|
|
CONTENTS is the contents of the list. INFO is a plist holding
|
|
|
|
|
contextual information."
|
|
|
|
|
(let* ((attr (org-export-read-attribute :attr_texinfo plain-list))
|
|
|
|
|
(indic (or (plist-get attr :indic)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(plist-get info :texinfo-def-table-markup)))
|
2013-03-08 19:02:02 -05:00
|
|
|
|
(table-type (plist-get attr :table-type))
|
2014-08-06 17:46:04 -04:00
|
|
|
|
(type (org-element-property :type plain-list))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(list-type (cond
|
|
|
|
|
((eq type 'ordered) "enumerate")
|
|
|
|
|
((eq type 'unordered) "itemize")
|
2014-08-06 17:46:04 -04:00
|
|
|
|
((member table-type '("ftable" "vtable")) table-type)
|
|
|
|
|
(t "table"))))
|
|
|
|
|
(format "@%s\n%s@end %s"
|
|
|
|
|
(if (eq type 'descriptive) (concat list-type " " indic) list-type)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
contents
|
|
|
|
|
list-type)))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Plain Text
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-plain-text (text info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a TEXT string from Org to Texinfo.
|
|
|
|
|
TEXT is the string to transcode. INFO is a plist holding
|
|
|
|
|
contextual information."
|
2012-10-26 18:36:00 -04:00
|
|
|
|
;; First protect @, { and }.
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(let ((output (org-texinfo--sanitize-content text)))
|
2012-10-26 18:36:00 -04:00
|
|
|
|
;; Activate smart quotes. Be sure to provide original TEXT string
|
|
|
|
|
;; since OUTPUT may have been modified.
|
|
|
|
|
(when (plist-get info :with-smart-quotes)
|
|
|
|
|
(setq output
|
|
|
|
|
(org-export-activate-smart-quotes output :texinfo info text)))
|
|
|
|
|
;; LaTeX into @LaTeX{} and TeX into @TeX{}
|
|
|
|
|
(let ((case-fold-search nil)
|
|
|
|
|
(start 0))
|
|
|
|
|
(while (string-match "\\(\\(?:La\\)?TeX\\)" output start)
|
|
|
|
|
(setq output (replace-match
|
|
|
|
|
(format "@%s{}" (match-string 1 output)) nil t output)
|
|
|
|
|
start (match-end 0))))
|
|
|
|
|
;; Convert special strings.
|
|
|
|
|
(when (plist-get info :with-special-strings)
|
|
|
|
|
(while (string-match (regexp-quote "...") output)
|
|
|
|
|
(setq output (replace-match "@dots{}" nil t output))))
|
|
|
|
|
;; Handle break preservation if required.
|
|
|
|
|
(when (plist-get info :preserve-breaks)
|
|
|
|
|
(setq output (replace-regexp-in-string
|
|
|
|
|
"\\(\\\\\\\\\\)?[ \t]*\n" " @*\n" output)))
|
|
|
|
|
;; Return value.
|
|
|
|
|
output))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Planning
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-planning (planning _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a PLANNING element from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual
|
|
|
|
|
information."
|
|
|
|
|
(concat
|
|
|
|
|
"@noindent"
|
|
|
|
|
(mapconcat
|
|
|
|
|
'identity
|
|
|
|
|
(delq nil
|
|
|
|
|
(list
|
|
|
|
|
(let ((closed (org-element-property :closed planning)))
|
|
|
|
|
(when closed
|
|
|
|
|
(concat
|
2012-10-30 16:59:50 -04:00
|
|
|
|
(format "@strong{%s} " org-closed-string)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(format (plist-get info :texinfo-inactive-timestamp-format)
|
2014-12-03 11:09:43 -05:00
|
|
|
|
(org-timestamp-translate closed)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(let ((deadline (org-element-property :deadline planning)))
|
|
|
|
|
(when deadline
|
|
|
|
|
(concat
|
|
|
|
|
(format "@strong{%s} " org-deadline-string)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(format (plist-get info :texinfo-active-timestamp-format)
|
2014-12-03 11:09:43 -05:00
|
|
|
|
(org-timestamp-translate deadline)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(let ((scheduled (org-element-property :scheduled planning)))
|
|
|
|
|
(when scheduled
|
|
|
|
|
(concat
|
|
|
|
|
(format "@strong{%s} " org-scheduled-string)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(format (plist-get info :texinfo-active-timestamp-format)
|
2014-12-03 11:09:43 -05:00
|
|
|
|
(org-timestamp-translate scheduled)))))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
" ")
|
|
|
|
|
"@*"))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Property Drawer
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-property-drawer (_property-drawer contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a PROPERTY-DRAWER element from Org to Texinfo.
|
2013-09-25 15:27:29 -04:00
|
|
|
|
CONTENTS holds the contents of the drawer. INFO is a plist
|
|
|
|
|
holding contextual information."
|
|
|
|
|
(and (org-string-nw-p contents)
|
|
|
|
|
(format "@verbatim\n%s@end verbatim" contents)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Quote Block
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-quote-block (quote-block contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a QUOTE-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the block. INFO is a plist
|
|
|
|
|
holding contextual information."
|
|
|
|
|
(let* ((title (org-element-property :name quote-block))
|
|
|
|
|
(start-quote (concat "@quotation"
|
|
|
|
|
(if title
|
2012-08-15 18:00:51 -04:00
|
|
|
|
(format " %s" title)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(format "%s\n%s@end quotation" start-quote contents)))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Radio Target
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-radio-target (radio-target text info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a RADIO-TARGET object from Org to Texinfo.
|
|
|
|
|
TEXT is the text of the target. INFO is a plist holding
|
|
|
|
|
contextual information."
|
|
|
|
|
(format "@anchor{%s}%s"
|
2015-04-13 05:24:42 -04:00
|
|
|
|
(org-export-get-reference radio-target info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
text))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Section
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-section (section contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a SECTION element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the section. INFO is a plist
|
|
|
|
|
holding contextual information."
|
2014-08-08 19:54:51 -04:00
|
|
|
|
(concat contents
|
|
|
|
|
(let ((parent (org-export-get-parent-headline section)))
|
|
|
|
|
(and parent (org-texinfo-make-menu parent info)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Special Block
|
2012-10-26 18:36:00 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-special-block (special-block contents _info)
|
2012-10-26 18:36:00 -04:00
|
|
|
|
"Transcode a SPECIAL-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the block. INFO is a plist used
|
|
|
|
|
as a communication channel."
|
2014-09-19 04:39:02 -04:00
|
|
|
|
(let ((type (org-element-property :type special-block)))
|
2014-09-17 13:38:06 -04:00
|
|
|
|
(format "@%s\n%s@end %s" type contents type)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Src Block
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-src-block (src-block _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a SRC-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS holds the contents of the item. INFO is a plist holding
|
|
|
|
|
contextual information."
|
2015-05-26 04:02:36 -04:00
|
|
|
|
(let* ((lisp (org-string-match-p "lisp"
|
2014-08-14 05:44:52 -04:00
|
|
|
|
(org-element-property :language src-block)))
|
2015-05-26 04:02:36 -04:00
|
|
|
|
(code (org-texinfo--sanitize-content
|
|
|
|
|
(org-export-format-code-default src-block info)))
|
|
|
|
|
(value (format
|
|
|
|
|
(if lisp "@lisp\n%s@end lisp" "@example\n%s@end example")
|
|
|
|
|
code))
|
|
|
|
|
(caption (org-export-get-caption src-block))
|
|
|
|
|
(shortcaption (org-export-get-caption src-block t)))
|
|
|
|
|
(if (not (or caption shortcaption)) value
|
|
|
|
|
(org-texinfo--wrap-float value
|
|
|
|
|
info
|
|
|
|
|
(org-export-translate "Listing" :utf-8 info)
|
2015-05-29 05:43:28 -04:00
|
|
|
|
(org-export-get-reference src-block info)
|
2015-05-26 04:02:36 -04:00
|
|
|
|
caption
|
|
|
|
|
shortcaption))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Statistics Cookie
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-statistics-cookie (statistics-cookie _contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a STATISTICS-COOKIE object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual information."
|
|
|
|
|
(org-element-property :value statistics-cookie))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Subscript
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-subscript (_subscript contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a SUBSCRIPT object from Org to Texinfo.
|
|
|
|
|
CONTENTS is the contents of the object. INFO is a plist holding
|
|
|
|
|
contextual information."
|
|
|
|
|
(format "@math{_%s}" contents))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Superscript
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-superscript (_superscript contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a SUPERSCRIPT object from Org to Texinfo.
|
|
|
|
|
CONTENTS is the contents of the object. INFO is a plist holding
|
|
|
|
|
contextual information."
|
|
|
|
|
(format "@math{^%s}" contents))
|
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Table
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-table (table contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a TABLE element from Org to Texinfo.
|
|
|
|
|
CONTENTS is the contents of the table. INFO is a plist holding
|
|
|
|
|
contextual information."
|
2014-08-04 09:03:29 -04:00
|
|
|
|
(if (eq (org-element-property :type table) 'table.el)
|
|
|
|
|
(format "@verbatim\n%s@end verbatim"
|
|
|
|
|
(org-element-normalize-string
|
|
|
|
|
(org-element-property :value table)))
|
|
|
|
|
(let* ((col-width (org-export-read-attribute :attr_texinfo table :columns))
|
|
|
|
|
(columns
|
|
|
|
|
(if col-width (format "@columnfractions %s" col-width)
|
2015-05-26 03:52:02 -04:00
|
|
|
|
(org-texinfo-table-column-widths table info)))
|
|
|
|
|
(caption (org-export-get-caption table))
|
|
|
|
|
(shortcaption (org-export-get-caption table t))
|
|
|
|
|
(table-str (format "@multitable %s\n%s@end multitable"
|
|
|
|
|
columns
|
|
|
|
|
contents)))
|
|
|
|
|
(if (not (or caption shortcaption)) table-str
|
|
|
|
|
(org-texinfo--wrap-float table-str
|
|
|
|
|
info
|
|
|
|
|
(org-export-translate "Table" :utf-8 info)
|
2015-05-29 05:43:28 -04:00
|
|
|
|
(org-export-get-reference table info)
|
2015-05-26 03:52:02 -04:00
|
|
|
|
caption
|
|
|
|
|
shortcaption)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-table-column-widths (table info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Determine the largest table cell in each column to process alignment.
|
|
|
|
|
TABLE is the table element to transcode. INFO is a plist used as
|
|
|
|
|
a communication channel."
|
2014-08-04 09:03:29 -04:00
|
|
|
|
(let ((widths (make-vector (cdr (org-export-table-dimensions table info)) 0)))
|
|
|
|
|
(org-element-map table 'table-row
|
|
|
|
|
(lambda (row)
|
|
|
|
|
(let ((idx 0))
|
|
|
|
|
(org-element-map row 'table-cell
|
|
|
|
|
(lambda (cell)
|
|
|
|
|
;; Length of the cell in the original buffer is only an
|
|
|
|
|
;; approximation of the length of the cell in the
|
|
|
|
|
;; output. It can sometimes fail (e.g. it considers
|
|
|
|
|
;; "/a/" being larger than "ab").
|
|
|
|
|
(let ((w (- (org-element-property :contents-end cell)
|
|
|
|
|
(org-element-property :contents-begin cell))))
|
|
|
|
|
(aset widths idx (max w (aref widths idx))))
|
|
|
|
|
(incf idx))
|
|
|
|
|
info)))
|
|
|
|
|
info)
|
|
|
|
|
(format "{%s}" (mapconcat (lambda (w) (make-string w ?a)) widths "} {"))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Table Cell
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-table-cell (table-cell contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a TABLE-CELL element from Org to Texinfo.
|
|
|
|
|
CONTENTS is the cell contents. INFO is a plist used as
|
|
|
|
|
a communication channel."
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(concat
|
|
|
|
|
(let ((scientific-notation
|
|
|
|
|
(plist-get info :texinfo-table-scientific-notation)))
|
|
|
|
|
(if (and contents
|
|
|
|
|
scientific-notation
|
|
|
|
|
(string-match orgtbl-exp-regexp contents))
|
|
|
|
|
;; Use appropriate format string for scientific notation.
|
|
|
|
|
(format scientific-notation
|
|
|
|
|
(match-string 1 contents)
|
|
|
|
|
(match-string 2 contents))
|
|
|
|
|
contents))
|
|
|
|
|
(when (org-export-get-next-element table-cell info) "\n@tab ")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Table Row
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-table-row (table-row contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a TABLE-ROW element from Org to Texinfo.
|
|
|
|
|
CONTENTS is the contents of the row. INFO is a plist used as
|
|
|
|
|
a communication channel."
|
|
|
|
|
;; Rules are ignored since table separators are deduced from
|
|
|
|
|
;; borders of the current row.
|
2012-08-15 18:00:51 -04:00
|
|
|
|
(when (eq (org-element-property :type table-row) 'standard)
|
2014-08-04 09:03:29 -04:00
|
|
|
|
(let ((rowgroup-tag
|
|
|
|
|
(if (and (= 1 (org-export-table-row-group table-row info))
|
|
|
|
|
(org-export-table-has-header-p
|
|
|
|
|
(org-export-get-parent-table table-row) info))
|
|
|
|
|
"@headitem "
|
|
|
|
|
"@item ")))
|
|
|
|
|
(concat rowgroup-tag contents "\n"))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Target
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-target (target _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a TARGET object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual
|
|
|
|
|
information."
|
2015-04-13 05:24:42 -04:00
|
|
|
|
(format "@anchor{%s}" (org-export-get-reference target info)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Timestamp
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-timestamp (timestamp _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a TIMESTAMP object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist holding contextual
|
|
|
|
|
information."
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(let ((value (org-texinfo-plain-text
|
2013-01-10 15:42:21 -05:00
|
|
|
|
(org-timestamp-translate timestamp) info)))
|
2012-10-28 11:20:45 -04:00
|
|
|
|
(case (org-element-property :type timestamp)
|
|
|
|
|
((active active-range)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(format (plist-get info :texinfo-active-timestamp-format) value))
|
2012-10-28 11:20:45 -04:00
|
|
|
|
((inactive inactive-range)
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(format (plist-get info :texinfo-inactive-timestamp-format) value))
|
|
|
|
|
(t (format (plist-get info :texinfo-diary-timestamp-format) value)))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Verbatim
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-verbatim (verbatim _contents info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a VERBATIM object from Org to Texinfo.
|
|
|
|
|
CONTENTS is nil. INFO is a plist used as a communication
|
|
|
|
|
channel."
|
Use options instead of hard-coded variables
* lisp/ox-beamer.el (org-beamer--format-frame,
org-beamer--format-block, org-beamer-template): Use options instead
of hard-coded variables.
* lisp/ox-man.el (org-man-inline-src-block, org-man-src-block,
org-man-table, org-man-table-cell): Use options instead of
hard-coded variables.
* lisp/ox-md.el (org-md-headline): Use options instead of hard-coded
variables.
* lisp/ox-texinfo.el (org-texinfo-format-headline-function,
org-texinfo-format-inlinetask-function): Change default value.
(org-texinfo--text-markup, org-texinfo--format-menu): Change signature
(org-texinfo--build-menu, org-texinfo-bold, org-texinfo-code,
org-texinfo-comment, org-texinfo-italic, org-texinfo-verbatim): Apply
signature change.
(org-texinfo-template, org-texinfo-clock, org-texinfo-drawer,
org-texinfo-link, org-texinfo-plain-list, org-texinfo-planning,
org-texinfo-table, org-texinfo-table-cell, org-texinfo-timestamp): Use
options instead of variable names.
(org-texinfo-format-headline-default-function,
org-texinfo-format-inlinetask-default-function): New functions.
(org-texinfo-headline, org-texinfo-inlinetask): Use new functions.
2014-07-28 09:44:56 -04:00
|
|
|
|
(org-texinfo--text-markup
|
|
|
|
|
(org-element-property :value verbatim) 'verbatim info))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2014-08-06 17:53:42 -04:00
|
|
|
|
;;;; Verse Block
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2015-11-05 18:11:00 -05:00
|
|
|
|
(defun org-texinfo-verse-block (_verse-block contents _info)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Transcode a VERSE-BLOCK element from Org to Texinfo.
|
|
|
|
|
CONTENTS is verse block contents. INFO is a plist holding
|
|
|
|
|
contextual information."
|
2014-08-04 09:21:51 -04:00
|
|
|
|
(format "@display\n%s@end display" contents))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Interactive functions
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-export-to-texinfo
|
2012-12-02 11:24:19 -05:00
|
|
|
|
(&optional async subtreep visible-only body-only ext-plist)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Export current buffer to a Texinfo file.
|
|
|
|
|
|
|
|
|
|
If narrowing is active in the current buffer, only export its
|
|
|
|
|
narrowed part.
|
|
|
|
|
|
|
|
|
|
If a region is active, export that region.
|
|
|
|
|
|
2012-12-02 11:24:19 -05:00
|
|
|
|
A non-nil optional argument ASYNC means the process should happen
|
|
|
|
|
asynchronously. The resulting file should be accessible through
|
|
|
|
|
the `org-export-stack' interface.
|
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
When optional argument SUBTREEP is non-nil, export the sub-tree
|
|
|
|
|
at point, extracting information from the headline properties
|
|
|
|
|
first.
|
|
|
|
|
|
|
|
|
|
When optional argument VISIBLE-ONLY is non-nil, don't export
|
|
|
|
|
contents of hidden elements.
|
|
|
|
|
|
|
|
|
|
When optional argument BODY-ONLY is non-nil, only write code
|
|
|
|
|
between \"\\begin{document}\" and \"\\end{document}\".
|
|
|
|
|
|
|
|
|
|
EXT-PLIST, when provided, is a property list with external
|
|
|
|
|
parameters overriding Org default settings, but still inferior to
|
|
|
|
|
file-local settings.
|
|
|
|
|
|
|
|
|
|
Return output file's name."
|
|
|
|
|
(interactive)
|
2013-03-19 05:24:30 -04:00
|
|
|
|
(let ((outfile (org-export-output-file-name ".texi" subtreep))
|
2013-09-20 04:41:21 -04:00
|
|
|
|
(org-export-coding-system org-texinfo-coding-system))
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 04:35:42 -04:00
|
|
|
|
(org-export-to-file 'texinfo outfile
|
|
|
|
|
async subtreep visible-only body-only ext-plist)))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-export-to-info
|
2012-12-02 11:24:19 -05:00
|
|
|
|
(&optional async subtreep visible-only body-only ext-plist)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Export current buffer to Texinfo then process through to INFO.
|
|
|
|
|
|
|
|
|
|
If narrowing is active in the current buffer, only export its
|
|
|
|
|
narrowed part.
|
|
|
|
|
|
|
|
|
|
If a region is active, export that region.
|
|
|
|
|
|
2012-12-02 11:24:19 -05:00
|
|
|
|
A non-nil optional argument ASYNC means the process should happen
|
|
|
|
|
asynchronously. The resulting file should be accessible through
|
|
|
|
|
the `org-export-stack' interface.
|
|
|
|
|
|
2012-08-15 16:00:20 -04:00
|
|
|
|
When optional argument SUBTREEP is non-nil, export the sub-tree
|
|
|
|
|
at point, extracting information from the headline properties
|
|
|
|
|
first.
|
|
|
|
|
|
|
|
|
|
When optional argument VISIBLE-ONLY is non-nil, don't export
|
|
|
|
|
contents of hidden elements.
|
|
|
|
|
|
|
|
|
|
When optional argument BODY-ONLY is non-nil, only write code
|
|
|
|
|
between \"\\begin{document}\" and \"\\end{document}\".
|
|
|
|
|
|
|
|
|
|
EXT-PLIST, when provided, is a property list with external
|
|
|
|
|
parameters overriding Org default settings, but still inferior to
|
|
|
|
|
file-local settings.
|
|
|
|
|
|
|
|
|
|
When optional argument PUB-DIR is set, use it as the publishing
|
|
|
|
|
directory.
|
|
|
|
|
|
|
|
|
|
Return INFO file's name."
|
|
|
|
|
(interactive)
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 04:35:42 -04:00
|
|
|
|
(let ((outfile (org-export-output-file-name ".texi" subtreep))
|
2013-09-20 04:37:32 -04:00
|
|
|
|
(org-export-coding-system org-texinfo-coding-system))
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 04:35:42 -04:00
|
|
|
|
(org-export-to-file 'texinfo outfile
|
|
|
|
|
async subtreep visible-only body-only ext-plist
|
|
|
|
|
(lambda (file) (org-texinfo-compile file)))))
|
2013-03-19 05:24:30 -04:00
|
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun org-texinfo-publish-to-texinfo (plist filename pub-dir)
|
|
|
|
|
"Publish an org file to Texinfo.
|
|
|
|
|
|
|
|
|
|
FILENAME is the filename of the Org file to be published. PLIST
|
|
|
|
|
is the property list for the given project. PUB-DIR is the
|
|
|
|
|
publishing directory.
|
|
|
|
|
|
|
|
|
|
Return output file name."
|
|
|
|
|
(org-publish-org-to 'texinfo filename ".texi" plist pub-dir))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-04-06 13:09:38 -04:00
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun org-texinfo-convert-region-to-texinfo ()
|
|
|
|
|
"Assume the current region has org-mode syntax, and convert it to Texinfo.
|
|
|
|
|
This can be used in any buffer. For example, you can write an
|
|
|
|
|
itemized list in org-mode syntax in an Texinfo buffer and use
|
|
|
|
|
this command to convert it."
|
|
|
|
|
(interactive)
|
|
|
|
|
(org-export-replace-region-by 'texinfo))
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-compile (file)
|
2012-08-15 16:00:20 -04:00
|
|
|
|
"Compile a texinfo file.
|
|
|
|
|
|
2012-10-25 10:07:13 -04:00
|
|
|
|
FILE is the name of the file being compiled. Processing is
|
2013-01-27 17:11:34 -05:00
|
|
|
|
done through the command specified in `org-texinfo-info-process'.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
Return INFO file name or an error if it couldn't be produced."
|
2012-10-25 10:07:13 -04:00
|
|
|
|
(let* ((base-name (file-name-sans-extension (file-name-nondirectory file)))
|
|
|
|
|
(full-name (file-truename file))
|
|
|
|
|
(out-dir (file-name-directory file))
|
2013-05-30 14:29:34 -04:00
|
|
|
|
;; Properly set working directory for compilation.
|
2013-05-30 15:48:48 -04:00
|
|
|
|
(default-directory (if (file-name-absolute-p file)
|
2013-05-30 14:29:34 -04:00
|
|
|
|
(file-name-directory full-name)
|
|
|
|
|
default-directory))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
errors)
|
2015-08-05 22:06:57 -04:00
|
|
|
|
(message "Processing Texinfo file %s..." file)
|
2012-10-25 10:07:13 -04:00
|
|
|
|
(save-window-excursion
|
2014-08-11 07:44:13 -04:00
|
|
|
|
;; Replace %b, %f and %o with appropriate values in each command
|
|
|
|
|
;; before applying it. Output is redirected to "*Org INFO
|
|
|
|
|
;; Texinfo Output*" buffer.
|
|
|
|
|
(let ((outbuf (get-buffer-create "*Org INFO Texinfo Output*")))
|
2015-05-29 05:31:01 -04:00
|
|
|
|
(with-current-buffer outbuf (compilation-mode))
|
2014-08-11 07:44:13 -04:00
|
|
|
|
(dolist (command org-texinfo-info-process)
|
|
|
|
|
(shell-command
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
"%b" (shell-quote-argument base-name)
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
"%f" (shell-quote-argument full-name)
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
"%o" (shell-quote-argument out-dir) command t t) t t) t t)
|
|
|
|
|
outbuf))
|
|
|
|
|
;; Collect standard errors from output buffer.
|
|
|
|
|
(setq errors (org-texinfo-collect-errors outbuf)))
|
2013-05-30 14:29:48 -04:00
|
|
|
|
(let ((infofile (concat out-dir base-name ".info")))
|
2012-10-25 10:07:13 -04:00
|
|
|
|
;; Check for process failure. Provide collected errors if
|
|
|
|
|
;; possible.
|
|
|
|
|
(if (not (file-exists-p infofile))
|
2015-09-20 12:40:35 -04:00
|
|
|
|
(error "INFO file %s wasn't produced%s" infofile
|
|
|
|
|
(if errors (concat ": " errors) ""))
|
2012-10-25 10:07:13 -04:00
|
|
|
|
;; Else remove log files, when specified, and signal end of
|
|
|
|
|
;; process to user, along with any error encountered.
|
2013-03-19 05:31:23 -04:00
|
|
|
|
(when org-texinfo-remove-logfiles
|
|
|
|
|
(dolist (ext org-texinfo-logfiles-extensions)
|
|
|
|
|
(let ((file (concat out-dir base-name "." ext)))
|
|
|
|
|
(when (file-exists-p file) (delete-file file)))))
|
2012-10-25 10:07:13 -04:00
|
|
|
|
(message (concat "Process completed"
|
|
|
|
|
(if (not errors) "."
|
|
|
|
|
(concat " with errors: " errors)))))
|
|
|
|
|
;; Return output file name.
|
|
|
|
|
infofile))))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
(defun org-texinfo-collect-errors (buffer)
|
2012-08-23 08:36:15 -04:00
|
|
|
|
"Collect some kind of errors from \"makeinfo\" command output.
|
2012-08-15 16:00:20 -04:00
|
|
|
|
|
|
|
|
|
BUFFER is the buffer containing output.
|
|
|
|
|
|
|
|
|
|
Return collected error types as a string, or nil if there was
|
|
|
|
|
none."
|
|
|
|
|
(with-current-buffer buffer
|
|
|
|
|
(save-excursion
|
2012-08-23 08:36:15 -04:00
|
|
|
|
(goto-char (point-min))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
;; Find final "makeinfo" run.
|
2012-08-23 08:36:15 -04:00
|
|
|
|
(when t
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(let ((case-fold-search t)
|
|
|
|
|
(errors ""))
|
|
|
|
|
(when (save-excursion
|
|
|
|
|
(re-search-forward "perhaps incorrect sectioning?" nil t))
|
2012-11-10 21:41:54 -05:00
|
|
|
|
(setq errors (concat errors " [incorrect sectioning]")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(when (save-excursion
|
|
|
|
|
(re-search-forward "missing close brace" nil t))
|
|
|
|
|
(setq errors (concat errors " [syntax error]")))
|
|
|
|
|
(when (save-excursion
|
|
|
|
|
(re-search-forward "Unknown command" nil t))
|
|
|
|
|
(setq errors (concat errors " [undefined @command]")))
|
|
|
|
|
(when (save-excursion
|
|
|
|
|
(re-search-forward "No matching @end" nil t))
|
|
|
|
|
(setq errors (concat errors " [block incomplete]")))
|
|
|
|
|
(when (save-excursion
|
|
|
|
|
(re-search-forward "requires a sectioning" nil t))
|
|
|
|
|
(setq errors (concat errors " [invalid section command]")))
|
|
|
|
|
(when (save-excursion
|
2015-09-17 19:08:20 -04:00
|
|
|
|
(re-search-forward "\\[unexpected\ ]" nil t))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(setq errors (concat errors " [unexpected error]")))
|
2012-08-23 08:36:15 -04:00
|
|
|
|
(when (save-excursion
|
|
|
|
|
(re-search-forward "misplaced " nil t))
|
|
|
|
|
(setq errors (concat errors " [syntax error]")))
|
2012-08-15 16:00:20 -04:00
|
|
|
|
(and (org-string-nw-p errors) (org-trim errors)))))))
|
|
|
|
|
|
2013-01-27 17:11:34 -05:00
|
|
|
|
|
|
|
|
|
(provide 'ox-texinfo)
|
|
|
|
|
|
|
|
|
|
;; Local variables:
|
|
|
|
|
;; generated-autoload-file: "org-loaddefs.el"
|
|
|
|
|
;; End:
|
|
|
|
|
|
|
|
|
|
;;; ox-texinfo.el ends here
|