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

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.

Article lu   fois.

Les deux auteurs

Site personnel

Profil ProSite personnel

Liens sociaux

Viadeo Twitter Facebook Share on Google+   

1. Introduction

Org-mode est outil de gestion et de plannification 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é 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 tutorial 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.

1.1. 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 tutorial.

1.2. Installation

Ajoute le code suivant dans votre ".emacs":

 
Sélectionnez

(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 claviers globaux. Nous aborderont "org-store-link" et "org-agenda" plus tard dans ce tutorial.

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.

2. Les bases

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

2.1. Création d'un nouveau fichier

Si vous avez configurer 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.

2.2. Liste des tâches simples

Tout d'abord, j'ai saisi une 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 taches du corps du document en cours de rédaction.

L'entête de premier niveau commence avec une "asterisque", une entête de second niveau avec deux, ...

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

Image non disponible

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.

Image non disponible

Notez que org-mode spécifie une heure de "cloture" lorsqu'un item TODO a été marqué comme "fait".

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

Image non disponible

2.3. Utilisation des entêtes pour structurer un document

La meilleur 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 que une astérisque indique une entête de premier niveau, deux asterisques une entête de second niveau,...

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

Image non disponible

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.

2.4. Remplissage des sections

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

Image non disponible

2.5. 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:

 
Sélectionnez

[[lien][description]]
		  

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

Image non disponible

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

Image non disponible

Essayer de positionner le curseur et utiliser 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 copier le lien en utilisant le raccourci C-c C-l qui appel org-insert-link. (Il est possible que vous ayez à naviguer dans le document pour retrouver le lien que vous venez de coller).

2.6. Vue d'ensemble du document

A 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.

Image non disponible

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

Image non disponible

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

Image non disponible

2.7. Ajouter des notes aux tâches

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

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

3. 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é.

3.1. Configuration

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

Imaginons que nous avons plusieurs fichiers existants: 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:

 
Sélectionnez

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

3.2. 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:

Image non disponible

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 où utiliser le raccourci RET pour ouvrir le fichier et se placer dans l'item TODO sélectionné.

3.3. Programmer des tâches et utilisation de l'agenda

Imaginons que nous souhaitions plannifier 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 executer org-schedule. Le calendrier s'ouvre et vous pouvez choisir, ou entrer, la date désirée:

Image non disponible

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

Image non disponible

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

Image non disponible

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

Image non disponible

4. 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

Date: 2008-12-28

Vous avez aimé ce tutoriel ? Alors partagez-le en cliquant sur les boutons suivants : Viadeo Twitter Facebook Share on Google+   

  

Copyright © . 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.