Jour 7 :org-mode (partie 1)

#emacs #orgmode

Présentation

#

La page web du projet indique de manière laconique:

Votre vie en texte brut

Un mode majeur de GNU Emacs pour un format de balisage léger et pratique — et bien plus.

Exemples d’utilisation d’org-mode:

• prise de notes
• création de présentation
• agenda
• suivi des événements importants
• suivi des événements récurrents
• tâches à faire (TODO liste)
• gestion des courriels
• journaux
• tenu de compte
• registres de travail
• priorisation des tâches
• suivi du temps consacré à différentes tâches
• génération de rapports
• annotation de présentations
• annotation d’un livre
• suivi des bogues dans le code
• exportation de documents vers divers formats courants

Le guide de démarrage officiel traduit en français.

#

Préambule

#

Au début d’un fichier (avant le premier titre), il est courant de définir le titre, l’auteur et autres options d’export.

Titre

#

Les lignes qui commencent par un astérisque * sont des titres.

Un seul * indique un titre de niveau 1, ** indique un titre de niveau 2, etc.

Bienvenue dans Org-mode

#

Sous-titre

#

Chaque astérisque supplémentaire augmente le niveau d’un cran.

Dans leur forme la plus simple, les titres sont simplement le début d’une section. Cependant, tout titre peut également devenir une tâche à faire.

Les éléments TODO sont le bloc de construction de base que Org utilise pour suivre et organiser tous les types de tâches.

Pour ajouter un élément TODO à un titre, commencez le titre avec un mot-clé TODO tel que TODO ou HOLD.

TODO Propager Org dans le monde

#

DONE Créer un guide de démarrage rapide

#

Marque d’accentuation

#

Pour marquer du texte en Org, il suffit de l’entourer avec un ou plusieurs caractères marqueurs. Gras, italique et souligné sont assez intuitifs, et la capacité d’utiliser ~~~~barré~~~~ est un plus. Vous pouvez combiner le marquage de base dans n’importe quel ordre, mais code et verbatim doivent être les marqueurs les plus intérieurs s’ils sont présents car leur contenu est interprété littéralement.

Voir Marques d’accentuation pour plus de détails.

Listes

#

Les listes non ordonnées commencent par +, -, ou *. Les listes ordonnées commencent par 1., 1), A., ou A). Les éléments de liste ordonné et non ordonné peuvent être imbriqués dans n’importe quel ordre.

Pour acheter :

1. Lait
2. Oeufs
   • Bio
3. Fromage
   • Parmesan
   • Mozzarella

Les listes peuvent contenir des cases à cocher [ ], [-], [X].

• non démarré
• [-] en cours
• terminé

Les listes peuvent contenir des étiquettes (et des cases à cocher en même temps).

• fruits : obtenir des pommes
• légumes : obtenir des carottes

Liens

#

Pour créer un lien, placez la cible entre deux crochets droits, comme ceci : https://www.emacs.org. Vous pouvez inclure une description dans les crochets droits après la cible emacs.

L’ordre est facile à retenir car il est le même qu’une balise html <a>: <a href=“cible”>desc</a> et vous ne pouvez pas mélanger les crochets et les parenthèses car il n’y a que des crochets droits !

Org prend en charge une grande variété de types de cibles de lien, et vous pouvez également en ajouter vous-même. Les types de liens sont indiqués avec un préfixe de type, c’est-à-dire [type : target]. Si aucun type : n’est fourni, org recherche dans le fichier actuel un en-tête qui correspond à la cible.

Voici quelques exemples : un joli site web

Pour en savoir plus sur les liens, consultez les sections du manuel dédiées aux Liens internes et Liens externes.

Images

#

Org mode reconnaît et rend automatiquement les liens d’image pendant l’exportation. Il vous suffit de faire un lien vers une image (ne pas inclure une description). C’est tout.

Les images situées sur votre ordinateur peuvent également être rendues dans le tampon Emacs avec C-c C-x C-v.

Blocs

#

Org mode utilise des blocs #+BEGIN … #+END pour de nombreux usages. Certains des types de blocs de base sont cite, exemple, et src.

Si vous avez simplement besoin d’un texte monospaced, vous pouvez utiliser un bloc exemple.

monospaced

accessible via C-c C-,

Cependant, les blocs exemples ne vous donnent pas la puissance d’org babel. Pour cela, vous avez besoin d’un bloc source. Les blocs sources fournissent une mise en forme syntaxique, une exécution de code, une programmation littéraire et plus encore.

(message "Bonjour le monde")

Un exemple bonjour monde ne peut même pas commencer à gratter la surface du support d’org mode pour travailler avec le code source.

Tables

#

Dans sa forme la plus simple, un tableau est du texte séparé à l’aide de pipes |

Un exemple plus utile est cette comparaison des outils existants de programmation littéraire / recherche reproducible (à partir de Schulte et al. 2012).

Inquiets quant à l’alignement des tables de texte libre ? Org mode le fait en une seule frappe: tab.

Commentaires

#

Org mode dispose de nombreuses façons d’ajouter des commentaires.

• Les commentaires de ligne commencent par #.
• Les commentaires en ligne enveloppés par .
• Les commentaires de bloc sont enveloppés avec #+BEGIN_COMMENT et #+END_COMMENT.
• Les commentaires de section peuvent être créés en ajoutant le mot-clé COMMENT à un en-tête

Exemple d’un .

Les commentaires en ligne sont utilisés pour les commentaires de fin de ligne. ne fonctionne que s’il est précédé d’une nouvelle ligne suivie d’un espace blanc.

• Exemple COMMENT

Macros

#

Org possède de nombreuses fonctionnalités plus avancées intégrées à sa syntaxe. Pour donner un seul exemple, intéressons-nous aux macros.

Attention! This text gets all the markup!

Du texte. This text will be red.Encore du texte.