Skip to content

Latest commit

 

History

History
416 lines (300 loc) · 19.9 KB

README-fr.adoc

File metadata and controls

416 lines (300 loc) · 19.9 KB

Asciidoctor

Asciidoctor est un processeur de texte rapide et une chaîne de publication pour convertir du contenu AsciiDoc en HTML5, DocBook 5 (ou 4.5) et d’autres formats. Asciidoctor est écrit en Ruby, packagé sous forme de RubyGem et publié sur RubyGems.org. La gemme est aussi incluse dans plusieurs distributions Linux, dont Fedora, Debian et Ubuntu. Asciidoctor est open source, hébergé sur GitHub et distribué sous licence MIT.

Ce document est traduit dans les langues suivantes :
Asciidoctor est disponible partout où Ruby est disponible

Vous pouvez exécuter Asciidoctor dans la JVM en utilisant JRuby. Pour invoquer l’API Asciidoctor directement depuis Java ou d’autres langages de la JVM, utilisez AsciidoctorJ. Des plugins basés sur AsciidoctorJ permettent d’intégrer le processeur Asciidoctor avec Apache Maven, Gradle ou Javadoc.

Asciidoctor s’exécute également au sein de JavaScript. Nous utilisons Opal pour transcrire le code source Ruby en JavaScript afin de produire Asciidoctor.js, une version pleinement fonctionnelle d’Asciidoctor qui s’intègre dans tout environnement JavaScript, comme un navigateur web ou Node.js. Asciidoctor.js est utilisé pour faire fonctionner les extensions AsciiDoc Preview pour Chrome, Atom, Brackets et autres outils web.

Santé du projet

Build Status (Travis CI) Build Status (AppVeyor) Code Climate Inline docs

En un mot

Asciidoctor lit du contenu écrit en texte brut, comme présenté dans la partie gauche de l’image ci-dessous, et le convertit en HTML5, comme présenté dans la partie droite. Asciidoctor applique une feuille de style par défaut au document HTML5 afin de fournir une expérience de lecture agréable, clé en main.

Prévisualisation d’une source AsciiDoc et le rendu HTML correspondant

Le traitement d’AsciiDoc

Asciidoctor lit et analyse la syntaxe du texte écrit en AsciiDoc afin de créer une représentation, sous forme d’arbre, à partir de laquelle des templates sont appliqués pour produire de l’HTML5, du DocBook 5 (ou 4.5).

Vous avez la possibilité d’écrire votre propre convertisseur ou de fournir des templates supportant Tilt pour personnaliser le résultat généré ou pour produire des formats alternatifs.

Note
 Asciidoctor est un remplaçant du processeur AsciiDoc original écrit en Python (asciidoc.py). La suite de tests Asciidoctor possède > 1,600 tests pour garantir la compatibilité avec la syntaxe AsciiDoc.

En plus de la syntaxe AsciiDoc standard, Asciidoctor reconnaît des balises additionnelles ainsi que des options de formatage, comme les polices d’icônes (par exemple icon:fire[]) et des éléments d’interface (par exemple button:[Enregistrer]). Asciidoctor offre aussi un thème moderne et « responsive » basé sur Foundation pour styliser le document HTML5 généré.

Prérequis

Asciidoctor fonctionne sur Linux, OS X (Mac), Windows et requiert une des implémentations suivantes :

  • MRI (Ruby 1.8.7, 1.9.3, 2.0, 2.1, 2.2 & 2.3)

  • JRuby (1.7 dans les modes Ruby 1.8 et 1.9, 9000)

  • Rubinius 2.2.x

  • Opal (JavaScript)

Votre aide est appréciée pour tester Asciidoctor sur l’une de ces plateformes. Référez-vous au paragraphe Contributions si vous souhaitez vous impliquer dans ce projet.

Caution

Si vous utilisez un environnement Windows dans une autre langue que l’anglais, vous pourriez tomber sur l’erreur Encoding::UndefinedConversionError lors du lancement d’Asciidoctor. Pour corriger ce problème, nous recommandons de changer la page de code en UTF-8 dans votre console :

chcp 65001

Après ce changement, tous les maux de tête liés à l’Unicode seront derrière vous. Si vous utilisez un environnement de développement comme Eclipse, assurez-vous de définir l’encodage en UTF-8. Asciidoctor fonctionne mieux lorsque vous utilisez UTF-8 partout.

Installation

Asciidoctor peut être installé en utilisant la commande (a) gem install, (b) Bundler ou (c) les gestionnaires de paquets pour les distributions Linux populaires.

Tip
 L’avantage d’utiliser le gestionnaire de paquets pour installer la gemme est que l’installation englobe celle des librairies Ruby et RubyGems si elles ne sont pas déjà installés. L’inconvénient est que le paquet n’est pas forcément mis à jour immédiatement après la mise à disposition de la gemme. Si vous avez besoin de la dernière version, vous devez passer par la commande gem.

(a) Installation de la gemme

Ouvrir un terminal et taper (en excluant le $) :

$ gem install asciidoctor

Si vous souhaitez installer une version pre-release (c’est-à-dire, une « release candidate »), utilisez :

