Ebook Arduino !

couverture ebook

Pelican étant sympa, l’outil propose différentes méthodes de rédaction pour correspondre au goût du plus grand nombre. Parmi les plus habituels, on retrouve le markdown, le rst ou encore le HTML. Je vais vous présenter leur utilisation dans Pelican dans ce chapitre, mais je ne rentrerais pas dans le détail concernant leur mécanisme de rédaction. Aussi, ormis les différences dans la syntaxe de la rédaction, les metadonnées ne seront pas écrites pareil, et c’est là surtout l’objet de ce court chapitre.

Sommaire

Markdown

Le premier moyen de rédaction que je souhaite vous présenter est le markdown. Pour l’utiliser il faudra que vos fichiers aient l’extension .md (les extensions .markdown , .mkd ou .mdown sont aussi acceptées). Aussi, le parseur markdown doit-être installé via la commande pip install markdown .

Markdown est un format de rédaction très agréable à utiliser car son markup est très léger, ce qui fait qu’un document rédigé mais non mis en forme reste tout de même très lisible.

La syntaxe des métadonnées lorsque l’on utilise le format markdown est celle que l’on a vu dans le chapitre précédent, à savoir une liste de clé:valeur.

Title: Ma super recette de cookies
Date: 2018-06-06 09:00
Modified: 2018-06-07 14:42
Category: Cookie
Tags: cookie, chocolat, recette
Slug: ma-super-recette-de-cookies
Authors: Eskimon
Summary: Dans cette article je vous présente une recette pour des cookies délicieux !

Voici le corps de l'article, blablabla...

reStructuredText - .rst

Le format reStructuredText possède quant à lui l’extension .rst . Il ne nécessite pas l’installation d’un package supplémentaire particulier. Pour ceux qui l’ignore, c’est le langage utilisé pour la rédaction de la documentation de python !

Là encore, au delà des sucres syntaxiques, tout se joue dans l’organisation des métadonnées. On retrouve de nouveau une liste de clé:valeur au format :clé:valeur ( : avant la clé). Regardez bien l’exemple suivant, le titre lui aussi change d’aspect.

Ma super recette de cookies
###########################

:Date: 2018-06-06 09:00
:Modified: 2018-06-07 14:42
:Category: Cookie
:Tags: cookie, chocolat, recette
:Slug: ma-super-recette-de-cookies
:Authors: Eskimon
:Summary: Dans cette article je vous présente une recette pour des cookies délicieux !

Voici le corps de l'article, blablabla...

Hypertext Markup Language - .html

Le dernier langage utilisable lui aussi sans extension est le HTML. Indispensable pour faire des pages web, il permet aussi de rédiger directement vos articles. Il est cependant bien plus verbeux que les deux précédents que nous venons de voir.

Pour l’utiliser, il faudra que les fichiers des articles aient l’extension .html ou .htm . Ensuite, il suffit d’imaginer rédiger une page web classique, en se contentant du strict minimum. On trouve alors les metadonnées dans la balise <head> et le corps de l’article dans <body> . Le tout étant englobé d’une balise <html> .

Voici notre exemple de nouveau :

<html>
    <head>
        <title>Ma super recette de cookies</title>
        <meta name="tags" content="cookie, chocolat, recette" />
        <meta name="date" content="2018-06-06 09:00" />
        <meta name="modified" content="2018-06-07 14:42" />
        <meta name="category" content="Cookie" />
        <meta name="authors" content="Eskimon" />
        <meta name="summary" content="Dans cette article je vous présente une recette pour des cookies délicieux !" />
    </head>
    <body>
        Voici le corps de l'article, blablabla...
    </body>
</html>

Voilà cette rapide présentation faite. Comme vous pouvez vous en doutez, bien que la rédaction aura un aspect différent dans le document brut, le rendu sera quant à lui le même.

Si jamais vous souhaitez utiliser un autre format de rédaction, il existe de nombreux plugins ajoutant ces fonctionnalités. Veillez à bien consulter leur documentation, la mise en forme des métadonnées peut changer d’un article à l’autre. Pour ceux voulant aller plus loin, j’avais même fait un billet traitant de l’ajout du zmarkdown dans Pelican pour pouvoir rédiger avec le même markdown que celui de Zeste de Savoir !


Licence CC BY-NC-SA