Introduction au mode org-mode, le mode d'organisation sous Emacs

| dotoole | traduit par hiko-seijuro |

Cet article est la traduction de l'orgtutorial de David O'Toole disponible à cette adresse: http://dto.github.com/notebook/orgtutorial.html. Le but est d'introduire à l'utilisation du mode organisation sous Emacs.

- Titre : Introduction au mode org-mode, le mode d'organisation sous Emacs

- Auteurs : dotoole, traduit par hiko-seijuro

- Parution : 4 septembre 2009

- Mise à jour : 29 mars 2020

- Licence : Copyright ® 2020 dotoole. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Introduction

- I-A. Récupérer org-mode

- I-B. Installation

- II. Les bases

- II-A. Création d'un nouveau fichier

- II-B. Liste des tâches simples

- II-C. Utilisation des entêtes pour structurer un document

- II-D. Remplissage des sections

- II-E. Ajouts de liens

- II-F. Vue d'ensemble du document

- II-G. Ajouter des notes aux tâches

- III. Un aperçu des fonctionnalités avancées

- III-A. Configuration

- III-B. Une TODO liste globale

- III-C. Programmer des tâches et utilisations de l'agenda

- IV. Conclusion

I - Introduction

Org-mode est outil de gestion et de planification personnel pour Emacs. Cet article a pour objectif de donner au lecteur un aperçu de l'org-mode et de lui enseigner les bases grâce une progression pas à pas détaillée et un nombre élevé de captures d'écran. Le but n'étant pas de se substituer au manuel, l'objet de cet article ne porte que sur une partie des fonctionnalités de l'org-mode.

Ce tutoriel a été traduit en français, japonais, chinois, et coréen. La version originale étant disponible à l'adresse http://dto.github.com/notebook/orgtutorial.html.

I-A - Récupérer org-mode

Vous pouvez télécharger org-mode sur son site web. Il est préférable de récupérer la dernière version pour suivre ce tutoriel.

I-B - Installation

Ajoutez le code suivant dans votre « .emacs »:

