2009-04-09 11:25:44 -04:00
|
|
|
;;; org-latex.el --- LaTeX exporter for org-mode
|
2008-01-31 05:36:29 -05:00
|
|
|
;;
|
2010-04-07 10:26:10 -04:00
|
|
|
;; Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
|
2008-01-31 05:35:58 -05:00
|
|
|
;;
|
2008-01-31 05:36:29 -05:00
|
|
|
;; Emacs Lisp Archive Entry
|
2009-04-09 11:25:44 -04:00
|
|
|
;; Filename: org-latex.el
|
2011-03-07 09:27:39 -05:00
|
|
|
;; Version: 7.5
|
2008-01-31 05:35:58 -05:00
|
|
|
;; Author: Bastien Guerry <bzg AT altern DOT org>
|
2009-02-20 01:55:05 -05:00
|
|
|
;; Maintainer: Carsten Dominik <carsten.dominik AT gmail DOT com>
|
2008-01-31 05:36:29 -05:00
|
|
|
;; Keywords: org, wp, tex
|
|
|
|
;; Description: Converts an org-mode buffer into LaTeX
|
2008-05-06 08:45:52 -04:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
;; This file is part of GNU Emacs.
|
2008-05-06 08:45:52 -04:00
|
|
|
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
|
|
;; 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.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
|
|
;; 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.
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2008-05-06 08:45:52 -04:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
;;; Commentary:
|
2008-01-31 05:36:08 -05:00
|
|
|
;;
|
|
|
|
;; This library implements a LaTeX exporter for org-mode.
|
2008-01-31 05:37:51 -05:00
|
|
|
;;
|
2009-04-09 11:25:44 -04:00
|
|
|
;; It is part of Org and will be autoloaded
|
2008-01-31 05:37:51 -05:00
|
|
|
;;
|
2008-01-31 05:35:58 -05:00
|
|
|
;; The interactive functions are similar to those of the HTML exporter:
|
2008-01-31 05:37:51 -05:00
|
|
|
;;
|
2008-01-31 05:35:58 -05:00
|
|
|
;; M-x `org-export-as-latex'
|
2008-10-15 11:21:52 -04:00
|
|
|
;; M-x `org-export-as-pdf'
|
|
|
|
;; M-x `org-export-as-pdf-and-open'
|
2008-01-31 05:35:58 -05:00
|
|
|
;; M-x `org-export-as-latex-batch'
|
|
|
|
;; M-x `org-export-as-latex-to-buffer'
|
|
|
|
;; M-x `org-export-region-as-latex'
|
|
|
|
;; M-x `org-replace-region-by-latex'
|
2008-03-07 06:57:14 -05:00
|
|
|
;;
|
2008-01-31 05:35:58 -05:00
|
|
|
;;; Code:
|
|
|
|
|
2008-01-31 05:36:08 -05:00
|
|
|
(eval-when-compile
|
2008-01-31 05:36:18 -05:00
|
|
|
(require 'cl))
|
2008-01-31 05:36:08 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
(require 'footnote)
|
2008-01-31 05:35:58 -05:00
|
|
|
(require 'org)
|
2008-03-22 11:52:18 -04:00
|
|
|
(require 'org-exp)
|
2009-09-29 05:53:03 -04:00
|
|
|
(require 'org-macs)
|
2009-12-11 02:56:14 -05:00
|
|
|
(require 'org-beamer)
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
;;; Variables:
|
2008-01-31 05:37:51 -05:00
|
|
|
(defvar org-export-latex-class nil)
|
2009-11-27 08:48:03 -05:00
|
|
|
(defvar org-export-latex-class-options nil)
|
2008-01-31 05:37:51 -05:00
|
|
|
(defvar org-export-latex-header nil)
|
|
|
|
(defvar org-export-latex-append-header nil)
|
|
|
|
(defvar org-export-latex-options-plist nil)
|
|
|
|
(defvar org-export-latex-todo-keywords-1 nil)
|
2009-05-14 04:20:04 -04:00
|
|
|
(defvar org-export-latex-complex-heading-re nil)
|
2009-05-12 06:27:56 -04:00
|
|
|
(defvar org-export-latex-not-done-keywords nil)
|
|
|
|
(defvar org-export-latex-done-keywords nil)
|
2009-04-13 02:52:11 -04:00
|
|
|
(defvar org-export-latex-display-custom-times nil)
|
2008-01-31 05:37:51 -05:00
|
|
|
(defvar org-export-latex-all-targets-re nil)
|
|
|
|
(defvar org-export-latex-add-level 0)
|
|
|
|
(defvar org-export-latex-sectioning "")
|
|
|
|
(defvar org-export-latex-sectioning-depth 0)
|
2009-01-08 08:25:26 -05:00
|
|
|
(defvar org-export-latex-special-keyword-regexp
|
|
|
|
(concat "\\<\\(" org-scheduled-string "\\|"
|
|
|
|
org-deadline-string "\\|"
|
|
|
|
org-closed-string"\\)")
|
|
|
|
"Regexp matching special time planning keywords plus the time after it.")
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
(defvar re-quote) ; dynamically scoped from org.el
|
|
|
|
(defvar commentsp) ; dynamically scoped from org.el
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
;;; User variables:
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-09-03 03:10:17 -04:00
|
|
|
(defgroup org-export-latex nil
|
|
|
|
"Options for exporting Org-mode files to LaTeX."
|
|
|
|
:tag "Org Export LaTeX"
|
|
|
|
:group 'org-export)
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(defcustom org-export-latex-default-class "article"
|
|
|
|
"The default LaTeX class."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(string :tag "LaTeX class"))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(defcustom org-export-latex-classes
|
|
|
|
'(("article"
|
2010-03-30 12:06:55 -04:00
|
|
|
"\\documentclass[11pt]{article}"
|
2008-01-31 05:37:51 -05:00
|
|
|
("\\section{%s}" . "\\section*{%s}")
|
|
|
|
("\\subsection{%s}" . "\\subsection*{%s}")
|
|
|
|
("\\subsubsection{%s}" . "\\subsubsection*{%s}")
|
|
|
|
("\\paragraph{%s}" . "\\paragraph*{%s}")
|
|
|
|
("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
|
|
|
|
("report"
|
2010-03-30 12:06:55 -04:00
|
|
|
"\\documentclass[11pt]{report}"
|
2008-01-31 05:37:51 -05:00
|
|
|
("\\part{%s}" . "\\part*{%s}")
|
|
|
|
("\\chapter{%s}" . "\\chapter*{%s}")
|
|
|
|
("\\section{%s}" . "\\section*{%s}")
|
|
|
|
("\\subsection{%s}" . "\\subsection*{%s}")
|
|
|
|
("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
|
|
|
|
("book"
|
2010-03-30 12:06:55 -04:00
|
|
|
"\\documentclass[11pt]{book}"
|
2008-01-31 05:37:51 -05:00
|
|
|
("\\part{%s}" . "\\part*{%s}")
|
|
|
|
("\\chapter{%s}" . "\\chapter*{%s}")
|
|
|
|
("\\section{%s}" . "\\section*{%s}")
|
|
|
|
("\\subsection{%s}" . "\\subsection*{%s}")
|
2009-12-11 02:56:14 -05:00
|
|
|
("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
|
|
|
|
("beamer"
|
2010-03-30 12:06:55 -04:00
|
|
|
"\\documentclass{beamer}"
|
2009-12-11 02:56:14 -05:00
|
|
|
org-beamer-sectioning
|
2010-03-30 12:06:55 -04:00
|
|
|
))
|
2008-01-31 05:37:51 -05:00
|
|
|
"Alist of LaTeX classes and associated header and structure.
|
|
|
|
If #+LaTeX_CLASS is set in the buffer, use its value and the
|
|
|
|
associated information. Here is the structure of each cell:
|
|
|
|
|
|
|
|
\(class-name
|
|
|
|
header-string
|
2008-10-13 01:26:05 -04:00
|
|
|
(numbered-section . unnumbered-section\)
|
2008-01-31 05:37:51 -05:00
|
|
|
...\)
|
|
|
|
|
2010-01-24 05:21:34 -05:00
|
|
|
The header string
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
The HEADER-STRING is the header that will be inserted into the LaTeX file.
|
2010-04-05 09:10:22 -04:00
|
|
|
It should contain the \\documentclass macro, and anything else that is needed
|
|
|
|
for this setup. To this header, the following commands will be added:
|
|
|
|
|
|
|
|
- Calls to \\usepackage for all packages mentioned in the variables
|
|
|
|
`org-export-latex-default-packages-alist' and
|
|
|
|
`org-export-latex-packages-alist'. Thus, your header definitions should
|
|
|
|
avoid to also request these packages.
|
|
|
|
|
|
|
|
- Lines specified via \"#+LaTeX_HEADER:\"
|
|
|
|
|
|
|
|
If you need more control about the sequence in which the header is built
|
|
|
|
up, or if you want to exclude one of these building blocks for a particular
|
|
|
|
class, you can use the following macro-like placeholders.
|
|
|
|
|
2010-04-06 03:15:16 -04:00
|
|
|
[DEFAULT-PACKAGES] \\usepackage statements for default packages
|
2010-04-05 09:10:22 -04:00
|
|
|
[NO-DEFAULT-PACKAGES] do not include any of the default packages
|
2010-06-07 02:35:10 -04:00
|
|
|
[PACKAGES] \\usepackage statements for packages
|
2010-04-05 09:10:22 -04:00
|
|
|
[NO-PACKAGES] do not include the packages
|
|
|
|
[EXTRA] the stuff from #+LaTeX_HEADER
|
|
|
|
[NO-EXTRA] do not include #+LaTeX_HEADER stuff
|
2010-07-06 09:01:18 -04:00
|
|
|
[BEAMER-HEADER-EXTRA] the beamer extra headers
|
2010-04-05 09:10:22 -04:00
|
|
|
|
|
|
|
So a header like
|
|
|
|
|
|
|
|
\\documentclass{article}
|
|
|
|
[NO-DEFAULT-PACKAGES]
|
|
|
|
[EXTRA]
|
|
|
|
\\providecommand{\\alert}[1]{\\textbf{#1}}
|
|
|
|
[PACKAGES]
|
|
|
|
|
|
|
|
will omit the default packages, and will include the #+LaTeX_HEADER lines,
|
|
|
|
then have a call to \\providecommand, and then place \\usepackage commands
|
|
|
|
based on the content of `org-export-latex-packages-alist'.
|
|
|
|
|
|
|
|
If your header or `org-export-latex-default-packages-alist' inserts
|
2010-03-30 12:06:55 -04:00
|
|
|
\"\\usepackage[AUTO]{inputenc}\", AUTO will automatically be replaced with
|
|
|
|
a coding system derived from `buffer-file-coding-system'. See also the
|
|
|
|
variable `org-export-latex-inputenc-alist' for a way to influence this
|
|
|
|
mechanism.
|
2010-01-24 05:21:34 -05:00
|
|
|
|
|
|
|
The sectioning structure
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
The sectioning structure of the class is given by the elements following
|
2010-04-05 09:10:22 -04:00
|
|
|
the header string. For each sectioning level, a number of strings is
|
2010-01-24 05:21:34 -05:00
|
|
|
specified. A %s formatter is mandatory in each section string and will
|
|
|
|
be replaced by the title of the section.
|
2008-10-13 01:26:05 -04:00
|
|
|
|
|
|
|
Instead of a cons cell (numbered . unnumbered), you can also provide a list
|
2010-01-24 05:21:34 -05:00
|
|
|
of 2 or 4 elements,
|
2008-10-13 01:26:05 -04:00
|
|
|
|
|
|
|
(numbered-open numbered-close)
|
|
|
|
|
|
|
|
or
|
|
|
|
|
|
|
|
(numbered-open numbered-close unnumbered-open unnumbered-close)
|
|
|
|
|
2010-04-05 09:10:22 -04:00
|
|
|
providing opening and closing strings for a LaTeX environment that should
|
2008-10-13 01:26:05 -04:00
|
|
|
represent the document section. The opening clause should have a %s
|
2009-12-11 02:56:14 -05:00
|
|
|
to represent the section title.
|
|
|
|
|
|
|
|
Instead of a list of sectioning commands, you can also specify a
|
2010-01-24 05:21:34 -05:00
|
|
|
function name. That function will be called with two parameters,
|
2010-04-05 09:10:22 -04:00
|
|
|
the (reduced) level of the headline, and the headline text. The function
|
|
|
|
must return a cons cell with the (possibly modified) headline text, and the
|
2009-12-11 02:56:14 -05:00
|
|
|
sectioning list in the cdr."
|
2008-01-31 05:35:58 -05:00
|
|
|
:group 'org-export-latex
|
2008-12-04 09:33:43 -05:00
|
|
|
:type '(repeat
|
2008-01-31 05:37:51 -05:00
|
|
|
(list (string :tag "LaTeX class")
|
|
|
|
(string :tag "LaTeX header")
|
2008-10-13 01:26:05 -04:00
|
|
|
(repeat :tag "Levels" :inline t
|
|
|
|
(choice
|
|
|
|
(cons :tag "Heading"
|
2009-12-11 02:56:14 -05:00
|
|
|
(string :tag " numbered")
|
|
|
|
(string :tag "unnumbered"))
|
2008-10-13 01:26:05 -04:00
|
|
|
(list :tag "Environment"
|
2009-12-11 02:56:14 -05:00
|
|
|
(string :tag "Opening (numbered)")
|
|
|
|
(string :tag "Closing (numbered)")
|
2008-10-13 01:26:05 -04:00
|
|
|
(string :tag "Opening (unnumbered)")
|
2009-12-11 02:56:14 -05:00
|
|
|
(string :tag "Closing (unnumbered)"))
|
|
|
|
(function :tag "Hook computing sectioning"))))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2010-01-10 04:18:27 -05:00
|
|
|
(defcustom org-export-latex-inputenc-alist nil
|
|
|
|
"Alist of inputenc coding system names, and what should really be used.
|
|
|
|
For example, adding an entry
|
|
|
|
|
|
|
|
(\"utf8\" . \"utf8x\")
|
|
|
|
|
|
|
|
will cause \\usepackage[utf8x]{inputenc} to be used for buffers that
|
|
|
|
are written as utf8 files."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(repeat
|
|
|
|
(cons
|
|
|
|
(string :tag "Derived from buffer")
|
|
|
|
(string :tag "Use this instead"))))
|
|
|
|
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defcustom org-export-latex-emphasis-alist
|
2008-01-31 05:36:18 -05:00
|
|
|
'(("*" "\\textbf{%s}" nil)
|
|
|
|
("/" "\\emph{%s}" nil)
|
|
|
|
("_" "\\underline{%s}" nil)
|
2009-08-18 02:28:03 -04:00
|
|
|
("+" "\\st{%s}" nil)
|
2011-02-01 05:21:34 -05:00
|
|
|
("=" "\\protectedtexttt" t)
|
2009-03-14 03:36:48 -04:00
|
|
|
("~" "\\verb" t))
|
2008-01-31 05:36:18 -05:00
|
|
|
"Alist of LaTeX expressions to convert emphasis fontifiers.
|
|
|
|
Each element of the list is a list of three elements.
|
|
|
|
The first element is the character used as a marker for fontification.
|
|
|
|
The second element is a formatting string to wrap fontified text with.
|
2009-11-12 07:39:29 -05:00
|
|
|
If it is \"\\verb\", Org will automatically select a delimiter
|
2011-02-01 05:21:34 -05:00
|
|
|
character that is not in the string. \"\\protectedtexttt\" will use \\texttt
|
|
|
|
to typeset and try to protect special characters.
|
2008-01-31 05:36:29 -05:00
|
|
|
The third element decides whether to protect converted text from other
|
2008-01-31 05:36:18 -05:00
|
|
|
conversions."
|
2008-01-31 05:35:58 -05:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'alist)
|
|
|
|
|
2008-01-31 05:36:29 -05:00
|
|
|
(defcustom org-export-latex-title-command "\\maketitle"
|
|
|
|
"The command used to insert the title just after \\begin{document}.
|
|
|
|
If this string contains the formatting specification \"%s\" then
|
|
|
|
it will be used as a formatting string, passing the title as an
|
|
|
|
argument."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
2009-02-20 01:55:05 -05:00
|
|
|
(defcustom org-export-latex-import-inbuffer-stuff nil
|
|
|
|
"Non-nil means define TeX macros for Org's inbuffer definitions.
|
|
|
|
For example \orgTITLE for #+TITLE."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'boolean)
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(defcustom org-export-latex-date-format
|
2008-01-31 05:36:18 -05:00
|
|
|
"%d %B %Y"
|
2008-01-31 05:35:58 -05:00
|
|
|
"Format string for \\date{...}."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
2009-05-12 06:27:56 -04:00
|
|
|
(defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
|
|
|
|
"Markup for TODO keywords, as a printf format.
|
|
|
|
This can be a single format for all keywords, a cons cell with separate
|
|
|
|
formats for not-done and done states, or an association list with setup
|
|
|
|
for individual keywords. If a keyword shows up for which there is no
|
|
|
|
markup defined, the first one in the association list will be used."
|
|
|
|
:group 'org-export-latex
|
2009-06-08 02:00:46 -04:00
|
|
|
:type '(choice
|
2009-05-12 06:27:56 -04:00
|
|
|
(string :tag "Default")
|
|
|
|
(cons :tag "Distinguish undone and done"
|
|
|
|
(string :tag "Not-DONE states")
|
|
|
|
(string :tag "DONE states"))
|
|
|
|
(repeat :tag "Per keyword markup"
|
|
|
|
(cons
|
|
|
|
(string :tag "Keyword")
|
|
|
|
(string :tag "Markup")))))
|
2009-06-08 02:00:46 -04:00
|
|
|
|
2010-09-14 08:42:37 -04:00
|
|
|
(defcustom org-export-latex-tag-markup "\\textbf{%s}"
|
|
|
|
"Markup for tags, as a printf format."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
2009-04-13 02:52:11 -04:00
|
|
|
(defcustom org-export-latex-timestamp-markup "\\textit{%s}"
|
|
|
|
"A printf format string to be applied to time stamps."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
2009-04-19 01:46:54 -04:00
|
|
|
(defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
|
|
|
|
"A printf format string to be applied to time stamps."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
Internal links in LaTeX export
Carsten Dominik <carsten.dominik@gmail.com> writes:
> On Oct 29, 2010, at 5:22 AM, Jambunathan K wrote:
>
>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>
>>> Aloha Jambunathan K.,
>>>
>>> Yes, thanks for that suggestion. It should work on your example, but
>>> it breaks external links, like this:
>>>
>>> \hyperref[http://www.ctan.org/tex-archive/macros/latex/contrib/koma-script/
>>> ]{KOMA-script}
>>>
>>> External links require the \href{}{} command. It appears the LaTeX
>>> export process no longer distinguishes internal and external links,
>>> as
>>> I believe it used to do.
>>>
>>
>> This is the problematic commit:
>>
>> commit f5918bdcc05d7924dc204b57307023eb1ef011f0
>> parent df5894cdcb10819560f003c5b94b8f5f2b7d33cf
>> Date: Sun Oct 17 08:29:51 2010 +0000
>>
>> LaTeX export: use org-export-latex-hyperref-format
>
> I have just reverted this commit.
>
> - Carsten
>
Looks like time to change the variable name which is actually confusing.
Since href and hyperref are two different things, I renamed the existing
`org-export-latex-hyperref-format' variable as
`org-export-latex-href-format' and introduced a new one
`org-export-latex-hyperref-format'.
* org-latex.el (org-export-latex-hyperref-format): New option.
(org-export-latex-href-format): Renamed the existing variable
`org-export-latex-hyperref-format' as `org-export-latex-href-format'
(org-export-latex-links): Use `org-export-latex-hyperref-format' and
`org-export-latex-href-format'
Thanks and Regards
Noorul
>>
>> * lisp/org-latex.el (org-export-latex-links) : Replaced hard coded
>> hyperref format with custom
>> variable `org-export-latex-hyperref-format'
>>
>> Note that href is not same as hyperref.
>>
>> Jambunthan K.
>>
>>
>>> All the best,
>>> Tom
>>>
>>> On Oct 28, 2010, at 3:30 PM, Jambunathan K wrote:
>>>
>>>>
>>>> Thomas
>>>>
>>>> There was a hint at possible solution (or atleast a partial
>>>> solution) in
>>>> my original post. Did you try it before jumping in to rough waters
>>>> or
>>>> digging deeper?
>>>>
>>>> Do
>>>>
>>>> ,----
>>>> | M-x customize-variable RET org-export-latex-hyperref-format'
>>>> `----
>>>>
>>>> so that your .emacs has an entry like this
>>>>
>>>> ,---- [.emacs]
>>>> |
>>>> | (custom-set-variables
>>>> | '(org-export-latex-hyperref-format "\\hyperref[%s]{%s}"))
>>>> |
>>>> `----
>>>>
>>>> The above setting solves the problem for me with the following
>>>> simple
>>>> Org file.
>>>>
>>>> * Heading1
>>>> Make this section as large as possible so that it fills atleast a
>>>> page.
>>>>
>>>> * Heading2
>>>> Links to [[Heading1]]
>>>>
>>>> Jambunathan K.
>>>>
>>>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>>>
>>>>> On Oct 28, 2010, at 12:35 PM, Nick Dokos wrote:
>>>>>
>>>>>> Thomas S. Dye <tsd@tsdye.com> wrote:
>>>>>>
>>>>>>> On Oct 28, 2010, at 11:01 AM, Jambunathan K wrote:
>>>>>>>
>>>>>>>
>>>>>>> This is a regression. release-7.01h is good. HEAD is bad. I get
>>>>>>> the
>>>>>>> following line with release-7.01h.<
>>>>>>>
>>>>>>> Links to \hyperref[sec-1]{Heading1}
>>>>>>>
>>>>>>> Jambunathan K.
>>>>>>>
>>>>>>> Aloha Jambunathan K.,
>>>>>>>
>>>>>>> Very many thanks for this information. I have Org-mode version
>>>>>>> 7.01trans
>>>>>>> (release_7.01h.880.g7531f). I take it the problem I'm having is
>>>>>>> due to a relatively recent change
>>>>>>> to Org-mode. If there is anything I can do to help isolate the
>>>>>>> problem, please let me know.
>>>>>>>
>>>>>>
>>>>>> Tom,
>>>>>>
>>>>>> If you have the time and the inclination, you might try bisecting
>>>>>> your
>>>>>> way through. Bisecting org-mode problems is actually a very good
>>>>>> way
>>>>>> to
>>>>>> practice because the turnaround time is very small.
>>>>>>
>>>>>> Prerequisites:
>>>>>>
>>>>>> * you have a clone of the org-mode git repository.
>>>>>>
>>>>>> * you have an org test file.
>>>>>>
>>>>>>
>>>>>> Steps:
>>>>>>
>>>>>> * [optional, but it makes me feel a little safer] create a test
>>>>>> branch
>>>>>> and switch to it:
>>>>>>
>>>>>> git checkout -b test-branch master
>>>>>>
>>>>>> * I clean out all the compiled files while doing a bisection: it's
>>>>>> quicker
>>>>>> than regenerating them every time and I don't have to worry (much)
>>>>>> about
>>>>>> emacs loading a wayward .elc file:
>>>>>>
>>>>>> make clean
>>>>>>
>>>>>> * start the bisection and tell git which commit is known good and
>>>>>> which is known bad:
>>>>>>
>>>>>> git bisect start
>>>>>>
>>>>>> # current version is bad
>>>>>> git bisect bad
>>>>>>
>>>>>> # release_7.01h was good - I got the name with ``git tag''
>>>>>> git bisect good release_7.01h
>>>>>>
>>>>>> That checks out a revision half-way in between the bad and good
>>>>>> commits: since
>>>>>> there are about 900 commits in between, you'll be at approx the
>>>>>> 450-
>>>>>> mark and it
>>>>>> should take about 10 bisections to get it down to a single commit.
>>>>>>
>>>>>> * LOOP Now all you have to do is repeat the following steps:
>>>>>>
>>>>>> # since you did ``make clean'' you don't have to worry about .elc
>>>>>> files
>>>>>> # just reload all the .el files.
>>>>>> M-x org-reload
>>>>>>
>>>>>> visit your org test file, export to LaTeX, check for \href/
>>>>>> \hyperref (or
>>>>>> whatever other telltale sign shows badness/goodness).
>>>>>>
>>>>>> # tell git about it
>>>>>> git bisect good *OR* git bisect bad
>>>>>>
>>>>>> This last step will check out another revision and in about 10
>>>>>> repetitions
>>>>>> of the loop, you are done.
>>>>>>
>>>>>> * Tell git you are done, so it can clean up:
>>>>>>
>>>>>> git bisect reset
>>>>>>
>>>>>> Theoretically, you could do all of this in your master branch
>>>>>> without
>>>>>> creating a test-branch and this last step will reset everything to
>>>>>> the
>>>>>> way it was before ``git start''.
>>>>>>
>>>>>> * Post the offending commit to the list.
>>>>>>
>>>>>> * Get back to your master branch:
>>>>>>
>>>>>> git checkout master
>>>>>>
>>>>>> * If you created a test-branch, clean it out:
>>>>>>
>>>>>> git branch -d test-branch
>>>>>>
>>>>>> * [Optional] Recreate your .elc files and reload them:
>>>>>>
>>>>>> make
>>>>>> M-x org-reload
>>>>>>
>>>>>>
>>>>>> And that's it: a half-hour of fun and games. Unless of course, you
>>>>>> hit upon a revision that is neither good nor bad (in the above
>>>>>> restricted
>>>>>> sense): you might get some other problem that prevents you from
>>>>>> being
>>>>>> able to answer. That might or might not be easy to resolve, so
>>>>>> I'll
>>>>>> leave that as an advanced topic (truth be told, I came up against
>>>>>> this
>>>>>> situation a couple of days ago and I didn't know how to proceed:
>>>>>> so
>>>>>> it's ignorance more than anything else that prevents me from
>>>>>> saying
>>>>>> anything more).
>>>>>>
>>>>>> If you want to try, I'd be happy to answer questions - I might try
>>>>>> the
>>>>>> bisection later on tonight myself in any case. And btw, this is of
>>>>>> course archeology of a different (and much easier) kind, so I
>>>>>> imagine
>>>>>> you'll take to it like a fish in water :-)
>>>>>>
>>>>>> HTH,
>>>>>> Nick
>>>>>
>>>>> Hi Nick,
>>>>>
>>>>> Irresistible hook at the end there. I wish this stuff were as easy
>>>>> as
>>>>> archaeology is for me. Your instructions are terrific, though.
>>>>>
>>>>> I did hit on a revision that was neither good nor bad:
>>>>>
>>>>> commit 8562273b272024a630a582b0e1b94c481d8abeec
>>>>> Author: Eric Schulte <schulte.eric@gmail.com>
>>>>> Date: Sat Oct 16 13:21:47 2010 -0600
>>>>>
>>>>> ob-ref: don't forget arguments to referenced code blocks
>>>>>
>>>>> * lisp/ob-ref.el (org-babel-ref-resolve): bringing the referent
>>>>> arguments back to their params before evaluation
>>>>>
>>>>> This one puts these lines in *Messages* when I export to LaTeX
>>>>>
>>>>> executing Org code block...
>>>>> if: Symbol's value as variable is void: result-type
>>>>>
>>>>> I tried using different commits for the initial git bisect good,
>>>>> hoping that would skip by the problem, but this one appears to have
>>>>> stuck around a while. My other two tries both ended with this same
>>>>> error, but with different commits.
>>>>>
>>>>> I'm not sure what to do next. This problem isn't yielding to my
>>>>> archaeo-logic. :)
>>>>>
>>>>> All the best,
>>>>> Tom
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
2010-10-29 06:01:12 -04:00
|
|
|
(defcustom org-export-latex-href-format "\\href{%s}{%s}"
|
|
|
|
"A printf format string to be applied to href links.
|
|
|
|
The format must contain two %s instances. The first will be filled with
|
|
|
|
the link, the second with the link description."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
|
|
|
(defcustom org-export-latex-hyperref-format "\\hyperref[%s]{%s}"
|
2010-01-20 04:27:45 -05:00
|
|
|
"A printf format string to be applied to hyperref links.
|
2011-02-12 18:43:46 -05:00
|
|
|
The format must contain one or two %s instances. The first one
|
|
|
|
will be filled with the link, the second with its description."
|
2010-01-20 04:27:45 -05:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
(defcustom org-export-latex-tables-verbatim nil
|
2008-09-20 08:45:11 -04:00
|
|
|
"When non-nil, tables are exported verbatim."
|
2008-01-31 05:36:18 -05:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'boolean)
|
|
|
|
|
2009-05-13 08:42:21 -04:00
|
|
|
(defcustom org-export-latex-tables-centered t
|
|
|
|
"When non-nil, tables are exported in a center environment."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'boolean)
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(defcustom org-export-latex-tables-column-borders nil
|
2009-03-16 16:43:20 -04:00
|
|
|
"When non-nil, grouping columns can cause outer vertical lines in tables.
|
|
|
|
When nil, grouping causes only separation lines between groups."
|
2008-01-31 05:37:51 -05:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'boolean)
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2009-03-21 08:12:07 -04:00
|
|
|
(defcustom org-export-latex-low-levels 'itemize
|
2008-09-20 08:45:11 -04:00
|
|
|
"How to convert sections below the current level of sectioning.
|
|
|
|
This is specified by the `org-export-headline-levels' option or the
|
|
|
|
value of \"H:\" in Org's #+OPTION line.
|
2008-01-31 05:36:29 -05:00
|
|
|
|
2009-03-21 08:12:07 -04:00
|
|
|
This can be either nil (skip the sections), `description', `itemize',
|
|
|
|
or `enumerate' (convert the sections as the corresponding list type), or
|
|
|
|
a string to be used instead of \\section{%s}. In this latter case,
|
2009-06-26 11:13:42 -04:00
|
|
|
the %s stands here for the inserted headline and is mandatory.
|
|
|
|
|
|
|
|
It may also be a list of three string to define a user-defined environment
|
|
|
|
that should be used. The first string should be the like
|
|
|
|
\"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
|
2009-11-12 07:39:29 -05:00
|
|
|
to two occurrences of %s for the title and a label, respectively. The third
|
2009-06-26 11:13:42 -04:00
|
|
|
string should be like \"\\end{itemize\"."
|
2008-01-31 05:35:58 -05:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(choice (const :tag "Ignore" nil)
|
2009-05-21 11:59:58 -04:00
|
|
|
(const :tag "Convert as descriptive list" description)
|
|
|
|
(const :tag "Convert as itemized list" itemize)
|
|
|
|
(const :tag "Convert as enumerated list" enumerate)
|
2009-06-26 11:13:42 -04:00
|
|
|
(list :tag "User-defined environment"
|
|
|
|
:value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
|
|
|
|
(string :tag "Start")
|
|
|
|
(string :tag "End")
|
|
|
|
(string :tag "item"))
|
2008-01-31 05:35:58 -05:00
|
|
|
(string :tag "Use a section string" :value "\\subparagraph{%s}")))
|
|
|
|
|
2009-01-06 11:23:36 -05:00
|
|
|
(defcustom org-export-latex-list-parameters
|
2009-11-06 11:11:44 -05:00
|
|
|
'(:cbon "$\\boxtimes$" :cboff "$\\Box$")
|
2009-01-06 11:23:36 -05:00
|
|
|
"Parameters for the LaTeX list exporter.
|
|
|
|
These parameters will be passed on to `org-list-to-latex', which in turn
|
|
|
|
will pass them (combined with the LaTeX default list parameters) to
|
|
|
|
`org-list-to-generic'."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'plist)
|
|
|
|
|
2009-06-18 03:30:00 -04:00
|
|
|
(defcustom org-export-latex-verbatim-wrap
|
|
|
|
'("\\begin{verbatim}\n" . "\\end{verbatim}\n")
|
|
|
|
"Environment to be wrapped around a fixed-width section in LaTeX export.
|
|
|
|
This is a cons with two strings, to be added before and after the
|
|
|
|
fixed-with text.
|
|
|
|
|
|
|
|
Defaults to \\begin{verbatim} and \\end{verbatim}."
|
2009-07-09 00:29:51 -04:00
|
|
|
:group 'org-export-translation
|
2009-06-18 03:30:00 -04:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(cons (string :tag "Open")
|
|
|
|
(string :tag "Close")))
|
|
|
|
|
2009-08-09 08:49:52 -04:00
|
|
|
(defcustom org-export-latex-listings nil
|
2010-01-21 10:15:40 -05:00
|
|
|
"Non-nil means export source code using the listings package.
|
2009-08-09 08:49:52 -04:00
|
|
|
This package will fontify source code, possibly even with color.
|
|
|
|
If you want to use this, you also need to make LaTeX use the
|
|
|
|
listings package, and if you want to have color, the color
|
|
|
|
package. Just add these to `org-export-latex-packages-alist',
|
|
|
|
for example using customize, or with something like
|
|
|
|
|
|
|
|
(require 'org-latex)
|
|
|
|
(add-to-list 'org-export-latex-packages-alist '(\"\" \"listings\"))
|
2010-10-28 16:55:40 -04:00
|
|
|
(add-to-list 'org-export-latex-packages-alist '(\"\" \"color\"))
|
|
|
|
|
|
|
|
Alternatively,
|
|
|
|
|
|
|
|
(setq org-export-latex-listings 'minted)
|
|
|
|
|
|
|
|
causes source code to be exported using the minted package as
|
2011-02-15 09:46:23 -05:00
|
|
|
opposed to listings. If you want to use minted, you need to add
|
2010-10-28 16:55:40 -04:00
|
|
|
the minted package to `org-export-latex-packages-alist', for
|
|
|
|
example using customize, or with
|
|
|
|
|
|
|
|
(require 'org-latex)
|
|
|
|
(add-to-list 'org-export-latex-packages-alist '(\"\" \"minted\"))
|
|
|
|
|
2011-03-04 14:20:12 -05:00
|
|
|
In addition, it is necessary to install
|
2011-02-15 09:46:23 -05:00
|
|
|
pygments (http://pygments.org), and to configure the variable
|
2010-10-28 16:55:40 -04:00
|
|
|
`org-latex-to-pdf-process' so that the -shell-escape option is
|
|
|
|
passed to pdflatex.
|
|
|
|
"
|
2009-08-09 08:49:52 -04:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'boolean)
|
|
|
|
|
|
|
|
(defcustom org-export-latex-listings-langs
|
2010-10-14 09:13:42 -04:00
|
|
|
'((emacs-lisp "Lisp") (lisp "Lisp") (clojure "Lisp")
|
2009-08-23 13:11:12 -04:00
|
|
|
(c "C") (cc "C++")
|
|
|
|
(fortran "fortran")
|
|
|
|
(perl "Perl") (cperl "Perl") (python "Python") (ruby "Ruby")
|
|
|
|
(html "HTML") (xml "XML")
|
|
|
|
(tex "TeX") (latex "TeX")
|
|
|
|
(shell-script "bash")
|
|
|
|
(gnuplot "Gnuplot")
|
|
|
|
(ocaml "Caml") (caml "Caml")
|
2010-07-09 20:40:58 -04:00
|
|
|
(sql "SQL") (sqlite "sql"))
|
2009-08-23 13:11:12 -04:00
|
|
|
"Alist mapping languages to their listing language counterpart.
|
|
|
|
The key is a symbol, the major mode symbol without the \"-mode\".
|
|
|
|
The value is the string that should be inserted as the language parameter
|
|
|
|
for the listings package. If the mode name and the listings name are
|
|
|
|
the same, the language does not need an entry in this list - but it does not
|
|
|
|
hurt if it is present."
|
2009-08-09 08:49:52 -04:00
|
|
|
:group 'org-export-latex
|
2009-08-23 13:11:12 -04:00
|
|
|
:type '(repeat
|
|
|
|
(list
|
|
|
|
(symbol :tag "Major mode ")
|
|
|
|
(string :tag "Listings language"))))
|
2009-08-09 08:49:52 -04:00
|
|
|
|
2010-07-21 13:39:53 -04:00
|
|
|
(defcustom org-export-latex-listings-w-names t
|
|
|
|
"Non-nil means export names of named code blocks.
|
|
|
|
Code blocks exported with the listings package (controlled by the
|
|
|
|
`org-export-latex-listings' variable) can be named in the style
|
|
|
|
of noweb."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'boolean)
|
|
|
|
|
2010-10-12 18:20:28 -04:00
|
|
|
(defcustom org-export-latex-minted-langs
|
|
|
|
'((emacs-lisp "common-lisp")
|
|
|
|
(cc "c++")
|
|
|
|
(cperl "perl")
|
|
|
|
(shell-script "bash")
|
|
|
|
(caml "ocaml"))
|
|
|
|
"Alist mapping languages to their minted language counterpart.
|
|
|
|
The key is a symbol, the major mode symbol without the \"-mode\".
|
|
|
|
The value is the string that should be inserted as the language parameter
|
|
|
|
for the minted package. If the mode name and the listings name are
|
|
|
|
the same, the language does not need an entry in this list - but it does not
|
|
|
|
hurt if it is present.
|
|
|
|
|
|
|
|
Note that minted uses all lower case for language identifiers,
|
|
|
|
and that the full list of language identifiers can be obtained
|
|
|
|
with:
|
|
|
|
pygmentize -L lexers
|
|
|
|
"
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(repeat
|
|
|
|
(list
|
|
|
|
(symbol :tag "Major mode ")
|
|
|
|
(string :tag "Listings language"))))
|
|
|
|
|
2010-11-17 04:50:50 -05:00
|
|
|
(defcustom org-export-latex-listings-options nil
|
|
|
|
"Association list of options for the latex listings package.
|
|
|
|
|
|
|
|
These options are supplied as a comma-separated list to the
|
|
|
|
\\lstset command. Each element of the association list should be
|
|
|
|
a list containing two strings: the name of the option, and the
|
|
|
|
value. For example,
|
|
|
|
|
|
|
|
(setq org-export-latex-listings-options
|
|
|
|
'((\"basicstyle\" \"\\small\")
|
|
|
|
(\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\")))
|
|
|
|
|
|
|
|
will typeset the code in a small size font with underlined, bold
|
|
|
|
black keywords.
|
|
|
|
|
|
|
|
Note that the same options will be applied to blocks of all
|
|
|
|
languages."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(repeat
|
|
|
|
(list
|
|
|
|
(string :tag "Listings option name ")
|
|
|
|
(string :tag "Listings option value"))))
|
|
|
|
|
|
|
|
(defcustom org-export-latex-minted-options nil
|
|
|
|
"Association list of options for the latex minted package.
|
|
|
|
|
|
|
|
These options are supplied within square brackets in
|
|
|
|
\\begin{minted} environments. Each element of the alist should be
|
|
|
|
a list containing two strings: the name of the option, and the
|
|
|
|
value. For example,
|
|
|
|
|
|
|
|
(setq org-export-latex-minted-options
|
|
|
|
'((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
|
|
|
|
|
|
|
|
will result in src blocks being exported with
|
|
|
|
|
|
|
|
\\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
|
|
|
|
|
|
|
|
as the start of the minted environment. Note that the same
|
|
|
|
options will be applied to blocks of all languages."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type '(repeat
|
|
|
|
(list
|
|
|
|
(string :tag "Minted option name ")
|
|
|
|
(string :tag "Minted option value"))))
|
|
|
|
|
|
|
|
(defvar org-export-latex-custom-lang-environments nil
|
|
|
|
"Association list mapping languages to language-specific latex
|
|
|
|
environments used during export of src blocks by the listings
|
|
|
|
and minted latex packages. For example,
|
|
|
|
|
|
|
|
(setq org-export-latex-custom-lang-environments
|
|
|
|
'((python \"pythoncode\")))
|
|
|
|
|
|
|
|
would have the effect that if org encounters begin_src python
|
|
|
|
during latex export it will output
|
|
|
|
|
|
|
|
\\begin{pythoncode}
|
|
|
|
<src block body>
|
|
|
|
\\end{pythoncode}")
|
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
(defcustom org-export-latex-remove-from-headlines
|
2009-01-06 11:23:36 -05:00
|
|
|
'(:todo nil :priority nil :tags nil)
|
2010-07-16 17:22:01 -04:00
|
|
|
"A plist of keywords to remove from headlines. OBSOLETE.
|
2008-01-31 05:35:58 -05:00
|
|
|
Non-nil means remove this keyword type from the headline.
|
|
|
|
|
2009-01-06 11:23:36 -05:00
|
|
|
Don't remove the keys, just change their values.
|
|
|
|
|
|
|
|
Obsolete, this variable is no longer used. Use the separate
|
|
|
|
variables `org-export-with-todo-keywords', `org-export-with-priority',
|
|
|
|
and `org-export-with-tags' instead."
|
2008-01-31 05:35:58 -05:00
|
|
|
:type 'plist
|
|
|
|
:group 'org-export-latex)
|
|
|
|
|
|
|
|
(defcustom org-export-latex-image-default-option "width=10em"
|
|
|
|
"Default option for images."
|
|
|
|
:group 'org-export-latex
|
2008-01-31 05:37:51 -05:00
|
|
|
:type 'string)
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2011-01-28 10:59:47 -05:00
|
|
|
(defcustom org-latex-default-figure-position "htb"
|
|
|
|
"Default position for latex figures."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
2010-07-06 04:39:35 -04:00
|
|
|
(defcustom org-export-latex-tabular-environment "tabular"
|
|
|
|
"Default environment used to build tables."
|
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'string)
|
|
|
|
|
Export: Better detection of images that can be inlined.
Two new variables, `org-export-html-inline-image-extensions' and
`org-export-latex-inline-image-extensions' now define the file
extensions that will be considered for inlining images. The default
for HTML is png, jpg, jpeg, and gif files. The default for LaTeX is
png, jpg, jpeg, and pdf, assuming processing with `pdflatex'.
For LaTeX export, this can lead to conflicts for links that point
to non-image PDF files. To avoid that such a link will be inlined by
accident, always give a description text for such a link, one that is
not equal to the path.
2009-01-18 03:11:24 -05:00
|
|
|
(defcustom org-export-latex-inline-image-extensions
|
2009-06-28 07:00:37 -04:00
|
|
|
'("pdf" "jpeg" "jpg" "png" "ps" "eps")
|
Export: Better detection of images that can be inlined.
Two new variables, `org-export-html-inline-image-extensions' and
`org-export-latex-inline-image-extensions' now define the file
extensions that will be considered for inlining images. The default
for HTML is png, jpg, jpeg, and gif files. The default for LaTeX is
png, jpg, jpeg, and pdf, assuming processing with `pdflatex'.
For LaTeX export, this can lead to conflicts for links that point
to non-image PDF files. To avoid that such a link will be inlined by
accident, always give a description text for such a link, one that is
not equal to the path.
2009-01-18 03:11:24 -05:00
|
|
|
"Extensions of image files that can be inlined into LaTeX.
|
2009-06-28 07:00:37 -04:00
|
|
|
Note that the image extension *actually* allowed depend on the way the
|
|
|
|
LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
|
|
|
|
are OK. When processing through dvi to Postscript, only ps and eps are
|
|
|
|
allowed. The default we use here encompasses both."
|
2009-05-03 14:47:04 -04:00
|
|
|
:group 'org-export-latex
|
Export: Better detection of images that can be inlined.
Two new variables, `org-export-html-inline-image-extensions' and
`org-export-latex-inline-image-extensions' now define the file
extensions that will be considered for inlining images. The default
for HTML is png, jpg, jpeg, and gif files. The default for LaTeX is
png, jpg, jpeg, and pdf, assuming processing with `pdflatex'.
For LaTeX export, this can lead to conflicts for links that point
to non-image PDF files. To avoid that such a link will be inlined by
accident, always give a description text for such a link, one that is
not equal to the path.
2009-01-18 03:11:24 -05:00
|
|
|
:type '(repeat (string :tag "Extension")))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defcustom org-export-latex-coding-system nil
|
2010-07-16 17:22:01 -04:00
|
|
|
"Coding system for the exported LaTeX file."
|
2008-01-31 05:35:58 -05:00
|
|
|
:group 'org-export-latex
|
|
|
|
:type 'coding-system)
|
|
|
|
|
2008-10-15 11:21:52 -04:00
|
|
|
(defgroup org-export-pdf nil
|
|
|
|
"Options for exporting Org-mode files to PDF, via LaTeX."
|
2009-11-26 01:27:55 -05:00
|
|
|
:tag "Org Export PDF"
|
2008-10-15 11:21:52 -04:00
|
|
|
:group 'org-export-latex
|
|
|
|
:group 'org-export)
|
|
|
|
|
2009-04-23 00:39:59 -04:00
|
|
|
(defcustom org-latex-to-pdf-process
|
2010-10-10 03:03:57 -04:00
|
|
|
'("pdflatex -interaction nonstopmode -output-directory %o %f"
|
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f"
|
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f")
|
2009-04-23 00:39:59 -04:00
|
|
|
"Commands to process a LaTeX file to a PDF file.
|
|
|
|
This is a list of strings, each of them will be given to the shell
|
2010-08-07 10:00:49 -04:00
|
|
|
as a command. %f in the command will be replaced by the full file name, %b
|
|
|
|
by the file base name (i.e. without extension) and %o by the base directory
|
|
|
|
of the file.
|
2010-10-10 03:03:57 -04:00
|
|
|
|
2009-04-23 00:39:59 -04:00
|
|
|
The reason why this is a list is that it usually takes several runs of
|
2010-10-10 03:03:57 -04:00
|
|
|
`pdflatex', maybe mixed with a call to `bibtex'. Org does not have a clever
|
2009-11-12 07:39:29 -05:00
|
|
|
mechanism to detect which of these commands have to be run to get to a stable
|
2009-04-23 00:39:59 -04:00
|
|
|
result, and it also does not do any error checking.
|
|
|
|
|
2010-10-10 03:03:57 -04:00
|
|
|
By default, Org uses 3 runs of `pdflatex' to do the processing. If you
|
|
|
|
have texi2dvi on your system and if that does not cause the infamous
|
|
|
|
egrep/locale bug:
|
|
|
|
|
|
|
|
http://lists.gnu.org/archive/html/bug-texinfo/2010-03/msg00031.html
|
|
|
|
|
|
|
|
then `texi2dvi' is the superior choice. Org does offer it as one
|
|
|
|
of the customize options.
|
2010-10-05 12:22:31 -04:00
|
|
|
|
2009-04-23 00:39:59 -04:00
|
|
|
Alternatively, this may be a Lisp function that does the processing, so you
|
|
|
|
could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
|
2009-11-12 07:39:29 -05:00
|
|
|
This function should accept the file name as its single argument."
|
2009-11-26 04:13:47 -05:00
|
|
|
:group 'org-export-pdf
|
2010-10-10 03:03:57 -04:00
|
|
|
:type '(choice
|
|
|
|
(repeat :tag "Shell command sequence"
|
2009-04-23 00:39:59 -04:00
|
|
|
(string :tag "Shell command"))
|
2010-10-10 03:03:57 -04:00
|
|
|
(const :tag "2 runs of pdflatex"
|
2010-10-20 01:36:48 -04:00
|
|
|
("pdflatex -interaction nonstopmode -output-directory %o %f"
|
2010-10-10 03:03:57 -04:00
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f"))
|
|
|
|
(const :tag "3 runs of pdflatex"
|
2010-10-20 01:36:48 -04:00
|
|
|
("pdflatex -interaction nonstopmode -output-directory %o %f"
|
2010-10-10 03:03:57 -04:00
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f"
|
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f"))
|
|
|
|
(const :tag "pdflatex,bibtex,pdflatex,pdflatex"
|
2010-10-20 01:36:48 -04:00
|
|
|
("pdflatex -interaction nonstopmode -output-directory %o %f"
|
2010-10-10 03:03:57 -04:00
|
|
|
"bibtex %b"
|
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f"
|
|
|
|
"pdflatex -interaction nonstopmode -output-directory %o %f"))
|
|
|
|
(const :tag "texi2dvi"
|
2010-10-20 01:36:48 -04:00
|
|
|
("texi2dvi -p -b -c -V %f"))
|
2010-10-13 08:33:48 -04:00
|
|
|
(const :tag "rubber"
|
2010-10-20 01:36:48 -04:00
|
|
|
("rubber -d --into %o %f"))
|
2010-10-10 03:03:57 -04:00
|
|
|
(function)))
|
2009-04-23 00:39:59 -04:00
|
|
|
|
2009-11-26 01:33:06 -05:00
|
|
|
(defcustom org-export-pdf-logfiles
|
|
|
|
'("aux" "idx" "log" "out" "toc" "nav" "snm" "vrb")
|
|
|
|
"The list of file extensions to consider as LaTeX logfiles."
|
|
|
|
:group 'org-export-pdf
|
2009-11-26 01:34:56 -05:00
|
|
|
:type '(repeat (string :tag "Extension")))
|
2009-11-26 01:33:06 -05:00
|
|
|
|
2008-10-15 11:21:52 -04:00
|
|
|
(defcustom org-export-pdf-remove-logfiles t
|
2010-01-21 10:15:40 -05:00
|
|
|
"Non-nil means remove the logfiles produced by PDF production.
|
2008-10-15 11:21:52 -04:00
|
|
|
These are the .aux, .log, .out, and .toc files."
|
2009-04-23 00:39:59 -04:00
|
|
|
:group 'org-export-pdf
|
2008-10-15 11:21:52 -04:00
|
|
|
:type 'boolean)
|
|
|
|
|
2009-05-02 02:02:17 -04:00
|
|
|
;;; Hooks
|
|
|
|
|
2009-12-11 02:50:51 -05:00
|
|
|
(defvar org-export-latex-after-initial-vars-hook nil
|
|
|
|
"Hook run before LaTeX export.
|
|
|
|
The exact moment is after the initial variables like org-export-latex-class
|
|
|
|
have been determined from the environment.")
|
|
|
|
|
2009-05-02 02:02:17 -04:00
|
|
|
(defvar org-export-latex-after-blockquotes-hook nil
|
|
|
|
"Hook run during LaTeX export, after blockquote, verse, center are done.")
|
|
|
|
|
2009-09-28 23:01:56 -04:00
|
|
|
(defvar org-export-latex-final-hook nil
|
|
|
|
"Hook run in the finalized LaTeX buffer.")
|
|
|
|
|
2010-01-06 02:50:47 -05:00
|
|
|
(defvar org-export-latex-after-save-hook nil
|
|
|
|
"Hook run in the finalized LaTeX buffer, after it has been saved.")
|
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
;;; Autoload functions:
|
2008-01-31 05:37:51 -05:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
;;;###autoload
|
|
|
|
(defun org-export-as-latex-batch ()
|
2008-09-20 08:45:11 -04:00
|
|
|
"Call `org-export-as-latex', may be used in batch processing.
|
|
|
|
For example:
|
|
|
|
|
2008-12-17 03:08:06 -05:00
|
|
|
emacs --batch
|
|
|
|
--load=$HOME/lib/emacs/org.el
|
|
|
|
--eval \"(setq org-export-headline-levels 2)\"
|
|
|
|
--visit=MyFile --funcall org-export-as-latex-batch"
|
2008-01-31 05:35:58 -05:00
|
|
|
(org-export-as-latex org-export-headline-levels 'hidden))
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun org-export-as-latex-to-buffer (arg)
|
2008-12-16 10:34:50 -05:00
|
|
|
"Call `org-export-as-latex` with output to a temporary buffer.
|
2008-01-31 05:35:58 -05:00
|
|
|
No file is created. The prefix ARG is passed through to `org-export-as-latex'."
|
|
|
|
(interactive "P")
|
|
|
|
(org-export-as-latex arg nil nil "*Org LaTeX Export*")
|
2009-05-21 03:14:33 -04:00
|
|
|
(when org-export-show-temporary-export-buffer
|
|
|
|
(switch-to-buffer-other-window "*Org LaTeX Export*")))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun org-replace-region-by-latex (beg end)
|
|
|
|
"Replace the region from BEG to END with its LaTeX export.
|
|
|
|
It assumes the region has `org-mode' syntax, and then convert it to
|
2008-01-31 05:37:51 -05:00
|
|
|
LaTeX. This can be used in any buffer. For example, you could
|
2008-01-31 05:35:58 -05:00
|
|
|
write an itemized list in `org-mode' syntax in an LaTeX buffer and
|
|
|
|
then use this command to convert it."
|
|
|
|
(interactive "r")
|
|
|
|
(let (reg latex buf)
|
|
|
|
(save-window-excursion
|
|
|
|
(if (org-mode-p)
|
|
|
|
(setq latex (org-export-region-as-latex
|
|
|
|
beg end t 'string))
|
|
|
|
(setq reg (buffer-substring beg end)
|
|
|
|
buf (get-buffer-create "*Org tmp*"))
|
2009-11-05 16:51:50 -05:00
|
|
|
(with-current-buffer buf
|
2008-01-31 05:35:58 -05:00
|
|
|
(erase-buffer)
|
|
|
|
(insert reg)
|
|
|
|
(org-mode)
|
|
|
|
(setq latex (org-export-region-as-latex
|
|
|
|
(point-min) (point-max) t 'string)))
|
|
|
|
(kill-buffer buf)))
|
|
|
|
(delete-region beg end)
|
|
|
|
(insert latex)))
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun org-export-region-as-latex (beg end &optional body-only buffer)
|
|
|
|
"Convert region from BEG to END in `org-mode' buffer to LaTeX.
|
|
|
|
If prefix arg BODY-ONLY is set, omit file header, footer, and table of
|
|
|
|
contents, and only produce the region of converted text, useful for
|
|
|
|
cut-and-paste operations.
|
|
|
|
If BUFFER is a buffer or a string, use/create that buffer as a target
|
|
|
|
of the converted LaTeX. If BUFFER is the symbol `string', return the
|
2009-05-04 01:32:23 -04:00
|
|
|
produced LaTeX as a string and leave no buffer behind. For example,
|
2008-01-31 05:35:58 -05:00
|
|
|
a Lisp program could call this function in the following way:
|
|
|
|
|
|
|
|
(setq latex (org-export-region-as-latex beg end t 'string))
|
|
|
|
|
|
|
|
When called interactively, the output buffer is selected, and shown
|
2009-05-04 16:26:41 -04:00
|
|
|
in a window. A non-interactive call will only return the buffer."
|
2008-01-31 05:35:58 -05:00
|
|
|
(interactive "r\nP")
|
|
|
|
(when (interactive-p)
|
|
|
|
(setq buffer "*Org LaTeX Export*"))
|
|
|
|
(let ((transient-mark-mode t) (zmacs-regions t)
|
2009-05-04 01:32:23 -04:00
|
|
|
ext-plist rtn)
|
2009-11-12 11:50:31 -05:00
|
|
|
(setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char end)
|
|
|
|
(set-mark (point)) ;; to activate the region
|
|
|
|
(goto-char beg)
|
|
|
|
(setq rtn (org-export-as-latex
|
2009-05-04 01:32:23 -04:00
|
|
|
nil nil ext-plist
|
2008-01-31 05:35:58 -05:00
|
|
|
buffer body-only))
|
|
|
|
(if (fboundp 'deactivate-mark) (deactivate-mark))
|
|
|
|
(if (and (interactive-p) (bufferp rtn))
|
|
|
|
(switch-to-buffer-other-window rtn)
|
|
|
|
rtn)))
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
(defun org-export-as-latex (arg &optional hidden ext-plist
|
2008-02-29 21:42:28 -05:00
|
|
|
to-buffer body-only pub-dir)
|
2008-01-31 05:37:51 -05:00
|
|
|
"Export current buffer to a LaTeX file.
|
|
|
|
If there is an active region, export only the region. The prefix
|
|
|
|
ARG specifies how many levels of the outline should become
|
|
|
|
headlines. The default is 3. Lower levels will be exported
|
|
|
|
depending on `org-export-latex-low-levels'. The default is to
|
2009-05-19 02:09:30 -04:00
|
|
|
convert them as description lists.
|
|
|
|
HIDDEN is obsolete and does nothing.
|
|
|
|
EXT-PLIST is a property list with
|
2008-01-31 05:37:51 -05:00
|
|
|
external parameters overriding org-mode's default settings, but
|
|
|
|
still inferior to file-local settings. When TO-BUFFER is
|
|
|
|
non-nil, create a buffer with that name and export to that
|
|
|
|
buffer. If TO-BUFFER is the symbol `string', don't leave any
|
|
|
|
buffer behind but just return the resulting LaTeX as a string.
|
|
|
|
When BODY-ONLY is set, don't produce the file header and footer,
|
2010-05-09 17:01:56 -04:00
|
|
|
simply return the content of \\begin{document}...\\end{document},
|
|
|
|
without even the \\begin{document} and \\end{document} commands.
|
2008-02-29 21:42:28 -05:00
|
|
|
when PUB-DIR is set, use this as the publishing directory."
|
2008-01-31 05:35:58 -05:00
|
|
|
(interactive "P")
|
2010-04-11 12:14:21 -04:00
|
|
|
(when (and (not body-only) arg (listp arg)) (setq body-only t))
|
2009-12-11 02:40:19 -05:00
|
|
|
(run-hooks 'org-export-first-hook)
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
;; Make sure we have a file name when we need it.
|
|
|
|
(when (and (not (or to-buffer body-only))
|
|
|
|
(not buffer-file-name))
|
|
|
|
(if (buffer-base-buffer)
|
|
|
|
(org-set-local 'buffer-file-name
|
|
|
|
(with-current-buffer (buffer-base-buffer)
|
|
|
|
buffer-file-name))
|
|
|
|
(error "Need a file name to be able to export")))
|
|
|
|
|
|
|
|
(message "Exporting to LaTeX...")
|
2009-02-22 14:50:12 -05:00
|
|
|
(org-unmodified
|
2009-12-16 05:12:05 -05:00
|
|
|
(let ((inhibit-read-only t))
|
|
|
|
(remove-text-properties (point-min) (point-max)
|
|
|
|
'(:org-license-to-kill nil))))
|
2008-01-31 05:35:58 -05:00
|
|
|
(org-update-radio-target-regexp)
|
2008-01-31 05:37:51 -05:00
|
|
|
(org-export-latex-set-initial-vars ext-plist arg)
|
Fix bug with #+BIND during LaTeX export
Christopher Suckling writes:
> Thank you, but not quite working yet:
>
> ,----
> | #+BIND: org-export-latex-title-command ""
> `----
>
> now appears to be having the *effect* of setting a global variable.
>
> I load Emacs then visit the below test org file. I then export the file.
>
> I get a \maketitle line.
>
> I then C-c C-c on the #+BIND: line and re-export.
>
> \maketitle is removed.
>
> I then export another org file without the #+BIND: line.
>
> There is no \maketitle, even though there should be.
>
> I add
>
> ,----
> | #+BIND: org-export-latex-title-command "\foobar"
> `----
>
> to the new org file, C-c C-c and export:
>
> \foobar is added to the exported file.
>
> Finally, I re-export the original test org file (without C-c C-c on the
> #+BIND: line):
>
> \foobar is added to the exported file.
>
> However,
>
> ,----
> | C-h v org-export-latex-title-command
> `----
>
> always returns the value "\\maketitle", no matter what the value of the
> #+BIND: line.
>
> Best, Christopher
2010-01-04 11:48:47 -05:00
|
|
|
(setq org-export-opt-plist org-export-latex-options-plist)
|
|
|
|
(org-install-letbind)
|
2009-12-11 02:50:51 -05:00
|
|
|
(run-hooks 'org-export-latex-after-initial-vars-hook)
|
2008-01-31 05:36:29 -05:00
|
|
|
(let* ((wcf (current-window-configuration))
|
2011-01-21 14:58:04 -05:00
|
|
|
(opt-plist
|
|
|
|
(org-export-process-option-filters org-export-latex-options-plist))
|
2008-01-31 05:37:51 -05:00
|
|
|
(region-p (org-region-active-p))
|
2008-05-21 03:49:04 -04:00
|
|
|
(rbeg (and region-p (region-beginning)))
|
|
|
|
(rend (and region-p (region-end)))
|
2008-01-31 05:37:51 -05:00
|
|
|
(subtree-p
|
2009-11-12 11:50:31 -05:00
|
|
|
(if (plist-get opt-plist :ignore-subtree-p)
|
2009-05-04 01:32:23 -04:00
|
|
|
nil
|
|
|
|
(when region-p
|
|
|
|
(save-excursion
|
|
|
|
(goto-char rbeg)
|
|
|
|
(and (org-at-heading-p)
|
|
|
|
(>= (org-end-of-subtree t t) rend))))))
|
2009-02-23 08:15:52 -05:00
|
|
|
(opt-plist (setq org-export-opt-plist
|
|
|
|
(if subtree-p
|
|
|
|
(org-export-add-subtree-options opt-plist rbeg)
|
|
|
|
opt-plist)))
|
2008-05-21 03:49:04 -04:00
|
|
|
;; Make sure the variable contains the updated values.
|
Fix bug with #+BIND during LaTeX export
Christopher Suckling writes:
> Thank you, but not quite working yet:
>
> ,----
> | #+BIND: org-export-latex-title-command ""
> `----
>
> now appears to be having the *effect* of setting a global variable.
>
> I load Emacs then visit the below test org file. I then export the file.
>
> I get a \maketitle line.
>
> I then C-c C-c on the #+BIND: line and re-export.
>
> \maketitle is removed.
>
> I then export another org file without the #+BIND: line.
>
> There is no \maketitle, even though there should be.
>
> I add
>
> ,----
> | #+BIND: org-export-latex-title-command "\foobar"
> `----
>
> to the new org file, C-c C-c and export:
>
> \foobar is added to the exported file.
>
> Finally, I re-export the original test org file (without C-c C-c on the
> #+BIND: line):
>
> \foobar is added to the exported file.
>
> However,
>
> ,----
> | C-h v org-export-latex-title-command
> `----
>
> always returns the value "\\maketitle", no matter what the value of the
> #+BIND: line.
>
> Best, Christopher
2010-01-04 11:48:47 -05:00
|
|
|
(org-export-latex-options-plist (setq org-export-opt-plist opt-plist))
|
2010-02-25 01:31:29 -05:00
|
|
|
;; The following two are dynamically scoped into other
|
|
|
|
;; routines below.
|
|
|
|
(org-current-export-dir
|
|
|
|
(or pub-dir (org-export-directory :html opt-plist)))
|
|
|
|
(org-current-export-file buffer-file-name)
|
2008-01-31 05:37:51 -05:00
|
|
|
(title (or (and subtree-p (org-export-get-title-from-subtree))
|
|
|
|
(plist-get opt-plist :title)
|
2010-11-21 04:03:07 -05:00
|
|
|
(and (not
|
|
|
|
(plist-get opt-plist :skip-before-1st-heading))
|
|
|
|
(org-export-grab-title-from-buffer))
|
2010-02-12 02:34:00 -05:00
|
|
|
(and buffer-file-name
|
|
|
|
(file-name-sans-extension
|
|
|
|
(file-name-nondirectory buffer-file-name)))
|
|
|
|
"No Title"))
|
2010-04-01 07:11:54 -04:00
|
|
|
(filename
|
2010-02-12 02:34:00 -05:00
|
|
|
(and (not to-buffer)
|
|
|
|
(concat
|
|
|
|
(file-name-as-directory
|
|
|
|
(or pub-dir
|
|
|
|
(org-export-directory :LaTeX ext-plist)))
|
|
|
|
(file-name-sans-extension
|
|
|
|
(or (and subtree-p
|
|
|
|
(org-entry-get rbeg "EXPORT_FILE_NAME" t))
|
|
|
|
(file-name-nondirectory ;sans-extension
|
|
|
|
(or buffer-file-name
|
2010-07-16 17:22:01 -04:00
|
|
|
(error "Don't know which export file to use")))))
|
2010-02-12 02:34:00 -05:00
|
|
|
".tex")))
|
|
|
|
(filename
|
|
|
|
(and filename
|
|
|
|
(if (equal (file-truename filename)
|
|
|
|
(file-truename (or buffer-file-name "dummy.org")))
|
|
|
|
(concat filename ".tex")
|
|
|
|
filename)))
|
2008-01-31 05:35:58 -05:00
|
|
|
(buffer (if to-buffer
|
|
|
|
(cond
|
|
|
|
((eq to-buffer 'string) (get-buffer-create
|
|
|
|
"*Org LaTeX Export*"))
|
|
|
|
(t (get-buffer-create to-buffer)))
|
|
|
|
(find-file-noselect filename)))
|
|
|
|
(odd org-odd-levels-only)
|
2009-02-23 08:15:52 -05:00
|
|
|
(header (org-export-latex-make-header title opt-plist))
|
2008-02-08 10:09:11 -05:00
|
|
|
(skip (cond (subtree-p nil)
|
2008-12-15 07:24:12 -05:00
|
|
|
(region-p nil)
|
2008-02-08 10:09:11 -05:00
|
|
|
(t (plist-get opt-plist :skip-before-1st-heading))))
|
2008-01-31 05:35:58 -05:00
|
|
|
(text (plist-get opt-plist :text))
|
2009-05-14 04:20:04 -04:00
|
|
|
(org-export-preprocess-hook
|
|
|
|
(cons
|
|
|
|
`(lambda () (org-set-local 'org-complex-heading-regexp
|
|
|
|
,org-export-latex-complex-heading-re))
|
|
|
|
org-export-preprocess-hook))
|
2009-01-26 03:42:33 -05:00
|
|
|
(first-lines (if skip "" (org-export-latex-first-lines
|
2009-05-04 01:32:23 -04:00
|
|
|
opt-plist
|
|
|
|
(if subtree-p
|
|
|
|
(save-excursion
|
|
|
|
(goto-char rbeg)
|
|
|
|
(point-at-bol 2))
|
|
|
|
rbeg)
|
|
|
|
(if region-p rend))))
|
2008-01-31 05:35:58 -05:00
|
|
|
(coding-system (and (boundp 'buffer-file-coding-system)
|
|
|
|
buffer-file-coding-system))
|
|
|
|
(coding-system-for-write (or org-export-latex-coding-system
|
|
|
|
coding-system))
|
|
|
|
(save-buffer-coding-system (or org-export-latex-coding-system
|
|
|
|
coding-system))
|
2008-12-16 11:58:02 -05:00
|
|
|
(region (buffer-substring
|
2008-01-31 05:35:58 -05:00
|
|
|
(if region-p (region-beginning) (point-min))
|
|
|
|
(if region-p (region-end) (point-max))))
|
2009-12-18 03:06:34 -05:00
|
|
|
(text
|
2009-12-18 10:00:46 -05:00
|
|
|
(and text (string-match "\\S-" text)
|
|
|
|
(org-export-preprocess-string
|
|
|
|
text
|
|
|
|
:emph-multiline t
|
2011-02-15 05:07:46 -05:00
|
|
|
:for-backend 'latex
|
2009-12-18 10:00:46 -05:00
|
|
|
:comments nil
|
|
|
|
:tags (plist-get opt-plist :tags)
|
|
|
|
:priority (plist-get opt-plist :priority)
|
|
|
|
:footnotes (plist-get opt-plist :footnotes)
|
|
|
|
:drawers (plist-get opt-plist :drawers)
|
|
|
|
:timestamps (plist-get opt-plist :timestamps)
|
|
|
|
:todo-keywords (plist-get opt-plist :todo-keywords)
|
|
|
|
:add-text nil
|
|
|
|
:skip-before-1st-heading skip
|
|
|
|
:select-tags nil
|
|
|
|
:exclude-tags nil
|
|
|
|
:LaTeX-fragments nil)))
|
2008-01-31 05:35:58 -05:00
|
|
|
(string-for-export
|
2008-04-13 13:26:31 -04:00
|
|
|
(org-export-preprocess-string
|
2008-12-15 07:24:12 -05:00
|
|
|
region
|
|
|
|
:emph-multiline t
|
2011-02-15 05:07:46 -05:00
|
|
|
:for-backend 'latex
|
2008-12-15 07:24:12 -05:00
|
|
|
:comments nil
|
|
|
|
:tags (plist-get opt-plist :tags)
|
|
|
|
:priority (plist-get opt-plist :priority)
|
2008-12-30 17:58:12 -05:00
|
|
|
:footnotes (plist-get opt-plist :footnotes)
|
2009-11-15 01:54:34 -05:00
|
|
|
:drawers (plist-get opt-plist :drawers)
|
2009-01-06 11:23:36 -05:00
|
|
|
:timestamps (plist-get opt-plist :timestamps)
|
2008-12-15 07:24:12 -05:00
|
|
|
:todo-keywords (plist-get opt-plist :todo-keywords)
|
|
|
|
:add-text (if (eq to-buffer 'string) nil text)
|
|
|
|
:skip-before-1st-heading skip
|
|
|
|
:select-tags (plist-get opt-plist :select-tags)
|
|
|
|
:exclude-tags (plist-get opt-plist :exclude-tags)
|
|
|
|
:LaTeX-fragments nil)))
|
2008-01-31 05:36:29 -05:00
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(set-buffer buffer)
|
2008-01-31 05:35:58 -05:00
|
|
|
(erase-buffer)
|
2009-07-06 11:00:03 -04:00
|
|
|
(org-install-letbind)
|
2008-01-31 05:36:18 -05:00
|
|
|
|
2008-01-31 05:36:29 -05:00
|
|
|
(and (fboundp 'set-buffer-file-coding-system)
|
|
|
|
(set-buffer-file-coding-system coding-system-for-write))
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
;; insert the header and initial document commands
|
2008-01-31 05:36:29 -05:00
|
|
|
(unless (or (eq to-buffer 'string) body-only)
|
2008-01-31 05:37:51 -05:00
|
|
|
(insert header))
|
2008-01-31 05:36:29 -05:00
|
|
|
|
|
|
|
;; insert text found in #+TEXT
|
|
|
|
(when (and text (not (eq to-buffer 'string)))
|
2008-01-31 05:37:51 -05:00
|
|
|
(insert (org-export-latex-content
|
|
|
|
text '(lists tables fixed-width keywords))
|
|
|
|
"\n\n"))
|
2008-01-31 05:36:29 -05:00
|
|
|
|
|
|
|
;; insert lines before the first headline
|
2011-02-12 10:01:40 -05:00
|
|
|
(unless (or skip (string-match "^\\*" first-lines))
|
2008-01-31 05:36:29 -05:00
|
|
|
(insert first-lines))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:36:29 -05:00
|
|
|
;; export the content of headlines
|
2008-01-31 05:35:58 -05:00
|
|
|
(org-export-latex-global
|
|
|
|
(with-temp-buffer
|
|
|
|
(insert string-for-export)
|
|
|
|
(goto-char (point-min))
|
2008-01-31 05:36:29 -05:00
|
|
|
(when (re-search-forward "^\\(\\*+\\) " nil t)
|
|
|
|
(let* ((asters (length (match-string 1)))
|
|
|
|
(level (if odd (- asters 2) (- asters 1))))
|
2008-01-31 05:37:51 -05:00
|
|
|
(setq org-export-latex-add-level
|
2008-01-31 05:36:29 -05:00
|
|
|
(if odd (1- (/ (1+ asters) 2)) (1- asters)))
|
|
|
|
(org-export-latex-parse-global level odd)))))
|
|
|
|
|
|
|
|
;; finalization
|
2008-01-31 05:35:58 -05:00
|
|
|
(unless body-only (insert "\n\\end{document}"))
|
2009-06-04 10:52:02 -04:00
|
|
|
|
2009-12-11 02:56:14 -05:00
|
|
|
;; Attach description terms to the \item macro
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "^[ \t]*\\\\item\\([ \t]+\\)\\[" nil t)
|
|
|
|
(delete-region (match-beginning 1) (match-end 1)))
|
|
|
|
|
2009-06-04 10:52:02 -04:00
|
|
|
;; Relocate the table of contents
|
|
|
|
(goto-char (point-min))
|
|
|
|
(when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
|
|
|
|
(replace-match ""))
|
|
|
|
(goto-char (point-min))
|
|
|
|
(and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
|
|
|
|
(replace-match "\\tableofcontents" t t)))
|
|
|
|
|
2009-12-16 05:47:51 -05:00
|
|
|
;; Cleanup forced line ends in items where they are not needed
|
2009-12-10 03:10:43 -05:00
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward
|
2009-12-16 05:47:51 -05:00
|
|
|
"^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*\n\\\\begin"
|
2009-12-10 03:10:43 -05:00
|
|
|
nil t)
|
|
|
|
(delete-region (match-beginning 1) (match-end 1)))
|
2009-12-16 05:47:51 -05:00
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward
|
|
|
|
"^[ \t]*\\\\item\\>.*\\(\\\\\\\\\\)[ \t]*\\(\n\\\\label.*\\)*"
|
|
|
|
nil t)
|
|
|
|
(if (looking-at "[\n \t]+")
|
|
|
|
(replace-match "\n")))
|
2009-12-10 03:10:43 -05:00
|
|
|
|
2009-09-28 23:01:56 -04:00
|
|
|
(run-hooks 'org-export-latex-final-hook)
|
2010-04-25 03:13:42 -04:00
|
|
|
(if to-buffer
|
|
|
|
(unless (eq major-mode 'latex-mode) (latex-mode))
|
|
|
|
(save-buffer))
|
2010-01-10 04:18:27 -05:00
|
|
|
(org-export-latex-fix-inputenc)
|
2010-01-06 02:50:47 -05:00
|
|
|
(run-hooks 'org-export-latex-after-save-hook)
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
2009-05-21 03:14:33 -04:00
|
|
|
(or (org-export-push-to-kill-ring "LaTeX")
|
|
|
|
(message "Exporting to LaTeX...done"))
|
2008-01-31 05:36:29 -05:00
|
|
|
(prog1
|
|
|
|
(if (eq to-buffer 'string)
|
|
|
|
(prog1 (buffer-substring (point-min) (point-max))
|
|
|
|
(kill-buffer (current-buffer)))
|
|
|
|
(current-buffer))
|
|
|
|
(set-window-configuration wcf))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-10-17 02:36:46 -04:00
|
|
|
;;;###autoload
|
2008-10-15 11:21:52 -04:00
|
|
|
(defun org-export-as-pdf (arg &optional hidden ext-plist
|
|
|
|
to-buffer body-only pub-dir)
|
|
|
|
"Export as LaTeX, then process through to PDF."
|
|
|
|
(interactive "P")
|
|
|
|
(message "Exporting to PDF...")
|
|
|
|
(let* ((wconfig (current-window-configuration))
|
|
|
|
(lbuf (org-export-as-latex arg hidden ext-plist
|
|
|
|
to-buffer body-only pub-dir))
|
|
|
|
(file (buffer-file-name lbuf))
|
|
|
|
(base (file-name-sans-extension (buffer-file-name lbuf)))
|
2009-04-23 00:39:59 -04:00
|
|
|
(pdffile (concat base ".pdf"))
|
|
|
|
(cmds org-latex-to-pdf-process)
|
|
|
|
(outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
|
|
|
|
(bibtex-p (with-current-buffer lbuf
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-min))
|
|
|
|
(re-search-forward "\\\\bibliography{" nil t))))
|
2010-10-05 17:12:34 -04:00
|
|
|
cmd output-dir errors)
|
2009-04-23 00:39:59 -04:00
|
|
|
(with-current-buffer outbuf (erase-buffer))
|
2010-08-07 10:00:49 -04:00
|
|
|
(message (concat "Processing LaTeX file " file "..."))
|
|
|
|
(setq output-dir (file-name-directory file))
|
2009-04-23 00:39:59 -04:00
|
|
|
(if (and cmds (symbolp cmds))
|
2010-07-18 01:50:43 -04:00
|
|
|
(funcall cmds (shell-quote-argument file))
|
2009-04-23 00:39:59 -04:00
|
|
|
(while cmds
|
|
|
|
(setq cmd (pop cmds))
|
|
|
|
(while (string-match "%b" cmd)
|
2009-08-03 11:30:30 -04:00
|
|
|
(setq cmd (replace-match
|
2009-06-26 07:09:40 -04:00
|
|
|
(save-match-data
|
|
|
|
(shell-quote-argument base))
|
|
|
|
t t cmd)))
|
2010-08-07 10:00:49 -04:00
|
|
|
(while (string-match "%f" cmd)
|
2009-06-26 07:09:40 -04:00
|
|
|
(setq cmd (replace-match
|
|
|
|
(save-match-data
|
|
|
|
(shell-quote-argument file))
|
|
|
|
t t cmd)))
|
2010-08-07 10:00:49 -04:00
|
|
|
(while (string-match "%o" cmd)
|
|
|
|
(setq cmd (replace-match
|
|
|
|
(save-match-data
|
|
|
|
(shell-quote-argument output-dir))
|
|
|
|
t t cmd)))
|
2010-10-18 08:23:38 -04:00
|
|
|
(shell-command cmd outbuf)))
|
2010-08-07 10:00:49 -04:00
|
|
|
(message (concat "Processing LaTeX file " file "...done"))
|
2010-10-05 12:22:31 -04:00
|
|
|
(setq errors (org-export-latex-get-error outbuf))
|
2008-10-15 11:21:52 -04:00
|
|
|
(if (not (file-exists-p pdffile))
|
2010-10-05 12:22:31 -04:00
|
|
|
(error (concat "PDF file " pdffile " was not produced"
|
|
|
|
(if errors (concat ":" errors "") "")))
|
2008-10-15 11:21:52 -04:00
|
|
|
(set-window-configuration wconfig)
|
|
|
|
(when org-export-pdf-remove-logfiles
|
2009-11-26 01:33:06 -05:00
|
|
|
(dolist (ext org-export-pdf-logfiles)
|
2008-10-15 11:21:52 -04:00
|
|
|
(setq file (concat base "." ext))
|
|
|
|
(and (file-exists-p file) (delete-file file))))
|
2010-10-05 12:22:31 -04:00
|
|
|
(message (concat
|
|
|
|
"Exporting to PDF...done"
|
|
|
|
(if errors
|
|
|
|
(concat ", with some errors:" errors)
|
|
|
|
"")))
|
2008-10-15 11:21:52 -04:00
|
|
|
pdffile)))
|
|
|
|
|
2010-10-05 12:22:31 -04:00
|
|
|
(defun org-export-latex-get-error (buf)
|
|
|
|
"Collect the kinds of errors that remain in pdflatex processing."
|
|
|
|
(with-current-buffer buf
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-max))
|
|
|
|
(when (re-search-backward "^[ \t]*This is pdf.*?TeX.*?Version" nil t)
|
|
|
|
;; OK, we are at the location of the final run
|
|
|
|
(let ((pos (point)) (errors "") (case-fold-search t))
|
|
|
|
(if (re-search-forward "Reference.*?undefined" nil t)
|
|
|
|
(setq errors (concat errors " [undefined reference]")))
|
|
|
|
(goto-char pos)
|
|
|
|
(if (re-search-forward "Citation.*?undefined" nil t)
|
|
|
|
(setq errors (concat errors " [undefined citation]")))
|
|
|
|
(goto-char pos)
|
|
|
|
(if (re-search-forward "Undefined control sequence" nil t)
|
|
|
|
(setq errors (concat errors " [undefined control sequence]")))
|
|
|
|
(and (org-string-nw-p errors) errors))))))
|
|
|
|
|
2008-10-17 02:36:46 -04:00
|
|
|
;;;###autoload
|
2008-10-15 11:21:52 -04:00
|
|
|
(defun org-export-as-pdf-and-open (arg)
|
|
|
|
"Export as LaTeX, then process through to PDF, and open."
|
|
|
|
(interactive "P")
|
|
|
|
(let ((pdffile (org-export-as-pdf arg)))
|
|
|
|
(if pdffile
|
2010-02-21 03:19:21 -05:00
|
|
|
(progn
|
|
|
|
(org-open-file pdffile)
|
|
|
|
(when org-export-kill-product-buffer-when-displayed
|
|
|
|
(kill-buffer (find-buffer-visiting
|
|
|
|
(concat (file-name-sans-extension (buffer-file-name))
|
|
|
|
".tex")))))
|
2008-10-15 11:21:52 -04:00
|
|
|
(error "PDF file was not produced"))))
|
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
;;; Parsing functions:
|
2008-01-31 05:37:51 -05:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-parse-global (level odd)
|
|
|
|
"Parse the current buffer recursively, starting at LEVEL.
|
|
|
|
If ODD is non-nil, assume the buffer only contains odd sections.
|
2008-01-31 05:37:51 -05:00
|
|
|
Return a list reflecting the document structure."
|
2008-01-31 05:35:58 -05:00
|
|
|
(save-excursion
|
|
|
|
(goto-char (point-min))
|
|
|
|
(let* ((cnt 0) output
|
2008-01-31 05:37:51 -05:00
|
|
|
(depth org-export-latex-sectioning-depth))
|
2009-11-25 05:15:19 -05:00
|
|
|
(while (org-re-search-forward-unprotected
|
2008-01-31 05:35:58 -05:00
|
|
|
(concat "^\\(\\(?:\\*\\)\\{"
|
|
|
|
(number-to-string (+ (if odd 2 1) level))
|
|
|
|
"\\}\\) \\(.*\\)$")
|
|
|
|
;; make sure that there is no upper heading
|
|
|
|
(when (> level 0)
|
|
|
|
(save-excursion
|
|
|
|
(save-match-data
|
2009-11-25 05:15:19 -05:00
|
|
|
(org-re-search-forward-unprotected
|
2008-01-31 05:35:58 -05:00
|
|
|
(concat "^\\(\\(?:\\*\\)\\{"
|
|
|
|
(number-to-string level)
|
|
|
|
"\\}\\) \\(.*\\)$") nil t)))) t)
|
|
|
|
(setq cnt (1+ cnt))
|
|
|
|
(let* ((pos (match-beginning 0))
|
|
|
|
(heading (match-string 2))
|
|
|
|
(nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
|
|
|
|
(save-excursion
|
|
|
|
(narrow-to-region
|
|
|
|
(point)
|
|
|
|
(save-match-data
|
2009-11-25 05:15:19 -05:00
|
|
|
(if (org-re-search-forward-unprotected
|
2008-01-31 05:35:58 -05:00
|
|
|
(concat "^\\(\\(?:\\*\\)\\{"
|
|
|
|
(number-to-string (+ (if odd 2 1) level))
|
|
|
|
"\\}\\) \\(.*\\)$") nil t)
|
|
|
|
(match-beginning 0)
|
|
|
|
(point-max))))
|
|
|
|
(goto-char (point-min))
|
|
|
|
(setq output
|
|
|
|
(append output
|
|
|
|
(list
|
|
|
|
(list
|
|
|
|
`(pos . ,pos)
|
|
|
|
`(level . ,nlevel)
|
|
|
|
`(occur . ,cnt)
|
|
|
|
`(heading . ,heading)
|
|
|
|
`(content . ,(org-export-latex-parse-content))
|
2008-01-31 05:37:51 -05:00
|
|
|
`(subcontent . ,(org-export-latex-parse-subcontent
|
2008-01-31 05:35:58 -05:00
|
|
|
level odd)))))))
|
|
|
|
(widen)))
|
|
|
|
(list output))))
|
|
|
|
|
|
|
|
(defun org-export-latex-parse-content ()
|
|
|
|
"Extract the content of a section."
|
|
|
|
(let ((beg (point))
|
2009-11-25 05:15:19 -05:00
|
|
|
(end (if (org-re-search-forward-unprotected "^\\(\\*\\)+ .*$" nil t)
|
2008-01-31 05:35:58 -05:00
|
|
|
(progn (beginning-of-line) (point))
|
|
|
|
(point-max))))
|
|
|
|
(buffer-substring beg end)))
|
|
|
|
|
|
|
|
(defun org-export-latex-parse-subcontent (level odd)
|
|
|
|
"Extract the subcontent of a section at LEVEL.
|
|
|
|
If ODD Is non-nil, assume subcontent only contains odd sections."
|
2010-08-27 03:29:25 -04:00
|
|
|
(if (not (org-re-search-forward-unprotected
|
|
|
|
(concat "^\\(\\(?:\\*\\)\\{"
|
|
|
|
(number-to-string (+ (if odd 4 2) level))
|
|
|
|
"\\}\\) \\(.*\\)$")
|
|
|
|
nil t))
|
|
|
|
nil ; subcontent is nil
|
|
|
|
(org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
;;; Rendering functions:
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-global (content)
|
|
|
|
"Export CONTENT to LaTeX.
|
|
|
|
CONTENT is an element of the list produced by
|
|
|
|
`org-export-latex-parse-global'."
|
|
|
|
(if (eq (car content) 'subcontent)
|
|
|
|
(mapc 'org-export-latex-sub (cdr content))
|
|
|
|
(org-export-latex-sub (car content))))
|
|
|
|
|
|
|
|
(defun org-export-latex-sub (subcontent)
|
|
|
|
"Export the list SUBCONTENT to LaTeX.
|
|
|
|
SUBCONTENT is an alist containing information about the headline
|
|
|
|
and its content."
|
2008-01-31 05:37:51 -05:00
|
|
|
(let ((num (plist-get org-export-latex-options-plist :section-numbers)))
|
2008-01-31 05:36:18 -05:00
|
|
|
(mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
(defun org-export-latex-subcontent (subcontent num)
|
2008-09-20 08:45:11 -04:00
|
|
|
"Export each cell of SUBCONTENT to LaTeX.
|
|
|
|
If NUM, export sections as numerical sections."
|
2009-12-11 02:56:14 -05:00
|
|
|
(let* ((heading (cdr (assoc 'heading subcontent)))
|
2008-10-10 05:42:01 -04:00
|
|
|
(level (- (cdr (assoc 'level subcontent))
|
|
|
|
org-export-latex-add-level))
|
|
|
|
(occur (number-to-string (cdr (assoc 'occur subcontent))))
|
|
|
|
(content (cdr (assoc 'content subcontent)))
|
|
|
|
(subcontent (cadr (assoc 'subcontent subcontent)))
|
2008-11-16 16:12:57 -05:00
|
|
|
(label (org-get-text-property-any 0 'target heading))
|
|
|
|
(label-list (cons label (cdr (assoc label
|
2009-12-11 02:56:14 -05:00
|
|
|
org-export-target-aliases))))
|
|
|
|
(sectioning org-export-latex-sectioning)
|
|
|
|
(depth org-export-latex-sectioning-depth)
|
|
|
|
main-heading sub-heading)
|
|
|
|
(when (symbolp (car sectioning))
|
|
|
|
(setq sectioning (funcall (car sectioning) level heading))
|
|
|
|
(when sectioning
|
|
|
|
(setq heading (car sectioning)
|
2010-01-05 08:53:14 -05:00
|
|
|
sectioning (cdr sectioning)
|
|
|
|
;; target property migh have changed...
|
|
|
|
label (org-get-text-property-any 0 'target heading)
|
|
|
|
label-list (cons label (cdr (assoc label
|
|
|
|
org-export-target-aliases)))))
|
2009-12-11 02:56:14 -05:00
|
|
|
(if sectioning (setq sectioning (make-list 10 sectioning)))
|
|
|
|
(setq depth (if sectioning 10000 0)))
|
|
|
|
(if (string-match "[ \t]*\\\\\\\\[ \t]*" heading)
|
|
|
|
(setq main-heading (substring heading 0 (match-beginning 0))
|
|
|
|
sub-heading (substring heading (match-end 0))))
|
|
|
|
(setq heading (org-export-latex-fontify-headline heading)
|
|
|
|
sub-heading (and sub-heading
|
|
|
|
(org-export-latex-fontify-headline sub-heading))
|
|
|
|
main-heading (and main-heading
|
|
|
|
(org-export-latex-fontify-headline main-heading)))
|
2008-01-31 05:37:51 -05:00
|
|
|
(cond
|
2008-01-31 05:35:58 -05:00
|
|
|
;; Normal conversion
|
2009-12-11 02:56:14 -05:00
|
|
|
((<= level depth)
|
|
|
|
(let* ((sec (nth (1- level) sectioning))
|
2008-10-13 01:26:05 -04:00
|
|
|
start end)
|
|
|
|
(if (consp (cdr sec))
|
|
|
|
(setq start (nth (if num 0 2) sec)
|
|
|
|
end (nth (if num 1 3) sec))
|
|
|
|
(setq start (if num (car sec) (cdr sec))))
|
2009-12-11 02:56:14 -05:00
|
|
|
(insert (format start (if main-heading main-heading heading)
|
|
|
|
(or sub-heading "")))
|
|
|
|
(insert "\n")
|
2008-11-16 16:12:57 -05:00
|
|
|
(when label
|
|
|
|
(insert (mapconcat (lambda (l) (format "\\label{%s}" l))
|
|
|
|
label-list "\n") "\n"))
|
2008-10-13 01:26:05 -04:00
|
|
|
(insert (org-export-latex-content content))
|
|
|
|
(cond ((stringp subcontent) (insert subcontent))
|
2009-12-10 03:10:43 -05:00
|
|
|
((listp subcontent)
|
|
|
|
(while (org-looking-back "\n\n") (backward-delete-char 1))
|
|
|
|
(org-export-latex-sub subcontent)))
|
2009-12-11 02:56:14 -05:00
|
|
|
(when (and end (string-match "[^ \t]" end))
|
|
|
|
(let ((hook (org-get-text-property-any 0 'org-insert-hook end)))
|
|
|
|
(and (functionp hook) (funcall hook)))
|
|
|
|
(insert end "\n"))))
|
2008-01-31 05:35:58 -05:00
|
|
|
;; At a level under the hl option: we can drop this subsection
|
2009-12-11 02:56:14 -05:00
|
|
|
((> level depth)
|
2008-01-31 05:35:58 -05:00
|
|
|
(cond ((eq org-export-latex-low-levels 'description)
|
2009-03-21 08:12:07 -04:00
|
|
|
(if (string-match "% ends low level$"
|
|
|
|
(buffer-substring (point-at-bol 0) (point)))
|
|
|
|
(delete-region (point-at-bol 0) (point))
|
|
|
|
(insert "\\begin{description}\n"))
|
2009-12-10 03:10:43 -05:00
|
|
|
(insert (format "\n\\item[%s]%s~\n"
|
2008-10-10 05:42:01 -04:00
|
|
|
heading
|
|
|
|
(if label (format "\\label{%s}" label) "")))
|
2008-01-31 05:35:58 -05:00
|
|
|
(insert (org-export-latex-content content))
|
|
|
|
(cond ((stringp subcontent) (insert subcontent))
|
|
|
|
((listp subcontent) (org-export-latex-sub subcontent)))
|
2009-03-21 08:12:07 -04:00
|
|
|
(insert "\\end{description} % ends low level\n"))
|
|
|
|
((memq org-export-latex-low-levels '(itemize enumerate))
|
|
|
|
(if (string-match "% ends low level$"
|
|
|
|
(buffer-substring (point-at-bol 0) (point)))
|
|
|
|
(delete-region (point-at-bol 0) (point))
|
|
|
|
(insert (format "\\begin{%s}\n"
|
|
|
|
(symbol-name org-export-latex-low-levels))))
|
2009-12-10 03:10:43 -05:00
|
|
|
(insert (format "\n\\item %s\\\\\n%s%%"
|
2009-03-21 08:12:07 -04:00
|
|
|
heading
|
|
|
|
(if label (format "\\label{%s}" label) "")))
|
|
|
|
(insert (org-export-latex-content content))
|
|
|
|
(cond ((stringp subcontent) (insert subcontent))
|
|
|
|
((listp subcontent) (org-export-latex-sub subcontent)))
|
|
|
|
(insert (format "\\end{%s} %% ends low level\n"
|
|
|
|
(symbol-name org-export-latex-low-levels))))
|
2009-06-26 11:13:42 -04:00
|
|
|
|
|
|
|
((listp org-export-latex-low-levels)
|
|
|
|
(if (string-match "% ends low level$"
|
|
|
|
(buffer-substring (point-at-bol 0) (point)))
|
|
|
|
(delete-region (point-at-bol 0) (point))
|
|
|
|
(insert (car org-export-latex-low-levels) "\n"))
|
|
|
|
(insert (format (nth 2 org-export-latex-low-levels)
|
|
|
|
heading
|
|
|
|
(if label (format "\\label{%s}" label) "")))
|
|
|
|
(insert (org-export-latex-content content))
|
|
|
|
(cond ((stringp subcontent) (insert subcontent))
|
|
|
|
((listp subcontent) (org-export-latex-sub subcontent)))
|
|
|
|
(insert (nth 1 org-export-latex-low-levels)
|
|
|
|
" %% ends low level\n"))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
((stringp org-export-latex-low-levels)
|
|
|
|
(insert (format org-export-latex-low-levels heading) "\n")
|
2008-10-10 05:42:01 -04:00
|
|
|
(when label (insert (format "\\label{%s}\n" label)))
|
2008-01-31 05:35:58 -05:00
|
|
|
(insert (org-export-latex-content content))
|
|
|
|
(cond ((stringp subcontent) (insert subcontent))
|
|
|
|
((listp subcontent) (org-export-latex-sub subcontent)))))))))
|
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
;;; Exporting internals:
|
2008-01-31 05:37:51 -05:00
|
|
|
(defun org-export-latex-set-initial-vars (ext-plist level)
|
2008-01-31 05:36:18 -05:00
|
|
|
"Store org local variables required for LaTeX export.
|
2008-01-31 05:37:51 -05:00
|
|
|
EXT-PLIST is an optional additional plist.
|
|
|
|
LEVEL indicates the default depth for export."
|
|
|
|
(setq org-export-latex-todo-keywords-1 org-todo-keywords-1
|
2009-05-12 06:27:56 -04:00
|
|
|
org-export-latex-done-keywords org-done-keywords
|
|
|
|
org-export-latex-not-done-keywords org-not-done-keywords
|
2009-05-14 04:20:04 -04:00
|
|
|
org-export-latex-complex-heading-re org-complex-heading-regexp
|
2009-04-13 02:52:11 -04:00
|
|
|
org-export-latex-display-custom-times org-display-custom-times
|
2008-01-31 05:37:51 -05:00
|
|
|
org-export-latex-all-targets-re
|
2008-01-31 05:36:18 -05:00
|
|
|
(org-make-target-link-regexp (org-all-targets))
|
2008-01-31 05:37:51 -05:00
|
|
|
org-export-latex-options-plist
|
2008-01-31 05:36:18 -05:00
|
|
|
(org-combine-plists (org-default-export-plist) ext-plist
|
|
|
|
(org-infile-export-plist))
|
2008-01-31 05:37:51 -05:00
|
|
|
org-export-latex-class
|
2009-01-20 03:07:35 -05:00
|
|
|
(or (and (org-region-active-p)
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (region-beginning))
|
|
|
|
(and (looking-at org-complex-heading-regexp)
|
|
|
|
(org-entry-get nil "LaTeX_CLASS" 'selective))))
|
|
|
|
(save-excursion
|
|
|
|
(save-restriction
|
|
|
|
(widen)
|
|
|
|
(goto-char (point-min))
|
2010-08-20 12:24:09 -04:00
|
|
|
(and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\(-[a-zA-Z]+\\)" nil t)
|
2009-01-20 03:07:35 -05:00
|
|
|
(match-string 1))))
|
2009-09-30 04:08:25 -04:00
|
|
|
(plist-get org-export-latex-options-plist :latex-class)
|
2009-01-20 03:07:35 -05:00
|
|
|
org-export-latex-default-class)
|
2009-11-27 08:48:03 -05:00
|
|
|
org-export-latex-class-options
|
|
|
|
(or (and (org-region-active-p)
|
|
|
|
(save-excursion
|
|
|
|
(goto-char (region-beginning))
|
|
|
|
(and (looking-at org-complex-heading-regexp)
|
|
|
|
(org-entry-get nil "LaTeX_CLASS_OPTIONS" 'selective))))
|
|
|
|
(save-excursion
|
|
|
|
(save-restriction
|
|
|
|
(widen)
|
|
|
|
(goto-char (point-min))
|
2010-08-20 12:24:09 -04:00
|
|
|
(and (re-search-forward "^#\\+LaTeX_CLASS_OPTIONS:[ \t]*\\(.*?\\)[ \t]*$" nil t)
|
|
|
|
(match-string 1))))
|
2009-11-27 08:48:03 -05:00
|
|
|
(plist-get org-export-latex-options-plist :latex-class-options))
|
2009-01-20 03:07:35 -05:00
|
|
|
org-export-latex-class
|
|
|
|
(or (car (assoc org-export-latex-class org-export-latex-classes))
|
|
|
|
(error "No definition for class `%s' in `org-export-latex-classes'"
|
|
|
|
org-export-latex-class))
|
2008-01-31 05:37:51 -05:00
|
|
|
org-export-latex-header
|
|
|
|
(cadr (assoc org-export-latex-class org-export-latex-classes))
|
|
|
|
org-export-latex-sectioning
|
|
|
|
(cddr (assoc org-export-latex-class org-export-latex-classes))
|
|
|
|
org-export-latex-sectioning-depth
|
|
|
|
(or level
|
|
|
|
(let ((hl-levels
|
|
|
|
(plist-get org-export-latex-options-plist :headline-levels))
|
|
|
|
(sec-depth (length org-export-latex-sectioning)))
|
2009-11-27 08:48:03 -05:00
|
|
|
(if (> hl-levels sec-depth) sec-depth hl-levels))))
|
|
|
|
(when (and org-export-latex-class-options
|
|
|
|
(string-match "\\S-" org-export-latex-class-options)
|
2009-12-11 02:52:26 -05:00
|
|
|
(string-match "^[ \t]*\\(\\\\documentclass\\)\\(\\[.*?\\]\\)?"
|
|
|
|
org-export-latex-header))
|
2009-11-27 08:48:03 -05:00
|
|
|
(setq org-export-latex-header
|
|
|
|
(concat (substring org-export-latex-header 0 (match-end 1))
|
|
|
|
org-export-latex-class-options
|
|
|
|
(substring org-export-latex-header (match-end 0))))))
|
2008-01-31 05:37:51 -05:00
|
|
|
|
2009-12-11 02:52:26 -05:00
|
|
|
(defvar org-export-latex-format-toc-function
|
|
|
|
'org-export-latex-format-toc-default
|
2010-07-16 17:22:01 -04:00
|
|
|
"The function formatting returning the string to create the table of contents.
|
2009-12-11 02:52:26 -05:00
|
|
|
The function mus take one parameter, the depth of the table of contents.")
|
|
|
|
|
2009-02-23 08:15:52 -05:00
|
|
|
(defun org-export-latex-make-header (title opt-plist)
|
2008-01-31 05:37:51 -05:00
|
|
|
"Make the LaTeX header and return it as a string.
|
|
|
|
TITLE is the current title from the buffer or region.
|
|
|
|
OPT-PLIST is the options plist for current buffer."
|
|
|
|
(let ((toc (plist-get opt-plist :table-of-contents))
|
2010-03-09 11:24:31 -05:00
|
|
|
(author (org-export-apply-macros-in-string
|
2011-01-13 14:29:39 -05:00
|
|
|
(plist-get opt-plist :author)))
|
2011-03-04 14:20:12 -05:00
|
|
|
(email (replace-regexp-in-string
|
|
|
|
"_" "\\\\_"
|
2011-03-01 12:35:47 -05:00
|
|
|
(org-export-apply-macros-in-string
|
|
|
|
(plist-get opt-plist :email)))))
|
2008-01-31 05:37:51 -05:00
|
|
|
(concat
|
2008-01-31 05:36:29 -05:00
|
|
|
(if (plist-get opt-plist :time-stamp-file)
|
2008-12-21 05:00:05 -05:00
|
|
|
(format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
|
2010-04-04 02:32:55 -04:00
|
|
|
;; insert LaTeX custom header and packages from the list
|
|
|
|
(org-splice-latex-header
|
|
|
|
(org-export-apply-macros-in-string org-export-latex-header)
|
|
|
|
org-export-latex-default-packages-alist
|
2010-04-26 12:53:39 -04:00
|
|
|
org-export-latex-packages-alist nil
|
2010-04-04 02:32:55 -04:00
|
|
|
(org-export-apply-macros-in-string
|
|
|
|
(plist-get opt-plist :latex-header-extra)))
|
|
|
|
;; append another special variable
|
2009-03-21 08:39:37 -04:00
|
|
|
(org-export-apply-macros-in-string org-export-latex-append-header)
|
2010-10-22 03:19:04 -04:00
|
|
|
;; define alert if not yet defined
|
2010-04-04 02:32:55 -04:00
|
|
|
"\n\\providecommand{\\alert}[1]{\\textbf{#1}}"
|
2011-03-04 14:20:12 -05:00
|
|
|
;; insert the title
|
2008-01-31 05:37:51 -05:00
|
|
|
(format
|
|
|
|
"\n\n\\title{%s}\n"
|
2010-11-21 04:22:09 -05:00
|
|
|
(org-export-latex-fontify-headline title))
|
2008-01-31 05:36:29 -05:00
|
|
|
;; insert author info
|
|
|
|
(if (plist-get opt-plist :author-info)
|
2011-01-13 14:29:39 -05:00
|
|
|
(format "\\author{%s%s}\n"
|
|
|
|
(org-export-latex-fontify-headline (or author user-full-name))
|
2011-03-01 12:35:47 -05:00
|
|
|
(if (and (plist-get opt-plist :email-info) email
|
2011-03-04 14:20:12 -05:00
|
|
|
(string-match "\\S-" email))
|
|
|
|
(format "\\thanks{%s}" email)
|
2011-03-01 12:35:47 -05:00
|
|
|
""))
|
2008-01-31 05:36:29 -05:00
|
|
|
(format "%%\\author{%s}\n"
|
2010-03-12 09:21:41 -05:00
|
|
|
(org-export-latex-fontify-headline (or author user-full-name))))
|
2008-01-31 05:36:29 -05:00
|
|
|
;; insert the date
|
|
|
|
(format "\\date{%s}\n"
|
2008-01-31 05:37:51 -05:00
|
|
|
(format-time-string
|
2008-01-31 05:36:29 -05:00
|
|
|
(or (plist-get opt-plist :date)
|
|
|
|
org-export-latex-date-format)))
|
2011-03-04 11:38:08 -05:00
|
|
|
;; beginning of the document
|
|
|
|
"\n\\begin{document}\n\n"
|
2008-01-31 05:36:29 -05:00
|
|
|
;; insert the title command
|
2009-07-27 02:45:02 -04:00
|
|
|
(when (string-match "\\S-" title)
|
|
|
|
(if (string-match "%s" org-export-latex-title-command)
|
|
|
|
(format org-export-latex-title-command title)
|
|
|
|
org-export-latex-title-command))
|
2008-01-31 05:36:29 -05:00
|
|
|
"\n\n"
|
|
|
|
;; table of contents
|
2008-01-31 05:37:51 -05:00
|
|
|
(when (and org-export-with-toc
|
2008-01-31 05:36:29 -05:00
|
|
|
(plist-get opt-plist :section-numbers))
|
2009-12-11 02:52:26 -05:00
|
|
|
(funcall org-export-latex-format-toc-function
|
|
|
|
(cond ((numberp toc)
|
|
|
|
(min toc (plist-get opt-plist :headline-levels)))
|
|
|
|
(toc (plist-get opt-plist :headline-levels))))))))
|
|
|
|
|
|
|
|
(defun org-export-latex-format-toc-default (depth)
|
|
|
|
(when depth
|
|
|
|
(format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
|
|
|
|
depth)))
|
2008-01-31 05:36:18 -05:00
|
|
|
|
2009-05-04 01:32:23 -04:00
|
|
|
(defun org-export-latex-first-lines (opt-plist &optional beg end)
|
2008-01-31 05:36:18 -05:00
|
|
|
"Export the first lines before first headline.
|
2009-05-04 01:32:23 -04:00
|
|
|
If BEG is non-nil, it is the beginning of the region.
|
|
|
|
If END is non-nil, it is the end of the region."
|
2008-01-31 05:36:18 -05:00
|
|
|
(save-excursion
|
2008-12-15 07:24:12 -05:00
|
|
|
(goto-char (or beg (point-min)))
|
2009-09-10 16:37:49 -04:00
|
|
|
(let* ((pt (point))
|
2010-12-15 06:37:45 -05:00
|
|
|
(end (if (re-search-forward
|
|
|
|
(concat "^" (org-get-limited-outline-regexp)) end t)
|
2009-09-10 16:37:49 -04:00
|
|
|
(goto-char (match-beginning 0))
|
|
|
|
(goto-char (or end (point-max))))))
|
2008-12-15 07:24:12 -05:00
|
|
|
(prog1
|
|
|
|
(org-export-latex-content
|
|
|
|
(org-export-preprocess-string
|
|
|
|
(buffer-substring pt end)
|
2011-02-15 05:07:46 -05:00
|
|
|
:for-backend 'latex
|
2008-12-15 07:24:12 -05:00
|
|
|
:emph-multiline t
|
|
|
|
:add-text nil
|
|
|
|
:comments nil
|
|
|
|
:skip-before-1st-heading nil
|
2009-01-26 01:36:01 -05:00
|
|
|
:LaTeX-fragments nil
|
|
|
|
:timestamps (plist-get opt-plist :timestamps)
|
|
|
|
:footnotes (plist-get opt-plist :footnotes)))
|
2009-02-22 14:50:12 -05:00
|
|
|
(org-unmodified
|
2010-07-09 04:06:17 -04:00
|
|
|
(let ((inhibit-read-only t)
|
|
|
|
(limit (max pt (1- end))))
|
|
|
|
(add-text-properties pt limit
|
|
|
|
'(:org-license-to-kill t))
|
|
|
|
(save-excursion
|
|
|
|
(goto-char pt)
|
2010-08-16 08:28:29 -04:00
|
|
|
(while (re-search-forward "^[ \t]*#\\+.*\n?" limit t)
|
|
|
|
(let ((case-fold-search t))
|
|
|
|
(unless (org-string-match-p
|
|
|
|
"^[ \t]*#\\+\\(attr_\\|caption\\>\\|label\\>\\)"
|
|
|
|
(match-string 0))
|
|
|
|
(remove-text-properties (match-beginning 0) (match-end 0)
|
|
|
|
'(:org-license-to-kill t))))))))))))
|
2011-02-13 06:15:08 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
|
2009-02-23 08:15:52 -05:00
|
|
|
(defvar org-export-latex-header-defs nil
|
|
|
|
"The header definitions that might be used in the LaTeX body.")
|
|
|
|
(defvar org-export-latex-header-defs-re nil
|
|
|
|
"The header definitions that might be used in the LaTeX body.")
|
2009-02-20 01:55:05 -05:00
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(defun org-export-latex-content (content &optional exclude-list)
|
|
|
|
"Convert CONTENT string to LaTeX.
|
|
|
|
Don't perform conversions that are in EXCLUDE-LIST. Recognized
|
|
|
|
conversion types are: quotation-marks, emphasis, sub-superscript,
|
|
|
|
links, keywords, lists, tables, fixed-width"
|
|
|
|
(with-temp-buffer
|
2011-02-18 05:25:11 -05:00
|
|
|
(org-install-letbind)
|
|
|
|
(insert content)
|
|
|
|
(unless (memq 'timestamps exclude-list)
|
|
|
|
(org-export-latex-time-stamps))
|
|
|
|
(unless (memq 'quotation-marks exclude-list)
|
|
|
|
(org-export-latex-quotation-marks))
|
|
|
|
(unless (memq 'emphasis exclude-list)
|
|
|
|
(when (plist-get org-export-latex-options-plist :emphasize)
|
|
|
|
(org-export-latex-fontify)))
|
|
|
|
(unless (memq 'sub-superscript exclude-list)
|
|
|
|
(org-export-latex-special-chars
|
|
|
|
(plist-get org-export-latex-options-plist :sub-superscript)))
|
|
|
|
(unless (memq 'links exclude-list)
|
|
|
|
(org-export-latex-links))
|
|
|
|
(unless (memq 'keywords exclude-list)
|
|
|
|
(org-export-latex-keywords))
|
|
|
|
(unless (memq 'lists exclude-list)
|
|
|
|
(org-export-latex-lists))
|
|
|
|
(unless (memq 'tables exclude-list)
|
|
|
|
(org-export-latex-tables
|
|
|
|
(plist-get org-export-latex-options-plist :tables)))
|
|
|
|
(unless (memq 'fixed-width exclude-list)
|
|
|
|
(org-export-latex-fixed-width
|
|
|
|
(plist-get org-export-latex-options-plist :fixed-width)))
|
2008-01-31 05:37:51 -05:00
|
|
|
;; return string
|
2011-02-18 05:25:11 -05:00
|
|
|
(buffer-substring (point-min) (point-max))))
|
2008-01-31 05:37:51 -05:00
|
|
|
|
|
|
|
(defun org-export-latex-protect-string (s)
|
2008-09-20 08:45:11 -04:00
|
|
|
"Add the org-protected property to string S."
|
2008-01-31 05:37:51 -05:00
|
|
|
(add-text-properties 0 (length s) '(org-protected t) s) s)
|
|
|
|
|
|
|
|
(defun org-export-latex-protect-char-in-string (char-list string)
|
|
|
|
"Add org-protected text-property to char from CHAR-LIST in STRING."
|
|
|
|
(with-temp-buffer
|
|
|
|
(save-match-data
|
|
|
|
(insert string)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward (regexp-opt char-list) nil t)
|
|
|
|
(add-text-properties (match-beginning 0)
|
|
|
|
(match-end 0) '(org-protected t)))
|
|
|
|
(buffer-string))))
|
|
|
|
|
2009-01-06 11:23:36 -05:00
|
|
|
(defun org-export-latex-keywords-maybe (&optional remove-list)
|
2008-01-31 05:35:58 -05:00
|
|
|
"Maybe remove keywords depending on rules in REMOVE-LIST."
|
|
|
|
(goto-char (point-min))
|
2008-01-31 05:37:51 -05:00
|
|
|
(let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
|
2009-05-12 06:27:56 -04:00
|
|
|
(case-fold-search nil)
|
|
|
|
(todo-markup org-export-latex-todo-keyword-markup)
|
|
|
|
fmt)
|
2008-01-31 05:35:58 -05:00
|
|
|
;; convert TODO keywords
|
|
|
|
(when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
|
|
|
|
(if (plist-get remove-list :todo)
|
|
|
|
(replace-match "")
|
2009-05-12 06:27:56 -04:00
|
|
|
(setq fmt (cond
|
|
|
|
((stringp todo-markup) todo-markup)
|
|
|
|
((and (consp todo-markup) (stringp (car todo-markup)))
|
|
|
|
(if (member (match-string 1) org-export-latex-done-keywords)
|
|
|
|
(cdr todo-markup) (car todo-markup)))
|
|
|
|
(t (cdr (or (assoc (match-string 1) todo-markup)
|
|
|
|
(car todo-markup))))))
|
2010-05-13 02:47:26 -04:00
|
|
|
(replace-match (org-export-latex-protect-string
|
|
|
|
(format fmt (match-string 1))) t t)))
|
2008-01-31 05:35:58 -05:00
|
|
|
;; convert priority string
|
|
|
|
(when (re-search-forward "\\[\\\\#.\\]" nil t)
|
|
|
|
(if (plist-get remove-list :priority)
|
|
|
|
(replace-match "")
|
2009-01-06 11:23:36 -05:00
|
|
|
(replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
|
2008-01-31 05:35:58 -05:00
|
|
|
;; convert tags
|
2010-08-20 20:30:31 -04:00
|
|
|
(when (re-search-forward "\\(:[a-zA-Z0-9_@#%]+\\)+:" nil t)
|
2008-01-31 05:36:08 -05:00
|
|
|
(if (or (not org-export-with-tags)
|
|
|
|
(plist-get remove-list :tags))
|
2008-01-31 05:35:58 -05:00
|
|
|
(replace-match "")
|
2008-09-20 08:45:11 -04:00
|
|
|
(replace-match
|
2008-07-03 13:36:32 -04:00
|
|
|
(org-export-latex-protect-string
|
2010-09-14 08:42:37 -04:00
|
|
|
(format org-export-latex-tag-markup
|
2008-12-16 11:58:02 -05:00
|
|
|
(save-match-data
|
|
|
|
(replace-regexp-in-string
|
|
|
|
"_" "\\\\_" (match-string 0)))))
|
|
|
|
t t)))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
(defun org-export-latex-fontify-headline (string)
|
2008-09-20 08:45:11 -04:00
|
|
|
"Fontify special words in STRING."
|
2008-01-31 05:35:58 -05:00
|
|
|
(with-temp-buffer
|
|
|
|
;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
|
|
|
|
;; the beginning of the buffer - inserting "\n" is safe here though.
|
2008-01-31 05:37:51 -05:00
|
|
|
(insert "\n" string)
|
2010-11-21 04:22:09 -05:00
|
|
|
|
|
|
|
;; Preserve math snippets
|
2011-02-13 06:15:08 -05:00
|
|
|
|
2010-11-21 04:22:09 -05:00
|
|
|
(let* ((matchers (plist-get org-format-latex-options :matchers))
|
|
|
|
(re-list org-latex-regexps)
|
|
|
|
beg end re e m n block off)
|
|
|
|
;; Check the different regular expressions
|
|
|
|
(while (setq e (pop re-list))
|
|
|
|
(setq m (car e) re (nth 1 e) n (nth 2 e)
|
|
|
|
block (if (nth 3 e) "\n\n" ""))
|
|
|
|
(setq off (if (member m '("$" "$1")) 1 0))
|
|
|
|
(when (and (member m matchers) (not (equal m "begin")))
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward re nil t)
|
|
|
|
(setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
|
|
|
|
(add-text-properties beg end
|
|
|
|
'(org-protected t org-latex-math t))))))
|
|
|
|
|
|
|
|
;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
|
|
|
|
(goto-char (point-min))
|
|
|
|
(let ((case-fold-search nil))
|
|
|
|
(while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
|
|
|
|
(unless (eq (char-before (match-beginning 1)) ?\\)
|
|
|
|
(org-if-unprotected-1
|
|
|
|
(replace-match (org-export-latex-protect-string
|
|
|
|
(concat "\\" (match-string 1)
|
|
|
|
"{}")) t t)))))
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
2010-04-07 09:32:31 -04:00
|
|
|
(let ((re (concat "\\\\\\([a-zA-Z]+\\)"
|
2010-01-28 09:50:20 -05:00
|
|
|
"\\(?:<[^<>\n]*>\\)*"
|
|
|
|
"\\(?:\\[[^][\n]*?\\]\\)*"
|
|
|
|
"\\(?:<[^<>\n]*>\\)*"
|
2010-03-12 09:21:41 -05:00
|
|
|
"\\("
|
|
|
|
(org-create-multibrace-regexp "{" "}" 3)
|
|
|
|
"\\)\\{1,3\\}")))
|
2009-10-20 08:06:23 -04:00
|
|
|
(while (re-search-forward re nil t)
|
2010-04-07 09:32:31 -04:00
|
|
|
(unless (or
|
|
|
|
;; check for comment line
|
|
|
|
(save-excursion (goto-char (match-beginning 0))
|
2010-05-14 08:27:35 -04:00
|
|
|
(org-in-indented-comment-line))
|
2010-04-07 09:32:31 -04:00
|
|
|
;; Check if this is a defined entity, so that is may need conversion
|
|
|
|
(org-entity-get (match-string 1)))
|
2009-10-20 08:06:23 -04:00
|
|
|
(add-text-properties (match-beginning 0) (match-end 0)
|
|
|
|
'(org-protected t)))))
|
2008-01-31 05:37:51 -05:00
|
|
|
(when (plist-get org-export-latex-options-plist :emphasize)
|
2008-01-31 05:35:58 -05:00
|
|
|
(org-export-latex-fontify))
|
2011-02-13 06:15:08 -05:00
|
|
|
(org-export-latex-time-stamps)
|
2009-01-06 11:23:36 -05:00
|
|
|
(org-export-latex-keywords-maybe)
|
2008-07-03 13:36:32 -04:00
|
|
|
(org-export-latex-special-chars
|
|
|
|
(plist-get org-export-latex-options-plist :sub-superscript))
|
2008-01-31 05:35:58 -05:00
|
|
|
(org-export-latex-links)
|
2008-10-10 05:42:01 -04:00
|
|
|
(org-trim (buffer-string))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2009-04-13 02:52:11 -04:00
|
|
|
(defun org-export-latex-time-stamps ()
|
|
|
|
"Format time stamps."
|
|
|
|
(goto-char (point-min))
|
|
|
|
(let ((org-display-custom-times org-export-latex-display-custom-times))
|
|
|
|
(while (re-search-forward org-ts-regexp-both nil t)
|
|
|
|
(org-if-unprotected-at (1- (point))
|
|
|
|
(replace-match
|
|
|
|
(org-export-latex-protect-string
|
|
|
|
(format org-export-latex-timestamp-markup
|
|
|
|
(substring (org-translate-time (match-string 0)) 1 -1)))
|
|
|
|
t t)))))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-quotation-marks ()
|
2008-09-20 08:45:11 -04:00
|
|
|
"Export quotation marks depending on language conventions."
|
2008-01-31 05:37:51 -05:00
|
|
|
(let* ((lang (plist-get org-export-latex-options-plist :language))
|
2008-01-31 05:35:58 -05:00
|
|
|
(quote-rpl (if (equal lang "fr")
|
Captions and attributes for images and tables during export
Tables, and Hyperlinks that represent inlined images, can now be
equipped with additional information that will be used during
export. The information will be taken from the following special
lines in the buffer and apply to the first following table or
link.
- #+CAPTION: :: The caption of the image or table. This string
should be processed according to the export backend, but
this is not yet done.
- #+LABEL: :: A label to identify the figure/table for cross
references. For HTML export, this string will become the
ID for the `<div class="figure">' element that encapsulates
the image tag and the caption. For LaTeX export, this
string will be used as the argument of a `\label{...}'
macro. These lables will be available for internal links
like `[[label][Table] ]'.
- #+ATTR_HTML: :: Attributes for HTML export of image, to be
added as attributes into the `<img...>' tag. This string
will not be processed, so it should have immediately the
right format.
- #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to
be inserted into the optional argument of the
`\includegraphics[...]{file}' command, to specify scaling,
clipping and other options. This string will not be
processed, so it should have immediately the right
format, like `width=5cm,angle=90'
For LaTeX export, if either a caption or a label is given, the
element will be exported as a float, i.e. wrapped into a figure
or table environment.
2008-12-10 06:50:07 -05:00
|
|
|
'(("\\(\\s-\\)\"" "«~")
|
|
|
|
("\\(\\S-\\)\"" "~»")
|
2008-01-31 05:35:58 -05:00
|
|
|
("\\(\\s-\\)'" "`"))
|
2009-10-28 05:30:07 -04:00
|
|
|
'(("\\(\\s-\\|[[(]\\)\"" "``")
|
2008-01-31 05:35:58 -05:00
|
|
|
("\\(\\S-\\)\"" "''")
|
2009-07-02 03:53:25 -04:00
|
|
|
("\\(\\s-\\|(\\)'" "`")))))
|
2008-01-31 05:35:58 -05:00
|
|
|
(mapc (lambda(l) (goto-char (point-min))
|
|
|
|
(while (re-search-forward (car l) nil t)
|
2009-10-26 15:15:48 -04:00
|
|
|
(let ((rpl (concat (match-string 1)
|
|
|
|
(org-export-latex-protect-string
|
|
|
|
(copy-sequence (cadr l))))))
|
LaTeX export: Make quotes exported right before a footnote reference.
Matt Lundin writes:
I'm have a *minor* issue to report. It occurs when I export
an org file with footnotes to LaTeX. Specifically, it has to
do with the combination of American style quotation marks
and footnotes.
According to many American manuals of style, quotation marks
are to be placed after a sentence ending period if the
quoted passage is at the end of the sentence. E.g.
,----
| Here is "a quote."
|
| not
|
| Here is "a quote".
`----
When I use American style quotation in conjuction with a
footnote, the exporter does not convert the closing quote
marks into a two single quotation marks (i.e., LaTeX smart
quotes).
Thus, the following source snippet:
,----
| This is a footnote "with a quote."[fn:sample] And here
| is another footnote "with a quote".[fn:another]
|
| [fn:sample] Here is the sample footnote.
|
| [fn:another] Another footnote.
`----
Becomes
,----
| This is a footnote ``with a quote."\footnote{Here is
| the sample footnote. } And here is another footnote ``with
| a quote''.\footnote{Another footnote. }
`----
Notice the double quotation mark (rather than two single
apostrophes) at the end of the first sentence. Notice also
the correct quotation mark format appears in the second
sentence, where the period comes after the quotation mark.
This commit addresses this issue by checking of text
protection is off not after the quotation mark, but before.
2009-01-20 02:26:44 -05:00
|
|
|
(org-if-unprotected-1
|
2008-01-31 05:35:58 -05:00
|
|
|
(replace-match rpl t t))))) quote-rpl)))
|
|
|
|
|
|
|
|
(defun org-export-latex-special-chars (sub-superscript)
|
|
|
|
"Export special characters to LaTeX.
|
|
|
|
If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
|
|
|
|
See the `org-export-latex.el' code for a complete conversion table."
|
|
|
|
(goto-char (point-min))
|
|
|
|
(mapc (lambda(c)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward c nil t)
|
|
|
|
;; Put the point where to check for org-protected
|
2008-12-16 01:44:13 -05:00
|
|
|
(unless (get-text-property (match-beginning 2) 'org-protected)
|
2008-01-31 05:35:58 -05:00
|
|
|
(cond ((member (match-string 2) '("\\$" "$"))
|
2008-01-31 05:36:29 -05:00
|
|
|
(if (equal (match-string 2) "\\$")
|
2009-01-06 06:56:30 -05:00
|
|
|
nil
|
|
|
|
(replace-match "\\$" t t)))
|
2008-01-31 05:36:29 -05:00
|
|
|
((member (match-string 2) '("&" "%" "#"))
|
|
|
|
(if (equal (match-string 1) "\\")
|
|
|
|
(replace-match (match-string 2) t t)
|
|
|
|
(replace-match (concat (match-string 1) "\\"
|
2010-03-03 06:59:26 -05:00
|
|
|
(match-string 2)) t t)
|
|
|
|
(backward-char 1)))
|
2008-01-31 05:37:51 -05:00
|
|
|
((equal (match-string 2) "...")
|
|
|
|
(replace-match
|
|
|
|
(concat (match-string 1)
|
|
|
|
(org-export-latex-protect-string "\\ldots{}")) t t))
|
2008-01-31 05:36:29 -05:00
|
|
|
((equal (match-string 2) "~")
|
|
|
|
(cond ((equal (match-string 1) "\\") nil)
|
|
|
|
((eq 'org-link (get-text-property 0 'face (match-string 2)))
|
|
|
|
(replace-match (concat (match-string 1) "\\~") t t))
|
2008-01-31 05:37:51 -05:00
|
|
|
(t (replace-match
|
2008-01-31 05:36:29 -05:00
|
|
|
(org-export-latex-protect-string
|
|
|
|
(concat (match-string 1) "\\~{}")) t t))))
|
|
|
|
((member (match-string 2) '("{" "}"))
|
2009-01-06 06:56:30 -05:00
|
|
|
(unless (save-match-data (org-inside-latex-math-p))
|
2008-01-31 05:36:29 -05:00
|
|
|
(if (equal (match-string 1) "\\")
|
|
|
|
(replace-match (match-string 2) t t)
|
|
|
|
(replace-match (concat (match-string 1) "\\"
|
|
|
|
(match-string 2)) t t)))))
|
2009-01-06 06:56:30 -05:00
|
|
|
(unless (save-match-data (org-inside-latex-math-p))
|
2008-01-31 05:36:29 -05:00
|
|
|
(cond ((equal (match-string 2) "\\")
|
|
|
|
(replace-match (or (save-match-data
|
|
|
|
(org-export-latex-treat-backslash-char
|
|
|
|
(match-string 1)
|
2008-12-21 05:00:05 -05:00
|
|
|
(or (match-string 3) "")))
|
2010-03-29 08:05:56 -04:00
|
|
|
"") t t)
|
2010-04-07 09:32:31 -04:00
|
|
|
(when (and (get-text-property (1- (point)) 'org-entity)
|
|
|
|
(looking-at "{}"))
|
|
|
|
;; OK, this was an entity replacement, and the user
|
|
|
|
;; had terminated the entity with {}. Make sure
|
|
|
|
;; {} is protected as well, and remove the extra {}
|
|
|
|
;; inserted by the conversion.
|
|
|
|
(put-text-property (point) (+ 2 (point)) 'org-protected t)
|
|
|
|
(if (save-excursion (goto-char (max (- (point) 2) (point-min)))
|
|
|
|
(looking-at "{}"))
|
|
|
|
(replace-match ""))
|
|
|
|
(forward-char 2))
|
2010-03-29 08:05:56 -04:00
|
|
|
(backward-char 1))
|
2008-01-31 05:36:29 -05:00
|
|
|
((member (match-string 2) '("_" "^"))
|
|
|
|
(replace-match (or (save-match-data
|
|
|
|
(org-export-latex-treat-sub-super-char
|
|
|
|
sub-superscript
|
|
|
|
(match-string 2)
|
2008-09-20 08:45:11 -04:00
|
|
|
(match-string 1)
|
2009-07-09 00:29:51 -04:00
|
|
|
(match-string 3))) "") t t)
|
|
|
|
(backward-char 1)))))))
|
2009-01-06 06:56:30 -05:00
|
|
|
'(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
|
|
|
|
"\\(\\(\\\\?\\$\\)\\)"
|
2010-03-30 04:36:02 -04:00
|
|
|
"\\([a-zA-Z0-9()]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-zA-Z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-zA-Z0-9]+}\\|([a-zA-Z0-9]+)\\)"
|
|
|
|
"\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|\\([&#%{}\"]\\|[a-zA-Z][a-zA-Z0-9]*\\)\\)"
|
2008-01-31 05:35:58 -05:00
|
|
|
"\\(.\\|^\\)\\(&\\)"
|
2008-12-16 11:58:02 -05:00
|
|
|
"\\(.\\|^\\)\\(#\\)"
|
|
|
|
"\\(.\\|^\\)\\(%\\)"
|
|
|
|
"\\(.\\|^\\)\\({\\)"
|
2008-01-31 05:35:58 -05:00
|
|
|
"\\(.\\|^\\)\\(}\\)"
|
2008-01-31 05:36:29 -05:00
|
|
|
"\\(.\\|^\\)\\(~\\)"
|
2008-01-31 05:37:51 -05:00
|
|
|
"\\(.\\|^\\)\\(\\.\\.\\.\\)"
|
2008-01-31 05:36:29 -05:00
|
|
|
;; (?\< . "\\textless{}")
|
|
|
|
;; (?\> . "\\textgreater{}")
|
|
|
|
)))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2009-01-06 06:56:30 -05:00
|
|
|
(defun org-inside-latex-math-p ()
|
|
|
|
(get-text-property (point) 'org-latex-math))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-treat-sub-super-char
|
2008-09-20 08:45:11 -04:00
|
|
|
(subsup char string-before string-after)
|
2008-01-31 05:35:58 -05:00
|
|
|
"Convert the \"_\" and \"^\" characters to LaTeX.
|
|
|
|
SUBSUP corresponds to the ^: option in the #+OPTIONS line.
|
|
|
|
Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
|
|
|
|
(cond ((equal string-before "\\")
|
|
|
|
(concat string-before char string-after))
|
2009-09-28 22:40:01 -04:00
|
|
|
((and (string-match "\\S-+" string-after))
|
|
|
|
;; this is part of a math formula
|
2008-01-31 05:35:58 -05:00
|
|
|
(cond ((eq 'org-link (get-text-property 0 'face char))
|
|
|
|
(concat string-before "\\" char string-after))
|
2009-01-06 06:56:30 -05:00
|
|
|
((save-match-data (org-inside-latex-math-p))
|
2008-01-31 05:35:58 -05:00
|
|
|
(if subsup
|
|
|
|
(cond ((eq 1 (length string-after))
|
|
|
|
(concat string-before char string-after))
|
|
|
|
((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
|
2008-01-31 05:37:51 -05:00
|
|
|
(format "%s%s{%s}" string-before char
|
2008-01-31 05:35:58 -05:00
|
|
|
(match-string 1 string-after))))))
|
2008-10-17 13:32:30 -04:00
|
|
|
((and (> (length string-after) 1)
|
|
|
|
(or (eq subsup t)
|
|
|
|
(and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
|
2010-04-28 11:21:41 -04:00
|
|
|
(or (string-match "[{]?\\([^}]+\\)[}]?" string-after)
|
|
|
|
(string-match "[(]?\\([^)]+\\)[)]?" string-after)))
|
|
|
|
|
2009-03-11 05:32:54 -04:00
|
|
|
(org-export-latex-protect-string
|
|
|
|
(format "%s$%s{%s}$" string-before char
|
|
|
|
(if (and (> (match-end 1) (1+ (match-beginning 1)))
|
|
|
|
(not (equal (substring string-after 0 2) "{\\")))
|
|
|
|
(concat "\\mathrm{" (match-string 1 string-after) "}")
|
|
|
|
(match-string 1 string-after)))))
|
2008-10-17 13:32:30 -04:00
|
|
|
((eq subsup t) (concat string-before "$" char string-after "$"))
|
2008-01-31 05:36:29 -05:00
|
|
|
(t (org-export-latex-protect-string
|
2008-01-31 05:36:18 -05:00
|
|
|
(concat string-before "\\" char "{}" string-after)))))
|
2008-01-31 05:36:29 -05:00
|
|
|
(t (org-export-latex-protect-string
|
2008-01-31 05:36:18 -05:00
|
|
|
(concat string-before "\\" char "{}" string-after)))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
|
|
|
(defun org-export-latex-treat-backslash-char (string-before string-after)
|
|
|
|
"Convert the \"$\" special character to LaTeX.
|
|
|
|
The conversion is made depending of STRING-BEFORE and STRING-AFTER."
|
2010-03-28 03:48:03 -04:00
|
|
|
(let ((ass (org-entity-get string-after)))
|
|
|
|
(cond
|
2010-04-07 09:32:31 -04:00
|
|
|
(ass (org-add-props
|
|
|
|
(if (nth 2 ass)
|
|
|
|
(concat string-before
|
|
|
|
(org-export-latex-protect-string
|
|
|
|
(concat "$" (nth 1 ass) "$")))
|
|
|
|
(concat string-before (org-export-latex-protect-string
|
|
|
|
(nth 1 ass))))
|
|
|
|
nil 'org-entity t))
|
2010-03-28 03:48:03 -04:00
|
|
|
((and (not (string-match "^[ \n\t]" string-after))
|
|
|
|
(not (string-match "[ \t]\\'\\|^" string-before)))
|
|
|
|
;; backslash is inside a word
|
|
|
|
(concat string-before
|
|
|
|
(org-export-latex-protect-string
|
|
|
|
(concat "\\textbackslash{}" string-after))))
|
|
|
|
((not (or (equal string-after "")
|
|
|
|
(string-match "^[ \t\n]" string-after)))
|
|
|
|
;; backslash might escape a character (like \#) or a user TeX
|
|
|
|
;; macro (like \setcounter)
|
|
|
|
(concat string-before
|
|
|
|
(org-export-latex-protect-string (concat "\\" string-after))))
|
|
|
|
((and (string-match "^[ \t\n]" string-after)
|
|
|
|
(string-match "[ \t\n]\\'" string-before))
|
|
|
|
;; backslash is alone, convert it to $\backslash$
|
|
|
|
(org-export-latex-protect-string
|
|
|
|
(concat string-before "\\textbackslash{}" string-after)))
|
|
|
|
(t (org-export-latex-protect-string
|
|
|
|
(concat string-before "\\textbackslash{}" string-after))))))
|
2010-04-01 07:11:54 -04:00
|
|
|
|
2009-01-06 11:23:36 -05:00
|
|
|
(defun org-export-latex-keywords ()
|
2009-01-08 08:25:26 -05:00
|
|
|
"Convert special keywords to LaTeX."
|
2009-01-06 11:23:36 -05:00
|
|
|
(goto-char (point-min))
|
2009-04-19 01:46:54 -04:00
|
|
|
(while (re-search-forward org-export-latex-special-keyword-regexp nil t)
|
|
|
|
(replace-match (format org-export-latex-timestamp-keyword-markup
|
|
|
|
(match-string 0)) t t)
|
|
|
|
(save-excursion
|
|
|
|
(beginning-of-line 1)
|
2010-03-19 14:51:58 -04:00
|
|
|
(unless (looking-at ".*\n[ \t]*\n")
|
2009-04-19 01:46:54 -04:00
|
|
|
(end-of-line 1)
|
2010-03-19 14:51:58 -04:00
|
|
|
(insert "\n")))))
|
2008-01-31 05:37:51 -05:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-fixed-width (opt)
|
|
|
|
"When OPT is non-nil convert fixed-width sections to LaTeX."
|
|
|
|
(goto-char (point-min))
|
2009-01-09 02:28:43 -05:00
|
|
|
(while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
|
2010-06-28 17:15:23 -04:00
|
|
|
(unless (get-text-property (point) 'org-example)
|
2010-06-27 22:36:14 -04:00
|
|
|
(if opt
|
|
|
|
(progn (goto-char (match-beginning 0))
|
|
|
|
(insert "\\begin{verbatim}\n")
|
|
|
|
(while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
|
|
|
|
(replace-match (concat (match-string 1)
|
|
|
|
(match-string 2)) t t)
|
|
|
|
(forward-line))
|
|
|
|
(insert "\\end{verbatim}\n\n"))
|
|
|
|
(progn (goto-char (match-beginning 0))
|
|
|
|
(while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
|
|
|
|
(replace-match (concat "%" (match-string 1)
|
|
|
|
(match-string 2)) t t)
|
|
|
|
(forward-line)))))))
|
2008-03-22 11:52:18 -04:00
|
|
|
|
|
|
|
(defvar org-table-last-alignment) ; defined in org-table.el
|
2009-08-31 06:19:56 -04:00
|
|
|
(defvar org-table-last-column-widths) ; defined in org-table.el
|
2008-03-22 11:52:18 -04:00
|
|
|
(declare-function orgtbl-to-latex "org-table" (table params) t)
|
2008-01-31 05:36:29 -05:00
|
|
|
(defun org-export-latex-tables (insert)
|
|
|
|
"Convert tables to LaTeX and INSERT it."
|
2010-02-26 04:08:27 -05:00
|
|
|
;; First, get the table.el tables
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "^[ \t]*\\(\\+-[-+]*\\+\\)[ \t]*\n[ \t]*|" nil t)
|
2010-03-03 07:26:24 -05:00
|
|
|
(org-if-unprotected
|
|
|
|
(require 'table)
|
|
|
|
(org-export-latex-convert-table.el-table)))
|
2010-02-26 04:08:27 -05:00
|
|
|
|
|
|
|
;; And now the Org-mode tables
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "^\\([ \t]*\\)|" nil t)
|
2009-10-07 02:10:05 -04:00
|
|
|
(org-if-unprotected-at (1- (point))
|
|
|
|
(org-table-align)
|
|
|
|
(let* ((beg (org-table-begin))
|
|
|
|
(end (org-table-end))
|
|
|
|
(raw-table (buffer-substring beg end))
|
|
|
|
(org-table-last-alignment (copy-sequence org-table-last-alignment))
|
|
|
|
(org-table-last-column-widths (copy-sequence
|
|
|
|
org-table-last-column-widths))
|
|
|
|
fnum fields line lines olines gr colgropen line-fmt align
|
2011-03-01 01:24:14 -05:00
|
|
|
caption width shortn label attr floatp placement
|
2010-12-17 15:31:09 -05:00
|
|
|
longtblp tblenv tabular-env)
|
2009-10-07 02:10:05 -04:00
|
|
|
(if org-export-latex-tables-verbatim
|
|
|
|
(let* ((tbl (concat "\\begin{verbatim}\n" raw-table
|
|
|
|
"\\end{verbatim}\n")))
|
|
|
|
(apply 'delete-region (list beg end))
|
|
|
|
(insert (org-export-latex-protect-string tbl)))
|
|
|
|
(progn
|
|
|
|
(setq caption (org-find-text-property-in-string
|
|
|
|
'org-caption raw-table)
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
shortn (org-find-text-property-in-string
|
|
|
|
'org-caption-shortn raw-table)
|
2009-10-07 02:10:05 -04:00
|
|
|
attr (org-find-text-property-in-string
|
|
|
|
'org-attributes raw-table)
|
|
|
|
label (org-find-text-property-in-string
|
|
|
|
'org-label raw-table)
|
|
|
|
longtblp (and attr (stringp attr)
|
|
|
|
(string-match "\\<longtable\\>" attr))
|
2010-12-17 15:31:09 -05:00
|
|
|
tblenv (if (and attr (stringp attr)
|
|
|
|
(string-match (regexp-quote "table*") attr))
|
|
|
|
"table*" "table")
|
|
|
|
tabular-env
|
|
|
|
(if (and attr (stringp attr)
|
|
|
|
(string-match "\\(tabular.\\)" attr))
|
|
|
|
(match-string 1 attr)
|
|
|
|
org-export-latex-tabular-environment)
|
|
|
|
width (and attr (stringp attr)
|
|
|
|
(string-match "\\<width=\\([^ \t\n\r]+\\)" attr)
|
|
|
|
(match-string 1 attr))
|
2009-10-07 02:10:05 -04:00
|
|
|
align (and attr (stringp attr)
|
2010-05-14 08:27:35 -04:00
|
|
|
(string-match "\\<align=\\([^ \t\n\r]+\\)" attr)
|
2009-10-07 02:10:05 -04:00
|
|
|
(match-string 1 attr))
|
2010-07-23 23:16:44 -04:00
|
|
|
floatp (or caption label)
|
2011-02-13 06:15:08 -05:00
|
|
|
placement (if (and attr
|
2010-07-23 23:16:44 -04:00
|
|
|
(stringp attr)
|
|
|
|
(string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
|
|
|
|
(match-string 1 attr)
|
2011-01-28 10:59:47 -05:00
|
|
|
(concat
|
|
|
|
"[" org-latex-default-figure-position "]")))
|
2010-04-07 10:10:28 -04:00
|
|
|
(setq caption (and caption (org-export-latex-fontify-headline caption)))
|
2009-10-07 02:10:05 -04:00
|
|
|
(setq lines (org-split-string raw-table "\n"))
|
|
|
|
(apply 'delete-region (list beg end))
|
|
|
|
(when org-export-table-remove-special-lines
|
|
|
|
(setq lines (org-table-clean-before-export lines 'maybe-quoted)))
|
|
|
|
(when org-table-clean-did-remove-column
|
LaTeX export: Fix bug with longtable export.
Karl Stump writes:
> When exporting a table with a horizontal line the column count is wrong.
>
> Output from pdflatex run:
>
> ! Extra alignment tab has been changed to \cr.
> <template> \endtemplate
>
> l.32 ....\multicolumn{4}{r}{Continued on next page}
> \
> ?
>
> Here's the table in the tex file:
>
> \begin{longtable}{||lll||}
> \caption{This is a long table with lines around and between cells}\\
> Heading1 & Heading2 & Heading3 \\
> \hline
> \endhead
> \hline\multicolumn{4}{r}{Continued on next page}\
> \endfoot
> \endlastfoot
> \hline
> alpha & beta & gamma \\
> & & \\
> \end{longtable}
>
> Here's the org file:
>
> ** table export test
>
> #+CAPTION: This is a long table with lines around and between cells
> #+LATEX_HEADER: \usepackage[landscape]{geometry}
> #+LATEX_HEADER: \geometry{left=0.12in,right=0.12in,top=0.25in,bottom=0.25in}
> #+ATTR_LaTeX: longtable align=||lll||
>
> | / | <30> | <10> | <10> |
> | | Heading1 | Heading2 | Heading3 |
> |---+----------+----------+----------|
> | | alpha | beta | gamma |
> | | | | |
Nick Dokos replies:
> I believe it's because of the dummy "calculation-mark" column,
> which is not exported. However, the variable org-table-last-alignment
> (a list, whose length becomes the value of the \multicolumn argument)
> ends up having the value (nil nil nil nil), i.e. it counts the dummy
> column as well. What the proper place to adjust the value is, I don't
> know, but it should be easy for Carsten to fix it. For the time being,
> you can either get rid of the dummy row and column (e.g. if you don't
> need the widths) or fix it by hand in the LaTeX file.
Indeed, and this commit pops `org-table-last-alignment' if the first
column has been removed by `org-table-clean-before-export'. The same
problem must have caused a one-off error when setting the alignment in
LaTeX tables, bu it seems nobody has noticed this so far. Anyway,
also this is fixed now.
2009-08-29 01:22:33 -04:00
|
|
|
(pop org-table-last-alignment)
|
|
|
|
(pop org-table-last-column-widths))
|
2009-11-12 07:39:29 -05:00
|
|
|
;; make a formatting string to reflect alignment
|
2009-10-07 02:10:05 -04:00
|
|
|
(setq olines lines)
|
|
|
|
(while (and (not line-fmt) (setq line (pop olines)))
|
|
|
|
(unless (string-match "^[ \t]*|-" line)
|
|
|
|
(setq fields (org-split-string line "[ \t]*|[ \t]*"))
|
|
|
|
(setq fnum (make-vector (length fields) 0))
|
|
|
|
(setq line-fmt
|
|
|
|
(mapconcat
|
|
|
|
(lambda (x)
|
|
|
|
(setq gr (pop org-table-colgroup-info))
|
|
|
|
(format "%s%%s%s"
|
|
|
|
(cond ((eq gr :start)
|
|
|
|
(prog1 (if colgropen "|" "|")
|
|
|
|
(setq colgropen t)))
|
|
|
|
((eq gr :startend)
|
|
|
|
(prog1 (if colgropen "|" "|")
|
|
|
|
(setq colgropen nil)))
|
|
|
|
(t ""))
|
|
|
|
(if (memq gr '(:end :startend))
|
|
|
|
(progn (setq colgropen nil) "|")
|
|
|
|
"")))
|
|
|
|
fnum ""))))
|
|
|
|
;; fix double || in line-fmt
|
|
|
|
(setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
|
|
|
|
;; maybe remove the first and last "|"
|
|
|
|
(when (and (not org-export-latex-tables-column-borders)
|
|
|
|
(string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
|
|
|
|
(setq line-fmt (match-string 2 line-fmt)))
|
|
|
|
;; format alignment
|
|
|
|
(unless align
|
|
|
|
(setq align (apply 'format
|
|
|
|
(cons line-fmt
|
|
|
|
(mapcar (lambda (x) (if x "r" "l"))
|
|
|
|
org-table-last-alignment)))))
|
|
|
|
;; prepare the table to send to orgtbl-to-latex
|
|
|
|
(setq lines
|
|
|
|
(mapcar
|
|
|
|
(lambda(elem)
|
|
|
|
(or (and (string-match "[ \t]*|-+" elem) 'hline)
|
|
|
|
(org-split-string (org-trim elem) "|")))
|
|
|
|
lines))
|
|
|
|
(when insert
|
|
|
|
(insert (org-export-latex-protect-string
|
|
|
|
(concat
|
|
|
|
(if longtblp
|
|
|
|
(concat "\\begin{longtable}{" align "}\n")
|
2010-12-17 15:31:09 -05:00
|
|
|
(if floatp
|
|
|
|
(format "\\begin{%s}%s\n" tblenv placement)))
|
2009-12-16 14:25:20 -05:00
|
|
|
(if floatp
|
2009-10-07 02:10:05 -04:00
|
|
|
(format
|
2010-07-28 19:59:42 -04:00
|
|
|
"\\caption%s{%s} %s"
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
(if shortn (concat "[" shortn "]") "")
|
2010-07-28 19:59:42 -04:00
|
|
|
(or caption "")
|
2010-08-10 21:48:52 -04:00
|
|
|
(if label (format "\\label{%s}" label) "")))
|
2009-12-17 04:57:42 -05:00
|
|
|
(if (and longtblp caption) "\\\\\n" "\n")
|
2009-10-07 02:10:05 -04:00
|
|
|
(if (and org-export-latex-tables-centered (not longtblp))
|
|
|
|
"\\begin{center}\n")
|
2010-07-06 04:39:35 -04:00
|
|
|
(if (not longtblp)
|
2010-12-17 15:31:09 -05:00
|
|
|
(format "\\begin{%s}%s{%s}\n"
|
|
|
|
tabular-env
|
|
|
|
(if width (format "{%s}" width) "")
|
|
|
|
align))
|
2009-10-07 02:10:05 -04:00
|
|
|
(orgtbl-to-latex
|
|
|
|
lines
|
|
|
|
`(:tstart nil :tend nil
|
|
|
|
:hlend ,(if longtblp
|
|
|
|
(format "\\\\
|
2008-12-15 15:28:02 -05:00
|
|
|
\\hline
|
|
|
|
\\endhead
|
|
|
|
\\hline\\multicolumn{%d}{r}{Continued on next page}\\
|
|
|
|
\\endfoot
|
|
|
|
\\endlastfoot" (length org-table-last-alignment))
|
2009-10-07 02:10:05 -04:00
|
|
|
nil)))
|
2010-12-17 15:31:09 -05:00
|
|
|
(if (not longtblp) (format "\n\\end{%s}" tabular-env))
|
2009-10-07 02:10:05 -04:00
|
|
|
(if longtblp "\n" (if org-export-latex-tables-centered
|
|
|
|
"\n\\end{center}\n" "\n"))
|
|
|
|
(if longtblp
|
|
|
|
"\\end{longtable}"
|
2010-12-17 15:31:09 -05:00
|
|
|
(if floatp (format "\\end{%s}" tblenv)))))
|
2009-10-07 02:10:05 -04:00
|
|
|
"\n\n"))))))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2010-02-26 04:08:27 -05:00
|
|
|
(defun org-export-latex-convert-table.el-table ()
|
|
|
|
"Replace table.el table at point with LaTeX code."
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
(let (tbl caption shortn label line floatp attr align rmlines)
|
2010-02-26 04:08:27 -05:00
|
|
|
(setq line (buffer-substring (point-at-bol) (point-at-eol))
|
|
|
|
label (org-get-text-property-any 0 'org-label line)
|
|
|
|
caption (org-get-text-property-any 0 'org-caption line)
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
shortn (org-get-text-property-any 0 'org-caption-shortn line)
|
2010-02-26 04:08:27 -05:00
|
|
|
attr (org-get-text-property-any 0 'org-attributes line)
|
|
|
|
align (and attr (stringp attr)
|
|
|
|
(string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
|
|
|
|
(match-string 1 attr))
|
|
|
|
rmlines (and attr (stringp attr)
|
|
|
|
(string-match "\\<rmlines\\>" attr))
|
|
|
|
floatp (or label caption))
|
|
|
|
(and (get-buffer "*org-export-table*")
|
|
|
|
(kill-buffer (get-buffer "*org-export-table*")))
|
|
|
|
(table-generate-source 'latex "*org-export-table*" "caption")
|
|
|
|
(setq tbl (with-current-buffer "*org-export-table*"
|
|
|
|
(buffer-string)))
|
|
|
|
(while (string-match "^%.*\n" tbl)
|
|
|
|
(setq tbl (replace-match "" t t tbl)))
|
|
|
|
;; fix the hlines
|
|
|
|
(when rmlines
|
|
|
|
(let ((n 0) lines)
|
|
|
|
(setq lines (mapcar (lambda (x)
|
|
|
|
(if (string-match "^\\\\hline$" x)
|
|
|
|
(progn
|
|
|
|
(setq n (1+ n))
|
|
|
|
(if (= n 2) x nil))
|
|
|
|
x))
|
|
|
|
(org-split-string tbl "\n")))
|
|
|
|
(setq tbl (mapconcat 'identity (delq nil lines) "\n"))))
|
|
|
|
(when (and align (string-match "\\\\begin{tabular}{.*}" tbl))
|
|
|
|
(setq tbl (replace-match (concat "\\begin{tabular}{" align "}")
|
2010-04-01 07:11:54 -04:00
|
|
|
t t tbl)))
|
2010-02-26 04:08:27 -05:00
|
|
|
(and (get-buffer "*org-export-table*")
|
|
|
|
(kill-buffer (get-buffer "*org-export-table*")))
|
|
|
|
(beginning-of-line 0)
|
|
|
|
(while (looking-at "[ \t]*\\(|\\|\\+-\\)")
|
|
|
|
(delete-region (point) (1+ (point-at-eol))))
|
|
|
|
(when org-export-latex-tables-centered
|
|
|
|
(setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
|
|
|
|
(when floatp
|
|
|
|
(setq tbl (concat "\\begin{table}\n"
|
2010-07-28 19:59:42 -04:00
|
|
|
(format "\\caption%s{%s}%s\n"
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
(if shortn (format "[%s]" shortn) "")
|
2010-02-26 04:08:27 -05:00
|
|
|
(if label (format "\\label{%s}" label) "")
|
|
|
|
(or caption ""))
|
|
|
|
tbl
|
|
|
|
"\n\\end{table}\n")))
|
|
|
|
(insert (org-export-latex-protect-string tbl))))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-fontify ()
|
|
|
|
"Convert fontification to LaTeX."
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward org-emph-re nil t)
|
2009-11-18 05:33:39 -05:00
|
|
|
;; The match goes one char after the *string*, except at the end of a line
|
2008-01-31 05:37:51 -05:00
|
|
|
(let ((emph (assoc (match-string 3)
|
|
|
|
org-export-latex-emphasis-alist))
|
2009-01-09 03:53:17 -05:00
|
|
|
(beg (match-beginning 0))
|
|
|
|
(end (match-end 0))
|
2009-11-09 14:51:28 -05:00
|
|
|
rpl s)
|
2009-02-22 14:51:19 -05:00
|
|
|
(unless emph
|
|
|
|
(message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
|
|
|
|
(match-string 3)))
|
2009-10-28 19:17:32 -04:00
|
|
|
(unless (or (and (get-text-property (- (point) 2) 'org-protected)
|
|
|
|
(not (get-text-property
|
|
|
|
(- (point) 2) 'org-verbatim-emph)))
|
2010-06-01 03:43:03 -04:00
|
|
|
(equal (char-after (match-beginning 3))
|
|
|
|
(char-after (1+ (match-beginning 3))))
|
2009-01-09 03:53:17 -05:00
|
|
|
(save-excursion
|
|
|
|
(goto-char (match-beginning 1))
|
|
|
|
(save-match-data
|
|
|
|
(and (org-at-table-p)
|
|
|
|
(string-match
|
2010-03-24 13:27:33 -04:00
|
|
|
"[|\n]" (buffer-substring beg end)))))
|
|
|
|
(and (equal (match-string 3) "+")
|
|
|
|
(save-match-data
|
|
|
|
(string-match "\\`-+\\'" (match-string 4)))))
|
2009-11-09 14:51:28 -05:00
|
|
|
(setq s (match-string 4))
|
2008-01-31 05:36:18 -05:00
|
|
|
(setq rpl (concat (match-string 1)
|
2009-03-14 03:36:48 -04:00
|
|
|
(org-export-latex-emph-format (cadr emph)
|
|
|
|
(match-string 4))
|
2008-01-31 05:36:18 -05:00
|
|
|
(match-string 5)))
|
2008-01-31 05:37:51 -05:00
|
|
|
(if (caddr emph)
|
2009-11-09 14:51:28 -05:00
|
|
|
(setq rpl (org-export-latex-protect-string rpl))
|
|
|
|
(save-match-data
|
2009-12-09 16:34:18 -05:00
|
|
|
(if (string-match "\\`.?\\(\\\\[a-z]+{\\)\\(.*\\)\\(}\\).?\\'" rpl)
|
2009-11-09 14:51:28 -05:00
|
|
|
(progn
|
|
|
|
(add-text-properties (match-beginning 1) (match-end 1)
|
|
|
|
'(org-protected t) rpl)
|
|
|
|
(add-text-properties (match-beginning 3) (match-end 3)
|
|
|
|
'(org-protected t) rpl)))))
|
2008-01-31 05:36:18 -05:00
|
|
|
(replace-match rpl t t)))
|
|
|
|
(backward-char)))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2009-03-14 03:36:48 -04:00
|
|
|
(defun org-export-latex-emph-format (format string)
|
|
|
|
"Format an emphasis string and handle the \\verb special case."
|
2011-02-01 05:21:34 -05:00
|
|
|
(when (member format '("\\verb" "\\protectedtexttt"))
|
2009-03-14 03:36:48 -04:00
|
|
|
(save-match-data
|
2011-02-01 12:03:57 -05:00
|
|
|
(if (equal format "\\verb")
|
2009-06-09 00:26:59 -04:00
|
|
|
(let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
|
|
|
|
(catch 'exit
|
|
|
|
(loop for i from 0 to (1- (length ll)) do
|
|
|
|
(if (not (string-match (regexp-quote (substring ll i (1+ i)))
|
|
|
|
string))
|
|
|
|
(progn
|
|
|
|
(setq format (concat "\\verb" (substring ll i (1+ i))
|
|
|
|
"%s" (substring ll i (1+ i))))
|
|
|
|
(throw 'exit nil))))))
|
|
|
|
(let ((start 0)
|
2009-09-24 05:02:00 -04:00
|
|
|
(trans '(("\\" . "\\textbackslash{}")
|
|
|
|
("~" . "\\textasciitilde{}")
|
|
|
|
("^" . "\\textasciicircum{}")))
|
2009-06-11 16:18:47 -04:00
|
|
|
(rtn "") char)
|
2009-06-09 06:10:27 -04:00
|
|
|
(while (string-match "[\\{}$%&_#~^]" string)
|
2009-06-09 00:26:59 -04:00
|
|
|
(setq char (match-string 0 string))
|
|
|
|
(if (> (match-beginning 0) 0)
|
|
|
|
(setq rtn (concat rtn (substring string
|
|
|
|
0 (match-beginning 0)))))
|
|
|
|
(setq string (substring string (1+ (match-beginning 0))))
|
|
|
|
(setq char (or (cdr (assoc char trans)) (concat "\\" char))
|
|
|
|
rtn (concat rtn char)))
|
2011-02-01 05:21:34 -05:00
|
|
|
(setq string (concat rtn string) format "\\texttt{%s}")
|
|
|
|
(while (string-match "--" string)
|
|
|
|
(setq string (replace-match "-{}-" t t string)))))))
|
2009-11-09 14:51:28 -05:00
|
|
|
(format format string))
|
2009-03-14 03:36:48 -04:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(defun org-export-latex-links ()
|
|
|
|
;; Make sure to use the LaTeX hyperref and graphicx package
|
|
|
|
;; or send some warnings.
|
|
|
|
"Convert links to LaTeX."
|
|
|
|
(goto-char (point-min))
|
2008-12-26 11:37:53 -05:00
|
|
|
(while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
|
2009-11-10 02:48:40 -05:00
|
|
|
(org-if-unprotected-1
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (match-beginning 0))
|
2008-01-31 05:37:51 -05:00
|
|
|
(let* ((re-radio org-export-latex-all-targets-re)
|
2008-01-31 05:35:58 -05:00
|
|
|
(remove (list (match-beginning 0) (match-end 0)))
|
2008-07-17 18:07:14 -04:00
|
|
|
(raw-path (org-extract-attributes (match-string 3)))
|
2008-01-31 05:35:58 -05:00
|
|
|
(full-raw-path (concat (match-string 1) raw-path))
|
|
|
|
(desc (match-string 5))
|
Captions and attributes for images and tables during export
Tables, and Hyperlinks that represent inlined images, can now be
equipped with additional information that will be used during
export. The information will be taken from the following special
lines in the buffer and apply to the first following table or
link.
- #+CAPTION: :: The caption of the image or table. This string
should be processed according to the export backend, but
this is not yet done.
- #+LABEL: :: A label to identify the figure/table for cross
references. For HTML export, this string will become the
ID for the `<div class="figure">' element that encapsulates
the image tag and the caption. For LaTeX export, this
string will be used as the argument of a `\label{...}'
macro. These lables will be available for internal links
like `[[label][Table] ]'.
- #+ATTR_HTML: :: Attributes for HTML export of image, to be
added as attributes into the `<img...>' tag. This string
will not be processed, so it should have immediately the
right format.
- #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to
be inserted into the optional argument of the
`\includegraphics[...]{file}' command, to specify scaling,
clipping and other options. This string will not be
processed, so it should have immediately the right
format, like `width=5cm,angle=90'
For LaTeX export, if either a caption or a label is given, the
element will be exported as a float, i.e. wrapped into a figure
or table environment.
2008-12-10 06:50:07 -05:00
|
|
|
(type (or (match-string 2)
|
|
|
|
(if (or (file-name-absolute-p raw-path)
|
|
|
|
(string-match "^\\.\\.?/" raw-path))
|
|
|
|
"file")))
|
2008-12-26 11:37:53 -05:00
|
|
|
(coderefp (equal type "coderef"))
|
Captions and attributes for images and tables during export
Tables, and Hyperlinks that represent inlined images, can now be
equipped with additional information that will be used during
export. The information will be taken from the following special
lines in the buffer and apply to the first following table or
link.
- #+CAPTION: :: The caption of the image or table. This string
should be processed according to the export backend, but
this is not yet done.
- #+LABEL: :: A label to identify the figure/table for cross
references. For HTML export, this string will become the
ID for the `<div class="figure">' element that encapsulates
the image tag and the caption. For LaTeX export, this
string will be used as the argument of a `\label{...}'
macro. These lables will be available for internal links
like `[[label][Table] ]'.
- #+ATTR_HTML: :: Attributes for HTML export of image, to be
added as attributes into the `<img...>' tag. This string
will not be processed, so it should have immediately the
right format.
- #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to
be inserted into the optional argument of the
`\includegraphics[...]{file}' command, to specify scaling,
clipping and other options. This string will not be
processed, so it should have immediately the right
format, like `width=5cm,angle=90'
For LaTeX export, if either a caption or a label is given, the
element will be exported as a float, i.e. wrapped into a figure
or table environment.
2008-12-10 06:50:07 -05:00
|
|
|
(caption (org-find-text-property-in-string 'org-caption raw-path))
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
(shortn (org-find-text-property-in-string 'org-caption-shortn raw-path))
|
2009-05-05 03:41:00 -04:00
|
|
|
(attr (or (org-find-text-property-in-string 'org-attributes raw-path)
|
|
|
|
(plist-get org-export-latex-options-plist :latex-image-options)))
|
Captions and attributes for images and tables during export
Tables, and Hyperlinks that represent inlined images, can now be
equipped with additional information that will be used during
export. The information will be taken from the following special
lines in the buffer and apply to the first following table or
link.
- #+CAPTION: :: The caption of the image or table. This string
should be processed according to the export backend, but
this is not yet done.
- #+LABEL: :: A label to identify the figure/table for cross
references. For HTML export, this string will become the
ID for the `<div class="figure">' element that encapsulates
the image tag and the caption. For LaTeX export, this
string will be used as the argument of a `\label{...}'
macro. These lables will be available for internal links
like `[[label][Table] ]'.
- #+ATTR_HTML: :: Attributes for HTML export of image, to be
added as attributes into the `<img...>' tag. This string
will not be processed, so it should have immediately the
right format.
- #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to
be inserted into the optional argument of the
`\includegraphics[...]{file}' command, to specify scaling,
clipping and other options. This string will not be
processed, so it should have immediately the right
format, like `width=5cm,angle=90'
For LaTeX export, if either a caption or a label is given, the
element will be exported as a float, i.e. wrapped into a figure
or table environment.
2008-12-10 06:50:07 -05:00
|
|
|
(label (org-find-text-property-in-string 'org-label raw-path))
|
2010-05-12 09:14:17 -04:00
|
|
|
imgp radiop fnc
|
2008-01-31 05:35:58 -05:00
|
|
|
;; define the path of the link
|
|
|
|
(path (cond
|
2008-12-26 11:37:53 -05:00
|
|
|
((member type '("coderef"))
|
|
|
|
raw-path)
|
2008-01-31 05:35:58 -05:00
|
|
|
((member type '("http" "https" "ftp"))
|
|
|
|
(concat type ":" raw-path))
|
|
|
|
((and re-radio (string-match re-radio raw-path))
|
2008-12-16 11:58:02 -05:00
|
|
|
(setq radiop t))
|
2008-01-31 05:35:58 -05:00
|
|
|
((equal type "mailto")
|
|
|
|
(concat type ":" raw-path))
|
|
|
|
((equal type "file")
|
Export: Better detection of images that can be inlined.
Two new variables, `org-export-html-inline-image-extensions' and
`org-export-latex-inline-image-extensions' now define the file
extensions that will be considered for inlining images. The default
for HTML is png, jpg, jpeg, and gif files. The default for LaTeX is
png, jpg, jpeg, and pdf, assuming processing with `pdflatex'.
For LaTeX export, this can lead to conflicts for links that point
to non-image PDF files. To avoid that such a link will be inlined by
accident, always give a description text for such a link, one that is
not equal to the path.
2009-01-18 03:11:24 -05:00
|
|
|
(if (and (org-file-image-p
|
|
|
|
(expand-file-name
|
|
|
|
raw-path)
|
|
|
|
org-export-latex-inline-image-extensions)
|
2009-06-23 00:15:01 -04:00
|
|
|
(or (get-text-property 0 'org-no-description
|
|
|
|
raw-path)
|
|
|
|
(equal desc full-raw-path)))
|
2008-01-31 05:35:58 -05:00
|
|
|
(setq imgp t)
|
|
|
|
(progn (when (string-match "\\(.+\\)::.+" raw-path)
|
|
|
|
(setq raw-path (match-string 1 raw-path)))
|
|
|
|
(if (file-exists-p raw-path)
|
|
|
|
(concat type "://" (expand-file-name raw-path))
|
|
|
|
(concat type "://" (org-export-directory
|
2008-01-31 05:37:51 -05:00
|
|
|
:LaTeX org-export-latex-options-plist)
|
2008-01-31 05:35:58 -05:00
|
|
|
raw-path))))))))
|
|
|
|
;; process with link inserting
|
|
|
|
(apply 'delete-region remove)
|
2010-04-07 10:10:28 -04:00
|
|
|
(setq caption (and caption (org-export-latex-fontify-headline caption)))
|
2009-10-02 04:28:56 -04:00
|
|
|
(cond ((and imgp
|
|
|
|
(plist-get org-export-latex-options-plist :inline-images))
|
|
|
|
;; OK, we need to inline an image
|
Captions and attributes for images and tables during export
Tables, and Hyperlinks that represent inlined images, can now be
equipped with additional information that will be used during
export. The information will be taken from the following special
lines in the buffer and apply to the first following table or
link.
- #+CAPTION: :: The caption of the image or table. This string
should be processed according to the export backend, but
this is not yet done.
- #+LABEL: :: A label to identify the figure/table for cross
references. For HTML export, this string will become the
ID for the `<div class="figure">' element that encapsulates
the image tag and the caption. For LaTeX export, this
string will be used as the argument of a `\label{...}'
macro. These lables will be available for internal links
like `[[label][Table] ]'.
- #+ATTR_HTML: :: Attributes for HTML export of image, to be
added as attributes into the `<img...>' tag. This string
will not be processed, so it should have immediately the
right format.
- #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to
be inserted into the optional argument of the
`\includegraphics[...]{file}' command, to specify scaling,
clipping and other options. This string will not be
processed, so it should have immediately the right
format, like `width=5cm,angle=90'
For LaTeX export, if either a caption or a label is given, the
element will be exported as a float, i.e. wrapped into a figure
or table environment.
2008-12-10 06:50:07 -05:00
|
|
|
(insert
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
(org-export-latex-format-image raw-path caption label attr shortn)))
|
2008-12-26 11:37:53 -05:00
|
|
|
(coderefp
|
|
|
|
(insert (format
|
|
|
|
(org-export-get-coderef-format path desc)
|
|
|
|
(cdr (assoc path org-export-code-refs)))))
|
Internal links in LaTeX export
Carsten Dominik <carsten.dominik@gmail.com> writes:
> On Oct 29, 2010, at 5:22 AM, Jambunathan K wrote:
>
>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>
>>> Aloha Jambunathan K.,
>>>
>>> Yes, thanks for that suggestion. It should work on your example, but
>>> it breaks external links, like this:
>>>
>>> \hyperref[http://www.ctan.org/tex-archive/macros/latex/contrib/koma-script/
>>> ]{KOMA-script}
>>>
>>> External links require the \href{}{} command. It appears the LaTeX
>>> export process no longer distinguishes internal and external links,
>>> as
>>> I believe it used to do.
>>>
>>
>> This is the problematic commit:
>>
>> commit f5918bdcc05d7924dc204b57307023eb1ef011f0
>> parent df5894cdcb10819560f003c5b94b8f5f2b7d33cf
>> Date: Sun Oct 17 08:29:51 2010 +0000
>>
>> LaTeX export: use org-export-latex-hyperref-format
>
> I have just reverted this commit.
>
> - Carsten
>
Looks like time to change the variable name which is actually confusing.
Since href and hyperref are two different things, I renamed the existing
`org-export-latex-hyperref-format' variable as
`org-export-latex-href-format' and introduced a new one
`org-export-latex-hyperref-format'.
* org-latex.el (org-export-latex-hyperref-format): New option.
(org-export-latex-href-format): Renamed the existing variable
`org-export-latex-hyperref-format' as `org-export-latex-href-format'
(org-export-latex-links): Use `org-export-latex-hyperref-format' and
`org-export-latex-href-format'
Thanks and Regards
Noorul
>>
>> * lisp/org-latex.el (org-export-latex-links) : Replaced hard coded
>> hyperref format with custom
>> variable `org-export-latex-hyperref-format'
>>
>> Note that href is not same as hyperref.
>>
>> Jambunthan K.
>>
>>
>>> All the best,
>>> Tom
>>>
>>> On Oct 28, 2010, at 3:30 PM, Jambunathan K wrote:
>>>
>>>>
>>>> Thomas
>>>>
>>>> There was a hint at possible solution (or atleast a partial
>>>> solution) in
>>>> my original post. Did you try it before jumping in to rough waters
>>>> or
>>>> digging deeper?
>>>>
>>>> Do
>>>>
>>>> ,----
>>>> | M-x customize-variable RET org-export-latex-hyperref-format'
>>>> `----
>>>>
>>>> so that your .emacs has an entry like this
>>>>
>>>> ,---- [.emacs]
>>>> |
>>>> | (custom-set-variables
>>>> | '(org-export-latex-hyperref-format "\\hyperref[%s]{%s}"))
>>>> |
>>>> `----
>>>>
>>>> The above setting solves the problem for me with the following
>>>> simple
>>>> Org file.
>>>>
>>>> * Heading1
>>>> Make this section as large as possible so that it fills atleast a
>>>> page.
>>>>
>>>> * Heading2
>>>> Links to [[Heading1]]
>>>>
>>>> Jambunathan K.
>>>>
>>>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>>>
>>>>> On Oct 28, 2010, at 12:35 PM, Nick Dokos wrote:
>>>>>
>>>>>> Thomas S. Dye <tsd@tsdye.com> wrote:
>>>>>>
>>>>>>> On Oct 28, 2010, at 11:01 AM, Jambunathan K wrote:
>>>>>>>
>>>>>>>
>>>>>>> This is a regression. release-7.01h is good. HEAD is bad. I get
>>>>>>> the
>>>>>>> following line with release-7.01h.<
>>>>>>>
>>>>>>> Links to \hyperref[sec-1]{Heading1}
>>>>>>>
>>>>>>> Jambunathan K.
>>>>>>>
>>>>>>> Aloha Jambunathan K.,
>>>>>>>
>>>>>>> Very many thanks for this information. I have Org-mode version
>>>>>>> 7.01trans
>>>>>>> (release_7.01h.880.g7531f). I take it the problem I'm having is
>>>>>>> due to a relatively recent change
>>>>>>> to Org-mode. If there is anything I can do to help isolate the
>>>>>>> problem, please let me know.
>>>>>>>
>>>>>>
>>>>>> Tom,
>>>>>>
>>>>>> If you have the time and the inclination, you might try bisecting
>>>>>> your
>>>>>> way through. Bisecting org-mode problems is actually a very good
>>>>>> way
>>>>>> to
>>>>>> practice because the turnaround time is very small.
>>>>>>
>>>>>> Prerequisites:
>>>>>>
>>>>>> * you have a clone of the org-mode git repository.
>>>>>>
>>>>>> * you have an org test file.
>>>>>>
>>>>>>
>>>>>> Steps:
>>>>>>
>>>>>> * [optional, but it makes me feel a little safer] create a test
>>>>>> branch
>>>>>> and switch to it:
>>>>>>
>>>>>> git checkout -b test-branch master
>>>>>>
>>>>>> * I clean out all the compiled files while doing a bisection: it's
>>>>>> quicker
>>>>>> than regenerating them every time and I don't have to worry (much)
>>>>>> about
>>>>>> emacs loading a wayward .elc file:
>>>>>>
>>>>>> make clean
>>>>>>
>>>>>> * start the bisection and tell git which commit is known good and
>>>>>> which is known bad:
>>>>>>
>>>>>> git bisect start
>>>>>>
>>>>>> # current version is bad
>>>>>> git bisect bad
>>>>>>
>>>>>> # release_7.01h was good - I got the name with ``git tag''
>>>>>> git bisect good release_7.01h
>>>>>>
>>>>>> That checks out a revision half-way in between the bad and good
>>>>>> commits: since
>>>>>> there are about 900 commits in between, you'll be at approx the
>>>>>> 450-
>>>>>> mark and it
>>>>>> should take about 10 bisections to get it down to a single commit.
>>>>>>
>>>>>> * LOOP Now all you have to do is repeat the following steps:
>>>>>>
>>>>>> # since you did ``make clean'' you don't have to worry about .elc
>>>>>> files
>>>>>> # just reload all the .el files.
>>>>>> M-x org-reload
>>>>>>
>>>>>> visit your org test file, export to LaTeX, check for \href/
>>>>>> \hyperref (or
>>>>>> whatever other telltale sign shows badness/goodness).
>>>>>>
>>>>>> # tell git about it
>>>>>> git bisect good *OR* git bisect bad
>>>>>>
>>>>>> This last step will check out another revision and in about 10
>>>>>> repetitions
>>>>>> of the loop, you are done.
>>>>>>
>>>>>> * Tell git you are done, so it can clean up:
>>>>>>
>>>>>> git bisect reset
>>>>>>
>>>>>> Theoretically, you could do all of this in your master branch
>>>>>> without
>>>>>> creating a test-branch and this last step will reset everything to
>>>>>> the
>>>>>> way it was before ``git start''.
>>>>>>
>>>>>> * Post the offending commit to the list.
>>>>>>
>>>>>> * Get back to your master branch:
>>>>>>
>>>>>> git checkout master
>>>>>>
>>>>>> * If you created a test-branch, clean it out:
>>>>>>
>>>>>> git branch -d test-branch
>>>>>>
>>>>>> * [Optional] Recreate your .elc files and reload them:
>>>>>>
>>>>>> make
>>>>>> M-x org-reload
>>>>>>
>>>>>>
>>>>>> And that's it: a half-hour of fun and games. Unless of course, you
>>>>>> hit upon a revision that is neither good nor bad (in the above
>>>>>> restricted
>>>>>> sense): you might get some other problem that prevents you from
>>>>>> being
>>>>>> able to answer. That might or might not be easy to resolve, so
>>>>>> I'll
>>>>>> leave that as an advanced topic (truth be told, I came up against
>>>>>> this
>>>>>> situation a couple of days ago and I didn't know how to proceed:
>>>>>> so
>>>>>> it's ignorance more than anything else that prevents me from
>>>>>> saying
>>>>>> anything more).
>>>>>>
>>>>>> If you want to try, I'd be happy to answer questions - I might try
>>>>>> the
>>>>>> bisection later on tonight myself in any case. And btw, this is of
>>>>>> course archeology of a different (and much easier) kind, so I
>>>>>> imagine
>>>>>> you'll take to it like a fish in water :-)
>>>>>>
>>>>>> HTH,
>>>>>> Nick
>>>>>
>>>>> Hi Nick,
>>>>>
>>>>> Irresistible hook at the end there. I wish this stuff were as easy
>>>>> as
>>>>> archaeology is for me. Your instructions are terrific, though.
>>>>>
>>>>> I did hit on a revision that was neither good nor bad:
>>>>>
>>>>> commit 8562273b272024a630a582b0e1b94c481d8abeec
>>>>> Author: Eric Schulte <schulte.eric@gmail.com>
>>>>> Date: Sat Oct 16 13:21:47 2010 -0600
>>>>>
>>>>> ob-ref: don't forget arguments to referenced code blocks
>>>>>
>>>>> * lisp/ob-ref.el (org-babel-ref-resolve): bringing the referent
>>>>> arguments back to their params before evaluation
>>>>>
>>>>> This one puts these lines in *Messages* when I export to LaTeX
>>>>>
>>>>> executing Org code block...
>>>>> if: Symbol's value as variable is void: result-type
>>>>>
>>>>> I tried using different commits for the initial git bisect good,
>>>>> hoping that would skip by the problem, but this one appears to have
>>>>> stuck around a while. My other two tries both ended with this same
>>>>> error, but with different commits.
>>>>>
>>>>> I'm not sure what to do next. This problem isn't yielding to my
>>>>> archaeo-logic. :)
>>>>>
>>>>> All the best,
>>>>> Tom
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
2010-10-29 06:01:12 -04:00
|
|
|
(radiop (insert (format org-export-latex-hyperref-format
|
2008-10-10 02:46:05 -04:00
|
|
|
(org-solidify-link-text raw-path) desc)))
|
2008-10-10 05:42:01 -04:00
|
|
|
((not type)
|
Internal links in LaTeX export
Carsten Dominik <carsten.dominik@gmail.com> writes:
> On Oct 29, 2010, at 5:22 AM, Jambunathan K wrote:
>
>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>
>>> Aloha Jambunathan K.,
>>>
>>> Yes, thanks for that suggestion. It should work on your example, but
>>> it breaks external links, like this:
>>>
>>> \hyperref[http://www.ctan.org/tex-archive/macros/latex/contrib/koma-script/
>>> ]{KOMA-script}
>>>
>>> External links require the \href{}{} command. It appears the LaTeX
>>> export process no longer distinguishes internal and external links,
>>> as
>>> I believe it used to do.
>>>
>>
>> This is the problematic commit:
>>
>> commit f5918bdcc05d7924dc204b57307023eb1ef011f0
>> parent df5894cdcb10819560f003c5b94b8f5f2b7d33cf
>> Date: Sun Oct 17 08:29:51 2010 +0000
>>
>> LaTeX export: use org-export-latex-hyperref-format
>
> I have just reverted this commit.
>
> - Carsten
>
Looks like time to change the variable name which is actually confusing.
Since href and hyperref are two different things, I renamed the existing
`org-export-latex-hyperref-format' variable as
`org-export-latex-href-format' and introduced a new one
`org-export-latex-hyperref-format'.
* org-latex.el (org-export-latex-hyperref-format): New option.
(org-export-latex-href-format): Renamed the existing variable
`org-export-latex-hyperref-format' as `org-export-latex-href-format'
(org-export-latex-links): Use `org-export-latex-hyperref-format' and
`org-export-latex-href-format'
Thanks and Regards
Noorul
>>
>> * lisp/org-latex.el (org-export-latex-links) : Replaced hard coded
>> hyperref format with custom
>> variable `org-export-latex-hyperref-format'
>>
>> Note that href is not same as hyperref.
>>
>> Jambunthan K.
>>
>>
>>> All the best,
>>> Tom
>>>
>>> On Oct 28, 2010, at 3:30 PM, Jambunathan K wrote:
>>>
>>>>
>>>> Thomas
>>>>
>>>> There was a hint at possible solution (or atleast a partial
>>>> solution) in
>>>> my original post. Did you try it before jumping in to rough waters
>>>> or
>>>> digging deeper?
>>>>
>>>> Do
>>>>
>>>> ,----
>>>> | M-x customize-variable RET org-export-latex-hyperref-format'
>>>> `----
>>>>
>>>> so that your .emacs has an entry like this
>>>>
>>>> ,---- [.emacs]
>>>> |
>>>> | (custom-set-variables
>>>> | '(org-export-latex-hyperref-format "\\hyperref[%s]{%s}"))
>>>> |
>>>> `----
>>>>
>>>> The above setting solves the problem for me with the following
>>>> simple
>>>> Org file.
>>>>
>>>> * Heading1
>>>> Make this section as large as possible so that it fills atleast a
>>>> page.
>>>>
>>>> * Heading2
>>>> Links to [[Heading1]]
>>>>
>>>> Jambunathan K.
>>>>
>>>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>>>
>>>>> On Oct 28, 2010, at 12:35 PM, Nick Dokos wrote:
>>>>>
>>>>>> Thomas S. Dye <tsd@tsdye.com> wrote:
>>>>>>
>>>>>>> On Oct 28, 2010, at 11:01 AM, Jambunathan K wrote:
>>>>>>>
>>>>>>>
>>>>>>> This is a regression. release-7.01h is good. HEAD is bad. I get
>>>>>>> the
>>>>>>> following line with release-7.01h.<
>>>>>>>
>>>>>>> Links to \hyperref[sec-1]{Heading1}
>>>>>>>
>>>>>>> Jambunathan K.
>>>>>>>
>>>>>>> Aloha Jambunathan K.,
>>>>>>>
>>>>>>> Very many thanks for this information. I have Org-mode version
>>>>>>> 7.01trans
>>>>>>> (release_7.01h.880.g7531f). I take it the problem I'm having is
>>>>>>> due to a relatively recent change
>>>>>>> to Org-mode. If there is anything I can do to help isolate the
>>>>>>> problem, please let me know.
>>>>>>>
>>>>>>
>>>>>> Tom,
>>>>>>
>>>>>> If you have the time and the inclination, you might try bisecting
>>>>>> your
>>>>>> way through. Bisecting org-mode problems is actually a very good
>>>>>> way
>>>>>> to
>>>>>> practice because the turnaround time is very small.
>>>>>>
>>>>>> Prerequisites:
>>>>>>
>>>>>> * you have a clone of the org-mode git repository.
>>>>>>
>>>>>> * you have an org test file.
>>>>>>
>>>>>>
>>>>>> Steps:
>>>>>>
>>>>>> * [optional, but it makes me feel a little safer] create a test
>>>>>> branch
>>>>>> and switch to it:
>>>>>>
>>>>>> git checkout -b test-branch master
>>>>>>
>>>>>> * I clean out all the compiled files while doing a bisection: it's
>>>>>> quicker
>>>>>> than regenerating them every time and I don't have to worry (much)
>>>>>> about
>>>>>> emacs loading a wayward .elc file:
>>>>>>
>>>>>> make clean
>>>>>>
>>>>>> * start the bisection and tell git which commit is known good and
>>>>>> which is known bad:
>>>>>>
>>>>>> git bisect start
>>>>>>
>>>>>> # current version is bad
>>>>>> git bisect bad
>>>>>>
>>>>>> # release_7.01h was good - I got the name with ``git tag''
>>>>>> git bisect good release_7.01h
>>>>>>
>>>>>> That checks out a revision half-way in between the bad and good
>>>>>> commits: since
>>>>>> there are about 900 commits in between, you'll be at approx the
>>>>>> 450-
>>>>>> mark and it
>>>>>> should take about 10 bisections to get it down to a single commit.
>>>>>>
>>>>>> * LOOP Now all you have to do is repeat the following steps:
>>>>>>
>>>>>> # since you did ``make clean'' you don't have to worry about .elc
>>>>>> files
>>>>>> # just reload all the .el files.
>>>>>> M-x org-reload
>>>>>>
>>>>>> visit your org test file, export to LaTeX, check for \href/
>>>>>> \hyperref (or
>>>>>> whatever other telltale sign shows badness/goodness).
>>>>>>
>>>>>> # tell git about it
>>>>>> git bisect good *OR* git bisect bad
>>>>>>
>>>>>> This last step will check out another revision and in about 10
>>>>>> repetitions
>>>>>> of the loop, you are done.
>>>>>>
>>>>>> * Tell git you are done, so it can clean up:
>>>>>>
>>>>>> git bisect reset
>>>>>>
>>>>>> Theoretically, you could do all of this in your master branch
>>>>>> without
>>>>>> creating a test-branch and this last step will reset everything to
>>>>>> the
>>>>>> way it was before ``git start''.
>>>>>>
>>>>>> * Post the offending commit to the list.
>>>>>>
>>>>>> * Get back to your master branch:
>>>>>>
>>>>>> git checkout master
>>>>>>
>>>>>> * If you created a test-branch, clean it out:
>>>>>>
>>>>>> git branch -d test-branch
>>>>>>
>>>>>> * [Optional] Recreate your .elc files and reload them:
>>>>>>
>>>>>> make
>>>>>> M-x org-reload
>>>>>>
>>>>>>
>>>>>> And that's it: a half-hour of fun and games. Unless of course, you
>>>>>> hit upon a revision that is neither good nor bad (in the above
>>>>>> restricted
>>>>>> sense): you might get some other problem that prevents you from
>>>>>> being
>>>>>> able to answer. That might or might not be easy to resolve, so
>>>>>> I'll
>>>>>> leave that as an advanced topic (truth be told, I came up against
>>>>>> this
>>>>>> situation a couple of days ago and I didn't know how to proceed:
>>>>>> so
>>>>>> it's ignorance more than anything else that prevents me from
>>>>>> saying
>>>>>> anything more).
>>>>>>
>>>>>> If you want to try, I'd be happy to answer questions - I might try
>>>>>> the
>>>>>> bisection later on tonight myself in any case. And btw, this is of
>>>>>> course archeology of a different (and much easier) kind, so I
>>>>>> imagine
>>>>>> you'll take to it like a fish in water :-)
>>>>>>
>>>>>> HTH,
>>>>>> Nick
>>>>>
>>>>> Hi Nick,
>>>>>
>>>>> Irresistible hook at the end there. I wish this stuff were as easy
>>>>> as
>>>>> archaeology is for me. Your instructions are terrific, though.
>>>>>
>>>>> I did hit on a revision that was neither good nor bad:
>>>>>
>>>>> commit 8562273b272024a630a582b0e1b94c481d8abeec
>>>>> Author: Eric Schulte <schulte.eric@gmail.com>
>>>>> Date: Sat Oct 16 13:21:47 2010 -0600
>>>>>
>>>>> ob-ref: don't forget arguments to referenced code blocks
>>>>>
>>>>> * lisp/ob-ref.el (org-babel-ref-resolve): bringing the referent
>>>>> arguments back to their params before evaluation
>>>>>
>>>>> This one puts these lines in *Messages* when I export to LaTeX
>>>>>
>>>>> executing Org code block...
>>>>> if: Symbol's value as variable is void: result-type
>>>>>
>>>>> I tried using different commits for the initial git bisect good,
>>>>> hoping that would skip by the problem, but this one appears to have
>>>>> stuck around a while. My other two tries both ended with this same
>>>>> error, but with different commits.
>>>>>
>>>>> I'm not sure what to do next. This problem isn't yielding to my
>>>>> archaeo-logic. :)
>>>>>
>>>>> All the best,
>>>>> Tom
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
2010-10-29 06:01:12 -04:00
|
|
|
(insert (format org-export-latex-hyperref-format
|
2009-07-02 03:54:33 -04:00
|
|
|
(org-remove-initial-hash
|
2009-08-31 08:27:28 -04:00
|
|
|
(org-solidify-link-text raw-path))
|
2009-08-31 15:21:03 -04:00
|
|
|
desc)))
|
2010-04-01 07:11:54 -04:00
|
|
|
(path
|
2009-08-31 08:27:28 -04:00
|
|
|
(when (org-at-table-p)
|
|
|
|
;; There is a strange problem when we have a link in a table,
|
|
|
|
;; ampersands then cause a problem. I think this must be
|
|
|
|
;; a LaTeX issue, but we here implement a work-around anyway.
|
|
|
|
(setq path (org-export-latex-protect-amp path)
|
|
|
|
desc (org-export-latex-protect-amp desc)))
|
Internal links in LaTeX export
Carsten Dominik <carsten.dominik@gmail.com> writes:
> On Oct 29, 2010, at 5:22 AM, Jambunathan K wrote:
>
>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>
>>> Aloha Jambunathan K.,
>>>
>>> Yes, thanks for that suggestion. It should work on your example, but
>>> it breaks external links, like this:
>>>
>>> \hyperref[http://www.ctan.org/tex-archive/macros/latex/contrib/koma-script/
>>> ]{KOMA-script}
>>>
>>> External links require the \href{}{} command. It appears the LaTeX
>>> export process no longer distinguishes internal and external links,
>>> as
>>> I believe it used to do.
>>>
>>
>> This is the problematic commit:
>>
>> commit f5918bdcc05d7924dc204b57307023eb1ef011f0
>> parent df5894cdcb10819560f003c5b94b8f5f2b7d33cf
>> Date: Sun Oct 17 08:29:51 2010 +0000
>>
>> LaTeX export: use org-export-latex-hyperref-format
>
> I have just reverted this commit.
>
> - Carsten
>
Looks like time to change the variable name which is actually confusing.
Since href and hyperref are two different things, I renamed the existing
`org-export-latex-hyperref-format' variable as
`org-export-latex-href-format' and introduced a new one
`org-export-latex-hyperref-format'.
* org-latex.el (org-export-latex-hyperref-format): New option.
(org-export-latex-href-format): Renamed the existing variable
`org-export-latex-hyperref-format' as `org-export-latex-href-format'
(org-export-latex-links): Use `org-export-latex-hyperref-format' and
`org-export-latex-href-format'
Thanks and Regards
Noorul
>>
>> * lisp/org-latex.el (org-export-latex-links) : Replaced hard coded
>> hyperref format with custom
>> variable `org-export-latex-hyperref-format'
>>
>> Note that href is not same as hyperref.
>>
>> Jambunthan K.
>>
>>
>>> All the best,
>>> Tom
>>>
>>> On Oct 28, 2010, at 3:30 PM, Jambunathan K wrote:
>>>
>>>>
>>>> Thomas
>>>>
>>>> There was a hint at possible solution (or atleast a partial
>>>> solution) in
>>>> my original post. Did you try it before jumping in to rough waters
>>>> or
>>>> digging deeper?
>>>>
>>>> Do
>>>>
>>>> ,----
>>>> | M-x customize-variable RET org-export-latex-hyperref-format'
>>>> `----
>>>>
>>>> so that your .emacs has an entry like this
>>>>
>>>> ,---- [.emacs]
>>>> |
>>>> | (custom-set-variables
>>>> | '(org-export-latex-hyperref-format "\\hyperref[%s]{%s}"))
>>>> |
>>>> `----
>>>>
>>>> The above setting solves the problem for me with the following
>>>> simple
>>>> Org file.
>>>>
>>>> * Heading1
>>>> Make this section as large as possible so that it fills atleast a
>>>> page.
>>>>
>>>> * Heading2
>>>> Links to [[Heading1]]
>>>>
>>>> Jambunathan K.
>>>>
>>>> "Thomas S. Dye" <tsd@tsdye.com> writes:
>>>>
>>>>> On Oct 28, 2010, at 12:35 PM, Nick Dokos wrote:
>>>>>
>>>>>> Thomas S. Dye <tsd@tsdye.com> wrote:
>>>>>>
>>>>>>> On Oct 28, 2010, at 11:01 AM, Jambunathan K wrote:
>>>>>>>
>>>>>>>
>>>>>>> This is a regression. release-7.01h is good. HEAD is bad. I get
>>>>>>> the
>>>>>>> following line with release-7.01h.<
>>>>>>>
>>>>>>> Links to \hyperref[sec-1]{Heading1}
>>>>>>>
>>>>>>> Jambunathan K.
>>>>>>>
>>>>>>> Aloha Jambunathan K.,
>>>>>>>
>>>>>>> Very many thanks for this information. I have Org-mode version
>>>>>>> 7.01trans
>>>>>>> (release_7.01h.880.g7531f). I take it the problem I'm having is
>>>>>>> due to a relatively recent change
>>>>>>> to Org-mode. If there is anything I can do to help isolate the
>>>>>>> problem, please let me know.
>>>>>>>
>>>>>>
>>>>>> Tom,
>>>>>>
>>>>>> If you have the time and the inclination, you might try bisecting
>>>>>> your
>>>>>> way through. Bisecting org-mode problems is actually a very good
>>>>>> way
>>>>>> to
>>>>>> practice because the turnaround time is very small.
>>>>>>
>>>>>> Prerequisites:
>>>>>>
>>>>>> * you have a clone of the org-mode git repository.
>>>>>>
>>>>>> * you have an org test file.
>>>>>>
>>>>>>
>>>>>> Steps:
>>>>>>
>>>>>> * [optional, but it makes me feel a little safer] create a test
>>>>>> branch
>>>>>> and switch to it:
>>>>>>
>>>>>> git checkout -b test-branch master
>>>>>>
>>>>>> * I clean out all the compiled files while doing a bisection: it's
>>>>>> quicker
>>>>>> than regenerating them every time and I don't have to worry (much)
>>>>>> about
>>>>>> emacs loading a wayward .elc file:
>>>>>>
>>>>>> make clean
>>>>>>
>>>>>> * start the bisection and tell git which commit is known good and
>>>>>> which is known bad:
>>>>>>
>>>>>> git bisect start
>>>>>>
>>>>>> # current version is bad
>>>>>> git bisect bad
>>>>>>
>>>>>> # release_7.01h was good - I got the name with ``git tag''
>>>>>> git bisect good release_7.01h
>>>>>>
>>>>>> That checks out a revision half-way in between the bad and good
>>>>>> commits: since
>>>>>> there are about 900 commits in between, you'll be at approx the
>>>>>> 450-
>>>>>> mark and it
>>>>>> should take about 10 bisections to get it down to a single commit.
>>>>>>
>>>>>> * LOOP Now all you have to do is repeat the following steps:
>>>>>>
>>>>>> # since you did ``make clean'' you don't have to worry about .elc
>>>>>> files
>>>>>> # just reload all the .el files.
>>>>>> M-x org-reload
>>>>>>
>>>>>> visit your org test file, export to LaTeX, check for \href/
>>>>>> \hyperref (or
>>>>>> whatever other telltale sign shows badness/goodness).
>>>>>>
>>>>>> # tell git about it
>>>>>> git bisect good *OR* git bisect bad
>>>>>>
>>>>>> This last step will check out another revision and in about 10
>>>>>> repetitions
>>>>>> of the loop, you are done.
>>>>>>
>>>>>> * Tell git you are done, so it can clean up:
>>>>>>
>>>>>> git bisect reset
>>>>>>
>>>>>> Theoretically, you could do all of this in your master branch
>>>>>> without
>>>>>> creating a test-branch and this last step will reset everything to
>>>>>> the
>>>>>> way it was before ``git start''.
>>>>>>
>>>>>> * Post the offending commit to the list.
>>>>>>
>>>>>> * Get back to your master branch:
>>>>>>
>>>>>> git checkout master
>>>>>>
>>>>>> * If you created a test-branch, clean it out:
>>>>>>
>>>>>> git branch -d test-branch
>>>>>>
>>>>>> * [Optional] Recreate your .elc files and reload them:
>>>>>>
>>>>>> make
>>>>>> M-x org-reload
>>>>>>
>>>>>>
>>>>>> And that's it: a half-hour of fun and games. Unless of course, you
>>>>>> hit upon a revision that is neither good nor bad (in the above
>>>>>> restricted
>>>>>> sense): you might get some other problem that prevents you from
>>>>>> being
>>>>>> able to answer. That might or might not be easy to resolve, so
>>>>>> I'll
>>>>>> leave that as an advanced topic (truth be told, I came up against
>>>>>> this
>>>>>> situation a couple of days ago and I didn't know how to proceed:
>>>>>> so
>>>>>> it's ignorance more than anything else that prevents me from
>>>>>> saying
>>>>>> anything more).
>>>>>>
>>>>>> If you want to try, I'd be happy to answer questions - I might try
>>>>>> the
>>>>>> bisection later on tonight myself in any case. And btw, this is of
>>>>>> course archeology of a different (and much easier) kind, so I
>>>>>> imagine
>>>>>> you'll take to it like a fish in water :-)
>>>>>>
>>>>>> HTH,
>>>>>> Nick
>>>>>
>>>>> Hi Nick,
>>>>>
>>>>> Irresistible hook at the end there. I wish this stuff were as easy
>>>>> as
>>>>> archaeology is for me. Your instructions are terrific, though.
>>>>>
>>>>> I did hit on a revision that was neither good nor bad:
>>>>>
>>>>> commit 8562273b272024a630a582b0e1b94c481d8abeec
>>>>> Author: Eric Schulte <schulte.eric@gmail.com>
>>>>> Date: Sat Oct 16 13:21:47 2010 -0600
>>>>>
>>>>> ob-ref: don't forget arguments to referenced code blocks
>>>>>
>>>>> * lisp/ob-ref.el (org-babel-ref-resolve): bringing the referent
>>>>> arguments back to their params before evaluation
>>>>>
>>>>> This one puts these lines in *Messages* when I export to LaTeX
>>>>>
>>>>> executing Org code block...
>>>>> if: Symbol's value as variable is void: result-type
>>>>>
>>>>> I tried using different commits for the initial git bisect good,
>>>>> hoping that would skip by the problem, but this one appears to have
>>>>> stuck around a while. My other two tries both ended with this same
>>>>> error, but with different commits.
>>>>>
>>>>> I'm not sure what to do next. This problem isn't yielding to my
>>>>> archaeo-logic. :)
>>>>>
>>>>> All the best,
>>>>> Tom
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
2010-10-29 06:01:12 -04:00
|
|
|
(insert (format org-export-latex-href-format path desc)))
|
2010-05-12 09:14:17 -04:00
|
|
|
|
|
|
|
((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
|
|
|
|
;; The link protocol has a function for formatting the link
|
|
|
|
(insert
|
|
|
|
(save-match-data
|
|
|
|
(funcall fnc (org-link-unescape raw-path) desc 'latex))))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(t (insert "\\texttt{" desc "}")))))))
|
|
|
|
|
2009-10-02 04:28:56 -04:00
|
|
|
|
2010-07-05 12:56:20 -04:00
|
|
|
(defun org-export-latex-format-image (path caption label attr &optional shortn)
|
2009-10-02 04:28:56 -04:00
|
|
|
"Format the image element, depending on user settings."
|
2010-05-15 08:26:38 -04:00
|
|
|
(let (ind floatp wrapp multicolumnp placement figenv)
|
2009-10-02 04:28:56 -04:00
|
|
|
(setq floatp (or caption label))
|
2009-11-24 14:41:53 -05:00
|
|
|
(setq ind (org-get-text-property-any 0 'original-indentation path))
|
2009-10-02 04:28:56 -04:00
|
|
|
(when (and attr (stringp attr))
|
|
|
|
(if (string-match "[ \t]*\\<wrap\\>" attr)
|
|
|
|
(setq wrapp t floatp nil attr (replace-match "" t t attr)))
|
|
|
|
(if (string-match "[ \t]*\\<float\\>" attr)
|
2010-05-15 08:26:38 -04:00
|
|
|
(setq wrapp nil floatp t attr (replace-match "" t t attr)))
|
|
|
|
(if (string-match "[ \t]*\\<multicolumn\\>" attr)
|
|
|
|
(setq multicolumnp t attr (replace-match "" t t attr))))
|
2010-06-07 02:35:10 -04:00
|
|
|
|
2009-10-02 04:28:56 -04:00
|
|
|
(setq placement
|
|
|
|
(cond
|
|
|
|
(wrapp "{l}{0.5\\textwidth}")
|
2011-01-28 10:59:47 -05:00
|
|
|
(floatp (concat "[" org-latex-default-figure-position "]"))
|
2009-10-02 04:28:56 -04:00
|
|
|
(t "")))
|
|
|
|
|
|
|
|
(when (and attr (stringp attr)
|
|
|
|
(string-match "[ \t]*\\<placement=\\(\\S-+\\)" attr))
|
|
|
|
(setq placement (match-string 1 attr)
|
|
|
|
attr (replace-match "" t t attr)))
|
|
|
|
(setq attr (and attr (org-trim attr)))
|
|
|
|
(when (or (not attr) (= (length attr) 0))
|
|
|
|
(setq attr (cond (floatp "width=0.7\\textwidth")
|
|
|
|
(wrapp "width=0.48\\textwidth")
|
|
|
|
(t attr))))
|
|
|
|
(setq figenv
|
|
|
|
(cond
|
|
|
|
(wrapp "\\begin{wrapfigure}%placement
|
|
|
|
\\centering
|
|
|
|
\\includegraphics[%attr]{%path}
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
\\caption%shortn{%labelcmd%caption}
|
2009-10-02 04:28:56 -04:00
|
|
|
\\end{wrapfigure}")
|
2010-05-15 08:26:38 -04:00
|
|
|
(multicolumnp "\\begin{figure*}%placement
|
|
|
|
\\centering
|
|
|
|
\\includegraphics[%attr]{%path}
|
|
|
|
\\caption{%labelcmd%caption}
|
|
|
|
\\end{figure*}")
|
2009-10-02 04:28:56 -04:00
|
|
|
(floatp "\\begin{figure}%placement
|
|
|
|
\\centering
|
|
|
|
\\includegraphics[%attr]{%path}
|
|
|
|
\\caption{%labelcmd%caption}
|
|
|
|
\\end{figure}")
|
|
|
|
(t "\\includegraphics[%attr]{%path}")))
|
|
|
|
|
2009-11-22 17:51:45 -05:00
|
|
|
|
|
|
|
(setq figenv (mapconcat 'identity (split-string figenv "\n")
|
|
|
|
(save-excursion (beginning-of-line 1)
|
|
|
|
(looking-at "[ \t]*")
|
|
|
|
(concat "\n" (match-string 0)))))
|
|
|
|
|
2009-10-02 04:28:56 -04:00
|
|
|
(if (and (not label) (not caption)
|
|
|
|
(string-match "^\\\\caption{.*\n" figenv))
|
|
|
|
(setq figenv (replace-match "" t t figenv)))
|
2009-11-24 14:41:53 -05:00
|
|
|
(org-add-props
|
|
|
|
(org-fill-template
|
|
|
|
figenv
|
|
|
|
(list (cons "path"
|
|
|
|
(if (file-name-absolute-p path)
|
|
|
|
(expand-file-name path)
|
|
|
|
path))
|
|
|
|
(cons "attr" attr)
|
a better way with babel
Of course, an updated patch is attached.
Best -- Eric
Carsten Dominik <carsten.dominik@gmail.com> writes:
> Hi Eric,
>
> I tried to apply the patch, but it does not apply cleanly, maybe due
> to other changes. Can I ask you to update and resubmit?
>
> Thanks!
>
> - Carsten
>
> On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote:
>
>> Hi Robert,
>>
>> Thanks for the thoughtful message.
>>
>> I present a couple of solutions below.
>>
>> Robert Cunningham <robut@iinet.net.au> writes:
>>
>>> G'day All,
>>>
>>> I wonder if I've missed something and there is a better way.
>>>
>>> Essentially I'm trying to use org babel with R and LaTeX to create
>>> figures
>>> with both long and short captions (for contents)
>>>
>>> I'd started with:
>>>
>>> #+CAPTION: Nice data (filled points indicate less nice data)
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>> which pointed to the need for long/short captions...
>>>
>>> feeling hopeful I tried:
>>>
>>> #+CAPTION: Nice data [Nice data (filled points indicate less nice
>>> data)]
>>> #+LABEL: fig:nicedata
>>> #+ATTR_LaTeX: width=0.98\textwidth
>>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>
>> I'm attaching a patch [1] which adds shortname support for captions.
>> Once
>> applied, the following syntax will result in a caption with a
>> shortname
>> and a longname.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :exports results
>> plot sin(x)
>> #+end_src
>>
>> #+Caption: [nice data]{a longer description of the niceness of the
>> data}
>> #+results: g-nicedata
>> [[file:graph.png]]
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> however, while this patch is still pending there is an Org-babel
>> solution below which should work immediately.
>>
>>>
>>>
>>> but no luck there.
>>>
>>> Next effort was to try to use R and LaTex more directly with
>>> noweb. I tried
>>> this:
>>>
>>>
>>>
>>> #+srcname: r-nicedata
>>> #+begin_src R :session :file ndata.pdf :results output :exports
>>> results
>>> dotchart(data$ndata)
>>> #+end_src
>>>
>>>
>>> #+begin_src latex :noweb yes
>>> \begin{figure}[htb!]
>>> \centering
>>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>}
>>> \caption[Nice data]{Nice data (filled points indicate less nice
>>> data)}
>>> \label{fig:nicedata}
>>> \end{figure}
>>> #+end_src
>>>
>>>
>>>
>>> This does produce the figure and long/short contents BUT ALSO
>>> produces this:
>>>
>>> #+results: r-nicedata
>>> [[file:ndata.pdf]]
>>>
>>> which upon export results in a link and consequently the plot
>>> appearing both
>>> in the figure and elsewhere. This second plot is unwelcome.
>>>
>>> I've tried assorted :results and :output options but have not found
>>> how to
>>> suppress the #+results: but still obtain the figure. I've always used
>>> the :session option.
>>>
>>> I've also tried twigging an org-export option to suppress pdf
>>> export but the
>>> link is still exported so that is not a solution.
>>>
>>> The current "working" solution is to use the noweb approach and
>>> then use sed
>>> to clean out the links to the second image-ugly to say the least!
>>>
>>
>> You were very close with the noweb approach. The following
>> combination
>> should work -- notice the ":results silent" header argument to the
>> source block.
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>> #+source: g-nicedata
>> #+begin_src gnuplot :file graph.png :results silent :exports none
>> plot sin(x)
>> #+end_src
>>
>> #+begin_src latex :noweb yes
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>> #+end_src
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> is exported to the following latex,
>>
>> --8<---------------cut here---------------start------------->8---
>> some pre-table text
>>
>>
>>
>> \begin{figure}[htb!]
>> \centering
>> \includegraphics[width=0.98\textwidth]{graph.png}
>> \caption[Nice data]{some nice data -- filled points indicate less
>> nice data}
>> \label{fig:nicedata}
>> \end{figure}
>>
>> some post-table text
>> --8<---------------cut here---------------end--------------->8---
>>
>> Hope this helps,
>>
>> Best -- Eric
>>
>>>
>>>
>>>
>>> All this with org version 6.36c
>>>
>>>
>>> What have I missed? What is the best way to do this?
>>>
>>>
>>> Cheers,
>>>
>>> Robert Cunningham
>>>
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> Footnotes:
>> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17
>> 00:00:00 2001
>> From: Eric Schulte <schulte.eric@gmail.com>
>> Date: Mon, 21 Jun 2010 09:02:37 -0700
>> Subject: [PATCH] add short-names to #+captions with support for
>> latex export
>>
>> captions specified with the following syntax
>> #+CAPTION: [shortname]{longname}
>> will have their short and longnames handled appropriately.
>>
>> Thanks to Robert Cunningham for suggesting this feature.
>>
>> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
>> a shortname attribute to caption strings under the symbol name
>> org-caption-shortn.
>>
>> * lisp/org-latex.el (org-export-latex-tables): handling caption short
>> names on table export
>>
>> (org-export-latex-convert-table.el-table): handling caption short
>> names on table.el type table export
>>
>> (org-export-latex-links): handling caption short names on link/image
>> export
>>
>> (org-export-latex-format-image): now takes an optional argument
>> specifying a caption short name
>> ---
>> lisp/org-exp.el | 14 +++++++++-----
>> lisp/org-latex.el | 21 ++++++++++++++-------
>> 2 files changed, 23 insertions(+), 12 deletions(-)
>>
>> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
>> index 029e4d7..466d7da 100644
>> --- a/lisp/org-exp.el
>> +++ b/lisp/org-exp.el
>> @@ -1256,7 +1256,7 @@ the current file."
>> (goto-char (point-min))
>> (while (re-search-forward org-bracket-link-regexp nil t)
>> (org-if-unprotected-at (1+ (match-beginning 0))
>> - (let* ((md (match-data))
>> + (let* ((md (match-data))
>> (desc (match-end 2))
>> (link (org-link-unescape (match-string 1)))
>> (slink (org-solidify-link-text link))
>> @@ -1381,8 +1381,8 @@ removed as well."
>> select-tags "\\|")
>> "\\):"))
>> (re-excl (concat ":\\(" (mapconcat 'regexp-quote
>> - exclude-tags "\\|")
>> - "\\):"))
>> + exclude-tags "\\|")
>> + "\\):"))
>> beg end cont)
>> (goto-char (point-min))
>> (when (and select-tags
>> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the
>> line containing the link."
>> "^[ \t]*\\(|[^-]\\)"
>> "\\|"
>> "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
>> - cap attr label end)
>> + cap shortn attr label end)
>> (while (re-search-forward re nil t)
>> (cond
>> ((match-end 1)
>> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))))
>> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
>> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
>> + (setq shortn (match-string 1 cap)
>> + cap (match-string 2 cap))))
>> ((match-end 2)
>> (setq attr (concat attr (if attr " " "") (org-trim
>> (match-string 2)))))
>> ((match-end 3)
>> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the
>> line containing the link."
>> (point-at-eol)))
>> (add-text-properties (point-at-bol) end
>> (list 'org-caption cap
>> + 'org-caption-shortn shortn
>> 'org-attributes attr
>> 'org-label label))
>> (if label (push (cons label label) target-alist))
>> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
>> index 01a4b05..6c2aab2 100644
>> --- a/lisp/org-latex.el
>> +++ b/lisp/org-latex.el
>> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (org-table-last-column-widths (copy-sequence
>> org-table-last-column-
>> widths))
>> fnum fields line lines olines gr colgropen line-fmt align
>> - caption label attr floatp longtblp)
>> + caption shortn label attr floatp longtblp)
>> (if org-export-latex-tables-verbatim
>> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
>> "\\end{verbatim}\n")))
>> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (progn
>> (setq caption (org-find-text-property-in-string
>> 'org-caption raw-table)
>> + shortn (org-find-text-property-in-string
>> + 'org-caption-shortn raw-table)
>> attr (org-find-text-property-in-string
>> 'org-attributes raw-table)
>> label (org-find-text-property-in-string
>> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (if floatp "\\begin{table}[htb]\n"))
>> (if floatp
>> (format
>> - "\\caption{%s%s}"
>> + "\\caption%s{%s%s}"
>> + (if shortn (concat "[" shortn "]") "")
>> (if label (concat "\\\label{" label
>> "}") "")
>> (or caption "")))
>> (if (and longtblp caption) "\\\\\n" "\n")
>> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>>
>> (defun org-export-latex-convert-table.el-table ()
>> "Replace table.el table at point with LaTeX code."
>> - (let (tbl caption label line floatp attr align rmlines)
>> + (let (tbl caption shortn label line floatp attr align rmlines)
>> (setq line (buffer-substring (point-at-bol) (point-at-eol))
>> label (org-get-text-property-any 0 'org-label line)
>> caption (org-get-text-property-any 0 'org-caption line)
>> + shortn (org-get-text-property-any 0 'org-caption-shortn line)
>> attr (org-get-text-property-any 0 'org-attributes line)
>> align (and attr (stringp attr)
>> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
>> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}")))
>> (when floatp
>> (setq tbl (concat "\\begin{table}\n"
>> - (format "\\caption{%s%s}\n"
>> + (format "\\caption%s{%s%s}\n"
>> + (if shortn (format "[%s]" shortn) "")
>> (if label (format "\\label{%s}" label) "")
>> (or caption ""))
>> tbl
>> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> "file")))
>> (coderefp (equal type "coderef"))
>> (caption (org-find-text-property-in-string 'org-caption
>> raw-
>> path))
>> + (shortn (org-find-text-property-in-string
>> org-caption-shortn raw-path))
>> (attr (or (org-find-text-property-in-string
>> org-attributes raw-
>> path)
>> (plist-get org-export-latex-options-plist
>> :latex-image-
>> options)))
>> (label (org-find-text-property-in-string 'org-label raw-path))
>> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (plist-get org-export-latex-options-plist :inline-images))
>> ;; OK, we need to inline an image
>> (insert
>> - (org-export-latex-format-image raw-path caption label attr)))
>> + (org-export-latex-format-image raw-path caption label
>> attr shortn)))
>> (coderefp
>> (insert (format
>> (org-export-get-coderef-format path desc)
>> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (t (insert "\\texttt{" desc "}")))))))
>>
>>
>> -(defun org-export-latex-format-image (path caption label attr)
>> +(defun org-export-latex-format-image (path caption label attr
>> &optional shortn)
>> "Format the image element, depending on user settings."
>> (let (ind floatp wrapp multicolumnp placement figenv)
>> (setq floatp (or caption label))
>> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (floatp "\\begin{figure}%placement
>> \\centering
>> \\includegraphics[%attr]{%path}
>> -\\caption{%labelcmd%caption}
>> +\\caption%shortn{%labelcmd%caption}
>> \\end{figure}")
>> (t "\\includegraphics[%attr]{%path}")))
>>
>> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING-
>> BEFORE and STRING-AFTER."
>> (expand-file-name path)
>> path))
>> (cons "attr" attr)
>> + (cons "shortn" (if shortn (format "[%s]" shortn) ""))
>> (cons "labelcmd" (if label (format "\\label{%s}"
>> label)""))
>> (cons "caption" (or caption ""))
>> --
>> 1.7.0.4
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten
>From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Thu, 1 Jul 2010 08:07:17 -0700
Subject: [PATCH] add short-names to #+captions with support for latex export
captions specified with the following syntax
#+CAPTION: [shortname]{longname}
will have their short and longnames handled appropriately.
Thanks to Robert Cunningham for suggesting this feature.
* lisp/org-exp.el (org-export-attach-captions-and-attributes): adding
a shortname attribute to caption strings under the symbol name
org-caption-shortn.
* lisp/org-latex.el (org-export-latex-tables): handling caption short
names on table export
(org-export-latex-convert-table.el-table): handling caption short
names on table.el type table export
(org-export-latex-links): handling caption short names on link/image
export
(org-export-latex-format-image): now takes an optional argument
specifying a caption short name
2010-07-01 16:19:14 -04:00
|
|
|
(cons "shortn" (if shortn (format "[%s]" shortn) ""))
|
2009-11-24 14:41:53 -05:00
|
|
|
(cons "labelcmd" (if label (format "\\label{%s}"
|
|
|
|
label)""))
|
|
|
|
(cons "caption" (or caption ""))
|
|
|
|
(cons "placement" (or placement ""))))
|
|
|
|
nil 'original-indentation ind)))
|
2009-10-02 04:28:56 -04:00
|
|
|
|
2009-08-31 08:27:28 -04:00
|
|
|
(defun org-export-latex-protect-amp (s)
|
|
|
|
(while (string-match "\\([^\\\\]\\)\\(&\\)" s)
|
|
|
|
(setq s (replace-match (concat (match-string 1 s) "\\" (match-string 2 s))
|
|
|
|
t t s)))
|
|
|
|
s)
|
|
|
|
|
2009-07-02 03:54:33 -04:00
|
|
|
(defun org-remove-initial-hash (s)
|
|
|
|
(if (string-match "\\`#" s)
|
|
|
|
(substring s 1)
|
|
|
|
s))
|
2008-01-31 05:37:51 -05:00
|
|
|
(defvar org-latex-entities) ; defined below
|
2008-10-21 11:54:04 -04:00
|
|
|
(defvar org-latex-entities-regexp) ; defined below
|
2008-01-31 05:37:51 -05:00
|
|
|
|
2009-03-08 01:55:17 -05:00
|
|
|
(defun org-export-latex-preprocess (parameters)
|
2008-01-31 05:35:58 -05:00
|
|
|
"Clean stuff in the LaTeX export."
|
2008-01-31 05:36:08 -05:00
|
|
|
;; Preserve line breaks
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "\\\\\\\\" nil t)
|
|
|
|
(add-text-properties (match-beginning 0) (match-end 0)
|
|
|
|
'(org-protected t)))
|
|
|
|
|
2008-09-19 15:48:47 -04:00
|
|
|
;; Preserve latex environments
|
|
|
|
(goto-char (point-min))
|
2009-04-29 15:36:28 -04:00
|
|
|
(while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
|
2010-06-13 11:21:59 -04:00
|
|
|
(org-if-unprotected
|
|
|
|
(let* ((start (progn (beginning-of-line) (point)))
|
2010-12-19 08:54:16 -05:00
|
|
|
(end (and (re-search-forward
|
|
|
|
(concat "^[ \t]*\\\\end{"
|
|
|
|
(regexp-quote (match-string 1))
|
|
|
|
"}") nil t)
|
|
|
|
(point-at-eol))))
|
|
|
|
(if end
|
|
|
|
(add-text-properties start end '(org-protected t))
|
|
|
|
(goto-char (point-at-eol))))))
|
2008-09-19 15:48:47 -04:00
|
|
|
|
2009-01-06 06:56:30 -05:00
|
|
|
;; Preserve math snippets
|
|
|
|
|
|
|
|
(let* ((matchers (plist-get org-format-latex-options :matchers))
|
|
|
|
(re-list org-latex-regexps)
|
|
|
|
beg end re e m n block off)
|
|
|
|
;; Check the different regular expressions
|
|
|
|
(while (setq e (pop re-list))
|
|
|
|
(setq m (car e) re (nth 1 e) n (nth 2 e)
|
|
|
|
block (if (nth 3 e) "\n\n" ""))
|
2009-01-08 15:36:01 -05:00
|
|
|
(setq off (if (member m '("$" "$1")) 1 0))
|
2009-01-06 06:56:30 -05:00
|
|
|
(when (and (member m matchers) (not (equal m "begin")))
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward re nil t)
|
2009-01-08 15:36:01 -05:00
|
|
|
(setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
|
2009-01-06 06:56:30 -05:00
|
|
|
(add-text-properties beg end '(org-protected t org-latex-math t))))))
|
|
|
|
|
2010-01-28 09:29:35 -05:00
|
|
|
;; Convert LaTeX to \LaTeX{} and TeX to \TeX{}
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
2009-01-26 03:42:33 -05:00
|
|
|
(let ((case-fold-search nil))
|
2010-01-28 09:29:35 -05:00
|
|
|
(while (re-search-forward "\\<\\(\\(La\\)?TeX\\)\\>" nil t)
|
|
|
|
(unless (eq (char-before (match-beginning 1)) ?\\)
|
|
|
|
(org-if-unprotected-1
|
|
|
|
(replace-match (org-export-latex-protect-string
|
|
|
|
(concat "\\" (match-string 1)
|
|
|
|
"{}")) t t)))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-05-05 20:06:09 -04:00
|
|
|
;; Convert blockquotes
|
|
|
|
(goto-char (point-min))
|
2008-09-05 10:36:07 -04:00
|
|
|
(while (search-forward "ORG-BLOCKQUOTE-START" nil t)
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties "\\begin{quote}" t t))
|
2008-05-05 20:06:09 -04:00
|
|
|
(goto-char (point-min))
|
2008-09-05 10:36:07 -04:00
|
|
|
(while (search-forward "ORG-BLOCKQUOTE-END" nil t)
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties "\\end{quote}" t t))
|
2008-05-05 20:06:09 -04:00
|
|
|
|
2008-05-13 09:57:23 -04:00
|
|
|
;; Convert verse
|
|
|
|
(goto-char (point-min))
|
2008-09-05 10:36:07 -04:00
|
|
|
(while (search-forward "ORG-VERSE-START" nil t)
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties "\\begin{verse}" t t)
|
2009-03-19 04:29:58 -04:00
|
|
|
(beginning-of-line 2)
|
|
|
|
(while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
|
|
|
|
(when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
|
|
|
|
(goto-char (match-end 1))
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties
|
2009-03-19 04:29:58 -04:00
|
|
|
(org-export-latex-protect-string
|
|
|
|
(concat "\\hspace*{1cm}" (match-string 2))) t t)
|
|
|
|
(beginning-of-line 1))
|
2009-09-28 15:08:34 -04:00
|
|
|
(if (looking-at "[ \t]*$")
|
2009-10-21 04:36:42 -04:00
|
|
|
(insert (org-export-latex-protect-string "\\vspace*{1em}"))
|
2009-09-28 15:08:34 -04:00
|
|
|
(unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
|
|
|
|
(end-of-line 1)
|
|
|
|
(insert "\\\\")))
|
2009-03-19 04:29:58 -04:00
|
|
|
(beginning-of-line 2))
|
|
|
|
(and (looking-at "[ \t]*ORG-VERSE-END.*")
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties "\\end{verse}" t t)))
|
2008-05-13 09:57:23 -04:00
|
|
|
|
2009-03-16 17:14:15 -04:00
|
|
|
;; Convert center
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (search-forward "ORG-CENTER-START" nil t)
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties "\\begin{center}" t t))
|
2009-03-16 17:14:15 -04:00
|
|
|
(goto-char (point-min))
|
|
|
|
(while (search-forward "ORG-CENTER-END" nil t)
|
2009-06-07 10:11:14 -04:00
|
|
|
(org-replace-match-keep-properties "\\end{center}" t t))
|
2009-03-16 17:14:15 -04:00
|
|
|
|
2009-05-02 02:02:17 -04:00
|
|
|
(run-hooks 'org-export-latex-after-blockquotes-hook)
|
|
|
|
|
2008-01-31 05:36:08 -05:00
|
|
|
;; Convert horizontal rules
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
2011-02-10 11:03:31 -05:00
|
|
|
(while (re-search-forward "^[ \t]*-\\{5,\\}[ \t]*$" nil t)
|
2009-01-21 04:23:49 -05:00
|
|
|
(org-if-unprotected
|
|
|
|
(replace-match (org-export-latex-protect-string "\\hrule") t t)))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-12-16 10:34:50 -05:00
|
|
|
;; Protect LaTeX commands like \command[...]{...} or \command{...}
|
2009-12-16 13:45:05 -05:00
|
|
|
(goto-char (point-min))
|
|
|
|
(let ((re (concat
|
2010-04-07 09:32:31 -04:00
|
|
|
"\\\\\\([a-zA-Z]+\\)"
|
2010-01-28 09:50:20 -05:00
|
|
|
"\\(?:<[^<>\n]*>\\)*"
|
2009-12-16 13:45:05 -05:00
|
|
|
"\\(?:\\[[^][\n]*?\\]\\)*"
|
2010-01-28 09:50:20 -05:00
|
|
|
"\\(?:<[^<>\n]*>\\)*"
|
2009-12-16 13:45:05 -05:00
|
|
|
"\\(" (org-create-multibrace-regexp "{" "}" 3) "\\)\\{1,3\\}")))
|
LaTeX export: Fix some problems with protection of inline latex commands
Scot Becker writes:
> Prompted by Chris Gray's request for org markup in Latex
> environment, I thought I'd submit a note (for his sake and
> others') about a few quirks of org-latex-export's handling
> of embedded Latex markup in org documents. I have been
> puzzling with these for a while but only discovered the
> problem triggers (and workarounds) this morning just before
> Chris' mail arrived. These are both about inline Latex
> commands:
>
> I use a few custom commands \mycommand{like this}, and
> occasionally have to invoke the odd bit of standard LaTeX
> markup, for example /when \textbf{embedding bold text}
> inside italics/. For the most part, these work fine, but
> I've discovered the following two 'gotchas' that happen when
> exporting to LaTeX.
>
> 1. Inline Latex commands get their final curly brace
> escaped with a slash (and therefore don't work) if they
> spill over into another line, i.e. if they contain one or
> more newlines. This is true also for standard LaTeX
> commands like \textbf{} and \emph{}.
>
> ----------------SAMPLE------------------------
> \mycommand{So, for example this
> wrapped setence gets a slash added just after the
> final period and before the curly brace.} Org is quite
> helpfully escaping the slash for LaTeX, apparently.
>
> \mycommand{no trouble if it's all on one line}
> ------------------END-------------------------
>
> The workaround of putting all such commands on one line is
> no hardship for me, since I use visual-line-mode in Emacs 23
> and keep my paragraphs as single logical lines. It might be
> harder for those accustomed to hard-wrapping their
> paragraphs.
>
>
> 2. If you have two inline Latex commands on the same
> logical line, org's latex export doesn't treat the text
> between them in its usual manner. Italics get processed,
> but not the latexification of quotes. ("this" --> ``this'')
> For example:
>
> ----------------SAMPLE------------------------
> I have a short custom command to tell Latex to invoke a
> Hebrew-language right-to-left environment when I want to refer to a
> Hebrew phrase like this: \heb{phrase here}. But then if I "quote
> something," and follow that by another \heb{phrase}, the inner
> quotation marks don't get processed. Oddly enough, this problem is
> only triggered when there is an inline Latex command both before and
> after the quoted material on the same logical line.
>
> Now if you put a footnote in between those two inline Latex commands,
> the output is really nutty:
>
> And \heb{phrase here} with a footnote[fn:: Footnote here.] I'm not
> sure what funky org commands get invoked, but again, only when
> bookended by an inline Latex command like \heb{phrase here}.
> ------------------END-------------------------
>
> The nutty output is a number in square brackets like
> this[1], with the following at the bottom of the document:
>
> \$\^{}{1}\$ Footnote here.
>
> This has a the opposite work-around: break the lines so
> those elements are not all on the same logical line. Put in
> a few newlines. Latex, of course doesn't care. Do take
> care not to start a newline with the org-footnote, like this
> [fn:: Org doesn't parse a footnote command which starts on
> its own line.]
>
> This is just "for what it's worth" to those who use org-mode
> as a front-end to writing for LaTeX.
These problems were caused by a regular expression for
matching latex macros with arguments, that did not allow any
newlines. Now we have a much better regexp, that even
allows for three levels of nested braces.
2009-04-16 08:17:51 -04:00
|
|
|
(while (re-search-forward re nil t)
|
2010-06-07 02:35:10 -04:00
|
|
|
(unless (or
|
2010-04-07 09:32:31 -04:00
|
|
|
;; check for comment line
|
|
|
|
(save-excursion (goto-char (match-beginning 0))
|
2010-05-14 08:27:35 -04:00
|
|
|
(org-in-indented-comment-line))
|
2010-04-07 09:32:31 -04:00
|
|
|
;; Check if this is a defined entity, so that is may need conversion
|
|
|
|
(org-entity-get (match-string 1))
|
|
|
|
)
|
2009-09-06 01:54:31 -04:00
|
|
|
(add-text-properties (match-beginning 0) (match-end 0)
|
|
|
|
'(org-protected t)))))
|
2008-01-31 05:36:18 -05:00
|
|
|
|
2010-07-14 04:54:39 -04:00
|
|
|
;; Special case for \nbsp
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward "\\\\nbsp\\({}\\|\\>\\)" nil t)
|
|
|
|
(org-if-unprotected
|
|
|
|
(replace-match (org-export-latex-protect-string "~"))))
|
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
;; Protect LaTeX entities
|
|
|
|
(goto-char (point-min))
|
2010-07-14 04:54:39 -04:00
|
|
|
(while (re-search-forward org-latex-entities-regexp nil t)
|
|
|
|
(org-if-unprotected
|
|
|
|
(add-text-properties (match-beginning 0) (match-end 0)
|
|
|
|
'(org-protected t))))
|
2008-01-31 05:37:51 -05:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
;; Replace radio links
|
|
|
|
(goto-char (point-min))
|
2008-01-31 05:36:18 -05:00
|
|
|
(while (re-search-forward
|
2008-01-31 05:37:51 -05:00
|
|
|
(concat "<<<?" org-export-latex-all-targets-re
|
2008-01-31 05:36:18 -05:00
|
|
|
">>>?\\((INVISIBLE)\\)?") nil t)
|
2009-11-08 05:24:01 -05:00
|
|
|
(org-if-unprotected-at (+ (match-beginning 0) 2)
|
2010-12-19 08:54:16 -05:00
|
|
|
(replace-match
|
|
|
|
(concat
|
|
|
|
(org-export-latex-protect-string
|
|
|
|
(format "\\label{%s}" (save-match-data (org-solidify-link-text
|
|
|
|
(match-string 1)))))
|
|
|
|
(if (match-string 2) "" (match-string 1)))
|
|
|
|
t t)))
|
2008-01-31 05:36:18 -05:00
|
|
|
|
2008-01-31 05:36:08 -05:00
|
|
|
;; Delete @<...> constructs
|
|
|
|
;; Thanks to Daniel Clemente for this regexp
|
2008-02-07 05:24:54 -05:00
|
|
|
(goto-char (point-min))
|
2008-01-31 05:36:08 -05:00
|
|
|
(while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
|
2009-01-21 04:23:49 -05:00
|
|
|
(org-if-unprotected
|
|
|
|
(replace-match "")))
|
2008-01-31 05:36:18 -05:00
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
;; When converting to LaTeX, replace footnotes
|
|
|
|
;; FIXME: don't protect footnotes from conversion
|
2008-01-31 05:37:51 -05:00
|
|
|
(when (plist-get org-export-latex-options-plist :footnotes)
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
2010-12-19 08:54:16 -05:00
|
|
|
(while (and (re-search-forward "\\[\\([0-9]+\\)\\]" nil t)
|
|
|
|
(not (equal (char-before (match-beginning 0)) ?\])))
|
2009-01-21 04:23:49 -05:00
|
|
|
(org-if-unprotected
|
2009-10-28 19:17:32 -04:00
|
|
|
(when (and (save-match-data
|
|
|
|
(save-excursion (beginning-of-line)
|
|
|
|
(looking-at "[^:|#]")))
|
|
|
|
(not (org-in-verbatim-emphasis)))
|
2009-01-21 04:23:49 -05:00
|
|
|
(let ((foot-beg (match-beginning 0))
|
|
|
|
(foot-end (match-end 0))
|
|
|
|
(foot-prefix (match-string 0))
|
|
|
|
footnote footnote-rpl)
|
|
|
|
(save-excursion
|
|
|
|
(if (not (re-search-forward (concat "^" (regexp-quote foot-prefix))
|
|
|
|
nil t))
|
2009-11-20 09:05:42 -05:00
|
|
|
(replace-match (org-export-latex-protect-string
|
|
|
|
(concat "$^{" (match-string 1) "}$")))
|
2009-01-21 04:23:49 -05:00
|
|
|
(replace-match "")
|
|
|
|
(let ((end (save-excursion
|
|
|
|
(if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t)
|
|
|
|
(match-beginning 0) (point-max)))))
|
|
|
|
(setq footnote (concat (org-trim (buffer-substring (point) end))
|
|
|
|
" ")) ; prevent last } being part of a link
|
|
|
|
(delete-region (point) end))
|
|
|
|
(goto-char foot-beg)
|
|
|
|
(delete-region foot-beg foot-end)
|
|
|
|
(unless (null footnote)
|
|
|
|
(setq footnote-rpl (format "\\footnote{%s}" footnote))
|
|
|
|
(add-text-properties 0 10 '(org-protected t) footnote-rpl)
|
|
|
|
(add-text-properties (1- (length footnote-rpl))
|
|
|
|
(length footnote-rpl)
|
|
|
|
'(org-protected t) footnote-rpl)
|
2010-02-26 15:02:25 -05:00
|
|
|
(if (org-on-heading-p)
|
2010-12-19 08:54:16 -05:00
|
|
|
(setq footnote-rpl
|
|
|
|
(concat (org-export-latex-protect-string "\\protect")
|
|
|
|
footnote-rpl)))
|
2009-01-21 04:23:49 -05:00
|
|
|
(insert footnote-rpl)))
|
|
|
|
)))))
|
2008-12-30 17:58:12 -05:00
|
|
|
|
|
|
|
;; Remove footnote section tag for LaTeX
|
2008-01-31 05:35:58 -05:00
|
|
|
(goto-char (point-min))
|
2008-01-31 05:37:51 -05:00
|
|
|
(while (re-search-forward
|
2008-01-31 05:35:58 -05:00
|
|
|
(concat "^" footnote-section-tag-regexp) nil t)
|
2009-01-21 04:23:49 -05:00
|
|
|
(org-if-unprotected
|
|
|
|
(replace-match "")))))
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2010-01-10 04:18:27 -05:00
|
|
|
(defun org-export-latex-fix-inputenc ()
|
2010-07-16 17:22:01 -04:00
|
|
|
"Set the coding system in inputenc to what the buffer is."
|
2010-01-10 04:18:27 -05:00
|
|
|
(let* ((cs buffer-file-coding-system)
|
2010-03-12 11:29:41 -05:00
|
|
|
(opt (or (ignore-errors (latexenc-coding-system-to-inputenc cs))
|
|
|
|
"utf8")))
|
2010-01-10 04:18:27 -05:00
|
|
|
(when opt
|
|
|
|
;; Translate if that is requested
|
|
|
|
(setq opt (or (cdr (assoc opt org-export-latex-inputenc-alist)) opt))
|
|
|
|
;; find the \usepackage statement and replace the option
|
|
|
|
(goto-char (point-min))
|
2010-01-24 05:21:34 -05:00
|
|
|
(while (re-search-forward "\\\\usepackage\\[\\(AUTO\\)\\]{inputenc}"
|
2010-01-10 04:18:27 -05:00
|
|
|
nil t)
|
|
|
|
(goto-char (match-beginning 1))
|
|
|
|
(delete-region (match-beginning 1) (match-end 1))
|
|
|
|
(insert opt))
|
2010-02-12 02:34:00 -05:00
|
|
|
(and buffer-file-name
|
|
|
|
(save-buffer)))))
|
2010-01-10 04:18:27 -05:00
|
|
|
|
2008-01-31 05:37:51 -05:00
|
|
|
;;; List handling:
|
|
|
|
|
|
|
|
(defun org-export-latex-lists ()
|
2009-01-06 11:23:36 -05:00
|
|
|
"Convert plain text lists in current buffer into LaTeX lists."
|
2011-02-28 05:04:46 -05:00
|
|
|
;; `org-list-end-re' output has changed since preprocess from
|
|
|
|
;; org-exp.el. Make sure it is taken into account.
|
|
|
|
(let ((org-list-ending-method
|
|
|
|
(if (eq org-list-ending-method 'regexp) 'regexp 'both))
|
2011-02-28 05:20:06 -05:00
|
|
|
(org-list-end-re "^ORG-LIST-END-MARKER\n"))
|
2011-02-28 05:04:46 -05:00
|
|
|
(mapc
|
|
|
|
(lambda (e)
|
|
|
|
;; For each type of context allowed for list export (E), find
|
|
|
|
;; every list, parse it, delete it and insert resulting
|
|
|
|
;; conversion to latex (RES), while keeping the same
|
|
|
|
;; `original-indentation' property.
|
|
|
|
(let (res)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(while (re-search-forward (org-item-beginning-re) nil t)
|
|
|
|
(when (and (eq (get-text-property (point) 'list-context) e)
|
|
|
|
(not (get-text-property (point) 'org-example)))
|
|
|
|
(beginning-of-line)
|
|
|
|
(setq res
|
|
|
|
(org-list-to-latex
|
|
|
|
;; Narrowing is needed because we're converting
|
|
|
|
;; from inner functions to outer ones.
|
|
|
|
(save-restriction
|
|
|
|
(narrow-to-region (point) (point-max))
|
|
|
|
(org-list-parse-list t))
|
|
|
|
org-export-latex-list-parameters))
|
|
|
|
;; Extend previous value of original-indentation to the
|
|
|
|
;; whole string
|
|
|
|
(insert (org-add-props res nil 'original-indentation
|
|
|
|
(org-find-text-property-in-string
|
|
|
|
'original-indentation res)))))))
|
|
|
|
;; List of allowed contexts for export, and the default one.
|
|
|
|
(append org-list-export-context '(nil)))))
|
2008-01-31 05:37:51 -05:00
|
|
|
|
|
|
|
(defconst org-latex-entities
|
|
|
|
'("\\!"
|
|
|
|
"\\'"
|
|
|
|
"\\+"
|
|
|
|
"\\,"
|
|
|
|
"\\-"
|
|
|
|
"\\:"
|
|
|
|
"\\;"
|
|
|
|
"\\<"
|
|
|
|
"\\="
|
|
|
|
"\\>"
|
|
|
|
"\\Huge"
|
|
|
|
"\\LARGE"
|
|
|
|
"\\Large"
|
|
|
|
"\\Styles"
|
|
|
|
"\\\\"
|
|
|
|
"\\`"
|
2011-01-16 03:53:28 -05:00
|
|
|
"\\\""
|
2008-01-31 05:37:51 -05:00
|
|
|
"\\addcontentsline"
|
|
|
|
"\\address"
|
|
|
|
"\\addtocontents"
|
|
|
|
"\\addtocounter"
|
|
|
|
"\\addtolength"
|
|
|
|
"\\addvspace"
|
|
|
|
"\\alph"
|
|
|
|
"\\appendix"
|
|
|
|
"\\arabic"
|
|
|
|
"\\author"
|
|
|
|
"\\begin{array}"
|
|
|
|
"\\begin{center}"
|
|
|
|
"\\begin{description}"
|
|
|
|
"\\begin{enumerate}"
|
|
|
|
"\\begin{eqnarray}"
|
|
|
|
"\\begin{equation}"
|
|
|
|
"\\begin{figure}"
|
|
|
|
"\\begin{flushleft}"
|
|
|
|
"\\begin{flushright}"
|
|
|
|
"\\begin{itemize}"
|
|
|
|
"\\begin{list}"
|
|
|
|
"\\begin{minipage}"
|
|
|
|
"\\begin{picture}"
|
|
|
|
"\\begin{quotation}"
|
|
|
|
"\\begin{quote}"
|
|
|
|
"\\begin{tabbing}"
|
|
|
|
"\\begin{table}"
|
|
|
|
"\\begin{tabular}"
|
|
|
|
"\\begin{thebibliography}"
|
|
|
|
"\\begin{theorem}"
|
|
|
|
"\\begin{titlepage}"
|
|
|
|
"\\begin{verbatim}"
|
|
|
|
"\\begin{verse}"
|
|
|
|
"\\bf"
|
|
|
|
"\\bf"
|
|
|
|
"\\bibitem"
|
|
|
|
"\\bigskip"
|
|
|
|
"\\cdots"
|
|
|
|
"\\centering"
|
|
|
|
"\\circle"
|
|
|
|
"\\cite"
|
|
|
|
"\\cleardoublepage"
|
|
|
|
"\\clearpage"
|
|
|
|
"\\cline"
|
|
|
|
"\\closing"
|
|
|
|
"\\dashbox"
|
|
|
|
"\\date"
|
|
|
|
"\\ddots"
|
|
|
|
"\\dotfill"
|
|
|
|
"\\em"
|
|
|
|
"\\fbox"
|
|
|
|
"\\flushbottom"
|
|
|
|
"\\fnsymbol"
|
|
|
|
"\\footnote"
|
|
|
|
"\\footnotemark"
|
|
|
|
"\\footnotesize"
|
|
|
|
"\\footnotetext"
|
|
|
|
"\\frac"
|
|
|
|
"\\frame"
|
|
|
|
"\\framebox"
|
|
|
|
"\\hfill"
|
|
|
|
"\\hline"
|
|
|
|
"\\hrulespace"
|
|
|
|
"\\hspace"
|
|
|
|
"\\huge"
|
|
|
|
"\\hyphenation"
|
|
|
|
"\\include"
|
|
|
|
"\\includeonly"
|
|
|
|
"\\indent"
|
|
|
|
"\\input"
|
|
|
|
"\\it"
|
|
|
|
"\\kill"
|
|
|
|
"\\label"
|
|
|
|
"\\large"
|
|
|
|
"\\ldots"
|
|
|
|
"\\line"
|
|
|
|
"\\linebreak"
|
|
|
|
"\\linethickness"
|
|
|
|
"\\listoffigures"
|
|
|
|
"\\listoftables"
|
|
|
|
"\\location"
|
|
|
|
"\\makebox"
|
|
|
|
"\\maketitle"
|
|
|
|
"\\mark"
|
|
|
|
"\\mbox"
|
|
|
|
"\\medskip"
|
|
|
|
"\\multicolumn"
|
|
|
|
"\\multiput"
|
|
|
|
"\\newcommand"
|
|
|
|
"\\newcounter"
|
|
|
|
"\\newenvironment"
|
|
|
|
"\\newfont"
|
|
|
|
"\\newlength"
|
|
|
|
"\\newline"
|
|
|
|
"\\newpage"
|
|
|
|
"\\newsavebox"
|
|
|
|
"\\newtheorem"
|
|
|
|
"\\nocite"
|
|
|
|
"\\nofiles"
|
|
|
|
"\\noindent"
|
|
|
|
"\\nolinebreak"
|
|
|
|
"\\nopagebreak"
|
|
|
|
"\\normalsize"
|
|
|
|
"\\onecolumn"
|
|
|
|
"\\opening"
|
|
|
|
"\\oval"
|
|
|
|
"\\overbrace"
|
|
|
|
"\\overline"
|
|
|
|
"\\pagebreak"
|
|
|
|
"\\pagenumbering"
|
|
|
|
"\\pageref"
|
|
|
|
"\\pagestyle"
|
|
|
|
"\\par"
|
|
|
|
"\\parbox"
|
|
|
|
"\\put"
|
|
|
|
"\\raggedbottom"
|
|
|
|
"\\raggedleft"
|
|
|
|
"\\raggedright"
|
|
|
|
"\\raisebox"
|
|
|
|
"\\ref"
|
|
|
|
"\\rm"
|
|
|
|
"\\roman"
|
|
|
|
"\\rule"
|
|
|
|
"\\savebox"
|
|
|
|
"\\sc"
|
|
|
|
"\\scriptsize"
|
|
|
|
"\\setcounter"
|
|
|
|
"\\setlength"
|
|
|
|
"\\settowidth"
|
|
|
|
"\\sf"
|
|
|
|
"\\shortstack"
|
|
|
|
"\\signature"
|
|
|
|
"\\sl"
|
|
|
|
"\\small"
|
|
|
|
"\\smallskip"
|
|
|
|
"\\sqrt"
|
|
|
|
"\\tableofcontents"
|
|
|
|
"\\telephone"
|
|
|
|
"\\thanks"
|
|
|
|
"\\thispagestyle"
|
|
|
|
"\\tiny"
|
|
|
|
"\\title"
|
|
|
|
"\\tt"
|
|
|
|
"\\twocolumn"
|
|
|
|
"\\typein"
|
|
|
|
"\\typeout"
|
|
|
|
"\\underbrace"
|
|
|
|
"\\underline"
|
|
|
|
"\\usebox"
|
|
|
|
"\\usecounter"
|
|
|
|
"\\value"
|
|
|
|
"\\vdots"
|
|
|
|
"\\vector"
|
|
|
|
"\\verb"
|
|
|
|
"\\vfill"
|
|
|
|
"\\vline"
|
|
|
|
"\\vspace")
|
|
|
|
"A list of LaTeX commands to be protected when performing conversion.")
|
|
|
|
|
2008-10-18 04:44:41 -04:00
|
|
|
(defconst org-latex-entities-regexp
|
|
|
|
(let (names rest)
|
|
|
|
(dolist (x org-latex-entities)
|
2009-11-12 03:38:39 -05:00
|
|
|
(if (string-match "[a-zA-Z]$" x)
|
2008-10-18 04:44:41 -04:00
|
|
|
(push x names)
|
|
|
|
(push x rest)))
|
|
|
|
(concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
|
|
|
|
"\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
|
|
|
|
|
2008-01-31 05:35:58 -05:00
|
|
|
(provide 'org-export-latex)
|
2009-04-09 11:25:44 -04:00
|
|
|
(provide 'org-latex)
|
2008-01-31 05:35:58 -05:00
|
|
|
|
2008-01-31 05:36:18 -05:00
|
|
|
;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
|
2008-04-29 01:15:41 -04:00
|
|
|
|
2009-04-09 11:25:44 -04:00
|
|
|
;;; org-latex.el ends here
|