$ gem install asciidoctor --pre
Tip
Mettre à jour votre installation

Si vous avez une précédente version d’Asciidoctor installée, vous pouvez la mettre à jour en utilisant :

$ gem update asciidoctor

Si vous installez une nouvelle version de la gemme en utilisant gem install au lieu de gem update, vous aurez plusieurs versions d’installées. Si c’est le cas, utilisez la commande gem suivante pour supprimer la vieille version :

$ gem cleanup asciidoctor

(b) Bundler

  1. Créez un fichier Gemfile à la racine de votre projet (ou du répertoire courant)

  2. Ajoutez la gemme asciidoctor dans votre fichier Gemfile comme ci-dessous :

    source 'https://rubygems.org'
gem 'asciidoctor'
# ou spécifier la version explicitement
# gem 'asciidoctor', '1.5.4'

  3. Sauvegardez le fichier Gemfile

  4. Ouvrez un terminal et installez la gemme en utilisant :

    $ bundle

Pour mettre à jour la gemme, spécifiez la nouvelle version dans le fichier Gemfile et exécutez bundle à nouveau. Utiliser bundle update n'est pas recommandé car les autres gemmes seront également mises à jour, ce qui n’est pas forcément le résultat voulu.

(c) Gestionnaire de paquets Linux

DNF (Fedora 21 ou supérieure)

Pour installer la gemme sur Fedora 21 ou supérieure en utilisant dnf, ouvrez un terminal et tapez :

$ sudo dnf install -y asciidoctor

Pour mettre à jour la gemme, utilisez :

$ sudo dnf update -y asciidoctor
Tip
 Votre système peut être configuré pour mettre à jour automatiquement les paquets rpm, auquel cas aucune action de votre part ne sera nécessaire pour mettre à jour la gemme.

apt-get (Debian, Ubuntu, Mint)

Pour installer la gemme sur Debian, Ubuntu ou Mint, ouvrez un terminal et tapez :

$ sudo apt-get install -y asciidoctor

Pour mettre à jour la gemme, utilisez :

$ sudo apt-get upgrade -y asciidoctor
Tip
 Votre système peut être configuré pour mettre à jour automatiquement les paquets deb, auquel cas aucune action de votre part ne sera nécessaire pour mettre à jour la gemme.

La version d’Asciidoctor installé par le gestionnaire de paquets (apt-get) peut ne pas correspondre à la dernière version d’Asciidoctor. Consultez le dépôt de paquets de votre distribution pour trouver quelle version est disponible par version de distribution.

Caution

Il est déconseillé d’utiliser la commande gem update pour mettre à jour la gemme gérée par le gestionnaire de paquets. Le faire mettrait la système dans un état incohérent car le gestionnaire de paquets ne pourrait plus gérer les fichiers (qui sont installés dans /usr/local). En résumé, les gemmes du système doivent être gérées seulement par le gestionnaire de paquets.

Si vous souhaitez utiliser une version d’Asciidoctor qui est plus récente que celle installée par votre gestionnaire de paquets, vous devriez utiliser RVM pour installer Ruby dans votre répertoire personnel (dans votre espace utilisateur). Vous pouvez alors utiliser la commande gem pour installer ou mettre à jour la gemme Asciidoctor. En utilisant RVM, les gemmes sont installées dans un emplacement isolé du système.

apk (Alpine Linux)

Pour installer la gemme sur Alpine Linux, ouvrez un terminal et tapez :

$ sudo apk add asciidoctor

Pour mettre à jour la gemme, utilisez :

$ sudo apk add -u asciidoctor
Tip
 Votre système peut être configuré pour mettre à jour automatiquement les paquets apk, auquel cas aucune action de votre part ne sera nécessaire pour mettre à jour la gemme.

Utilisation

Si la gemme Asciidoctor s’est installée correctement, la ligne de commande (CLI) asciidoctor sera disponible dans votre PATH. Pour vérifier sa disponibilité, exécutez la commande suivante dans votre terminal :

$ asciidoctor --version

Vous devriez voir les informations concernant la version d’Asciidoctor et celle de votre environnement Ruby s’afficher dans le terminal.

