1 ;;; muse-latex.el --- publish entries in LaTex or PDF format
3 ;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
5 ;; This file is part of Emacs Muse. It is not part of GNU Emacs.
7 ;; Emacs Muse is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published
9 ;; by the Free Software Foundation; either version 2, or (at your
10 ;; option) any later version.
12 ;; Emacs Muse is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 ;; General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Emacs Muse; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 ;; Boston, MA 02110-1301, USA.
26 ;; Li Daobing (lidaobing AT gmail DOT com) provided CJK support.
28 ;; Trent Buck (trentbuck AT gmail DOT com) gave valuable advice for
29 ;; how to treat LaTeX specials and the like.
31 ;; Matthias Kegelmann (mathias DOT kegelmann AT sdm DOT de) provided a
32 ;; scenario where we would need to respect the <contents> tag.
36 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
38 ;; Muse LaTeX Publishing
40 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
42 (require 'muse-publish
)
44 (defgroup muse-latex nil
45 "Rules for marking up a Muse file as a LaTeX article."
48 (defcustom muse-latex-extension
".tex"
49 "Default file extension for publishing LaTeX files."
53 (defcustom muse-latex-pdf-extension
".pdf"
54 "Default file extension for publishing LaTeX files to PDF."
58 (defcustom muse-latex-header
59 "\\documentclass{article}
61 \\usepackage[english]{babel}
62 \\usepackage[latin1]{inputenc}
63 \\usepackage[T1]{fontenc}
64 \\usepackage{hyperref}
65 \\usepackage[pdftex]{graphicx}
67 \\newcommand{\\comment}[1]{}
71 \\title{<lisp>(muse-publishing-directive \"title\")</lisp>}
72 \\author{<lisp>(muse-publishing-directive \"author\")</lisp>}
73 \\date{<lisp>(muse-publishing-directive \"date\")</lisp>}
77 <lisp>(and muse-publish-generate-contents
78 (not muse-latex-permit-contents-tag)
79 \"\\\\tableofcontents\n\\\\newpage\")</lisp>\n\n"
80 "Header used for publishing LaTeX files. This may be text or a filename."
84 (defcustom muse-latex-footer
"\n\\end{document}\n"
85 "Footer used for publishing LaTeX files. This may be text or a filename."
89 (defcustom muse-latexcjk-header
90 "\\documentclass{article}
93 \\usepackage{indentfirst}
94 \\usepackage[CJKbookmarks=true]{hyperref}
95 \\usepackage[pdftex]{graphicx}
97 \\newcommand{\\comment}[1]{}
100 \\begin{CJK*}<lisp>(muse-latexcjk-encoding)</lisp>
102 \\title{<lisp>(muse-publishing-directive \"title\")</lisp>}
103 \\author{<lisp>(muse-publishing-directive \"author\")</lisp>}
104 \\date{<lisp>(muse-publishing-directive \"date\")</lisp>}
108 <lisp>(and muse-publish-generate-contents
109 (not muse-latex-permit-contents-tag)
110 \"\\\\tableofcontents\n\\\\newpage\")</lisp>\n\n"
111 "Header used for publishing LaTeX files (CJK). This may be text or a
116 (defcustom muse-latexcjk-footer
119 "Footer used for publishing LaTeX files (CJK). This may be text or a
124 (defcustom muse-latex-markup-regexps
126 (10000 "\\([0-9]+\\)-\\([0-9]+\\)" 0 "\\1--\\2")
128 ;; be careful of closing quote pairs
129 (10100 "\"'" 0 "\"\\\\-'"))
130 "List of markup regexps for identifying regions in a Muse page.
131 For more on the structure of this list, see `muse-publish-markup-regexps'."
132 :type
'(repeat (choice
133 (list :tag
"Markup rule"
135 (choice regexp symbol
)
137 (choice string function symbol
))
141 (defcustom muse-latex-markup-functions
142 '((table . muse-latex-markup-table
))
143 "An alist of style types to custom functions for that kind of text.
144 For more on the structure of this list, see
145 `muse-publish-markup-functions'."
146 :type
'(alist :key-type symbol
:value-type function
)
149 (defcustom muse-latex-markup-strings
150 '((image-with-desc .
"\\begin{figure}[h]\\centering\\includegraphics[width=0.75\\textwidth]{%s}\\caption{%s}\\end{figure}")
151 (image-link .
"\\begin{figure}[h]\\centering\\includegraphics[width=0.75\\textwidth]{%s}\\end{figure}")
152 (url-with-image .
"%% %s\n\\includegraphics[width=0.75\\textwidth]{%s}")
153 (anchor-ref .
"\\ref{%s}")
155 (url-and-desc .
"\\href{%s}{%s}\\footnote{%1%}")
156 (link .
"\\href{%s}{%s}\\footnote{%1%}")
157 (link-and-anchor .
"\\href{%1%}{%3%}\\footnote{%1%}")
158 (email-addr .
"\\verb|%s|")
159 (anchor .
"\\label{%s}")
161 (comment-begin .
"\\comment{")
164 (no-break-space .
"~")
165 (enddots .
"\\ldots{}")
169 (chapter .
"\\chapter{")
171 (section .
"\\section{")
173 (subsection .
"\\subsection{")
174 (subsection-end .
"}")
175 (subsubsection .
"\\subsubsection{")
176 (subsubsection-end .
"}")
177 (section-other .
"\\paragraph{")
178 (section-other-end .
"}")
179 (footnote .
"\\footnote{")
181 (footnotetext .
"\\footnotetext[%d]{")
182 (begin-underline .
"\\underline{")
183 (end-underline .
"}")
184 (begin-literal .
"\\texttt{")
186 (begin-emph .
"\\emph{")
188 (begin-more-emph .
"\\textbf{")
189 (end-more-emph .
"}")
190 (begin-most-emph .
"\\textbf{\\emph{")
191 (end-most-emph .
"}}")
192 (begin-verse .
"\\begin{verse}\n")
193 (end-verse-line .
" \\\\")
194 (verse-space .
"~~~~")
195 (end-verse .
"\n\\end{verse}")
196 (begin-example .
"\\begin{quote}\n\\begin{verbatim}")
197 (end-example .
"\\end{verbatim}\n\\end{quote}")
198 (begin-center .
"\\begin{center}\n")
199 (end-center .
"\n\\end{center}")
200 (begin-quote .
"\\begin{quote}\n")
201 (end-quote .
"\n\\end{quote}")
202 (begin-uli .
"\\begin{itemize}\n")
203 (end-uli .
"\n\\end{itemize}")
204 (begin-uli-item .
"\\item ")
205 (begin-oli .
"\\begin{enumerate}\n")
206 (end-oli .
"\n\\end{enumerate}")
207 (begin-oli-item .
"\\item ")
208 (begin-dl .
"\\begin{description}\n")
209 (end-dl .
"\n\\end{description}")
210 (begin-ddt .
"\\item[")
212 "Strings used for marking up text.
213 These cover the most basic kinds of markup, the handling of which
214 differs little between the various styles."
215 :type
'(alist :key-type symbol
:value-type string
)
218 (defcustom muse-latexcjk-encoding-map
219 '((utf-8 .
"{UTF8}{song}")
220 (japanese-iso-8bit .
"[dnp]{JIS}{min}")
221 (chinese-big5 .
"{Bg5}{bsmi}")
222 (mule-utf-8 .
"{UTF8}{song}")
223 (chinese-iso-8bit .
"{GB}{song}")
224 (chinese-gbk .
"{GBK}{song}"))
225 "An alist mapping emacs coding systems to appropriate CJK codings.
226 Use the base name of the coding system (ie, without the -unix)."
227 :type
'(alist :key-type coding-system
:value-type string
)
230 (defcustom muse-latexcjk-encoding-default
"{GB}{song}"
231 "The default Emacs buffer encoding to use in published files.
232 This will be used if no special characters are found."
236 (defun muse-latexcjk-encoding ()
237 (when (boundp 'buffer-file-coding-system
)
238 (muse-latexcjk-transform-content-type buffer-file-coding-system
)))
240 (defun muse-latexcjk-transform-content-type (content-type)
241 "Using `muse-cjklatex-encoding-map', try and resolve an emacs coding
242 system to an associated CJK coding system."
243 (let ((match (and (fboundp 'coding-system-base
)
244 (assoc (coding-system-base content-type
)
245 muse-latexcjk-encoding-map
))))
248 muse-latexcjk-encoding-default
)))
250 (defcustom muse-latex-markup-specials-document
251 '((?
\\ .
"\\textbackslash{}")
252 (?\_ .
"\\textunderscore{}")
253 (?\
< .
"\\textless{}")
254 (?\
> .
"\\textgreater{}")
264 "A table of characters which must be represented specially.
265 These are applied to the entire document, sans already-escaped
267 :type
'(alist :key-type character
:value-type string
)
270 (defcustom muse-latex-markup-specials-example
272 "A table of characters which must be represented specially.
273 These are applied to <example> regions.
275 With the default interpretation of <example> regions, no specials
277 :type
'(alist :key-type character
:value-type string
)
280 (defcustom muse-latex-markup-specials-literal
282 (?_ .
"\\textunderscore{}")
283 (?\
< .
"\\textless{}")
284 (?\
> .
"\\textgreater{}")
293 "A table of characters which must be represented specially.
294 This applies to =monospaced text= and <code> regions."
295 :type
'(alist :key-type character
:value-type string
)
298 (defcustom muse-latex-markup-specials-url
309 "A table of characters which must be represented specially.
310 These are applied to URLs."
311 :type
'(alist :key-type character
:value-type string
)
314 (defun muse-latex-decide-specials (context)
315 "Determine the specials to escape, depending on CONTEXT."
316 (cond ((memq context
'(underline emphasis document url-desc verbatim
))
317 muse-latex-markup-specials-document
)
318 ((memq context
'(email url
))
319 muse-latex-markup-specials-url
)
320 ((eq context
'literal
)
321 muse-latex-markup-specials-literal
)
322 ((eq context
'example
)
323 muse-latex-markup-specials-example
)
324 (t (error "Invalid context '%s' in muse-latex" context
))))
326 (defun muse-latex-markup-table ()
327 (let* ((table-info (muse-publish-table-fields (match-beginning 0)
329 (row-len (car table-info
))
330 (field-list (cdr table-info
)))
332 (muse-insert-markup "\\begin{tabular}{" (make-string row-len ?l
) "}\n")
333 (dolist (fields field-list
)
334 (let ((type (car fields
)))
335 (setq fields
(cdr fields
))
337 (muse-insert-markup "\\hline\n"))
338 (insert (car fields
))
339 (setq fields
(cdr fields
))
340 (dolist (field fields
)
341 (muse-insert-markup " & ")
343 (muse-insert-markup " \\\\\n")
345 (muse-insert-markup "\\hline\n"))))
346 (muse-insert-markup "\\end{tabular}"))))
348 (defun muse-latex-fixup-dquotes ()
349 "Fixup double quotes."
351 (while (search-forward "\"" nil t
)
352 (unless (get-text-property (match-beginning 0) 'read-only
)
354 (eq (char-before) ?
\n))
363 (defcustom muse-latex-permit-contents-tag nil
364 "If nil, ignore <contents> tags. Otherwise, insert table of contents.
366 Most of the time, it is best to have a table of contents on the
367 first page, with a new page immediately following. To make this
368 work with documents published in both HTML and LaTeX, we need to
369 ignore the <contents> tag.
371 If you don't agree with this, then set this option to non-nil,
372 and it will do what you expect."
376 (defun muse-latex-finalize-buffer ()
377 (goto-char (point-min))
378 (muse-latex-fixup-dquotes)
379 (when (and muse-latex-permit-contents-tag
380 muse-publish-generate-contents
)
381 (goto-char (car muse-publish-generate-contents
))
382 (muse-insert-markup "\\tableofcontents")))
384 (defun muse-latex-pdf-browse-file (file)
385 (shell-command (concat "open " file
)))
387 (defun muse-latex-pdf-generate (file output-path final-target
)
388 (muse-publish-transform-output
389 file output-path final-target
"PDF"
391 (lambda (file output-path
)
392 (let ((command (format "cd \"%s\"; pdflatex \"%s\""
393 (file-name-directory output-path
) file
))
396 ;; XEmacs can sometimes return a non-number result. We'll err
397 ;; on the side of caution by continuing to attempt to generate
398 ;; the PDF if this happens and treat the final result as
400 (while (and (< times
2)
401 (or (not (numberp result
))
403 ;; table of contents takes 2 passes
405 (muse-replace-regexp-in-string
406 "\\.tex\\'" ".toc" file t t
))))
407 (setq result
(shell-command command
)
409 (if (or (not (numberp result
))
413 ".aux" ".toc" ".out" ".log"))
415 (unless (assoc "latex" muse-publishing-styles
)
416 (muse-define-style "latex"
417 :suffix
'muse-latex-extension
418 :regexps
'muse-latex-markup-regexps
419 :functions
'muse-latex-markup-functions
420 :strings
'muse-latex-markup-strings
421 :specials
'muse-latex-decide-specials
422 :after
'muse-latex-finalize-buffer
423 :header
'muse-latex-header
424 :footer
'muse-latex-footer
427 (muse-derive-style "pdf" "latex"
428 :final
'muse-latex-pdf-generate
429 :browser
'muse-latex-pdf-browse-file
430 :link-suffix
'muse-latex-pdf-extension
431 :osuffix
'muse-latex-pdf-extension
)
433 (muse-derive-style "latexcjk" "latex"
434 :header
'muse-latexcjk-header
435 :footer
'muse-latexcjk-footer
)
437 (muse-derive-style "pdfcjk" "latexcjk"
438 :final
'muse-latex-pdf-generate
439 :browser
'muse-latex-pdf-browse-file
440 :link-suffix
'muse-latex-pdf-extension
441 :osuffix
'muse-latex-pdf-extension
))
443 (provide 'muse-latex
)
445 ;;; muse-latex.el ends here