ox-koma-letter.el 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  1. ;;; ox-koma-letter.el --- KOMA Scrlttr2 Back-End for Org Export Engine
  2. ;; Copyright (C) 2007-2012, 2014 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou AT gmail DOT com>
  4. ;; Alan Schmitt <alan.schmitt AT polytechnique DOT org>
  5. ;; Viktor Rosenfeld <listuser36 AT gmail DOT com>
  6. ;; Rasmus Pank Roulund <emacs AT pank DOT eu>
  7. ;; Keywords: org, wp, tex
  8. ;; This program is free software: you can redistribute it and/or modify
  9. ;; it under the terms of the GNU General Public License as published by
  10. ;; the Free Software Foundation, either version 3 of the License, or
  11. ;; (at your option) any later version.
  12. ;; This program is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. ;; GNU General Public License for more details.
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  18. ;;; Commentary:
  19. ;;
  20. ;; This library implements a KOMA Scrlttr2 back-end, derived from the
  21. ;; LaTeX one.
  22. ;;
  23. ;; Depending on the desired output format, three commands are provided
  24. ;; for export: `org-koma-letter-export-as-latex' (temporary buffer),
  25. ;; `org-koma-letter-export-to-latex' ("tex" file) and
  26. ;; `org-koma-letter-export-to-pdf' ("pdf" file).
  27. ;;
  28. ;; On top of buffer keywords supported by `latex' back-end (see
  29. ;; `org-latex-options-alist'), this back-end introduces the following
  30. ;; keywords:
  31. ;; - "CLOSING" (see `org-koma-letter-closing'),
  32. ;; - "FROM_ADDRESS" (see `org-koma-letter-from-address'),
  33. ;; - "LCO" (see `org-koma-letter-class-option-file'),
  34. ;; - "OPENING" (see `org-koma-letter-opening'),
  35. ;; - "PHONE_NUMBER" (see `org-koma-letter-phone-number'),
  36. ;; - "SIGNATURE" (see `org-koma-letter-signature')
  37. ;; - "PLACE" (see `org-koma-letter-place')
  38. ;; - and "TO_ADDRESS". If unspecified this is set to "\mbox{}".
  39. ;;
  40. ;; TO_ADDRESS and FROM_ADDRESS can also be specified using heading
  41. ;; with the special tags specified in
  42. ;; `org-koma-letter-special-tags-in-letter', namely "to" and "from".
  43. ;; LaTeX line breaks are not necessary if using these headings. If
  44. ;; both a headline and a keyword specify a to or from address the
  45. ;; value is determined in accordance with
  46. ;; `org-koma-letter-prefer-special-headings'.
  47. ;;
  48. ;; A number of OPTIONS settings can be set to change which contents is
  49. ;; exported.
  50. ;; - backaddress (see `org-koma-letter-use-backaddress')
  51. ;; - foldmarks (see `org-koma-letter-use-foldmarks')
  52. ;; - phone (see `org-koma-letter-use-phone')
  53. ;; - email (see `org-koma-letter-use-email')
  54. ;; - place (see `org-koma-letter-use-place')
  55. ;; - subject, a list of format options
  56. ;; (see `org-koma-letter-subject-format')
  57. ;; - after-closing-order, a list of the ordering of headings with
  58. ;; special tags after closing (see
  59. ;; `org-koma-letter-special-tags-after-closing')
  60. ;; - after-letter-order, as above, but after the end of the letter
  61. ;; (see `org-koma-letter-special-tags-after-letter').
  62. ;;
  63. ;; The following variables works differently from the main LaTeX class
  64. ;; - "AUTHOR": default to user-full-name but may be disabled. (see org-koma-letter-author),
  65. ;; - "EMAIL": same as AUTHOR, (see org-koma-letter-email),
  66. ;;
  67. ;; Headlines are in general ignored. However, headlines with special
  68. ;; tags can be used for specified contents like postscript (ps),
  69. ;; carbon copy (cc), enclosures (encl) and code to be inserted after
  70. ;; \end{letter} (after_letter). Specials tags are defined in
  71. ;; `org-koma-letter-special-tags-after-closing' and
  72. ;; `org-koma-letter-special-tags-after-letter'. Currently members of
  73. ;; `org-koma-letter-special-tags-after-closing' used as macros and the
  74. ;; content of the headline is the argument.
  75. ;;
  76. ;; Headlines with two and from may also be used rather than the
  77. ;; keyword approach described above. If both a keyword and a headline
  78. ;; with information is present precedence is determined by
  79. ;; `org-koma-letter-prefer-special-headings'.
  80. ;;
  81. ;; You will need to add an appropriate association in
  82. ;; `org-latex-classes' in order to use the KOMA Scrlttr2 class.
  83. ;; The easiest way to do this is by adding
  84. ;;
  85. ;; (eval-after-load "ox-koma-letter"
  86. ;; '(org-koma-letter-plug-into-ox))
  87. ;;
  88. ;; to your init file. This will add a sparse scrlttr2 class and
  89. ;; set it as the default `org-koma-latex-default-class'. You can also
  90. ;; add you own letter class. For instace:
  91. ;;
  92. ;; (add-to-list 'org-latex-classes
  93. ;; '("my-letter"
  94. ;; "\\documentclass\[%
  95. ;; DIV=14,
  96. ;; fontsize=12pt,
  97. ;; parskip=half,
  98. ;; subject=titled,
  99. ;; backaddress=false,
  100. ;; fromalign=left,
  101. ;; fromemail=true,
  102. ;; fromphone=true\]\{scrlttr2\}
  103. ;; \[DEFAULT-PACKAGES]
  104. ;; \[PACKAGES]
  105. ;; \[EXTRA]"))
  106. ;;
  107. ;; Then, in your Org document, be sure to require the proper class
  108. ;; with :
  109. ;;
  110. ;; #+LATEX_CLASS: my-letter
  111. ;;
  112. ;; Or by setting `org-koma-letter-default-class'.
  113. ;;; Code:
  114. (require 'ox-latex)
  115. ;;; User-Configurable Variables
  116. (defgroup org-export-koma-letter nil
  117. "Options for exporting to KOMA scrlttr2 class in LaTeX export."
  118. :tag "Org Koma-Letter"
  119. :group 'org-export)
  120. (defcustom org-koma-letter-class-option-file "NF"
  121. "Letter Class Option File."
  122. :group 'org-export-koma-letter
  123. :type 'string)
  124. (defcustom org-koma-letter-author 'user-full-name
  125. "Sender's name.
  126. This variable defaults to calling the function `user-full-name'
  127. which just returns the current function `user-full-name'.
  128. Alternatively a string, nil or a function may be given.
  129. Functions must return a string."
  130. :group 'org-export-koma-letter
  131. :type '(radio (function-item user-full-name)
  132. (string)
  133. (function)
  134. (const :tag "Do not export author" nil)))
  135. (defcustom org-koma-letter-email 'org-koma-letter-email
  136. "Sender's email address.
  137. This variable defaults to the value `org-koma-letter-email' which
  138. returns `user-mail-address'. Alternatively a string, nil or
  139. a function may be given. Functions must return a string."
  140. :group 'org-export-koma-letter
  141. :type '(radio (function-item org-koma-letter-email)
  142. (string)
  143. (function)
  144. (const :tag "Do not export email" nil)))
  145. (defcustom org-koma-letter-from-address nil
  146. "Sender's address, as a string."
  147. :group 'org-export-koma-letter
  148. :type 'string)
  149. (defcustom org-koma-letter-phone-number nil
  150. "Sender's phone number, as a string."
  151. :group 'org-export-koma-letter
  152. :type 'string)
  153. (defcustom org-koma-letter-place nil
  154. "Place from which the letter is sent, as a string."
  155. :group 'org-export-koma-letter
  156. :type 'string)
  157. (defcustom org-koma-letter-opening nil
  158. "Letter's opening, as a string.
  159. If (1) this value is nil; (2) the letter is started with a
  160. headline; and (3) `org-koma-letter-headline-is-opening-maybe' is
  161. t the value opening will be implicit set as the headline title."
  162. :group 'org-export-koma-letter
  163. :type 'string)
  164. (defcustom org-koma-letter-closing nil
  165. "Koma-Letter's closing, as a string."
  166. :group 'org-export-koma-letter
  167. :type 'string)
  168. (defcustom org-koma-letter-prefer-special-headings nil
  169. "Non-nil means prefer headlines over keywords for TO and FROM."
  170. :group 'org-export-koma-letter
  171. :type 'boolean)
  172. (defcustom org-koma-letter-signature nil
  173. "Signature, as a string."
  174. :group 'org-export-koma-letter
  175. :type 'string)
  176. (defcustom org-koma-letter-subject-format t
  177. "Use the title as the subject of the letter.
  178. At this time the following values are allowed:
  179. `afteropening' Subject after opening
  180. `beforeopening' Subject before opening
  181. `centered' Subject centered
  182. `left' Subject left-justified
  183. `right' Subject right-justified
  184. `titled' Add title/description to subject
  185. `underlined' Set subject underlined
  186. `untitled' Do not add title/description to subject
  187. nil Do no insert a subject even if present
  188. t Use default options
  189. It can also be a string. Please refer to the KOMA-script
  190. manual (Table 4.16. in the English manual of 2012-07-22)."
  191. :type '(radio
  192. (const :tag "No export" nil)
  193. (const :tag "Default options" t)
  194. (set :tag "selection"
  195. (const 'afteropening)
  196. (const 'beforeopening)
  197. (const 'centered)
  198. (const 'left)
  199. (const 'right)
  200. (const 'underlined)
  201. (const 'titled)
  202. (const 'untitled))
  203. (string))
  204. :group 'org-export-koma-letter)
  205. (defcustom org-koma-letter-use-backaddress nil
  206. "Non-nil prints return address in small line above to address."
  207. :group 'org-export-koma-letter
  208. :type 'boolean)
  209. (defcustom org-koma-letter-use-foldmarks "true"
  210. "Configure appearence of fold marks.
  211. Accepts any valid value for the KOMA-Script `foldmarks' option.
  212. Use `foldmarks:true' to activate default fold marks or
  213. `foldmarks:nil' to deactivate fold marks."
  214. :group 'org-export-koma-letter
  215. :type 'string)
  216. (defcustom org-koma-letter-use-phone nil
  217. "Non-nil prints sender's phone number."
  218. :group 'org-export-koma-letter
  219. :type 'boolean)
  220. (defcustom org-koma-letter-use-email nil
  221. "Non-nil prints sender's email address."
  222. :group 'org-export-koma-letter
  223. :type 'boolean)
  224. (defcustom org-koma-letter-use-place t
  225. "Non-nil prints the letter's place next to the date."
  226. :group 'org-export-koma-letter
  227. :type 'boolean)
  228. (defcustom org-koma-letter-default-class nil
  229. "Default class for `org-koma-letter'.
  230. The value must be a member of `org-latex-classes'."
  231. :group 'org-export-koma-letter
  232. :type 'string)
  233. (defcustom org-koma-letter-headline-is-opening-maybe t
  234. "Non-nil means a headline may be used as an opening.
  235. A headline is only used if #+OPENING is not set. See also
  236. `org-koma-letter-opening'."
  237. :group 'org-export-koma-letter
  238. :type 'boolean)
  239. (defconst org-koma-letter-special-tags-in-letter '(to from)
  240. "Header tags related to the letter itself.")
  241. (defconst org-koma-letter-special-tags-after-closing '(ps encl cc)
  242. "Header tags to be inserted after closing.")
  243. (defconst org-koma-letter-special-tags-after-letter '(after_letter)
  244. "Header tags to be inserted after closing.")
  245. (defvar org-koma-letter-special-contents nil
  246. "Holds special content temporarily.")
  247. ;;; Define Back-End
  248. (org-export-define-derived-backend 'koma-letter 'latex
  249. :options-alist
  250. '((:lco "LCO" nil org-koma-letter-class-option-file)
  251. (:latex-class "LATEX_CLASS" nil (if org-koma-letter-default-class
  252. org-koma-letter-default-class
  253. org-latex-default-class) t)
  254. (:author "AUTHOR" nil (org-koma-letter--get-value org-koma-letter-author) t)
  255. (:author-changed-in-buffer-p "AUTHOR" nil nil t)
  256. (:from-address "FROM_ADDRESS" nil nil newline)
  257. (:phone-number "PHONE_NUMBER" nil org-koma-letter-phone-number)
  258. (:email "EMAIL" nil (org-koma-letter--get-value org-koma-letter-email) t)
  259. (:email-changed-in-buffer-p "EMAIL" nil nil t)
  260. (:to-address "TO_ADDRESS" nil nil newline)
  261. (:place "PLACE" nil org-koma-letter-place)
  262. (:opening "OPENING" nil org-koma-letter-opening)
  263. (:closing "CLOSING" nil org-koma-letter-closing)
  264. (:signature "SIGNATURE" nil org-koma-letter-signature newline)
  265. (:special-tags nil nil (append
  266. org-koma-letter-special-tags-in-letter
  267. org-koma-letter-special-tags-after-closing
  268. org-koma-letter-special-tags-after-letter))
  269. (:special-headings nil "special-headings"
  270. org-koma-letter-prefer-special-headings)
  271. (:with-after-closing nil "after-closing-order"
  272. org-koma-letter-special-tags-after-closing)
  273. (:with-after-letter nil "after-letter-order"
  274. org-koma-letter-special-tags-after-letter)
  275. (:with-backaddress nil "backaddress" org-koma-letter-use-backaddress)
  276. (:with-backaddress-changed-in-buffer-p nil "backaddress" nil)
  277. (:with-foldmarks nil "foldmarks" org-koma-letter-use-foldmarks)
  278. (:with-foldmarks-changed-in-buffer-p nil "foldmarks" "foldmarks-not-set")
  279. (:with-phone nil "phone" org-koma-letter-use-phone)
  280. (:with-phone-changed-in-buffer-p nil "phone" nil)
  281. (:with-email nil "email" org-koma-letter-use-email)
  282. (:with-email-changed-in-buffer-p nil "email" nil)
  283. (:with-place nil "place" org-koma-letter-use-place)
  284. (:with-subject nil "subject" org-koma-letter-subject-format))
  285. :translate-alist '((export-block . org-koma-letter-export-block)
  286. (export-snippet . org-koma-letter-export-snippet)
  287. (headline . org-koma-letter-headline)
  288. (keyword . org-koma-letter-keyword)
  289. (template . org-koma-letter-template))
  290. :menu-entry
  291. '(?k "Export with KOMA Scrlttr2"
  292. ((?L "As LaTeX buffer" org-koma-letter-export-as-latex)
  293. (?l "As LaTeX file" org-koma-letter-export-to-latex)
  294. (?p "As PDF file" org-koma-letter-export-to-pdf)
  295. (?o "As PDF file and open"
  296. (lambda (a s v b)
  297. (if a (org-koma-letter-export-to-pdf t s v b)
  298. (org-open-file (org-koma-letter-export-to-pdf nil s v b))))))))
  299. ;;; Initialize class function
  300. (defun org-koma-letter-plug-into-ox ()
  301. "Initialize `koma-letter' export back-end.
  302. Add a sparse `default-koma-letter' to `org-latex-classes' and set
  303. `org-koma-letter-default-class' to `default-koma-letter'."
  304. (let ((class "default-koma-letter"))
  305. (eval-after-load "ox-latex"
  306. `(unless (member ,class 'org-latex-classes)
  307. (add-to-list 'org-latex-classes
  308. `(,class
  309. "\\documentclass[11pt]{scrlttr2}") ())
  310. (setq org-koma-letter-default-class class)))))
  311. ;;; Helper functions
  312. (defun org-koma-letter-email ()
  313. "Return the current `user-mail-address'."
  314. user-mail-address)
  315. ;; The following is taken from/inspired by ox-grof.el
  316. ;; Thanks, Luis!
  317. (defun org-koma-letter--get-tagged-contents (key)
  318. "Get contents from a headline tagged with KEY.
  319. The contents is stored in `org-koma-letter-special-contents'."
  320. (cdr (assoc (org-koma-letter--get-value key)
  321. org-koma-letter-special-contents)))
  322. (defun org-koma-letter--get-value (value)
  323. "Turn value into a string whenever possible.
  324. Determines if VALUE is nil, a string, a function or a symbol and
  325. return a string or nil."
  326. (when value
  327. (cond ((stringp value) value)
  328. ((functionp value) (funcall value))
  329. ((symbolp value) (symbol-name value))
  330. (t value))))
  331. (defun org-koma-letter--special-contents-as-macro (a-list &optional keep-newlines no-tag)
  332. "Find members of `org-koma-letter-special-contents' corresponding to A-LIST.
  333. Return them as a string to be formatted.
  334. The function is used for inserting content of speciall headings
  335. such as PS.
  336. If KEEP-NEWLINES is t newlines will not be removed. If NO-TAG is
  337. is t the content in `org-koma-letter-special-contents' will not
  338. be wrapped in a macro named whatever the members of A-LIST are
  339. called."
  340. (let (output)
  341. (dolist (ac* a-list output)
  342. (let*
  343. ((ac (org-koma-letter--get-value ac*))
  344. (x (org-koma-letter--get-tagged-contents ac)))
  345. (when x
  346. (setq output
  347. (concat
  348. output "\n"
  349. ;; sometimes LaTeX complains about newlines
  350. ;; at the end or beginning of macros. Remove them.
  351. (org-koma-letter--format-string-as-macro
  352. (if keep-newlines x (org-koma-letter--normalize-string x))
  353. (unless no-tag ac)))))))))
  354. (defun org-koma-letter--format-string-as-macro (string &optional macro)
  355. "Format STRING as \"string\".
  356. If optional argument MACRO is provided, format it as
  357. \"\\macro{string}\" instead."
  358. (if macro
  359. (format "\\%s{%s}" macro string)
  360. (format "%s" string)))
  361. (defun org-koma-letter--normalize-string (string)
  362. "Remove new lines in the beginning and end of STRING."
  363. (replace-regexp-in-string "\\`[ \n\t]+\\|[\n\t ]*\\'" "" string))
  364. (defun org-koma-letter--determine-to-and-from (info key)
  365. "Given INFO determine KEY for the letter.
  366. KEY should be `to' or `from'.
  367. `ox-koma-letter' allows two ways to specify to and from. If both
  368. are present return the preferred one as determined by
  369. `org-koma-letter-prefer-special-headings'."
  370. (let* ((plist-alist '((from . :from-address)
  371. (to . :to-address)))
  372. (default-alist `((from ,org-koma-letter-from-address)
  373. (to "\\mbox{}")))
  374. (option-value (plist-get info (cdr-safe (assoc key plist-alist))))
  375. (head-value (org-koma-letter--get-tagged-contents key))
  376. (order (append
  377. (funcall
  378. (if (plist-get info :special-headings)
  379. 'reverse 'identity)
  380. `(,option-value ,head-value))
  381. (cdr-safe (assoc key default-alist))))
  382. tmp
  383. (adr (dolist (x order tmp)
  384. (when (and (not tmp) x)
  385. (setq tmp x)))))
  386. (when adr
  387. (replace-regexp-in-string
  388. "\n" "\\\\\\\\\n"
  389. (org-koma-letter--normalize-string adr)))))
  390. ;;; Transcode Functions
  391. ;;;; Export Block
  392. (defun org-koma-letter-export-block (export-block contents info)
  393. "Transcode an EXPORT-BLOCK element into KOMA Scrlttr2 code.
  394. CONTENTS is nil. INFO is a plist used as a communication
  395. channel."
  396. (when (member (org-element-property :type export-block) '("KOMA-LETTER" "LATEX"))
  397. (org-remove-indentation (org-element-property :value export-block))))
  398. ;;;; Export Snippet
  399. (defun org-koma-letter-export-snippet (export-snippet contents info)
  400. "Transcode an EXPORT-SNIPPET object into KOMA Scrlttr2 code.
  401. CONTENTS is nil. INFO is a plist used as a communication
  402. channel."
  403. (when (memq (org-export-snippet-backend export-snippet) '(latex koma-letter))
  404. (org-element-property :value export-snippet)))
  405. ;;;; Keyword
  406. (defun org-koma-letter-keyword (keyword contents info)
  407. "Transcode a KEYWORD element into KOMA Scrlttr2 code.
  408. CONTENTS is nil. INFO is a plist used as a communication
  409. channel."
  410. (let ((key (org-element-property :key keyword))
  411. (value (org-element-property :value keyword)))
  412. ;; Handle specifically BEAMER and TOC (headlines only) keywords.
  413. ;; Otherwise, fallback to `latex' back-end.
  414. (if (equal key "KOMA-LETTER") value
  415. (org-export-with-backend 'latex keyword contents info))))
  416. ;; Headline
  417. (defun org-koma-letter-headline (headline contents info)
  418. "Transcode a HEADLINE element from Org to LaTeX.
  419. CONTENTS holds the contents of the headline. INFO is a plist
  420. holding contextual information.
  421. Note that if a headline is tagged with a tag from
  422. `org-koma-letter-special-tags' it will not be exported, but
  423. stored in `org-koma-letter-special-contents' and included at the
  424. appropriate place."
  425. (let*
  426. ((tags (org-export-get-tags headline info))
  427. (tag* (car tags))
  428. (tag (when tag*
  429. (car (member-ignore-case
  430. tag*
  431. (mapcar 'symbol-name (plist-get info :special-tags)))))))
  432. (if tag
  433. (progn
  434. (push (cons tag contents)
  435. org-koma-letter-special-contents)
  436. nil)
  437. (unless (or (plist-get info :opening)
  438. (not org-koma-letter-headline-is-opening-maybe))
  439. (plist-put info :opening
  440. (org-export-data (org-element-property :title headline) info)))
  441. contents)))
  442. ;;;; Template
  443. (defun org-koma-letter-template (contents info)
  444. "Return complete document string after KOMA Scrlttr2 conversion.
  445. CONTENTS is the transcoded contents string. INFO is a plist
  446. holding export options."
  447. ;; FIXME: instead of setq'ing org-koma-letter-special-contents and
  448. ;; callying varioues stuff it might be nice to put a big let* around the templace
  449. ;; as in org-groff...
  450. (concat
  451. ;; Time-stamp.
  452. (and (plist-get info :time-stamp-file)
  453. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  454. ;; Document class and packages.
  455. (let* ((class (plist-get info :latex-class))
  456. (class-options (plist-get info :latex-class-options))
  457. (header (nth 1 (assoc class org-latex-classes)))
  458. (document-class-string
  459. (and (stringp header)
  460. (if (not class-options) header
  461. (replace-regexp-in-string
  462. "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
  463. class-options header t nil 1)))))
  464. (if (not document-class-string)
  465. (user-error "Unknown LaTeX class `%s'" class)
  466. (org-latex-guess-babel-language
  467. (org-latex-guess-inputenc
  468. (org-element-normalize-string
  469. (org-splice-latex-header
  470. document-class-string
  471. org-latex-default-packages-alist ; Defined in org.el.
  472. org-latex-packages-alist nil ; Defined in org.el.
  473. (concat (org-element-normalize-string (plist-get info :latex-header))
  474. (plist-get info :latex-header-extra)))))
  475. info)))
  476. (let ((lco (plist-get info :lco))
  477. (author (plist-get info :author))
  478. (author-set (plist-get info :author-changed-in-buffer-p))
  479. (from-address (org-koma-letter--determine-to-and-from info 'from))
  480. (phone-number (plist-get info :phone-number))
  481. (email (plist-get info :email))
  482. (email-set (plist-get info :email-changed-in-buffer-p))
  483. (signature (plist-get info :signature)))
  484. (concat
  485. ;; author or email not set in file: may be overridden by lco
  486. (unless author-set
  487. (when author (format "\\setkomavar{fromname}{%s}\n"
  488. (org-export-data author info))))
  489. (unless email-set
  490. (when email (format "\\setkomavar{fromemail}{%s}\n" email)))
  491. ;; Letter Class Option File
  492. (when lco
  493. (let ((lco-files (split-string lco " "))
  494. (lco-def ""))
  495. (dolist (lco-file lco-files lco-def)
  496. (setq lco-def (format "%s\\LoadLetterOption{%s}\n" lco-def lco-file)))
  497. lco-def))
  498. ;; Define "From" data.
  499. (when (and author author-set) (format "\\setkomavar{fromname}{%s}\n"
  500. (org-export-data author info)))
  501. (when from-address (format "\\setkomavar{fromaddress}{%s}\n" from-address))
  502. (when phone-number
  503. (format "\\setkomavar{fromphone}{%s}\n" phone-number))
  504. (when (and email email-set) (format "\\setkomavar{fromemail}{%s}\n" email))
  505. (when signature (format "\\setkomavar{signature}{%s}\n" signature))))
  506. ;; Date.
  507. (format "\\date{%s}\n" (org-export-data (org-export-get-date info) info))
  508. ;; Place
  509. (let ((with-place (plist-get info :with-place))
  510. (place (plist-get info :place)))
  511. (when (or place (not with-place))
  512. (format "\\setkomavar{place}{%s}\n" (if with-place place ""))))
  513. ;; KOMA options
  514. (let ((with-backaddress (plist-get info :with-backaddress))
  515. (with-backaddress-set (plist-get info :with-backaddress-changed-in-buffer-p))
  516. (with-foldmarks (plist-get info :with-foldmarks))
  517. (with-foldmarks-set
  518. (not (string-equal (plist-get info :with-foldmarks-changed-in-buffer-p)
  519. "foldmarks-not-set")))
  520. (with-phone (plist-get info :with-phone))
  521. (with-phone-set (plist-get info :with-phone-changed-in-buffer-p))
  522. (with-email (plist-get info :with-email))
  523. (with-email-set (plist-get info :with-email-changed-in-buffer-p)))
  524. (concat
  525. (when with-backaddress-set
  526. (format "\\KOMAoption{backaddress}{%s}\n" (if with-backaddress "true" "false")))
  527. (when with-foldmarks-set
  528. (format "\\KOMAoption{foldmarks}{%s}\n" (if with-foldmarks with-foldmarks "false")))
  529. (when with-phone-set
  530. (format "\\KOMAoption{fromphone}{%s}\n" (if with-phone "true" "false")))
  531. (when with-email-set
  532. (format "\\KOMAoption{fromemail}{%s}\n" (if with-email "true" "false")))))
  533. ;; Document start
  534. "\\begin{document}\n\n"
  535. ;; Subject
  536. (let* ((with-subject (plist-get info :with-subject))
  537. (subject-format (cond ((member with-subject '("true" "t" t)) nil)
  538. ((stringp with-subject) (list with-subject))
  539. ((symbolp with-subject)
  540. (list (symbol-name with-subject)))
  541. (t with-subject)))
  542. (subject (org-export-data (plist-get info :title) info))
  543. (l (length subject-format))
  544. (y ""))
  545. (concat
  546. (when (and with-subject subject-format)
  547. (concat
  548. "\\KOMAoption{subject}{"
  549. (apply 'format
  550. (dotimes (x l y)
  551. (setq y (concat (if (> x 0) "%s," "%s") y)))
  552. subject-format) "}\n"))
  553. (when (and subject with-subject)
  554. (format "\\setkomavar{subject}{%s}\n\n" subject))))
  555. ;; Letter start
  556. (format "\\begin{letter}{%%\n%s}\n\n"
  557. (org-koma-letter--determine-to-and-from info 'to))
  558. ;; Opening.
  559. (format "\\opening{%s}\n\n" (or (plist-get info :opening) ""))
  560. ;; Letter body.
  561. contents
  562. ;; Closing.
  563. (format "\n\\closing{%s}\n" (or (plist-get info :closing) ""))
  564. (org-koma-letter--special-contents-as-macro
  565. (plist-get info :with-after-closing))
  566. ;; Letter end.
  567. "\n\\end{letter}\n"
  568. (org-koma-letter--special-contents-as-macro
  569. (plist-get info :with-after-letter) t t)
  570. ;; Document end.
  571. "\n\\end{document}"
  572. ))
  573. ;;; Commands
  574. ;;;###autoload
  575. (defun org-koma-letter-export-as-latex
  576. (&optional async subtreep visible-only body-only ext-plist)
  577. "Export current buffer as a KOMA Scrlttr2 letter.
  578. If narrowing is active in the current buffer, only export its
  579. narrowed part.
  580. If a region is active, export that region.
  581. A non-nil optional argument ASYNC means the process should happen
  582. asynchronously. The resulting buffer should be accessible
  583. through the `org-export-stack' interface.
  584. When optional argument SUBTREEP is non-nil, export the sub-tree
  585. at point, extracting information from the headline properties
  586. first.
  587. When optional argument VISIBLE-ONLY is non-nil, don't export
  588. contents of hidden elements.
  589. When optional argument BODY-ONLY is non-nil, only write code
  590. between \"\\begin{letter}\" and \"\\end{letter}\".
  591. EXT-PLIST, when provided, is a proeprty list with external
  592. parameters overriding Org default settings, but still inferior to
  593. file-local settings.
  594. Export is done in a buffer named \"*Org KOMA-LETTER Export*\". It
  595. will be displayed if `org-export-show-temporary-export-buffer' is
  596. non-nil."
  597. (interactive)
  598. (let (org-koma-letter-special-contents)
  599. (org-export-to-buffer 'koma-letter "*Org KOMA-LETTER Export*"
  600. async subtreep visible-only body-only ext-plist
  601. (lambda () (LaTeX-mode)))))
  602. ;;;###autoload
  603. (defun org-koma-letter-export-to-latex
  604. (&optional async subtreep visible-only body-only ext-plist)
  605. "Export current buffer as a KOMA Scrlttr2 letter (tex).
  606. If narrowing is active in the current buffer, only export its
  607. narrowed part.
  608. If a region is active, export that region.
  609. A non-nil optional argument ASYNC means the process should happen
  610. asynchronously. The resulting file should be accessible through
  611. the `org-export-stack' interface.
  612. When optional argument SUBTREEP is non-nil, export the sub-tree
  613. at point, extracting information from the headline properties
  614. first.
  615. When optional argument VISIBLE-ONLY is non-nil, don't export
  616. contents of hidden elements.
  617. When optional argument BODY-ONLY is non-nil, only write code
  618. between \"\\begin{letter}\" and \"\\end{letter}\".
  619. EXT-PLIST, when provided, is a property list with external
  620. parameters overriding Org default settings, but still inferior to
  621. file-local settings.
  622. When optional argument PUB-DIR is set, use it as the publishing
  623. directory.
  624. Return output file's name."
  625. (interactive)
  626. (let ((outfile (org-export-output-file-name ".tex" subtreep))
  627. (org-koma-letter-special-contents))
  628. (org-export-to-file 'koma-letter outfile
  629. async subtreep visible-only body-only ext-plist)))
  630. ;;;###autoload
  631. (defun org-koma-letter-export-to-pdf
  632. (&optional async subtreep visible-only body-only ext-plist)
  633. "Export current buffer as a KOMA Scrlttr2 letter (pdf).
  634. If narrowing is active in the current buffer, only export its
  635. narrowed part.
  636. If a region is active, export that region.
  637. A non-nil optional argument ASYNC means the process should happen
  638. asynchronously. The resulting file should be accessible through
  639. the `org-export-stack' interface.
  640. When optional argument SUBTREEP is non-nil, export the sub-tree
  641. at point, extracting information from the headline properties
  642. first.
  643. When optional argument VISIBLE-ONLY is non-nil, don't export
  644. contents of hidden elements.
  645. When optional argument BODY-ONLY is non-nil, only write code
  646. between \"\\begin{letter}\" and \"\\end{letter}\".
  647. EXT-PLIST, when provided, is a property list with external
  648. parameters overriding Org default settings, but still inferior to
  649. file-local settings.
  650. Return PDF file's name."
  651. (interactive)
  652. (let ((file (org-export-output-file-name ".tex" subtreep))
  653. (org-koma-letter-special-contents))
  654. (org-export-to-file 'koma-letter file
  655. async subtreep visible-only body-only ext-plist
  656. (lambda (file) (org-latex-compile file)))))
  657. (provide 'ox-koma-letter)
  658. ;;; ox-koma-letter.el ends here