ox-koma-letter.el 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
  1. ;;; ox-koma-letter.el --- KOMA Scrlttr2 Back-End for Org Export Engine
  2. ;; Copyright (C) 2007-2015 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. ;; - 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.
  65. ;; (See also `org-koma-letter-author'),
  66. ;; - EMAIL: Same as AUTHOR. (see also `org-koma-letter-email'),
  67. ;;
  68. ;; Headlines are in general ignored. However, headlines with special
  69. ;; tags can be used for specified contents like postscript (ps),
  70. ;; carbon copy (cc), enclosures (encl) and code to be inserted after
  71. ;; \end{letter} (after_letter). Specials tags are defined in
  72. ;; `org-koma-letter-special-tags-after-closing' and
  73. ;; `org-koma-letter-special-tags-after-letter'. Currently members of
  74. ;; `org-koma-letter-special-tags-after-closing' used as macros and the
  75. ;; content of the headline is the argument.
  76. ;;
  77. ;; Headlines with two and from may also be used rather than the
  78. ;; keyword approach described above. If both a keyword and a headline
  79. ;; with information is present precedence is determined by
  80. ;; `org-koma-letter-prefer-special-headings'.
  81. ;;
  82. ;; You need an appropriate association in `org-latex-classes' in order
  83. ;; to use the KOMA Scrlttr2 class. By default, a sparse scrlttr2
  84. ;; class is provided: "default-koma-letter". You can also add you own
  85. ;; letter class. For instance:
  86. ;;
  87. ;; (add-to-list 'org-latex-classes
  88. ;; '("my-letter"
  89. ;; "\\documentclass\[%
  90. ;; DIV=14,
  91. ;; fontsize=12pt,
  92. ;; parskip=half,
  93. ;; subject=titled,
  94. ;; backaddress=false,
  95. ;; fromalign=left,
  96. ;; fromemail=true,
  97. ;; fromphone=true\]\{scrlttr2\}
  98. ;; \[DEFAULT-PACKAGES]
  99. ;; \[PACKAGES]
  100. ;; \[EXTRA]"))
  101. ;;
  102. ;; Then, in your Org document, be sure to require the proper class
  103. ;; with:
  104. ;;
  105. ;; #+LATEX_CLASS: my-letter
  106. ;;
  107. ;; Or by setting `org-koma-letter-default-class'.
  108. ;;
  109. ;; You may have to load (LaTeX) Babel as well, e.g., by adding
  110. ;; it to `org-latex-packages-alist',
  111. ;;
  112. ;; (add-to-list 'org-latex-packages-alist '("AUTO" "babel" nil))
  113. ;;; Code:
  114. (require 'ox-latex)
  115. ;; Install a default letter class.
  116. (unless (assoc "default-koma-letter" org-latex-classes)
  117. (add-to-list 'org-latex-classes
  118. '("default-koma-letter" "\\documentclass[11pt]{scrlttr2}")))
  119. ;;; User-Configurable Variables
  120. (defgroup org-export-koma-letter nil
  121. "Options for exporting to KOMA scrlttr2 class in LaTeX export."
  122. :tag "Org Koma-Letter"
  123. :group 'org-export)
  124. (defcustom org-koma-letter-class-option-file "NF"
  125. "Letter Class Option File.
  126. This option can also be set with the LCO keyword."
  127. :group 'org-export-koma-letter
  128. :type 'string)
  129. (defcustom org-koma-letter-author 'user-full-name
  130. "Sender's name.
  131. This variable defaults to calling the function `user-full-name'
  132. which just returns the current function `user-full-name'.
  133. Alternatively a string, nil or a function may be given.
  134. Functions must return a string.
  135. This option can also be set with the AUTHOR keyword."
  136. :group 'org-export-koma-letter
  137. :type '(radio (function-item user-full-name)
  138. (string)
  139. (function)
  140. (const :tag "Do not export author" nil)))
  141. (defcustom org-koma-letter-email 'org-koma-letter-email
  142. "Sender's email address.
  143. This variable defaults to the value `org-koma-letter-email' which
  144. returns `user-mail-address'. Alternatively a string, nil or
  145. a function may be given. Functions must return a string.
  146. This option can also be set with the EMAIL keyword."
  147. :group 'org-export-koma-letter
  148. :type '(radio (function-item org-koma-letter-email)
  149. (string)
  150. (function)
  151. (const :tag "Do not export email" nil)))
  152. (defcustom org-koma-letter-from-address ""
  153. "Sender's address, as a string.
  154. This option can also be set with one or more FROM_ADDRESS
  155. keywords."
  156. :group 'org-export-koma-letter
  157. :type 'string)
  158. (defcustom org-koma-letter-phone-number ""
  159. "Sender's phone number, as a string.
  160. This option can also be set with the PHONE_NUMBER keyword."
  161. :group 'org-export-koma-letter
  162. :type 'string)
  163. (defcustom org-koma-letter-place ""
  164. "Place from which the letter is sent, as a string.
  165. This option can also be set with the PLACE keyword."
  166. :group 'org-export-koma-letter
  167. :type 'string)
  168. (defcustom org-koma-letter-opening ""
  169. "Letter's opening, as a string.
  170. This option can also be set with the OPENING keyword. Moreover,
  171. when:
  172. (1) this value is the empty string;
  173. (2) there's no OPENING keyword or it is empty;
  174. (3) `org-koma-letter-headline-is-opening-maybe' is non-nil;
  175. (4) the letter contains a headline without a special
  176. tag (e.g. \"to\" or \"ps\");
  177. then the opening will be implicitly set as the headline title."
  178. :group 'org-export-koma-letter
  179. :type 'string)
  180. (defcustom org-koma-letter-closing ""
  181. "Letter's closing, as a string.
  182. This option can also be set with the CLOSING keyword."
  183. :group 'org-export-koma-letter
  184. :type 'string)
  185. (defcustom org-koma-letter-signature ""
  186. "Signature, as a string.
  187. This option can also be set with the SIGNATURE keyword."
  188. :group 'org-export-koma-letter
  189. :type 'string)
  190. (defcustom org-koma-letter-prefer-special-headings nil
  191. "Non-nil means prefer headlines over keywords for TO and FROM.
  192. This option can also be set with the OPTIONS keyword, e.g.:
  193. \"special-headings:t\"."
  194. :group 'org-export-koma-letter
  195. :type 'boolean)
  196. (defcustom org-koma-letter-subject-format t
  197. "Non-nil means include the subject.
  198. Support formatting options.
  199. When t, insert a subject using default options. When nil, do not
  200. insert a subject at all. It can also be a list of symbols among
  201. the following ones:
  202. `afteropening' Subject after opening
  203. `beforeopening' Subject before opening
  204. `centered' Subject centered
  205. `left' Subject left-justified
  206. `right' Subject right-justified
  207. `titled' Add title/description to subject
  208. `underlined' Set subject underlined
  209. `untitled' Do not add title/description to subject
  210. Please refer to the KOMA-script manual (Table 4.16. in the
  211. English manual of 2012-07-22).
  212. This option can also be set with the OPTIONS keyword, e.g.:
  213. \"subject:(underlined centered)\"."
  214. :type
  215. '(choice
  216. (const :tag "No export" nil)
  217. (const :tag "Default options" t)
  218. (set :tag "Configure options"
  219. (const :tag "Subject after opening" afteropening)
  220. (const :tag "Subject before opening" beforeopening)
  221. (const :tag "Subject centered" centered)
  222. (const :tag "Subject left-justified" left)
  223. (const :tag "Subject right-justified" right)
  224. (const :tag "Add title or description to subject" underlined)
  225. (const :tag "Set subject underlined" titled)
  226. (const :tag "Do not add title or description to subject" untitled)))
  227. :group 'org-export-koma-letter)
  228. (defcustom org-koma-letter-use-backaddress nil
  229. "Non-nil prints return address in line above to address.
  230. This option can also be set with the OPTIONS keyword, e.g.:
  231. \"backaddress:t\"."
  232. :group 'org-export-koma-letter
  233. :type 'boolean)
  234. (defcustom org-koma-letter-use-foldmarks t
  235. "Configure appearance of folding marks.
  236. When t, activate default folding marks. When nil, do not insert
  237. folding marks at all. It can also be a list of symbols among the
  238. following ones:
  239. `B' Activate upper horizontal mark on left paper edge
  240. `b' Deactivate upper horizontal mark on left paper edge
  241. `H' Activate all horizontal marks on left paper edge
  242. `h' Deactivate all horizontal marks on left paper edge
  243. `L' Activate left vertical mark on upper paper edge
  244. `l' Deactivate left vertical mark on upper paper edge
  245. `M' Activate middle horizontal mark on left paper edge
  246. `m' Deactivate middle horizontal mark on left paper edge
  247. `P' Activate punch or center mark on left paper edge
  248. `p' Deactivate punch or center mark on left paper edge
  249. `T' Activate lower horizontal mark on left paper edge
  250. `t' Deactivate lower horizontal mark on left paper edge
  251. `V' Activate all vertical marks on upper paper edge
  252. `v' Deactivate all vertical marks on upper paper edge
  253. This option can also be set with the OPTIONS keyword, e.g.:
  254. \"foldmarks:(b l m t)\"."
  255. :group 'org-export-koma-letter
  256. :type '(choice
  257. (const :tag "Activate default folding marks" t)
  258. (const :tag "Deactivate folding marks" nil)
  259. (set
  260. :tag "Configure folding marks"
  261. (const :tag "Activate upper horizontal mark on left paper edge" B)
  262. (const :tag "Deactivate upper horizontal mark on left paper edge" b)
  263. (const :tag "Activate all horizontal marks on left paper edge" H)
  264. (const :tag "Deactivate all horizontal marks on left paper edge" h)
  265. (const :tag "Activate left vertical mark on upper paper edge" L)
  266. (const :tag "Deactivate left vertical mark on upper paper edge" l)
  267. (const :tag "Activate middle horizontal mark on left paper edge" M)
  268. (const :tag "Deactivate middle horizontal mark on left paper edge" m)
  269. (const :tag "Activate punch or center mark on left paper edge" P)
  270. (const :tag "Deactivate punch or center mark on left paper edge" p)
  271. (const :tag "Activate lower horizontal mark on left paper edge" T)
  272. (const :tag "Deactivate lower horizontal mark on left paper edge" t)
  273. (const :tag "Activate all vertical marks on upper paper edge" V)
  274. (const :tag "Deactivate all vertical marks on upper paper edge" v))))
  275. (defcustom org-koma-letter-use-phone nil
  276. "Non-nil prints sender's phone number.
  277. This option can also be set with the OPTIONS keyword, e.g.:
  278. \"phone:t\"."
  279. :group 'org-export-koma-letter
  280. :type 'boolean)
  281. (defcustom org-koma-letter-use-email nil
  282. "Non-nil prints sender's email address.
  283. This option can also be set with the OPTIONS keyword, e.g.:
  284. \"email:t\"."
  285. :group 'org-export-koma-letter
  286. :type 'boolean)
  287. (defcustom org-koma-letter-use-place t
  288. "Non-nil prints the letter's place next to the date.
  289. This option can also be set with the OPTIONS keyword, e.g.:
  290. \"place:nil\"."
  291. :group 'org-export-koma-letter
  292. :type 'boolean)
  293. (defcustom org-koma-letter-default-class "default-koma-letter"
  294. "Default class for `org-koma-letter'.
  295. The value must be a member of `org-latex-classes'."
  296. :group 'org-export-koma-letter
  297. :type 'string)
  298. (defcustom org-koma-letter-headline-is-opening-maybe t
  299. "Non-nil means a headline may be used as an opening.
  300. A headline is only used if #+OPENING is not set. See also
  301. `org-koma-letter-opening'."
  302. :group 'org-export-koma-letter
  303. :type 'boolean)
  304. (defcustom org-koma-letter-prefer-subject nil
  305. "Non-nil means title should be interpret as subject if subject is missing.
  306. This option can also be set with the OPTIONS keyword,
  307. e.g. \"title-subject:t\".
  308. This may be useful for older documents where the SUBJECT keyword
  309. was not present."
  310. :group 'org-export-koma-letter
  311. :type 'boolean)
  312. (defconst org-koma-letter-special-tags-in-letter '(to from)
  313. "Header tags related to the letter itself.")
  314. (defconst org-koma-letter-special-tags-after-closing '(ps encl cc)
  315. "Header tags to be inserted after closing.")
  316. (defconst org-koma-letter-special-tags-after-letter '(after_letter)
  317. "Header tags to be inserted after closing.")
  318. (defvar org-koma-letter-special-contents nil
  319. "Holds special content temporarily.")
  320. (make-obsolete-variable 'org-koma-letter-use-title
  321. 'org-export-with-title
  322. "25.1" 'set)
  323. ;;; Define Back-End
  324. (org-export-define-derived-backend 'koma-letter 'latex
  325. :options-alist
  326. '((:latex-class "LATEX_CLASS" nil org-koma-letter-default-class t)
  327. (:lco "LCO" nil org-koma-letter-class-option-file)
  328. (:author "AUTHOR" nil (org-koma-letter--get-value org-koma-letter-author) t)
  329. (:author-changed-in-buffer-p "AUTHOR" nil nil t)
  330. (:from-address "FROM_ADDRESS" nil org-koma-letter-from-address newline)
  331. (:phone-number "PHONE_NUMBER" nil org-koma-letter-phone-number)
  332. (:email "EMAIL" nil (org-koma-letter--get-value org-koma-letter-email) t)
  333. (:to-address "TO_ADDRESS" nil nil newline)
  334. (:place "PLACE" nil org-koma-letter-place)
  335. (:subject "SUBJECT" nil nil space)
  336. (:opening "OPENING" nil org-koma-letter-opening)
  337. (:closing "CLOSING" nil org-koma-letter-closing)
  338. (:signature "SIGNATURE" nil org-koma-letter-signature newline)
  339. (:special-headings nil "special-headings"
  340. org-koma-letter-prefer-special-headings)
  341. (:special-tags nil nil (append
  342. org-koma-letter-special-tags-in-letter
  343. org-koma-letter-special-tags-after-closing
  344. org-koma-letter-special-tags-after-letter))
  345. (:with-after-closing nil "after-closing-order"
  346. org-koma-letter-special-tags-after-closing)
  347. (:with-after-letter nil "after-letter-order"
  348. org-koma-letter-special-tags-after-letter)
  349. (:with-backaddress nil "backaddress" org-koma-letter-use-backaddress)
  350. (:with-email nil "email" org-koma-letter-use-email)
  351. (:with-foldmarks nil "foldmarks" org-koma-letter-use-foldmarks)
  352. (:with-phone nil "phone" org-koma-letter-use-phone)
  353. (:with-place nil "place" org-koma-letter-use-place)
  354. (:with-subject nil "subject" org-koma-letter-subject-format)
  355. (:with-title-as-subject nil "title-subject" org-koma-letter-prefer-subject)
  356. (:with-headline-opening nil nil org-koma-letter-headline-is-opening-maybe)
  357. ;; Special properties non-nil when a setting happened in buffer.
  358. ;; They are used to prioritize in-buffer settings over "lco"
  359. ;; files. See `org-koma-letter-template'.
  360. (:inbuffer-author "AUTHOR" nil 'koma-letter:empty)
  361. (:inbuffer-email "EMAIL" nil 'koma-letter:empty)
  362. (:inbuffer-phone-number "PHONE_NUMBER" nil 'koma-letter:empty)
  363. (:inbuffer-place "PLACE" nil 'koma-letter:empty)
  364. (:inbuffer-signature "SIGNATURE" nil 'koma-letter:empty)
  365. (:inbuffer-with-backaddress nil "backaddress" 'koma-letter:empty)
  366. (:inbuffer-with-email nil "email" 'koma-letter:empty)
  367. (:inbuffer-with-foldmarks nil "foldmarks" 'koma-letter:empty)
  368. (:inbuffer-with-phone nil "phone" 'koma-letter:empty))
  369. :translate-alist '((export-block . org-koma-letter-export-block)
  370. (export-snippet . org-koma-letter-export-snippet)
  371. (headline . org-koma-letter-headline)
  372. (keyword . org-koma-letter-keyword)
  373. (template . org-koma-letter-template))
  374. :menu-entry
  375. '(?k "Export with KOMA Scrlttr2"
  376. ((?L "As LaTeX buffer" org-koma-letter-export-as-latex)
  377. (?l "As LaTeX file" org-koma-letter-export-to-latex)
  378. (?p "As PDF file" org-koma-letter-export-to-pdf)
  379. (?o "As PDF file and open"
  380. (lambda (a s v b)
  381. (if a (org-koma-letter-export-to-pdf t s v b)
  382. (org-open-file (org-koma-letter-export-to-pdf nil s v b))))))))
  383. ;;; Helper functions
  384. (defun org-koma-letter-email ()
  385. "Return the current `user-mail-address'."
  386. user-mail-address)
  387. ;; The following is taken from/inspired by ox-grof.el
  388. ;; Thanks, Luis!
  389. (defun org-koma-letter--get-tagged-contents (key)
  390. "Get contents from a headline tagged with KEY.
  391. The contents is stored in `org-koma-letter-special-contents'."
  392. (cdr (assoc-string (org-koma-letter--get-value key)
  393. org-koma-letter-special-contents)))
  394. (defun org-koma-letter--get-value (value)
  395. "Turn value into a string whenever possible.
  396. Determines if VALUE is nil, a string, a function or a symbol and
  397. return a string or nil."
  398. (when value
  399. (cond ((stringp value) value)
  400. ((functionp value) (funcall value))
  401. ((symbolp value) (symbol-name value))
  402. (t value))))
  403. (defun org-koma-letter--special-contents-as-macro
  404. (keywords &optional keep-newlines no-tag)
  405. "Process KEYWORDS members of `org-koma-letter-special-contents'.
  406. KEYWORDS is a list of symbols. Return them as a string to be
  407. formatted.
  408. The function is used for inserting content of special headings
  409. such as PS.
  410. If KEEP-NEWLINES is t newlines will not be removed. If NO-TAG is
  411. t the content in `org-koma-letter-special-contents' will not be
  412. wrapped in a macro named whatever the members of KEYWORDS are
  413. called."
  414. (mapconcat
  415. #'(lambda (keyword)
  416. (let* ((name (org-koma-letter--get-value keyword))
  417. (value (org-koma-letter--get-tagged-contents name)))
  418. (when value
  419. (if no-tag (if keep-newlines value (org-trim value))
  420. (format "\\%s{%s}\n"
  421. name
  422. (if keep-newlines value (org-trim value)))))))
  423. keywords
  424. ""))
  425. (defun org-koma-letter--determine-to-and-from (info key)
  426. "Given INFO determine KEY for the letter.
  427. KEY should be `to' or `from'.
  428. `ox-koma-letter' allows two ways to specify TO and FROM. If both
  429. are present return the preferred one as determined by
  430. `org-koma-letter-prefer-special-headings'."
  431. (let ((option (org-string-nw-p
  432. (plist-get info (if (eq key 'to) :to-address :from-address))))
  433. (headline (org-koma-letter--get-tagged-contents key)))
  434. (replace-regexp-in-string
  435. "\n" "\\\\\\\\\n"
  436. (org-trim
  437. (if (plist-get info :special-headings) (or headline option "")
  438. (or option headline ""))))))
  439. ;;; Transcode Functions
  440. ;;;; Export Block
  441. (defun org-koma-letter-export-block (export-block contents info)
  442. "Transcode an EXPORT-BLOCK element into KOMA Scrlttr2 code.
  443. CONTENTS is nil. INFO is a plist used as a communication
  444. channel."
  445. (when (member (org-element-property :type export-block) '("KOMA-LETTER" "LATEX"))
  446. (org-remove-indentation (org-element-property :value export-block))))
  447. ;;;; Export Snippet
  448. (defun org-koma-letter-export-snippet (export-snippet contents info)
  449. "Transcode an EXPORT-SNIPPET object into KOMA Scrlttr2 code.
  450. CONTENTS is nil. INFO is a plist used as a communication
  451. channel."
  452. (when (memq (org-export-snippet-backend export-snippet) '(latex koma-letter))
  453. (org-element-property :value export-snippet)))
  454. ;;;; Keyword
  455. (defun org-koma-letter-keyword (keyword contents info)
  456. "Transcode a KEYWORD element into KOMA Scrlttr2 code.
  457. CONTENTS is nil. INFO is a plist used as a communication
  458. channel."
  459. (let ((key (org-element-property :key keyword))
  460. (value (org-element-property :value keyword)))
  461. ;; Handle specifically KOMA-LETTER keywords. Otherwise, fallback
  462. ;; to `latex' back-end.
  463. (if (equal key "KOMA-LETTER") value
  464. (org-export-with-backend 'latex keyword contents info))))
  465. ;; Headline
  466. (defun org-koma-letter-headline (headline contents info)
  467. "Transcode a HEADLINE element from Org to LaTeX.
  468. CONTENTS holds the contents of the headline. INFO is a plist
  469. holding contextual information.
  470. Note that if a headline is tagged with a tag from
  471. `org-koma-letter-special-tags' it will not be exported, but
  472. stored in `org-koma-letter-special-contents' and included at the
  473. appropriate place."
  474. (let ((special-tag (org-koma-letter--special-tag headline info)))
  475. (if (not special-tag)
  476. contents
  477. (push (cons special-tag contents) org-koma-letter-special-contents)
  478. "")))
  479. (defun org-koma-letter--special-tag (headline info)
  480. "Non-nil if HEADLINE is a special headline.
  481. INFO is a plist holding contextual information. Return first
  482. special tag headline."
  483. (let ((special-tags (plist-get info :special-tags)))
  484. (catch 'exit
  485. (dolist (tag (org-export-get-tags headline info))
  486. (let ((tag (assoc-string tag special-tags)))
  487. (when tag (throw 'exit tag)))))))
  488. ;;;; Template
  489. (defun org-koma-letter-template (contents info)
  490. "Return complete document string after KOMA Scrlttr2 conversion.
  491. CONTENTS is the transcoded contents string. INFO is a plist
  492. holding export options."
  493. (concat
  494. ;; Time-stamp.
  495. (and (plist-get info :time-stamp-file)
  496. (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
  497. ;; Document class and packages.
  498. (let* ((class (plist-get info :latex-class))
  499. (class-options (plist-get info :latex-class-options))
  500. (header (nth 1 (assoc class org-latex-classes)))
  501. (document-class-string
  502. (and (stringp header)
  503. (if (not class-options) header
  504. (replace-regexp-in-string
  505. "^[ \t]*\\\\documentclass\\(\\(\\[[^]]*\\]\\)?\\)"
  506. class-options header t nil 1)))))
  507. (if (not document-class-string)
  508. (user-error "Unknown LaTeX class `%s'" class)
  509. (org-latex-guess-babel-language
  510. (org-latex-guess-inputenc
  511. (org-element-normalize-string
  512. (org-splice-latex-header
  513. document-class-string
  514. org-latex-default-packages-alist ; Defined in org.el.
  515. org-latex-packages-alist nil ; Defined in org.el.
  516. (concat (org-element-normalize-string (plist-get info :latex-header))
  517. (plist-get info :latex-header-extra)))))
  518. info)))
  519. ;; Settings. They can come from three locations, in increasing
  520. ;; order of precedence: global variables, LCO files and in-buffer
  521. ;; settings. Thus, we first insert settings coming from global
  522. ;; variables, then we insert LCO files, and, eventually, we insert
  523. ;; settings coming from buffer keywords.
  524. (org-koma-letter--build-settings 'global info)
  525. (mapconcat #'(lambda (file) (format "\\LoadLetterOption{%s}\n" file))
  526. (org-split-string (or (plist-get info :lco) "") " ")
  527. "")
  528. (org-koma-letter--build-settings 'buffer info)
  529. ;; From address.
  530. (let ((from-address (org-koma-letter--determine-to-and-from info 'from)))
  531. (when (org-string-nw-p from-address)
  532. (format "\\setkomavar{fromaddress}{%s}\n" from-address)))
  533. ;; Date.
  534. (format "\\date{%s}\n" (org-export-data (org-export-get-date info) info))
  535. ;; Hyperref, document start, and subject and title.
  536. (let ((with-subject (plist-get info :with-subject)))
  537. (when (and with-subject (plist-get info :with-title))
  538. (concat
  539. (unless (eq with-subject t)
  540. (format "\\KOMAoption{subject}{%s}\n"
  541. (if (symbolp with-subject) with-subject
  542. (mapconcat #'symbol-name with-subject ","))))
  543. (let* ((title-as-subject (plist-get info :with-title-as-subject))
  544. (subject* (org-string-nw-p
  545. (org-export-data
  546. (org-element-parse-secondary-string
  547. (plist-get info :subject)
  548. (org-element-restriction 'keyword))
  549. info)))
  550. (title* (and (plist-get info :with-title)
  551. (org-string-nw-p
  552. (org-export-data (plist-get info :title) info))))
  553. (subject (if title-as-subject (or subject* title*) subject*))
  554. (title (if title-as-subject (and subject* title*) title*))
  555. (hyperref-template (plist-get info :latex-hyperref-template))
  556. (spec (append (list (cons ?t (or title subject "")))
  557. (org-latex--format-spec info))))
  558. (concat
  559. ;; Hyperref.
  560. (format-spec hyperref-template spec)
  561. ;; Document start.
  562. "\\begin{document}\n\n"
  563. ;; Subject and title.
  564. (when subject (format "\\setkomavar{subject}{%s}\n" subject))
  565. (when title (format "\\setkomavar{title}{%s}\n" title))
  566. (when (or (org-string-nw-p title) (org-string-nw-p subject)) "\n"))))))
  567. ;; Letter start.
  568. (format "\\begin{letter}{%%\n%s}\n\n"
  569. (org-koma-letter--determine-to-and-from info 'to))
  570. ;; Opening.
  571. (format "\\opening{%s}\n\n"
  572. (org-export-data
  573. (or (org-string-nw-p (plist-get info :opening))
  574. (when (plist-get info :with-headline-opening)
  575. (org-element-map (plist-get info :parse-tree) 'headline
  576. (lambda (head)
  577. (unless (org-koma-letter--special-tag head info)
  578. (org-element-property :title head)))
  579. info t))
  580. "")
  581. info))
  582. ;; Letter body.
  583. contents
  584. ;; Closing.
  585. (format "\n\\closing{%s}\n" (plist-get info :closing))
  586. (org-koma-letter--special-contents-as-macro
  587. (plist-get info :with-after-closing))
  588. ;; Letter end.
  589. "\n\\end{letter}\n"
  590. (org-koma-letter--special-contents-as-macro
  591. (plist-get info :with-after-letter) t t)
  592. ;; Document end.
  593. "\n\\end{document}"))
  594. (defun org-koma-letter--build-settings (scope info)
  595. "Build settings string according to type.
  596. SCOPE is either `global' or `buffer'. INFO is a plist used as
  597. a communication channel."
  598. (let ((check-scope
  599. (function
  600. ;; Non-nil value when SETTING was defined in SCOPE.
  601. (lambda (setting)
  602. (let ((property (intern (format ":inbuffer-%s" setting))))
  603. (if (eq scope 'global)
  604. (eq (plist-get info property) 'koma-letter:empty)
  605. (not (eq (plist-get info property) 'koma-letter:empty))))))))
  606. (concat
  607. ;; Name.
  608. (let ((author (plist-get info :author)))
  609. (and author
  610. (funcall check-scope 'author)
  611. (format "\\setkomavar{fromname}{%s}\n"
  612. (org-export-data author info))))
  613. ;; Email.
  614. (let ((email (plist-get info :email)))
  615. (and email
  616. (funcall check-scope 'email)
  617. (format "\\setkomavar{fromemail}{%s}\n" email)))
  618. (and (funcall check-scope 'with-email)
  619. (format "\\KOMAoption{fromemail}{%s}\n"
  620. (if (plist-get info :with-email) "true" "false")))
  621. ;; Phone number.
  622. (let ((phone-number (plist-get info :phone-number)))
  623. (and (org-string-nw-p phone-number)
  624. (funcall check-scope 'phone-number)
  625. (format "\\setkomavar{fromphone}{%s}\n" phone-number)))
  626. (and (funcall check-scope 'with-phone)
  627. (format "\\KOMAoption{fromphone}{%s}\n"
  628. (if (plist-get info :with-phone) "true" "false")))
  629. ;; Signature.
  630. (let ((signature (plist-get info :signature)))
  631. (and (org-string-nw-p signature)
  632. (funcall check-scope 'signature)
  633. (format "\\setkomavar{signature}{%s}\n" signature)))
  634. ;; Back address.
  635. (and (funcall check-scope 'with-backaddress)
  636. (format "\\KOMAoption{backaddress}{%s}\n"
  637. (if (plist-get info :with-backaddress) "true" "false")))
  638. ;; Place.
  639. (and (funcall check-scope 'place)
  640. (format "\\setkomavar{place}{%s}\n"
  641. (if (plist-get info :with-place) (plist-get info :place) "")))
  642. ;; Folding marks.
  643. (and (funcall check-scope 'with-foldmarks)
  644. (let ((foldmarks (plist-get info :with-foldmarks)))
  645. (cond ((consp foldmarks)
  646. (format "\\KOMAoptions{foldmarks=true,foldmarks=%s}\n"
  647. (mapconcat #'symbol-name foldmarks "")))
  648. (foldmarks "\\KOMAoptions{foldmarks=true}\n")
  649. (t "\\KOMAoptions{foldmarks=false}\n")))))))
  650. ;;; Commands
  651. ;;;###autoload
  652. (defun org-koma-letter-export-as-latex
  653. (&optional async subtreep visible-only body-only ext-plist)
  654. "Export current buffer as a KOMA Scrlttr2 letter.
  655. If narrowing is active in the current buffer, only export its
  656. narrowed part.
  657. If a region is active, export that region.
  658. A non-nil optional argument ASYNC means the process should happen
  659. asynchronously. The resulting buffer should be accessible
  660. through the `org-export-stack' interface.
  661. When optional argument SUBTREEP is non-nil, export the sub-tree
  662. at point, extracting information from the headline properties
  663. first.
  664. When optional argument VISIBLE-ONLY is non-nil, don't export
  665. contents of hidden elements.
  666. When optional argument BODY-ONLY is non-nil, only write code
  667. between \"\\begin{letter}\" and \"\\end{letter}\".
  668. EXT-PLIST, when provided, is a proeprty list with external
  669. parameters overriding Org default settings, but still inferior to
  670. file-local settings.
  671. Export is done in a buffer named \"*Org KOMA-LETTER Export*\". It
  672. will be displayed if `org-export-show-temporary-export-buffer' is
  673. non-nil."
  674. (interactive)
  675. (let (org-koma-letter-special-contents)
  676. (org-export-to-buffer 'koma-letter "*Org KOMA-LETTER Export*"
  677. async subtreep visible-only body-only ext-plist
  678. (lambda () (LaTeX-mode)))))
  679. ;;;###autoload
  680. (defun org-koma-letter-export-to-latex
  681. (&optional async subtreep visible-only body-only ext-plist)
  682. "Export current buffer as a KOMA Scrlttr2 letter (tex).
  683. If narrowing is active in the current buffer, only export its
  684. narrowed part.
  685. If a region is active, export that region.
  686. A non-nil optional argument ASYNC means the process should happen
  687. asynchronously. The resulting file should be accessible through
  688. the `org-export-stack' interface.
  689. When optional argument SUBTREEP is non-nil, export the sub-tree
  690. at point, extracting information from the headline properties
  691. first.
  692. When optional argument VISIBLE-ONLY is non-nil, don't export
  693. contents of hidden elements.
  694. When optional argument BODY-ONLY is non-nil, only write code
  695. between \"\\begin{letter}\" and \"\\end{letter}\".
  696. EXT-PLIST, when provided, is a property list with external
  697. parameters overriding Org default settings, but still inferior to
  698. file-local settings.
  699. When optional argument PUB-DIR is set, use it as the publishing
  700. directory.
  701. Return output file's name."
  702. (interactive)
  703. (let ((outfile (org-export-output-file-name ".tex" subtreep))
  704. (org-koma-letter-special-contents))
  705. (org-export-to-file 'koma-letter outfile
  706. async subtreep visible-only body-only ext-plist)))
  707. ;;;###autoload
  708. (defun org-koma-letter-export-to-pdf
  709. (&optional async subtreep visible-only body-only ext-plist)
  710. "Export current buffer as a KOMA Scrlttr2 letter (pdf).
  711. If narrowing is active in the current buffer, only export its
  712. narrowed part.
  713. If a region is active, export that region.
  714. A non-nil optional argument ASYNC means the process should happen
  715. asynchronously. The resulting file should be accessible through
  716. the `org-export-stack' interface.
  717. When optional argument SUBTREEP is non-nil, export the sub-tree
  718. at point, extracting information from the headline properties
  719. first.
  720. When optional argument VISIBLE-ONLY is non-nil, don't export
  721. contents of hidden elements.
  722. When optional argument BODY-ONLY is non-nil, only write code
  723. between \"\\begin{letter}\" and \"\\end{letter}\".
  724. EXT-PLIST, when provided, is a property list with external
  725. parameters overriding Org default settings, but still inferior to
  726. file-local settings.
  727. Return PDF file's name."
  728. (interactive)
  729. (let ((file (org-export-output-file-name ".tex" subtreep))
  730. (org-koma-letter-special-contents))
  731. (org-export-to-file 'koma-letter file
  732. async subtreep visible-only body-only ext-plist
  733. (lambda (file) (org-latex-compile file)))))
  734. (provide 'ox-koma-letter)
  735. ;;; ox-koma-letter.el ends here