From: Rasmus <rasmus@gmx.us>
To: emacs-orgmode@gnu.org
Subject: Re: [patch][ox-koma-letter] Support for to and from headings
Date: Mon, 03 Jun 2013 15:48:40 +0200 [thread overview]
Message-ID: <87a9n79ufb.fsf@pank.eu> (raw)
In-Reply-To: 8738t1aes7.fsf@pank.eu
[-- Attachment #1.1: Type: text/plain, Size: 612 bytes --]
Rasmus <rasmus@gmx.us> writes:
> Hi,
>
> Some more patches that should work against the master branch.
>
> Patch 1: bug fixes. Most notably use symbols some places rather than
> strings.
>
> Patch 2 adds support for TO and FROM headings. If you've got time for
> testing I would appreciate feedback. It's explained in the top of the
> patch.
Patch 1 and 2 are updated. Patch three adds support for an
`org-koma-letter-default-class' and a plug-in function to make it
easier to use letters. They should apply against master.
–Rasmus
--
If you can mix business and politics wonderful things can happen!
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-Bug-fixes-for-ox-koma-letter.el.patch --]
[-- Type: text/x-patch, Size: 8137 bytes --]
From 4c993600fb032e91a0122520a1e41c0f8d1caade Mon Sep 17 00:00:00 2001
From: "rasmus.pank" <rasmus.pank@gmail.com>
Date: Mon, 27 May 2013 17:29:14 +0200
Subject: [PATCH 1/3] Bug fixes for ox-koma-letter.el
* ox-koma-letter.el: If tag wasn't given a headline could cause
trouble.
* ox-koma-letter.el: bug in subject-format defcustom.
* ox-koma-letter.el: some newline changes
* ox-koma-letter.el: changed varioues quoted things to symbols.
* ox-koma-letter.el: updated documentation in the top of the file.
---
contrib/lisp/ox-koma-letter.el | 106 +++++++++++++++++++++++++++--------------
1 file changed, 71 insertions(+), 35 deletions(-)
diff --git a/contrib/lisp/ox-koma-letter.el b/contrib/lisp/ox-koma-letter.el
index 4af0ba7..f1b18bf 100644
--- a/contrib/lisp/ox-koma-letter.el
+++ b/contrib/lisp/ox-koma-letter.el
@@ -33,12 +33,37 @@
;;
;; On top of buffer keywords supported by `latex' back-end (see
;; `org-latex-options-alist'), this back-end introduces the following
-;; keywords: "CLOSING" (see `org-koma-letter-closing'), "FROM_ADDRESS"
-;; (see `org-koma-letter-from-address'), "LCO" (see
-;; `org-koma-letter-class-option-file'), "OPENING" (see
-;; `org-koma-letter-opening'), "PHONE_NUMBER" (see
-;; `org-koma-letter-phone-number'), "SIGNATURE" (see
-;; `org-koma-letter-signature') and "TO_ADDRESS".
+;; keywords:
+;; - "CLOSING" (see `org-koma-letter-closing'),
+;; - "FROM_ADDRESS" (see `org-koma-letter-from-address'),
+;; - "LCO" (see `org-koma-letter-class-option-file'),
+;; - "OPENING" (see `org-koma-letter-opening'),
+;; - "PHONE_NUMBER" (see `org-koma-letter-phone-number'),
+;; - "SIGNATURE" (see `org-koma-letter-signature')
+;; - "PLACE" (see `org-koma-letter-place')
+;; - and "TO_ADDRESS".
+;;
+;; A number of OPTIONS settings can be set to change which contents is exported.
+;; - backaddress (see `org-koma-letter-use-backaddress')
+;; - foldmarks (see `org-koma-letter-use-foldmarks')
+;; - phone (see `org-koma-letter-use-phone')
+;; - email (see `org-koma-letter-use-email')
+;; - place (see `org-koma-letter-use-place')
+;; - subject, a list of format options
+;; (see `org-koma-letter-subject-format')
+;; - after-closing-order, a list of ordering after letter
+;; (see `org-koma-letter-special-tags-after-closing')
+;; - after-letter-order, as above
+;; (see `org-koma-letter-special-tags-after-letter').
+;;
+;; The following variables works differently from the main LaTeX class
+;; - "AUTHOR": default to user-full-name but may be disabled. (see org-koma-letter-author),
+;; - "EMAIL": same as AUTHOR, (see org-koma-letter-email),
+;;
+;; Headlines are in general ignored. However, headlines with special
+;; tags can be used for specified contents like postscript (ps), carbon
+;; copy (cc), commencements (encl) and code to be inserted after
+;; \end{letter} (after_letter).
;;
;; You will need to add an appropriate association in
;; `org-latex-classes' in order to use the KOMA Scrlttr2 class. For
@@ -93,7 +118,7 @@ string."
:type '(radio (function-item user-full-name)
(string)
(function)
- (const nil)))
+ (const :tag "Do not export author" nil)))
(defcustom org-koma-letter-email 'org-koma-letter-email
"The sender's email address.
@@ -105,7 +130,7 @@ function may be given. Functions must return a string."
:type '(radio (function-item org-koma-letter-email)
(string)
(function)
- (const nil)))
+ (const :tag "Do not export email" nil)))
(defcustom org-koma-letter-from-address nil
"Sender's address, as a string."
@@ -153,17 +178,19 @@ writing the following values are allowed:
Please refer to the KOMA-script manual (Table 4.16. in the
English manual of 2012-07-22)"
- :type '(set (const "afteropening")
- (const "beforeopening")
- (const "centered")
- (const "left")
- (const "right")
- (const "underlined")
- (const "titled")
- (const "untitled")
- (const :tag "No export" nil)
- (const :tag "Default options" t)
- (string))
+ :type '(radio
+ (const :tag "No export" nil)
+ (const :tag "Default options" t)
+ (set :tag "selection"
+ (const 'afteropening)
+ (const 'beforeopening)
+ (const 'centered)
+ (const 'left)
+ (const 'right)
+ (const 'underlined)
+ (const 'titled)
+ (const 'untitled))
+ (string))
:group 'org-export-koma-letter)
@@ -198,15 +225,16 @@ Use `foldmarks:true' to activate default fold marks or
:group 'org-export-koma-letter
:type 'boolean)
-(defconst org-koma-letter-special-tags-after-closing
- '("ps" "encl" "cc")
+
+
+(defconst org-koma-letter-special-tags-after-closing '(ps encl cc)
"Header tags to be inserted after closing")
-(defconst org-koma-letter-special-tags-after-letter '("after_letter")
+(defconst org-koma-letter-special-tags-after-letter '(after_letter)
"Header tags to be inserted after closing")
-(defvar org-koma-letter-special-contents nil "holds special
-content temporarily.")
+(defvar org-koma-letter-special-contents nil
+ "holds special content temporarily.")
\f
@@ -262,9 +290,10 @@ content temporarily.")
;; The following is taken from/inspired by ox-grof.el
;; Thanks, Luis!
-(defun org-koma-letter--get-tagged-contents (tag)
+(defun org-koma-letter--get-tagged-contents (key)
"Get tagged content from `org-koma-letter-special-contents'"
- (cdr (assoc tag org-koma-letter-special-contents)))
+ (cdr (assoc (org-koma-letter--get-custom key)
+ org-koma-letter-special-contents)))
(defun org-koma-letter--get-custom (value)
"Determines whether a value is nil, a string or a
@@ -272,7 +301,8 @@ function (a symobl). If it is a function it it evaluates it."
(when value
(cond ((stringp value) value)
((functionp value) (funcall value))
- ((symbolp value) (symbol-name value)))))
+ ((symbolp value) (symbol-name value))
+ (t value))))
(defun org-koma-letter--prepare-special-contents-as-macro (a-list &optional keep-newlines no-tag)
@@ -286,10 +316,10 @@ is t the content in `org-koma-letter-special-contents' will not
be wrapped in a macro named whatever the members of a-list are called.
"
(let (output)
- (dolist (ac a-list output)
- (let
- ((x (org-koma-letter--get-tagged-contents ac))
- (regexp (if keep-newlines "" "\\`\n+\\|\n*\\'")))
+ (dolist (ac* a-list output)
+ (let*
+ ((ac (org-koma-letter--get-custom ac*))
+ (x (org-koma-letter--get-tagged-contents ac)))
(when x
(setq output
(concat
@@ -297,7 +327,7 @@ be wrapped in a macro named whatever the members of a-list are called.
;; sometimes LaTeX complains about newlines
;; at the end or beginning of macros. Remove them.
(org-koma-letter--format-string-as-macro
- (format "%s" (replace-regexp-in-string regexp "" x))
+ (if keep-newlines x (org-koma-letter--remove-offending-new-lines x))
(unless no-tag ac)))))))))
(defun org-koma-letter--format-string-as-macro (string &optional macro)
@@ -306,6 +336,10 @@ be wrapped in a macro named whatever the members of a-list are called.
(format "\\%s{%s}" macro string)
(format "%s" string)))
+(defun org-koma-letter--remove-offending-new-lines (string)
+ "Remove new lines in the begging and end of `string'"
+ (replace-regexp-in-string "\\`\n+\\|\n*\\'" "" string))
+
;;; Transcode Functions
;;;; Export Block
@@ -354,8 +388,9 @@ appropriate place."
(let*
((tags (and (plist-get info :with-tags)
(org-export-get-tags headline info)))
- (tag (downcase (car tags))))
- (if (member tag (plist-get info :special-tags))
+ (tag (if tags (downcase (car tags)))))
+ (if (member tag
+ (mapcar 'symbol-name (plist-get info :special-tags)))
(progn
(push (cons tag contents)
org-koma-letter-special-contents)
@@ -564,7 +599,8 @@ directory.
Return output file's name."
(interactive)
- (let ((outfile (org-export-output-file-name ".tex" subtreep)))
+ (let ((outfile (org-export-output-file-name ".tex" subtreep))
+ org-koma-letter-special-contents)
(if async
(org-export-async-start
(lambda (f) (org-export-add-to-stack f 'koma-letter))
--
1.8.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.3: 0002-Added-support-for-to-and-from-heading.patch --]
[-- Type: text/x-patch, Size: 6134 bytes --]
From 68d94e6736083b148f8f7725aec12c4add834478 Mon Sep 17 00:00:00 2001
From: rasmus <rasmus@gmx.us>
Date: Sat, 1 Jun 2013 19:52:36 +0200
Subject: [PATCH 2/3] Added support for to and from heading.
* ox-koma-letter.el (org-koma-letter-special-tags-in-letter): list of
tags that are typeset as part of the letter. *
ox-koma-letter.el (org-koma-letter--determine-special-value):
determine which value to use (for to and from currentlly) if more than
candidate is available. Which value is selected depends on
`org-koma-letter-prefer-special-headings'. *
ox-koma-letter.el (org-koma-letter-prefer-special-headings): a boolean
stating whether to prefer headings with to/from or the #+X_ADDRESS.
The following letter now exports "as expected". In particular when
special-headings is t heading values have presedence so the
from address would be ="Rasmus\nEmacs\nOrg-mode"= where the
=\n=s would be escaped. If specia-headings is nil (default)
the from would be my-adr. The same is true for TO address.
Here's the contents
* from :from:
Rasmus
Emacs
Org-mode
On a technical note, note that the default value will be used if
neither #+X_ADDRESS or a heading is given.
---
contrib/lisp/ox-koma-letter.el | 53 +++++++++++++++++++++++++++++++++++-------
1 file changed, 45 insertions(+), 8 deletions(-)
diff --git a/contrib/lisp/ox-koma-letter.el b/contrib/lisp/ox-koma-letter.el
index f1b18bf..e70b8c4 100644
--- a/contrib/lisp/ox-koma-letter.el
+++ b/contrib/lisp/ox-koma-letter.el
@@ -157,6 +157,12 @@ function may be given. Functions must return a string."
:group 'org-export-koma-letter
:type 'string)
+(defcustom org-koma-letter-prefer-special-headings nil
+ "If both a TO or FROM is specified two places should the
+ heading version be preferred?"
+ :group 'org-export-koma-letter
+ :type 'boolean)
+
(defcustom org-koma-letter-signature nil
"String used as the signature."
:group 'org-export-koma-letter
@@ -225,7 +231,8 @@ Use `foldmarks:true' to activate default fold marks or
:group 'org-export-koma-letter
:type 'boolean)
-
+(defconst org-koma-letter-special-tags-in-letter '(to from)
+ "header tags related to the letter itself")
(defconst org-koma-letter-special-tags-after-closing '(ps encl cc)
"Header tags to be inserted after closing")
@@ -244,7 +251,7 @@ Use `foldmarks:true' to activate default fold marks or
:options-alist
'((:lco "LCO" nil org-koma-letter-class-option-file)
(:author "AUTHOR" nil (org-koma-letter--get-custom org-koma-letter-author) t)
- (:from-address "FROM_ADDRESS" nil org-koma-letter-from-address newline)
+ (:from-address "FROM_ADDRESS" nil nil newline)
(:phone-number "PHONE_NUMBER" nil org-koma-letter-phone-number)
(:email "EMAIL" nil (org-koma-letter--get-custom org-koma-letter-email) t)
(:to-address "TO_ADDRESS" nil nil newline)
@@ -252,9 +259,12 @@ Use `foldmarks:true' to activate default fold marks or
(:opening "OPENING" nil org-koma-letter-opening)
(:closing "CLOSING" nil org-koma-letter-closing)
(:signature "SIGNATURE" nil org-koma-letter-signature newline)
- (:special-tags nil nil
- (append org-koma-letter-special-tags-after-closing
- org-koma-letter-special-tags-after-letter))
+ (:special-tags nil nil (append
+ org-koma-letter-special-tags-in-letter
+ org-koma-letter-special-tags-after-closing
+ org-koma-letter-special-tags-after-letter))
+ (:special-headings nil "special-headings"
+ org-koma-letter-prefer-special-headings)
(:with-after-closing nil "after-closing-order"
org-koma-letter-special-tags-after-closing)
(:with-after-letter nil "after-letter-order"
@@ -340,6 +350,33 @@ be wrapped in a macro named whatever the members of a-list are called.
"Remove new lines in the begging and end of `string'"
(replace-regexp-in-string "\\`\n+\\|\n*\\'" "" string))
+
+(defun org-koma-letter--determine-special-value (info key)
+ "Determine who the letter is to and whom it is from.
+ oxkoma-letter allows two ways to specify these things. If both
+ are present return the preferred one as determined by
+ `org-koma-letter-prefer-special-headings'. When `from' is t "
+ (let* ((plit-alist '((from . :from-address)
+ (to . ::to-address)))
+ (default-alist `((from ,org-koma-letter-from-address)
+ (to "\\mbox{}")))
+ (option-value (plist-get info (cdr-safe (assoc key plit-alist))))
+ (head-value (org-koma-letter--get-tagged-contents key))
+ (order (append
+ (funcall
+ (if (plist-get info :special-headings)
+ 'reverse 'identity)
+ `(,option-value ,head-value))
+ (cdr-safe (assoc key default-alist))))
+ tmp
+ (adr (dolist (x order tmp)
+ (when (and (not tmp) x)
+ (setq tmp x)))))
+ (when adr
+ (replace-regexp-in-string
+ "\n" "\\\\\\\\\n"
+ (org-koma-letter--remove-offending-new-lines adr)))))
+
;;; Transcode Functions
;;;; Export Block
@@ -367,7 +404,7 @@ channel."
CONTENTS is nil. INFO is a plist used as a communication
channel."
(let ((key (org-element-property :key keyword))
- (value (org-element-property :value keyword)))
+ (value (org-element-property :value keyword)))
;; Handle specifically BEAMER and TOC (headlines only) keywords.
;; Otherwise, fallback to `latex' back-end.
(if (equal key "KOMA-LETTER") value
@@ -435,7 +472,7 @@ holding export options."
info)))))
(let ((lco (plist-get info :lco))
(author (plist-get info :author))
- (from-address (plist-get info :from-address))
+ (from-address (org-koma-letter--determine-special-value info 'from))
(phone-number (plist-get info :phone-number))
(email (plist-get info :email))
(signature (plist-get info :signature)))
@@ -495,7 +532,7 @@ holding export options."
(format "\\setkomavar{subject}{%s}\n\n" subject))))
;; Letter start
(format "\\begin{letter}{%%\n%s}\n\n"
- (or (plist-get info :to-address) "no address given"))
+ (org-koma-letter--determine-special-value info 'to))
;; Opening.
(format "\\opening{%s}\n\n" (plist-get info :opening))
;; Letter body.
--
1.8.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.4: 0003-Possible-to-set-default-class-for-ox-koma-letters.patch --]
[-- Type: text/x-patch, Size: 3569 bytes --]
From f74eaae6c4610701899f7127537acbc8fa88a10f Mon Sep 17 00:00:00 2001
From: rasmus <rasmus@gmx.us>
Date: Sun, 2 Jun 2013 17:59:48 +0200
Subject: [PATCH 3/3] Possible to set default class for ox koma letters.
* ox-koma-letter.el (org-koma-letter-default-class): default class for
=ox-koma-letter=. Default is nil.
* ox-koma-letter.el (org-koma-letter-plug-into-ox): add a sparse
letter class to =`org-latex-class'= and set it to default.
By default it will use =`org-latex-default-class'=.
---
contrib/lisp/ox-koma-letter.el | 41 ++++++++++++++++++++++++++++++++++++++---
1 file changed, 38 insertions(+), 3 deletions(-)
diff --git a/contrib/lisp/ox-koma-letter.el b/contrib/lisp/ox-koma-letter.el
index e70b8c4..61df703 100644
--- a/contrib/lisp/ox-koma-letter.el
+++ b/contrib/lisp/ox-koma-letter.el
@@ -65,9 +65,21 @@
;; copy (cc), commencements (encl) and code to be inserted after
;; \end{letter} (after_letter).
;;
+;; Headlines with two and from may also be used rather than the
+;; keyword approach described above. If both a keyword and a headline
+;; with information is present precedence is determined by
+;; `org-koma-letter-prefer-special-headings'.
+;;
;; You will need to add an appropriate association in
-;; `org-latex-classes' in order to use the KOMA Scrlttr2 class. For
-;; example, you can use the following code:
+;; `org-latex-classes' in order to use the KOMA Scrlttr2 class.
+;; The easiest way to do this is by adding
+;;
+;; (eval-after-load "ox-koma-letter"
+;; '(org-koma-letter-plug-into-ox))
+;;
+;; to your init file. This will add a very sparse scrlttr2 class and
+;; set it as the default `org-koma-latex-default-class'. You can also
+;; add you own letter class. For instace:
;;
;; (add-to-list 'org-latex-classes
;; '("my-letter"
@@ -88,7 +100,8 @@
;; with :
;;
;; #+LATEX_CLASS: my-letter
-
+;;
+;; Or by setting `org-koma-letter-default-class'.
;;; Code:
@@ -231,6 +244,12 @@ Use `foldmarks:true' to activate default fold marks or
:group 'org-export-koma-letter
:type 'boolean)
+(defcustom org-koma-letter-default-class nil
+ "Default class for `org-koma-letter'. Must be a member of
+ `org-latex-classes'"
+ :group 'org-export-koma-letter
+ :type 'string)
+
(defconst org-koma-letter-special-tags-in-letter '(to from)
"header tags related to the letter itself")
@@ -250,6 +269,9 @@ Use `foldmarks:true' to activate default fold marks or
(org-export-define-derived-backend 'koma-letter 'latex
:options-alist
'((:lco "LCO" nil org-koma-letter-class-option-file)
+ (:latex-class "LATEX_CLASS" nil (if org-koma-letter-default-class
+ org-koma-letter-default-class
+ org-latex-default-class) t)
(:author "AUTHOR" nil (org-koma-letter--get-custom org-koma-letter-author) t)
(:from-address "FROM_ADDRESS" nil nil newline)
(:phone-number "PHONE_NUMBER" nil org-koma-letter-phone-number)
@@ -291,6 +313,19 @@ Use `foldmarks:true' to activate default fold marks or
(org-open-file (org-koma-letter-export-to-pdf nil s v b))))))))
\f
+;;; Initialize class function
+
+(defun org-koma-letter-plug-into-ox ()
+ "Add a sparse `default-koma-letter' to `org-latex-classes' and set
+`org-koma-letter-default-class' to `default-koma-letter'"
+ (let ((class "default-koma-letter"))
+ (eval-after-load "ox-latex"
+ '(add-to-list 'org-latex-classes
+ `(,class
+ "\\documentclass[11pt]{scrlttr2}") ()))
+ (setq org-koma-letter-default-class class)))
+
+
;;; Helper functions
(defun org-koma-letter-email ()
--
1.8.3
[-- Attachment #2: Type: text/plain, Size: 29 bytes --]
--
Summon the Mothership!
next prev parent reply other threads:[~2013-06-03 13:50 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-01 18:04 [patch][ox-koma-letter] Support for to and from headings Rasmus
2013-06-03 13:48 ` Rasmus [this message]
2013-06-11 21:53 ` Rasmus
2013-06-12 11:40 ` Alan Schmitt
2013-06-12 14:32 ` Rasmus
2013-06-04 10:07 ` Bastien
2013-06-04 10:37 ` Rasmus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87a9n79ufb.fsf@pank.eu \
--to=rasmus@gmx.us \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).