Asciidoc

De Mi caja de notas

http://www.methods.co.nz/asciidoc/

Asciidoc est un langage de balisage léger. C'est aussi le nom de la suite logicielle qui permet de transformer les fichiers "texte source" en documents publiables.

La suite logicielle comprend les programmes spécialisés de conversion asciidoc et a2x.

Le texte du fichier source forme déjà un document lisible. Le programme de conversion asciidoc permet de transformer le document source au format XHTML, DocBook ou HTML. Le programme a2x permet d'obtenir d'autres formats tels que PDF, TeX, Unix manpages ou Epub.


AsciiDoc
Caractéristiques
Extensions
.txt, .adoc, .asciidocVoir et modifier les données sur Wikidata
Type MIME
text/plain
Version initiale
le 25 novembre 2002, il y a 22 ans
Spécification
Site web
AsciiDoc.py

Informations
Créateur Stuart Rackham
Développé par Matthew Peveler, Dan Allen, Michel Krämer, et al.
Première version le 25 novembre 2002, il y a 22 ans
Dernière version 9.1.1 (le 18 septembre 2021, il y a 3 ans)
Dépôt github.com/asciidoc/asciidoc-py3
Écrit en Python
Environnement Multi-plateforme
Type Générateur de documentation
Licence GNU GPL v2
Site web asciidoc-py.github.io

AsciiDoc est un langage de balisage léger proche du langage Markdown, proposant une richesse sémantique similaire à DocBook. Un document écrit en AsciiDoc forme déjà un document lisible par des humains tout en étant interprétable par des programmes. L'utilisation d'un éditeur de texte permet de créer et éditer un document AsciiDoc.

Un document AsciiDoc peut être publié dans de nombreux formats de sortie, notamment HTML, PDF, DocBook, EPUB et Unix manpages.

Les documents écrit en AsciiDoc comportent l'extension .adoc.

Historique

Le langage AsciiDoc a été créé en 2002 par Stuart Rackham. La première version (1.0) de AsciiDoc.py date du 25 novembre 2002[1]. Cette suite logicielle écrite en Python se compose de deux outils en ligne de commande, asciidoc et a2x, permettant de convertir des fichiers texte brut en documents publiables. Dès la version 1.2 en décembre 2002, AsciiDoc ajoute la balise include qui permet de modulariser et réutiliser du contenu.

Le langage AsciiDoc est actuellement en cours de standardisation à la Fondation Eclipse.

AsciiDoc.py

AsciiDoc.py est une ancienne suite logicielle gérant une version plus ancienne d'AsciiDoc[2].

Asciidoctor

Publiée en 2013, Asciidoctor est une suite logicielle moderne, conforme et sensiblement plus rapide d'AsciiDoc écrit en Ruby. Cette suite logicielle est aussi disponible dans l'écosystème Java via JRuby et JavaScript via Opal[3].

Cette suite logicielle est utilisée par GitHub et GitLab.

Exemple

L'exemple ci-dessous montre un texte utilisant le langage AsciiDoc, et un rendu similaire à celui produit par un processeur AsciiDoc :

Texte source en AsciiDoc Résultat rendu en HTML
= Mon Article
J. Smith

https://wikipedia.org[Wikipedia] 
est une encyclopédie en ligne, 
disponible en Anglais et 
dans *beaucoup* d'autres langues.

== Logiciel

Vous pouvez installer 
'nom-de-paquet' en utilisant 
la commande `gem` :

 gem install nom-de-paquet

== Matériel

Les métaux couramment utilisés 
sont :

* le cuivre ;
* l'étain ;
* le plomb.
Mon Article

J. Smith

Wikipedia est une encyclopédie en ligne, disponible en Anglais et dans beaucoup d'autres langues.

Logiciel

Vous pouvez installer nom-de-paquet en utilisant la commande gem :

gem install nom-de-paquet
Matériel

Les métaux couramment utilisés sont :

  • le cuivre ;
  • l'étain ;
  • le plomb.

Suite logicielle

Un programme de conversion, ou suite logicielle, comme AsciiDOc.py[4] ou Asciidoctor[5] permet de transformer un document écrit en AsciiDoc dans de nombreux formats de sortie.

La suite logicielle Asciidoctor intègre des fonctionnalités d'export avancées dont le format PDF et permet d'écrire et de publier des livres[6].

Notes et références

  1. « AsciiDoc ChangeLog », sur asciidoc-py.github.io (consulté le ).
  2. (en) « AsciiDoc.py Home Page » : « AsciiDoc.py is a legacy processor for this syntax, handling an older rendition of AsciiDoc. As such, this will not properly handle the current AsciiDoc specification. ».
  3. (en) « Opal », sur opalrb.com.
  4. (en) « AsciiDoc Home Page », sur github.io (consulté le ).
  5. (en) « Asciidoctor », sur asciidoctor.org (consulté le ).
  6. Antoine Fauchié et Thomas Parisot, « Repenser les chaînes de publication par l’intégration des pratiques du développement logiciel », Sciences du Design,‎ (ISSN 2428-3711, lire en ligne)

Articles connexes


<footer>source wp:Asciidoc</footer>



conférence Hubert Sablonnière (gestion de docs)

à étudier avec Aymeric pour Papa... L'idée retrouver ses archives moteurs de bagnole, meubles et construction de TV et l'inviter à documenter collaborativement...