Créer des documents simplement avec Pillar

Magazine
Marque
GNU/Linux Magazine
Numéro
192
Mois de parution
avril 2016
Domaines


Résumé
Pillar est un format textuel simple et concis. Un de plus ? Oui. Les développeurs de Pillar (dont moi) ont réutilisé le parser d'un vieux CMS appelé Pier et l'ont modifié jusqu'à en faire une plateforme idéale pour tous leurs besoins de documentation : des livres (dont 3 terminés ou quasiment terminés), des manuels techniques, des slides de cours (dont un MOOC sur Pharo) et des sites web. Le résultat de ce travail est un outil incluant des fonctions puissantes comme les éléments référençables (les titres, les figures, les scripts), la génération automatique de texte, la numérotation finement paramétrable des titres, et la génération de slides et de colonnes de texte. Cet article présente un tutoriel d'utilisation et les bases de la syntaxe Pillar.

Pillar [1] est un format textuel simple et concis, c'est aussi un logiciel libre (licence MIT) et multiplateforme, écrit en Pharo [2], permettant de convertir un texte Pillar vers un fichier PDF avec LaTeX (voir figure 1), HTML (voir figure 2) ou Markdown. D'autres formats de sortie sont en développement ou prévus comme Asciidoc et un format XML propre à une plateforme de cours en ligne.

Pillar a déjà été utilisé à de nombreuses occasions dans la communauté Pharo afin de produire des articles, des livres [3][4], le contenu des CMS Pier et Marina, le contenu du générateur de sites web statiques Ecstatic [5] et même le MOOC (cours en ligne) Pharo [6] pour la plateforme France Université Numérique (60 cours avec enseignant filmé, des dizaines de screencasts, des exercices de conception, des quiz, etc.). Pillar peut générer non seulement des documents textuels (livres, sites), mais aussi des slides (avec DeckJS ou Beamer, voir figure 3) pour illustrer des...

Cet article est réservé aux abonnés. Il vous reste 94% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Générez la documentation technique de vos projets Godot

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Découvrons comment utiliser GDScript Docs Maker pour générer automatiquement la documentation de vos projets Godot. Nous allons voir dans cet article que l’on peut simplement, à partir de notre code et de ses commentaires, avoir une documentation toujours à jour.

Implémentation du calcul symbolique et de la dérivation en Java

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Les logiciels de calcul symbolique sont relativement abondants. Pour les curieux ou ceux qui voudraient intégrer ce type de fonctionnalités dans leurs propres programmes, nous allons essayer de lever une partie des mystères des théories et des problèmes qui se cachent derrière la création de ces systèmes.

Déboguez vos codes PHP

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

La mise au point de programmes PHP est parfois perçue comme archaïque, car la configuration d’un environnement efficace de debugging peut s’avérer déroutante. Voici comment paramétrer une confortable installation pour profiter pleinement d’outils professionnels et maîtriser le développement local ou distant.