Présentation org-mode

Table des matières

Les différents formatages

Survoler la barre verticale verte à gauche pour afficher la table des matières.

Version .html ou .org.

Texte normal

  • Source :
    Ceci est du texte normal.
    Un retour chariot ne termine pas le paragraphe.
    
    Si on laisse une ligne vide, alors on insère un nouveau paragraphe.
    
  • Rendu :

    Ceci est du texte normal. Un retour chariot ne termine pas le paragraphe.

    Si on laisse une ligne vide, alors on insère un nouveau paragraphe.

Formatage simple du texte

  • Source :
    Dans un texte on peut insérer *du gras*, _du souligné_, +du barré+, ~du code~, =du verbatim= et /de l'italique/.
    
  • Rendu :

    Dans un texte on peut insérer du gras, du souligné, du barré, du code, du verbatim et de l'italique.

Listes à puces

  • Source :
    Il est possible d'ajouter des listes à puces :
    - Élément 1
    - Élément 2
    
    Ou :
    + Élément 1
    + Élément 2
    
  • Rendu :

    Il est possible d'ajouter des listes à puces :

    • Élément 1
    • Élément 2

    Ou :

    • Élément 1
    • Élément 2

Blocs de texte

  • Source :
    #+BEGIN_VERSE
    Ceci est un versé
    Ceci est la seconde ligne
    #+END_VERSE
    
    #+BEGIN_QUOTE
    Citation
    sans retour à la ligne.
    #+END_QUOTE
    
    #+BEGIN_CENTER
    Texte centré \\
    et retour à la ligne forcé.
    #+END_CENTER
    
  • Rendu :

    Ceci est un versé
    Ceci est la seconde ligne

    Citation sans retour à la ligne.

    Texte centré
    et retour à la ligne forcé.

Blocs de code

  • Source :
    #+BEGIN_SRC
    class Test:
        def __init__(self, param):
            self.__param = param
    #+END_SRC
    
  • Rendu :
    class Test:
        def __init__(self, param):
    	self.__param = param
    

