ox-koma-letter.el 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784
  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 ""
  146. "Sender's address, as a string."
  147. :group 'org-export-koma-letter
  148. :type 'string)
  149. (defcustom org-koma-letter-phone-number ""
  150. "Sender's phone number, as a string."
  151. :group 'org-export-koma-letter
  152. :type 'string)
  153. (defcustom org-koma-letter-place ""
  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 ""
  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 ""
  165. "Letter's closing, as a string."
  166. :group 'org-export-koma-letter
  167. :type 'string)
  168. (defcustom org-koma-letter-signature ""
  169. "Signature, as a string."
  170. :group 'org-export-koma-letter
  171. :type 'string)
  172. (defcustom org-koma-letter-prefer-special-headings nil
  173. "Non-nil means prefer headlines over keywords for TO and FROM."
  174. :group 'org-export-koma-letter
  175. :type 'boolean)
  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. Please refer to the KOMA-script manual (Table 4.16. in the
  190. 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. :group 'org-export-koma-letter)
  204. (defcustom org-koma-letter-use-backaddress nil
  205. "Non-nil prints return address in small line above to address."
  206. :group 'org-export-koma-letter
  207. :type 'boolean)
  208. (defcustom org-koma-letter-use-foldmarks t
  209. "Configure appearence of fold marks.
  210. Accepts any valid value for the KOMA-Script `foldmarks' option.
  211. This option can also be set with the OPTIONS keyword, e.g.:
  212. foldmarks:\"blmt\"
  213. nil and t are also accepted, as shortcuts for, respectively,
  214. \"false\" and \"true\", i.e. to deactivate folding marks or
  215. activate default ones."
  216. :group 'org-export-koma-letter
  217. :type '(choice
  218. (const :tag "Activate default folding marks" t)
  219. (const :tag "Deactivate folding marks" nil)
  220. (string :tag "Choose configuration flags")))
  221. (defcustom org-koma-letter-use-phone nil
  222. "Non-nil prints sender's phone number."
  223. :group 'org-export-koma-letter
  224. :type 'boolean)
  225. (defcustom org-koma-letter-use-email nil
  226. "Non-nil prints sender's email address."
  227. :group 'org-export-koma-letter
  228. :type 'boolean)
  229. (defcustom org-koma-letter-use-place t
  230. "Non-nil prints the letter's place next to the date."
  231. :group 'org-export-koma-letter
  232. :type 'boolean)
  233. (defcustom org-koma-letter-default-class ""
  234. "Default class for `org-koma-letter'.
  235. The value must be a member of `org-latex-classes'."
  236. :group 'org-export-koma-letter
  237. :type 'string)
  238. (defcustom org-koma-letter-headline-is-opening-maybe t
  239. "Non-nil means a headline may be used as an opening.
  240. A headline is only used if #+OPENING is not set. See also
  241. `org-koma-letter-opening'."
  242. :group 'org-export-koma-letter
  243. :type 'boolean)
  244. (defconst org-koma-letter-special-tags-in-letter '(to from)
  245. "Header tags related to the letter itself.")
  246. (defconst org-koma-letter-special-tags-after-closing '(ps encl cc)
  247. "Header tags to be inserted after closing.")
  248. (defconst org-koma-letter-special-tags-after-letter '(after_letter)
  249. "Header tags to be inserted after closing.")
  250. (defvar org-koma-letter-special-contents nil
  251. "Holds special content temporarily.")
  252. ;;; Define Back-End
  253. (org-export-define-derived-backend 'koma-letter 'latex
  254. :options-alist
  255. '((:author "AUTHOR" nil (org-koma-letter--get-value org-koma-letter-author) t)
  256. (:closing "CLOSING" nil org-koma-letter-closing)
  257. (:email "EMAIL" nil (org-koma-letter--get-value org-koma-letter-email) t)
  258. (:from-address "FROM_ADDRESS" nil nil newline)
  259. (:latex-class "LATEX_CLASS" nil
  260. (or org-koma-letter-default-class org-latex-default-class)
  261. t)
  262. (:lco "LCO" nil org-koma-letter-class-option-file)
  263. (:opening "OPENING" nil org-koma-letter-opening)
  264. (:phone-number "PHONE_NUMBER" nil org-koma-letter-phone-number)
  265. (:place "PLACE" nil org-koma-letter-place)
  266. (:signature "SIGNATURE" nil org-koma-letter-signature newline)
  267. (:to-address "TO_ADDRESS" nil nil newline)
  268. (:special-headings nil "special-headings"
  269. org-koma-letter-prefer-special-headings)
  270. (:special-tags nil nil (append
  271. org-koma-letter-special-tags-in-letter
  272. org-koma-letter-special-tags-after-closing
  273. org-koma-letter-special-tags-after-letter))
  274. (:with-after-closing nil "after-closing-order"
  275. org-koma-letter-special-tags-after-closing)
  276. (:with-after-letter nil "after-letter-order"
  277. org-koma-letter-special-tags-after-letter)
  278. (:with-backaddress nil "backaddress" org-koma-letter-use-backaddress)
  279. (:with-email nil "email" org-koma-letter-use-email)
  280. (:with-foldmarks nil "foldmarks" org-koma-letter-use-foldmarks)
  281. (:with-phone nil "phone" org-koma-letter-use-phone)
  282. (:with-place nil "place" org-koma-letter-use-place)
  283. (:with-subject nil "subject" org-koma-letter-subject-format)
  284. ;; Special properties non-nil when a setting happened in buffer.
  285. ;; They are used to prioritize in-buffer settings over "lco"
  286. ;; files. See `org-koma-letter-template'.
  287. (:inbuffer-author "AUTHOR" nil 'unset)
  288. (:inbuffer-email "EMAIL" nil 'unset)
  289. (:inbuffer-phone-number "PHONE_NUMBER" nil 'koma-letter:empty)
  290. (:inbuffer-place "PLACE" nil 'koma-letter:empty)
  291. (:inbuffer-signature "SIGNATURE" nil 'koma-letter:empty)
  292. (:inbuffer-with-backaddress nil "backaddress" 'koma-letter:empty)
  293. (:inbuffer-with-email nil "email" 'koma-letter:empty)
  294. (:inbuffer-with-foldmarks nil "foldmarks" 'koma-letter:empty)
  295. (:inbuffer-with-phone nil "phone" 'koma-letter:empty))
  296. :translate-alist '((export-block . org-koma-letter-export-block)
  297. (export-snippet . org-koma-letter-export-snippet)
  298. (headline . org-koma-letter-headline)
  299. (keyword . org-koma-letter-keyword)
  300. (template . org-koma-letter-template))
  301. :menu-entry
  302. '(?k "Export with KOMA Scrlttr2"
  303. ((?L "As LaTeX buffer" org-koma-letter-export-as-latex)
  304. (?l "As LaTeX file" org-koma-letter-export-to-latex)
  305. (?p "As PDF file" org-koma-letter-export-to-pdf)
  306. (?o "As PDF file and open"
  307. (lambda (a s v b)
  308. (if a (org-koma-letter-export-to-pdf t s v b)
  309. (org-open-file (org-koma-letter-export-to-pdf nil s v b))))))))
  310. ;;; Initialize class function
  311. (defun org-koma-letter-plug-into-ox ()
  312. "Initialize `koma-letter' export back-end.
  313. Add a sparse `default-koma-letter' to `org-latex-classes' and set
  314. `org-koma-letter-default-class' to `default-koma-letter'."
  315. (let ((class "default-koma-letter"))
  316. (eval-after-load "ox-latex"
  317. `(unless (member ,class 'org-latex-classes)
  318. (add-to-list 'org-latex-classes
  319. `(,class
  320. "\\documentclass[11pt]{scrlttr2}") ())
  321. (setq org-koma-letter-default-class class)))))
  322. ;;; Helper functions
  323. (defun org-koma-letter-email ()
  324. "Return the current `user-mail-address'."
  325. user-mail-address)
  326. ;; The following is taken from/inspired by ox-grof.el
  327. ;; Thanks, Luis!
  328. (defun org-koma-letter--get-tagged-contents (key)
  329. "Get contents from a headline tagged with KEY.
  330. The contents is stored in `org-koma-letter-special-contents'."
  331. (cdr (assoc (org-koma-letter--get-value key)
  332. org-koma-letter-special-contents)))
  333. (defun org-koma-letter--get-value (value)
  334. "Turn value into a string whenever possible.
  335. Determines if VALUE is nil, a string, a function or a symbol and
  336. return a string or nil."
  337. (when value
  338. (cond ((stringp value) value)
  339. ((functionp value) (funcall value))
  340. ((symbolp value) (symbol-name value))
  341. (t value))))
  342. (defun org-koma-letter--special-contents-as-macro (a-list &optional keep-newlines no-tag)
  343. "Find members of `org-koma-letter-special-contents' corresponding to A-LIST.
  344. Return them as a string to be formatted.
  345. The function is used for inserting content of speciall headings
  346. such as PS.
  347. If KEEP-NEWLINES is t newlines will not be removed. If NO-TAG is
  348. is t the content in `org-koma-letter-special-contents' will not
  349. be wrapped in a macro named whatever the members of A-LIST are
  350. called."
  351. (let (output)
  352. (dolist (ac* a-list output)
  353. (let*
  354. ((ac (org-koma-letter--get-value ac*))
  355. (x (org-koma-letter--get-tagged-contents ac)))
  356. (when x
  357. (setq output
  358. (concat
  359. output "\n"
  360. ;; sometimes LaTeX complains about newlines
  361. ;; at the end or beginning of macros. Remove them.
  362. (org-koma-letter--format-string-as-macro
  363. (if keep-newlines x (org-koma-letter--normalize-string x))
  364. (unless no-tag ac)))))))))
  365. (defun org-koma-letter--format-string-as-macro (string &optional macro)
  366. "Format STRING as \"string\".
  367. If optional argument MACRO is provided, format it as
  368. \"\\macro{string}\" instead."
  369. (if macro
  370. (format "\\%s{%s}" macro string)
  371. (format "%s" string)))
  372. (defun org-koma-letter--normalize-string (string)
  373. "Remove new lines in the beginning and end of STRING."
  374. (replace-regexp-in-string "\\`[ \n\t]+\\|[\n\t ]*\\'" "" string))
  375. (defun org-koma-letter--determine-to-and-from (info key)
  376. "Given INFO determine KEY for the letter.
  377. KEY should be `to' or `from'.
  378. `ox-koma-letter' allows two ways to specify to and from. If both
  379. are present return the preferred one as determined by
  380. `org-koma-letter-prefer-special-headings'."
  381. (let* ((plist-alist '((from . :from-address)
  382. (to . :to-address)))
  383. (default-alist `((from ,org-koma-letter-from-address)
  384. (to "\\mbox{}")))
  385. (option-value (plist-get info (cdr-safe (assoc key plist-alist))))
  386. (head-value (org-koma-letter--get-tagged-contents key))
  387. (order (append
  388. (funcall
  389. (if (plist-get info :special-headings)
  390. 'reverse 'identity)
  391. `(,option-value ,head-value))
  392. (cdr-safe (assoc key default-alist))))
  393. tmp
  394. (adr (dolist (x order tmp)
  395. (when (and (not tmp) x)
  396. (setq tmp x)))))
  397. (when adr
  398. (replace-regexp-in-string
  399. "\n" "\\\\\\\\\n"
  400. (org-koma-letter--normalize-string adr)))))
  401. ;;; Transcode Functions
  402. ;;;; Export Block
  403. (defun org-koma-letter-export-block (export-block contents info)
  404. "Transcode an EXPORT-BLOCK element into KOMA Scrlttr2 code.
  405. CONTENTS is nil. INFO is a plist used as a communication
  406. channel."
  407. (when (member (org-element-property :type export-block) '("KOMA-LETTER" "LATEX"))
  408. (org-remove-indentation (org-element-property :value export-block))))
  409. ;;;; Export Snippet
  410. (defun org-koma-letter-export-snippet (export-snippet contents info)
  411. "Transcode an EXPORT-SNIPPET object into KOMA Scrlttr2 code.
  412. CONTENTS is nil. INFO is a plist used as a communication
  413. channel."
  414. (when (memq (org-export-snippet-backend export-snippet) '(latex koma-letter))
  415. (org-element-property :value export-snippet)))
  416. ;;;; Keyword
  417. (defun org-koma-letter-keyword (keyword contents info)
  418. "Transcode a KEYWORD element into KOMA Scrlttr2 code.
  419. CONTENTS is nil. INFO is a plist used as a communication
  420. channel."
  421. (let ((key (org-element-property :key keyword))
  422. (value (org-element-property :value keyword)))
  423. ;; Handle specifically BEAMER and TOC (headlines only) keywords.
  424. ;; Otherwise, fallback to `latex' back-end.
  425. (if (equal key "KOMA-LETTER") value
  426. (org-export-with-backend 'latex keyword contents info))))
  427. ;; Headline
  428. (defun org-koma-letter-headline (headline contents info)
  429. "Transcode a HEADLINE element from Org to LaTeX.
  430. CONTENTS holds the contents of the headline. INFO is a plist
  431. holding contextual information.
  432. Note that if a headline is tagged with a tag from
  433. `org-koma-letter-special-tags' it will not be exported, but
  434. stored in `org-koma-letter-special-contents' and included at the
  435. appropriate place."
  436. (let*
  437. ((tags (org-export-get-tags headline info))
  438. (tag* (car tags))
  439. (tag (when tag*
  440. (car (member-ignore-case
  441. tag*
  442. (mapcar 'symbol-name (plist-get info :special-tags)))))))
  443. (if tag
  444. (progn
  445. (push (cons tag contents)
  446. org-koma-letter-special-contents)
  447. nil)
  448. (unless (or (plist-get info :opening)
  449. (not org-koma-letter-headline-is-opening-maybe))
  450. (plist-put info :opening
  451. (org-export-data (org-element-property :title headline) info)))
  452. contents)))
  453. ;;;; Template
  454. (defun org-koma-letter-template (contents info)
  455. "Return complete document string after KOMA Scrlttr2 conversion.
  456. CONTENTS is the transcoded contents string. INFO is a plist
  457. holding export options."
  458. (concat
  459. ;; Time-stamp.
  460. (and (plist-get info :time-stamp-file)
  461. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  462. ;; Document class and packages.
  463. (let* ((class (plist-get info :latex-class))
  464. (class-options (plist-get info :latex-class-options))
  465. (header (nth 1 (assoc class org-latex-classes)))
  466. (document-class-string
  467. (and (stringp header)
  468. (if (not class-options) header
  469. (replace-regexp-in-string
  470. "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
  471. class-options header t nil 1)))))
  472. (if (not document-class-string)
  473. (user-error "Unknown LaTeX class `%s'" class)
  474. (org-latex-guess-babel-language
  475. (org-latex-guess-inputenc
  476. (org-element-normalize-string
  477. (org-splice-latex-header
  478. document-class-string
  479. org-latex-default-packages-alist ; Defined in org.el.
  480. org-latex-packages-alist nil ; Defined in org.el.
  481. (concat (org-element-normalize-string (plist-get info :latex-header))
  482. (plist-get info :latex-header-extra)))))
  483. info)))
  484. ;; Settings. They can come from three locations: global variables,
  485. ;; LCO files and in-buffer settings. We prioritize them in that
  486. ;; order.
  487. (org-koma-letter--build-settings 'global info)
  488. (mapconcat #'(lambda (file) (format "\\LoadLetterOption{%s}\n" file))
  489. (org-split-string (or (plist-get info :lco) "") " ")
  490. "")
  491. (org-koma-letter--build-settings 'buffer info)
  492. ;; From address.
  493. (let ((from-address (org-koma-letter--determine-to-and-from info 'from)))
  494. (and from-address (format "\\setkomavar{fromaddress}{%s}\n" from-address)))
  495. ;; Date.
  496. (format "\\date{%s}\n" (org-export-data (org-export-get-date info) info))
  497. ;; Document start
  498. "\\begin{document}\n\n"
  499. ;; Subject
  500. (let* ((with-subject (plist-get info :with-subject))
  501. (subject-format (cond ((member with-subject '("true" "t" t)) nil)
  502. ((stringp with-subject) (list with-subject))
  503. ((symbolp with-subject)
  504. (list (symbol-name with-subject)))
  505. (t with-subject)))
  506. (subject (org-export-data (plist-get info :title) info))
  507. (l (length subject-format))
  508. (y ""))
  509. (concat
  510. (when (and with-subject subject-format)
  511. (concat
  512. "\\KOMAoption{subject}{"
  513. (apply 'format
  514. (dotimes (x l y)
  515. (setq y (concat (if (> x 0) "%s," "%s") y)))
  516. subject-format) "}\n"))
  517. (when (and subject with-subject)
  518. (format "\\setkomavar{subject}{%s}\n\n" subject))))
  519. ;; Letter start.
  520. (format "\\begin{letter}{%%\n%s}\n\n"
  521. (org-koma-letter--determine-to-and-from info 'to))
  522. ;; Opening.
  523. (format "\\opening{%s}\n\n" (plist-get info :opening))
  524. ;; Letter body.
  525. contents
  526. ;; Closing.
  527. (format "\n\\closing{%s}\n" (plist-get info :closing))
  528. (org-koma-letter--special-contents-as-macro
  529. (plist-get info :with-after-closing))
  530. ;; Letter end.
  531. "\n\\end{letter}\n"
  532. (org-koma-letter--special-contents-as-macro
  533. (plist-get info :with-after-letter) t t)
  534. ;; Document end.
  535. "\n\\end{document}"))
  536. (defun org-koma-letter--build-settings (type info)
  537. "Build settings string according to type.
  538. Type is either `global' or `buffer'. INFO is a plist used as
  539. a communication channel."
  540. (let ((check-validity
  541. (function
  542. ;; Non-nil value when SETTING is a valid TYPE setting.
  543. (lambda (setting)
  544. (let ((property (intern (format ":inbuffer-%s" setting))))
  545. (if (eq type 'global)
  546. (eq (plist-get info property) 'koma-letter:empty)
  547. (not (eq (plist-get info property) 'koma-letter:empty))))))))
  548. (concat
  549. ;; Variables.
  550. (let ((author (plist-get info :author)))
  551. (and author
  552. (funcall check-validity 'author)
  553. (format "\\setkomavar{fromname}{%s}\n"
  554. (org-export-data author info))))
  555. (let ((email (plist-get info :email)))
  556. (and email
  557. (funcall check-validity 'email)
  558. (format "\\setkomavar{fromemail}{%s}\n" email)))
  559. (let ((phone-number (plist-get info :phone-number)))
  560. (and (org-string-nw-p phone-number)
  561. (funcall check-validity 'phone-number)
  562. (format "\\setkomavar{fromphone}{%s}\n" phone-number)))
  563. (let ((signature (plist-get info :signature)))
  564. (and (org-string-nw-p signature)
  565. (funcall check-validity 'signature)
  566. (format "\\setkomavar{signature}{%s}\n" signature)))
  567. ;; Options.
  568. (and (funcall check-validity 'with-backaddress)
  569. (format "\\KOMAoption{backaddress}{%s}\n"
  570. (if (plist-get info :with-backaddress) "true" "false")))
  571. (and (funcall check-validity 'with-email)
  572. (format "\\KOMAoption{fromemail}{%s}\n"
  573. (if (plist-get info :with-email) "true" "false")))
  574. (and (funcall check-validity 'with-phone)
  575. (format "\\KOMAoption{fromphone}{%s}\n"
  576. (if (plist-get info :with-phone) "true" "false")))
  577. ;; Special cases: place and foldmarks.
  578. (and (funcall check-validity 'place)
  579. (format "\\setkomavar{place}{%s}\n"
  580. (if (plist-get info :with-place) (plist-get info :place) "")))
  581. (and (funcall check-validity 'with-foldmarks)
  582. (let ((foldmarks (plist-get info :with-foldmarks)))
  583. (cond
  584. ((symbolp foldmarks)
  585. (format "\\KOMAoptions{foldmarks=%s}\n"
  586. (if foldmarks "true" "false")))
  587. ((member foldmarks '("true" "on" "yes" "false" "off" "no"))
  588. (format "\\KOMAoptions{foldmarks=%s}\n" foldmarks))
  589. (t (format "\\KOMAoptions{foldmarks=true,foldmarks=%s}\n"
  590. foldmarks))))))))
  591. ;;; Commands
  592. ;;;###autoload
  593. (defun org-koma-letter-export-as-latex
  594. (&optional async subtreep visible-only body-only ext-plist)
  595. "Export current buffer as a KOMA Scrlttr2 letter.
  596. If narrowing is active in the current buffer, only export its
  597. narrowed part.
  598. If a region is active, export that region.
  599. A non-nil optional argument ASYNC means the process should happen
  600. asynchronously. The resulting buffer should be accessible
  601. through the `org-export-stack' interface.
  602. When optional argument SUBTREEP is non-nil, export the sub-tree
  603. at point, extracting information from the headline properties
  604. first.
  605. When optional argument VISIBLE-ONLY is non-nil, don't export
  606. contents of hidden elements.
  607. When optional argument BODY-ONLY is non-nil, only write code
  608. between \"\\begin{letter}\" and \"\\end{letter}\".
  609. EXT-PLIST, when provided, is a proeprty list with external
  610. parameters overriding Org default settings, but still inferior to
  611. file-local settings.
  612. Export is done in a buffer named \"*Org KOMA-LETTER Export*\". It
  613. will be displayed if `org-export-show-temporary-export-buffer' is
  614. non-nil."
  615. (interactive)
  616. (let (org-koma-letter-special-contents)
  617. (org-export-to-buffer 'koma-letter "*Org KOMA-LETTER Export*"
  618. async subtreep visible-only body-only ext-plist
  619. (lambda () (LaTeX-mode)))))
  620. ;;;###autoload
  621. (defun org-koma-letter-export-to-latex
  622. (&optional async subtreep visible-only body-only ext-plist)
  623. "Export current buffer as a KOMA Scrlttr2 letter (tex).
  624. If narrowing is active in the current buffer, only export its
  625. narrowed part.
  626. If a region is active, export that region.
  627. A non-nil optional argument ASYNC means the process should happen
  628. asynchronously. The resulting file should be accessible through
  629. the `org-export-stack' interface.
  630. When optional argument SUBTREEP is non-nil, export the sub-tree
  631. at point, extracting information from the headline properties
  632. first.
  633. When optional argument VISIBLE-ONLY is non-nil, don't export
  634. contents of hidden elements.
  635. When optional argument BODY-ONLY is non-nil, only write code
  636. between \"\\begin{letter}\" and \"\\end{letter}\".
  637. EXT-PLIST, when provided, is a property list with external
  638. parameters overriding Org default settings, but still inferior to
  639. file-local settings.
  640. When optional argument PUB-DIR is set, use it as the publishing
  641. directory.
  642. Return output file's name."
  643. (interactive)
  644. (let ((outfile (org-export-output-file-name ".tex" subtreep))
  645. (org-koma-letter-special-contents))
  646. (org-export-to-file 'koma-letter outfile
  647. async subtreep visible-only body-only ext-plist)))
  648. ;;;###autoload
  649. (defun org-koma-letter-export-to-pdf
  650. (&optional async subtreep visible-only body-only ext-plist)
  651. "Export current buffer as a KOMA Scrlttr2 letter (pdf).
  652. If narrowing is active in the current buffer, only export its
  653. narrowed part.
  654. If a region is active, export that region.
  655. A non-nil optional argument ASYNC means the process should happen
  656. asynchronously. The resulting file should be accessible through
  657. the `org-export-stack' interface.
  658. When optional argument SUBTREEP is non-nil, export the sub-tree
  659. at point, extracting information from the headline properties
  660. first.
  661. When optional argument VISIBLE-ONLY is non-nil, don't export
  662. contents of hidden elements.
  663. When optional argument BODY-ONLY is non-nil, only write code
  664. between \"\\begin{letter}\" and \"\\end{letter}\".
  665. EXT-PLIST, when provided, is a property list with external
  666. parameters overriding Org default settings, but still inferior to
  667. file-local settings.
  668. Return PDF file's name."
  669. (interactive)
  670. (let ((file (org-export-output-file-name ".tex" subtreep))
  671. (org-koma-letter-special-contents))
  672. (org-export-to-file 'koma-letter file
  673. async subtreep visible-only body-only ext-plist
  674. (lambda (file) (org-latex-compile file)))))
  675. (provide 'ox-koma-letter)
  676. ;;; ox-koma-letter.el ends here