Asciidoctor 1.5.4 [http://asciidoctor.org]
Runtime Environment (ruby 2.2.2p95 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:- ex:UTF-8)

Asciidoctor fournit aussi une API. Cette API permet une intégration avec d’autres logiciels Ruby, comme Rails, Sinatra et GitHub, ainsi que d’autres langages comme Java (via AsciidoctorJ) ou JavaScript (via Asciidoctor.js).

Interface de Ligne de Commande (CLI)

La commande asciidoctor vous permet d’invoquer Asciidoctor à partir de la ligne de commande (c’est-à-dire, un terminal).

La commande suivante convertit le fichier README.adoc en HTML et sauvegarde le résultat dans le fichier README.html dans le même répertoire. Le nom du fichier HTML généré est tiré de celui du fichier source, l’extension a été changée pour .html.

$ asciidoctor README.adoc

Vous pouvez contrôler le processeur Asciidoctor en ajoutant plusieurs paramètres, vous pouvez en apprendre plus sur ces derniers en utilisant la commande :

$ asciidoctor --help

Par exemple, pour écrire le fichier dans un répertoire différent, utilisez :

$ asciidoctor -D output README.adoc

La page man asciidoctor fournit une référence complète sur l’interface de ligne de commande.

Référez-vous aux ressources suivantes pour en apprendre davantage sur la façon d’utiliser la commande asciidoctor.

API Ruby

Pour utiliser Asciidoctor dans votre application, vous avez tout d’abord besoin de faire un « require » sur la gemme :

require 'asciidoctor'

Vous pouvez ensuite convertir un fichier AsciiDoc en fichier HTML en utilisant :

Asciidoctor.convert_file 'README.adoc', to_file: true, safe: :safe
Warning
 Quand vous utilisez Asciidoctor via l’API, le mode de sûreté par défaut est :secure. Dans le mode « secure », plusieurs fonctionnalités centrales sont désactivées, comme la directive include. Si vous souhaitez activer ces fonctionnalités, vous aurez besoin de définir explicitement le mode de sûreté avec une la valeur :server (recommandée) ou :safe.

Vous pouvez aussi convertir une chaîne de texte en fragment HTML (pour une insertion dans une page HTML) en utilisant :

content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
Asciidoctor.convert content, safe: :safe

Si vous voulez le document HTML complet, activez l’option header_footer comme ci-dessous :

content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
html = Asciidoctor.convert content, header_footer: true, safe: :safe

Si vous avez besoin d’accéder au document analysé, vous pouvez séparer la conversion en deux étapes distinctes :

content = '_Zen_ in the art of writing http://asciidoctor.org[AsciiDoc].'
document = Asciidoctor.load content, header_footer: true, safe: :safe
puts document.doctitle
html = document.convert

Gardez en tête que si vous n’aimez pas le contenu généré par Asciidoctor, vous pouvez le changer ! Asciidoctor supporte des convertisseurs personnalisés qui peuvent prendre en charge la conversion depuis le document analysé jusqu’au contenu généré.

Une façon simple de personnaliser les morceaux de contenu générés est d’utiliser le convertisseur de template. Le convertisseur de template vous permet, en utilisant un template supporté par Tilt, de prendre en charge la conversion de n’importe quel élément dans le document.

Vous l’aurez compris, vous pouvez complètement prendre le contrôle sur le contenu généré. Pour plus d’informations sur comment utiliser l’API ou personnaliser le contenu généré, référez-vous au manuel utilisateur.

Contributions

Dans l’esprit du logiciel libre, tout le monde est encouragé à aider en vue d’améliorer le projet. Si vous découvrez des erreurs ou des oublis dans le code source, la documentation, ou le contenu du site web, s’il vous plaît n’hésitez pas à ouvrir un ticket ou une « pull request » avec un correctif. Les contributeurs et contributrices sont toujours les bienvenus !

Voici quelques façons de contribuer :

  • en utilisant les versions prerelease (alpha, beta ou preview),

  • en rapportant des anomalies,

  • en suggérant de nouvelles fonctionnalités,

  • en écrivant ou éditant la documentation,

  • en écrivant des spécifications,

  • en écrivant du code — Aucun patch n’est trop petit

    • corriger une coquille,

    • ajouter des commentaires,

    • nettoyer des espaces inutiles,

    • écrire des tests !

  • en refactorant le code,

  • en corrigeant des anomalies,

  • en effectuant des relectures des patches.

Le guide du parfait Contributeur fournit des informations sur comment créer, styliser et soumettre des tickets, des demandes de fonctionnalités, du code et de la documentation pour le projet Asciidoctor.

Être aidé

Le projet Asciidoctor est développé pour vous aider à écrire et publier du contenu. Mais nous ne pouvons pas le faire sans avoir vos avis ! Nous vous encourageons à poser vos questions et discuter de n’importe quels aspects du projet sur la liste de discussion, Twitter ou dans le salon de discussion.

Mailing list

http://discuss.asciidoctor.org

Twitter (Chat)

hashtag #asciidoctor ou la mention @asciidoctor

Gitter (Chat)

Gitter

De plus amples informations et documentations sur Asciidoctor peuvent être trouvées sur le site web du projet.

Home | News | Docs

L’organisation Asciidoctor sur GitHub héberge le code source du projet, le gestionnaire de tickets ainsi que des sous-projets.

Copyright et licence

Copyright © 2012-2016 Dan Allen, Ryan Waldron et le projet Asciidoctor. Une utilisation libre de ce logiciel est autorisée sous les termes de la licence MIT.

Consultez le fichier LICENSE pour plus de détails.

Auteurs

Asciidoctor est mené par Dan Allen et Sarah White et reçoit de nombreuses contributions de la part de la géniale communauté Asciidoctor. Le projet a été initié en 2012 par Ryan Waldron et est basé sur un prototype écrit par Nick Hengeveld.

AsciiDoc a été démarré par Stuart Rackham et a reçu de nombreuses contributions de la part de la communauté AsciiDoc.

Changelog

Référez-vous au fichier CHANGELOG pour une liste complète des changements des versions précédentes.