Org-mode: Écrire une lettre

Pour comprendre cette article, il faut avoir quelques notions de base d'Org-mode et d'Emacs. Savoir écrire un document Org-mode, avec plusieurs sections et attacher des étiquettes sera suffisant.

Il faut aussi connaitre le format suivant pour les raccourcis clavier:

• C-i: Correspond à [CTRL] + [i]
• M-x: Correspond à [Alt] + [x]
• C-c c: Correspond à [Ctrl] + [c], relâcher, puis [c]
• C-c C-e: Correspond à [Ctrl] + [c], relâcher, puis [Ctrl] + [e]

Pour écrire des lettres avec Org-mode, il faut:

• Emacs
• Org-mode (fourni avec Emacs)
• TeX Live, dans sa version full
• La classe LaTeX scrlttr2: Koma-Script ‘letter’ (fourni avec TeX Live full)

Pour l'installation, si tu utilise une distribution GNU/Linux, Emacs et Tex Live sont certainement proposés sur ses dépôts.

Si tu utilise Mac OS ou Windows, je te renvoie aux sites web d'Emacs et de TeX Live.

Org-mode est fourni avec Emacs et Koma-Script ‘letter’ avec TeX Live full.

Pour exporter un document Org-mode vers une lettre, on va utiliser l'exportateur koma-letter, fourni par le paquet Emacs ox-koma-letter. Ce paquet vient avec Org-mode, il n'est pas nécessaire de l'installer.

Pour que les options d'exportation koma soient visibles dans le menu d'exportation d'Org-mode, il faut charger ox-koma-letter.el avant org.el.

Pour ça, on doit seulement ajouter ceci au fichier /.emacs.d/init.el:

(require 'ox-koma-letter)

La fonction Elisp (require) va charger la fonctionnalité ox-koma-letter, si ce n'est pas déjà fait. Il faut ajouter ce chargement avant toute instruction Elisp qui chargerait org. Si tu en as une dans ton /.emacs.d/init.el.

Pour que les dates soient traduites en français, je te renvoie à mon précédent billet sur l'exportation PDF et le français.

Il est possible de choisir le format de la lettre, avec le mot clé LCO placé en haut du document Org-mode.

Exemple:

#+TITLE:          Teste de lettre
#+LCO:            DIN

…

Ce mot clé peut être associé à un des codes suivants:

Il est aussi possible de fournir un format personnalisé.

Pour plus d'informations sur comment utiliser un format personnalisé, ou sur les différences entre les formats Japonnais, je t'invite à lire la documentation officielle de la classe LaTeX scrlttr2.

À noter qu'on peut définir le format par défaut des lettres avec la variable Emacs org-koma-letter-class-option-file. Par exemple, en ajoutant cette ligne de code Elisp dans ~/.emacs.d/init.el:

(setq org-koma-letter-class-option-file "SN")

La chaine de caractère correspond au code du format qu'on souhaite utiliser.

Le mot clé LCO définit en début de document Org-mode prend le pas sur la variable Emacs.

Pour définir un numéro de téléphone, une URL ou un e-mail avec les mots-clés suivants:

• PHONE_NUMBER: Numéro de téléphone
• URL: URL vers, par exemple, son site web
• EMAIL: Adresse E-mail

En plus de ces mots-clés, il faut aussi indiquer qu'on veut les inclure dans la lettre. Pour cela, on utilise le mot-clé OPTIONS comme ceci:

#+OPITONS: phone:t url:t email:t

La lettre t correspond à True, ce qui active l'option. Pour désactiver une option, il faut l'associer à nil.

Pour désactiver les petites marques de pliage, il faut définir l'option foldmarks à nil en utilisant le mot clé OPTIONS.

Par exemple:

#+OPITONS: foldmarks:nil

En générale, les sections sont ignorées lors de l'exportation.

À l'exception des sections avec une des étiquettes suivantes:

Si une section a l'étiquette ps, son corps sera ajouté en tant que postscriptum à la lettre.

Si une section a l'étiquette cc, son corps sera ajouté à la fin de la lettre pour indiquer à qui une copie de la lettre sera envoyée. On peut utiliser une liste pour représenter plusieurs personnes.

Si une section a l'étiquette encl, son corps sera ajouté pour indiquer la liste des pièces jointes. Dans le document Org-mode, on peut utiliser une liste ou simplement du texte. Très utile sur une lettre de motivation, pour indiquer qu'on a joint son CV et une copie de ses diplômes.

Si une section a l'étiquette after_closing, son corps sera ajouté après la formule de fermeture de la lettre.

Et si une section a l'étiquette after_letter, son corps sera ajouté après la lettre.

En plus des mots-clés disponibles pour une exportation au format LaTeX, on peut utiliser des mots-clés spécifiques à notre lettre.

Je t'en ai présenté quelques uns depuis le début de ce billet, mais en voici un résumé avec quelques ajouts (la variable Emacs peut être utilisée pour définir une valeur par défaut):

En plus des mots-clés, les options suivantes peuvent être définies avec le mot-clé OPTIONS (la variable Emacs peut être utilisée pour définir une valeur par défaut):

Pour l'option subject, les valeurs suivantes sont disponibles:

Pour avoir plusieurs lettre dans un même document Org-mode, il faut créer une section pour chaque lettre. Les mots clés peuvent être définis de 2 façons:

• En haut du document, comme on l'a vu jusqu'ici
• Sous forme de propriétés rattachées à la section représentant une lettre

Dans le premier cas, le mot clés sera appliqué pour toutes les lettres du document. Utile pour ne pas devoir se répéter à chaque lettre.

Dans le second cas, il faut préfixer chaque propriété avec "EXPORT_". Les mots-clés définis comme propriétés ne seront appliqués qu'à la section.

Le titre des lettres est définit par le titre de la section. Pour définir le nom du fichier PDF vers lequel chaque lettre est exportée, tu peux utiliser la propriété EXPORT_FILE_NAME.

Enfin, les status (TODO, DONE, etc) et étiquettes placées sur une section ne seront pas exportées. Très utile pour gérer le suivie d'une lettre. Un peu plus loin, j'explique aussi comment ajouter des notes à une lettre sans que celles-ci ne soient exportés.

Pour exporter une des lettres, il faut placer le curseur d'écriture sur la section et entrer le raccourcis clavier suivant: C-c C-e C-s k p.

Ceci va aussi appeler l'exportateur de Org-mode, mais en ajoutant C-s on limite l'exportation à la section où se trouve notre curseur.

N'oublie pas la partie C-s, sinon tu exportera tout le document Org-mode comme une seule lettre.

Voici une reprise de l'exemple montré plus haut dans ce billet, mais adapté pour former 2 lettres:

* Lettre numéro 1
:PROPERTIES:
:EXPORT_LANGUAGE:       fr
:EXPORT_AUTHOR:         Fox
:EXPORT_FROM_ADDRESS:   4 rue de nulle part\\1000 Lausanne
:EXPORT_TO_ADDRESS:     OCP\\2 chemin des virgules\\1000 Lausanne
:EXPORT_OPENING:        Madame, Monsieur
:EXPORT_CLOSING:        Avec mes meilleures salutations
:EXPORT_DATE:           \today
:EXPORT_PLACE:          Lausanne
:EXPORT_LCO:            SN
:EXPORT_OPTIONS:        
:END:

Exemple de lettre écrite avec Org-mode. Exemple de lettre écrite avec
Org-mode. Exemple de lettre écrite avec Org-mode. Exemple de lettre
écrite avec Org-mode. Exemple de lettre écrite avec Org-mode. Exemple
de lettre écrite avec Org-mode. Exemple de lettre écrite avec
Org-mode. Exemple de lettre écrite avec Org-mode. Exemple de lettre
écrite avec Org-mode. Exemple de lettre écrite avec Org-mode. Exemple
de lettre écrite avec Org-mode. Exemple de lettre écrite avec
Org-mode.


* Lettre numéro 2
:PROPERTIES:
:EXPORT_LANGUAGE:       fr
:EXPORT_AUTHOR:         Fox
:EXPORT_FROM_ADDRESS:   4 rue de nulle part\\1000 Lausanne
:EXPORT_TO_ADDRESS:     OCP\\2 chemin des virgules\\1000 Lausanne
:EXPORT_OPENING:        Madame, Monsieur
:EXPORT_CLOSING:        Avec mes meilleures salutations
:EXPORT_DATE:           \today
:EXPORT_PLACE:          Lausanne
:EXPORT_LCO:            SN
:EXPORT_OPTIONS:        
:END:

Exemple de lettre écrite avec Org-mode. Exemple de lettre écrite avec
Org-mode. Exemple de lettre écrite avec Org-mode. Exemple de lettre
écrite avec Org-mode. Exemple de lettre écrite avec Org-mode. Exemple
de lettre écrite avec Org-mode.