Images

  • Source :
    [[https://www.orgmode.org/img/org-mode-unicorn-logo.png]]
    
  • Rendu :

    org-mode-unicorn-logo.png

    Figure 1 : Logo de org-mode

Liens

Notes en bas de page

  • Source :
    Ceci est une phrase avec une note en bas de page[fn:1].
    ...
    [fn:1] Note en bas de page.
    
  • Rendu :

    Ceci est une phrase avec une note en bas de page1.

Tableaux

  • Source :
    | Titre 1     | Titre 2     | Titre 3     |
    |-------------+-------------+-------------|
    | Cellule 1,1 | Cellule 1,2 | Cellule 1,3 |
    | Cellule 2,1 | Cellule 2,2 | Cellule 2,3 |
    
  • Rendu :
    Titre 1 Titre 2 Titre 3
    Cellule 1,1 Cellule 1,2 Cellule 1,3
    Cellule 2,1 Cellule 2,2 Cellule 2,3

La gestion des tâches [40%]

TODO Tâche à faire

WAITING Tâche en attente

IN-PROGRESS Tâche en cours

DONE Tâche terminée

CANCELED Tâche annulée

La gestion des tags

Le tag noexport permet de ne pas exporter le contenu.

Titre avec un tag URGENT   URGENT

Titre avec un tag IMPORTANT   IMPORTANT

Titre avec un tag LOW   LOW

Titre avec un tag DIVERS   DIVERS

Titre avec un tag ARCHIVE   ARCHIVE

Le paramétrage

Il est possible de paramétrer le fichier org-mode pour adapter le comportement dans emacs et le rendu lors de l'export.

#+AUTHOR: Julien
#+EMAIL: julien@peclu.net
#+TITLE: Présentation org-mode

#+STARTUP: indent heading inlineimages logdone
#+LANGUAGE: fr
#+OPTIONS: email:t stat:t tags:t tasks:t
#+OPTIONS: H:2 num:nil
#+TODO: TODO(t) WAITING(w) IN-PROGRESS(i) | DONE(d) CANCELED(c)
#+TAGS: ARCHIVE(a) URGENT(u) LOW(l) IMPORTANT(i)

#+HTML_HEAD_EXTRA: <style>
#+HTML_HEAD_EXTRA: /* HTML_HEAD_EXTRA */
#+HTML_HEAD_EXTRA: ol {padding-inline-start:1.2em;}
#+HTML_HEAD_EXTRA: ul {padding-inline-start:1.2em;}
#+HTML_HEAD_EXTRA: body {margin:0; padding:0;}
#+HTML_HEAD_EXTRA: /* HTML_HEAD_EXTRA : table of content */
#+HTML_HEAD_EXTRA: div#table-of-contents {position:fixed; left:0; top:0; height:100%; max-width:0; padding:0; margin:0; overflow:hidden; background-color:#f5f5f5; border-left:1em solid #15EEB6; border-right:1px solid #ccc; box-shadow:3px 3px 3px #eee;}
#+HTML_HEAD_EXTRA: div#table-of-contents:hover {max-width:50%; padding:1em; overflow:auto;}
#+HTML_HEAD_EXTRA: div#table-of-contents ul {padding-inline-start:0; list-style-type:none;}
#+HTML_HEAD_EXTRA: div#table-of-contents ul {font-weight:bold;}
#+HTML_HEAD_EXTRA: div#table-of-contents ul ul {font-weight:normal;}
#+HTML_HEAD_EXTRA: div#table-of-contents h2 {border-bottom:1px solid #ccc;}
#+HTML_HEAD_EXTRA: div#table-of-contents a {text-decoration:none; color:#333;}
#+HTML_HEAD_EXTRA: div#table-of-contents a:hover {background-color:#15EEB6;}
#+HTML_HEAD_EXTRA: div#table-of-contents .tag {float:right;}
#+HTML_HEAD_EXTRA: /* HTML_HEAD_EXTRA : content */
#+HTML_HEAD_EXTRA: h1.title {margin:0 0 1em 0; padding:1.2em; display:block; background-color:#f5f5f5; border-bottom:1px solid #ccc; box-shadow:3px 3px 3px #eee;}
#+HTML_HEAD_EXTRA: div.outline-2,div#footnotes {clear:left; margin:2em;}
#+HTML_HEAD_EXTRA: div.outline-3 {margin:1em; padding:1em; overflow:auto; display:block; border:1px solid #ccc; box-shadow:3px 3px 3px #eee;}
#+HTML_HEAD_EXTRA: div.outline-3:hover {box-shadow:3px 3px 3px #15EEB6;}
#+HTML_HEAD_EXTRA: div#postamble {background-color:#f5f5f5; text-align:center; border-top:1px solid #ccc; border-bottom:1px solid #ccc; box-shadow:3px -3px 3px #eee;}
#+HTML_HEAD_EXTRA: table {margin:1.2em 0; border:1px solid #333; box-shadow:3px 3px 3px #eee;}
#+HTML_HEAD_EXTRA: table thead {background-color:#15EEB6;}
#+HTML_HEAD_EXTRA: pre {margin:1.2em 0; background-color:#f5f5f5;}
#+HTML_HEAD_EXTRA: .timestamp {font-family:monospace; color:blue;}
#+HTML_HEAD_EXTRA: .tag {margin:0; padding:0; font-weight:bold; background-color:transparent;}
#+HTML_HEAD_EXTRA: .tag span {margin:0; padding:0.2em; background-color:#15EEB6;}
#+HTML_HEAD_EXTRA: .tag span.URGENT {background-color:red; color:white;}
#+HTML_HEAD_EXTRA: .tag span.ARCHIVE {background-color:#CCC;}
#+HTML_HEAD_EXTRA: .tag span.IMPORTANT {background-color:red;}
#+HTML_HEAD_EXTRA: .tag span.LOW {background-color:orange;}
#+HTML_HEAD_EXTRA: </style>

Export HTML automatique

Il est possible d'ajouter un hook dans le fichier .emacs pour permettre l'export HTML automatique lors de l'enregistrement.

(defun toggle-org-html-export-on-save ()
  (interactive)
  (if (memq 'org-html-export-to-html after-save-hook)
      (progn
	(remove-hook 'after-save-hook 'org-html-export-to-html t)
	(message "Disabled org html export on save for current buffer..."))
    (add-hook 'after-save-hook 'org-html-export-to-html nil t)
    (message "Enabled org html export on save for current buffer...")))

Pour activer/désactiver l'option, il suffit d'exécuter la commande M+x toggle-org-html-export-on-save.

Besoin de plus d'info ?

Pour les compléments d'information, RTFM !

Notes de bas de page:

1

Note en bas de page.

Auteur: Julien

Email: julien_nospam_@peclu.net

Created: 2019-06-19 mer. 07:42

Validate