(add-to-list 'load-path "<chemin ou org-mode a ete installe>")
(require 'org-install)
(add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
(define-key global-map "\C-cl" 'org-store-link)
(define-key global-map "\C-ca" 'org-agenda)
(setq org-log-done t)

Cela permet de charger l'org-mode et de définir des raccourcis clavier globaux. Nous aborderons « org-store-link » et « org-agenda » plus tard dans ce tutoriel.

Une dernière chose, il est préférable de stocker les fichiers spécifiques à org-mode dans un répertoire spécifique. Je recommande d'utiliser ~/org.

II - Les bases

Cette section illustre les bases d'« org-mode ». Il montre, entre autres, comment ce mode a été utilisé pour produire ce document

II-A - Création d'un nouveau fichier

Si vous avez configuré Emacs comme indiqué précédemment, il devrait alors entrer dans le mode « org-mode » lors que vous ouvrez ou créez un fichier dont l'extension est « .org ».

J'ai créé un nouveau fichier nommé « OrgTutorial.org » et Emacs indique « Org » dans la ligne de mode. Cela signifie que nous sommes dans le mode org-mode.

II-B - Liste des tâches simples

Tout d'abord, j'ai saisi un entête intitulé « Tasks » afin de classer les tâches en dessous. Cela n'est pas nécessaire, mais utile, spécialement quand vous souhaitez séparer les tâches du corps du document en cours de rédaction.

L'entête de premier niveau commence avec un « astérisque », un entête de second niveau avec deux…

Dans « org-mode », les items TODO sont toujours des entêtes. J'ai créé un item TODO pour « Start new org file for tutorial » (« Créer un nouveau fichier pour le tutoriel »)

Ceci est un peu stupide puisque le fichier est déjà créé. On peut donc passer l'item TODO en item DONE. Pour cela, il faut se placer sur la ligne de l'item et utiliser le raccourci C-c C-t, qui fait appel à la fonction org-todo.

Notez que org-mode spécifie une heure de « clôture » lorsqu'un item TODO a été marqué comme « fait ».

Ajoutons d'autres items TODO. Positionnez le curseur sur la ligne suivante, puis utilisez le raccourci M-shift-RET qui exécute la fonction org-insert-todo-heading. Vous pouvez ajouter ainsi plusieurs items TODO

II-C - Utilisation des entêtes pour structurer un document

La meilleure façon d'organiser vos idées est généralement de les structurer sous forme de plan. La prochaine étape est de créer un plan résumant les différents points du tutoriel. En faisant cela, vous transformez le problème de l'intimidante page blanche en plusieurs petits problèmes moins intimidants. La rédaction devient alors plus facile.

Souvenez-vous qu’un astérisque indique un entête de premier niveau, deux astérisques un entête de second niveau…

Voilà ce que cela donne après avoir construit le plan du document (NDLR il s'agit d'une ancienne version de l'article original) :

Notez que j'ai passé la tâche « Définition du plan du document » en DONE dès que j'ai terminé sa rédaction.

II-D - Remplissage des sections

Vous pouvez ajouter facilement le contenu de la section en dessous de l'entête approprié.

II-E - Ajouts de liens

Dans la section « Obtenir org-mode », il a fallu spécifier un lien vers le site web de « org-mode ». Pour cela, on utilise les crochets comme suit :

[[lien][description]]

Voici ce que cela donne lorsque j'ai saisi le lien et la description en laissant le dernier crochet « global » ouvert :

Lorsque je ferme ce crochet, la mise en page spécifique au lien apparaît en ne montrant que la description soulignée comme suit :

Essayez de positionner le curseur et utilisez le raccourci C-c C-o pour appeler la fonction org-open-at-point.

Vous pouvez aussi faire des liens sur des fichiers locaux. Ouvrez un autre fichier. Dans le buffer du fichier ouvert utilisez le raccourci C-c l pour appeler org-store-link. Un message apparaîtra, dans le minibuffer, indiquant que le chemin du fichier a été stocké.

Retournez sur le buffer contenant votre document « org-mode » et copiez le lien en utilisant le raccourci C-c C-l qui appelle org-insert-link. (Il est possible que vous ayez à naviguer dans le document pour retrouver le lien que vous venez de coller.)

II-F - Vue d'ensemble du document

À cette étape, le document commence à devenir long et cela devient impossible de tout afficher à l'écran. « org-mode » permet d'obtenir un aperçu du document en utilisant le raccourci shift-TAB.

Notez que seuls les entêtes de premier niveau sont visibles. En utilisant le raccourci shift-TAB encore une fois, tous les entêtes sont affichés à l'écran, y compris les items TODO.

En utilisant ce raccourci encore une fois, tout le document est affiché, avec le corps des sections :

II-G - Ajouter des notes aux tâches

Vous pouvez ajouter autant de texte que vous voulez en dessous d'un entête. En réalité, vous pouvez avoir des entêtes de niveaux inférieurs sous un TODO ; un TODO sous un TODO…

Être capable d'annoter les tâches facilite de regrouper les liens et remarques spécifiques à la tâche. Être capable de segmenter les tâches est utile pour modéliser le processus. Généralement, une tâche volumineuse est décomposée en plusieurs sous-tâches qui doivent être contrôlées pendant leur avancement.

III - Un aperçu des fonctionnalités avancées

Pour terminer, nous allons aborder les TODO listes globales, la planification et les fonctionnalités de l'agenda. Elles sont utilisées en couple avec les items TODO dans différents fichiers pour gérer les priorités et l'affichage chronologique. Vous pouvez aussi les utiliser pour voir quelles sont les tâches qui sont terminées et quand elles l'ont été.

III-A - Configuration

Tout d'abord, vous devez définir la variable org-agenda-files pour que « org-mode » sache quels fichiers rechercher pour les items TODO et planifiés.

Imaginons que nous avons plusieurs fichiers : un pour le travail (work), un pour la maison (home) et un pour les cours (school). Voici ce que, par exemple, vous devez ajouter à votre fichier d'initialisation Emacs :

(setq org-agenda-files (list "~/org/work.org"
"~/org/school.org"
"~/org/home.org"))

III-B - Une TODO liste globale

Utiliser le raccourci C-c a t pour ouvrir la TODO liste globale. « org-mode » scannera tous les fichiers décrits par la variable org-agenda-files et affichera un listing de tous les items TODO :

Vous pouvez positionner votre curseur sur les différents items TODO, puis en utilisant le raccourci t pour indiquer que la tâche a été effectuée ou utiliser le raccourci RET pour ouvrir le fichier et se placer dans l'item TODO sélectionné.

III-C - Programmer des tâches et utilisations de l'agenda

Imaginons que nous souhaitions planifier la tâche « finir le document »(« Finish document ») pour aujourd'hui. Il suffit de positionner le curseur sur la ligne suivant l'entête de l'item TODO « Finish document », puis utiliser le raccourci C-c C-s pour exécuter org-schedule. Le calendrier s'ouvre et vous pouvez choisir, ou entrer, la date désirée :

Une fois la date sélectionnée, « org-mode » insère une « deadline » après l'item TODO :

Maintenant sauvez le fichier, puis utilisez le raccourci C-c a a pour appeler la fonction org-agenda. Le planning de la semaine s'affiche :

Maintenant utilisez le raccourci l (L minuscule) pour utiliser l'affichage « log ». Cela affiche toutes les tâches terminées et l'heure de fin.

IV - Conclusion

Cet article ne présente qu'un bref aperçu des possibilités de « org-mode ». Plus de détails vous attendent sur le manuel en ligne de « org-mode ».

Auteur: David O'Toole <dto@gnu.org>

Date: 2008-12-28