Memo Orgmode: Les bases

Table of Contents

Lien vers ma page web ISIMA

Comment bien commencer orgmode

Orgmode est un mécanisme dans emacs. C’est un type de fichier qui permet de faire de nombreuses choses, comme gérer des listes, gérer son plannig, manipuler différents langages de programmation, et bien d’autres choses. Tout cela est possible dans un seul fichier texte dont l’extension est .org. Pour accéder au manuel de orgmode : ALT+x puis org-info

Les déplacements

  • On utilise les mêmes touches que vim: h j k l
  • Pour aller directement au prochain titre de même niveau:
    • gj pour un titre en dessous de notre curseur
    • gk pour un titre au dessus de notre curseur
  • gh pour aller au titre de niveau supérieur
  • gl pour aller au titre de niveau inférieur

Gestion de la structure des titres

Les bases

  • Pour insérer un titre, il faut inscrire un certain nombre d’astérisques au début d’une ligne (1 pour un titre de niveau 1, ect…)
  • Insérer un titre en dessous d’un autre : ctrl-return
  • Surclasser ou déclasser un titre: alt-left ou alt-right
  • Pour déplacer un titre et son paragraphe: alt-j ou alt-k

Exemple

Titre

Sous-titre

Titre de niveau 3

  • ect…

    Pour créer un titre on peut aussi utiliser SPC-m-h Pour replier une partie du document et ne faire apparaitre que le texte, on se positionne au niveau du titre que l’on souhaite, et lorsqu’on appuie sur tabulation, tout les élements que comportent ce titre sont rendu invisible. Le seul indicateur montrant leur présence, c’est les points de suspensions à la suite du titre. Pour déplier à nouveau le contenu il suffit d’appuyer sur tabulation. Pour que tout les sous titres soient dépliées, il faut faire maj+tab au niveau des points de suspension.

Commandes avancées

  • Sélectionner un élement (titre et son paragraphe): vae
  • Supprimer un élement: dae

Mise en page

Il est possible de gérer la mise en page du texte à l’aide de différents environnements.

  1. L’environnement pour les poésies:

        #+BEGIN_VERSE
        Demain, dès l’aube, à l’heure où blanchit la campagne,
        Je partirai. Vois-tu, je sais que tu m’attends.
        J’irai par la forêt, j’irai par la montagne.
        Je ne puis demeurer loin de toi plus longtemps.
        #+END_VERSE
    
    • Rendu:

      Demain, dès l’aube, à l’heure où blanchit la campagne,
      Je partirai. Vois-tu, je sais que tu m’attends.
      J’irai par la forêt, j’irai par la montagne.
      Je ne puis demeurer loin de toi plus longtemps.

  2. L’environnement pour les citations:

        #+BEGIN_QUOTE
           «Rien ne se crée, rien ne se perd, tout se transforme».
    
            Antoine-Laurent de Lavoisier (1743 - 1794)
        #+END_QUOTE
    
    • Rendu:

«Rien ne se crée, rien ne se perd, tout se transforme».

Antoine-Laurent de Lavoisier (1743 - 1794)

Les styles

Il est possible d’ajouter un certain nombre d’effets de style aux différents mots de nos paragraphe:

  • ~mot~ : mot
  • *word* : word
  • /palabra/ : palabra

Les listes

Pour créer une nouvelle liste: SPC-m-i au niveau de l’élement voulu. On peut aussi ajouter un + après un élement en début de ligne pour créer un élement de liste non numéroté. Pour créer une liste numéroté, il suffit d’écrire en début de ligne n., où n est un nombre. Il est possible de faire des listes de listes en fonction de l’indentation.

Exemple

  • liste 1
  • liste 2
    1. élement 1
    2. élement 2
    3. élement 3
  • liste 3
  • liste 4

Les tableaux

  • Pour créer un tableau il suffit d’insérer le symbole | pour délimiter chaque colonne, comme ceci: |Nom|Prénom|Classe|
  • Pour créer une nouvelle ligne: SPC-RET
  • Pour créer un séparateur entre l’entête et les informations: SPC-m-b--
  • Pour dupliquer une cellule: MAJ-RETURN
  • Pour insérer une nouvelle colonne ou ligne: alt-SHIFT-j ou alt-SHIFT-l

Exemple:

Nom Prénom Classe
CHEDAS Mathieu Prep’ISIMA
2 2 Prep’ISIMA
3 3 Prep’ISIMA

Insérer des “snippet”

Les snippets sont des outils, qui peuvent être des constantes, des informations diverses et variées, des environnements, ect… Ils sont très utiles sur orgmode et peuvent aider dans la réalisation de documents. Pour en insérer:

  • SPC-i-s puis:
    • bang : pour un environnement Bash
    • time : pour afficher l’heure et la date
    • pi : pour obtenir une approximation de pi

Exemple

  • time: Fri Feb 3 17:35:02 2023

Insertion d’image

Dans un fichier orgmode il est possible d’insérer des images de différentes manières.

Image simple

Pour insérer une image de la façon la plus simple possible:

[[file:Image/b22.jpg]]

Qui nous donneras:

b22.jpg

Image légendé

Pour insérer une image avec une légende, alignée, ou avec une taille modifiée, on utilise la syntaxe suivante:

#+CAPTION: Logo du groupe INP
#+ATTR_HTML: :width 150px :style margin-left:40%;margin-right:40%;
[[./Image/b2.jpg]]

Qui donnera:

b2.jpg

Figure 1: Logo du groupe INP

Lien hypertext

Références internes

Pour créer des liens internes, on utilise des ancres, qui sont des balises spécifiques. Puis, on appelle l’ancre à l’endroit voulu.

Exemple

<<ancre1>>

Voir paragraphe [[ancre1][1]]

Qui donnera:

Voir paragraphe 1

Références externes

Pour ajouter une référence externe il y a deux possibilitées.

  • On met directement le lien du site dans notre paragraphe

Exemple

Pour aller sur la page wikipédia de Linux: https://fr.wikipedia.org/wiki/Linux

  • On rend un ou plusieurs mots cliquables

Exemple

[[https://fr.wikipedia.org/wiki/Linux][Ce lien]] vous dirige sur la page Wikipédia de Linux

Qui nous donnes:

Ce lien vous dirige sur la page Wikipédia de Linux

Insertion de code type LaTeX

Environnement Maths

Pour insérer des formules de mathématiques dans un document .org, et qu’elles apparaissent correctement en le convertissant en HTML,il faut utiliser la ligne suivante.

#+HTML_MATHJAX: align: left

Elle permet de faire en sorte que le code LaTeX de mathématiques soit convertit de la même manière que si l’on travaillait sur un document Latex.

Exemple

\begin{equation}
x=\sqrt(2)
\end{equation}

Nous donnera:

\begin{equation} x=\sqrt(2) \end{equation}

Symboles spéciaux

Il est également possible d’insérer des symboles spéciaux tel que les lettres grecs, ce qui peut être utile si on veut insérer des mathématiques dans une page HTML. Pour les insérer c’est assez simple, il suffit d’écrire \symbole.

Exemple

\alpha+\beta = \gamma donne α+β = γ

Insérer du code

Il est possible d’insérer du code dans un document orgmode de la façon suivante:

 #+INCLUDE: "code/fichier.c" src c

Ce qui donnera:

#include<stdio.h>

int main(){

  printf("Hello World\n"); // Affichage 
  
  return 0;
}

Pour gérer son organisation

Insérer des listes de choses à faire

  • TODO rapport codingame 2
  • DONE exercice graphviz
  • WAIT apprendre les commandes emacs
    • Pour changer l’état d’un item “TODO”: SPC-m-t

Emploi du temps

  • Affichage: alt-x puis org-schedule ou SPC-m-d-s

Pour créer une lsite d’item cochables [1/3]

  • Pour créer un item cochable: - [-] tache
    • [-] tache 1
    • [-] tache 2
    • [X] tache 3
  • Pour cocher une tache effuctuée: ctrl-c-ctrl-c
  • Pour afficher le nombre de taches accomplies: / entre crochets

Agenda

  • Pour ouvrir l’agenda: SPC-o-a
  • Pour fermer l’agenda: q

Conversion

Pour convertir un document initialement créé en orgmode, il suffit d’executer les commandes suivantes:

  • alt-x
  • org-export-dispatch ou
  • alt-SPC-m-e puis
  • h-o

Author: Mathieu CHEDAS

Created: 2023-02-04 sam. 16:44