Référence rapide du syntax AsciiDoc
AsciiDoc est un langage de balisage mature et léger pour la rédaction de notes, d’articles, de documentation, de livres, de pages Web, de présentations de diapositives et de pages de manuel en texte brut. This guide is a quick reference for the common formatting markup and document elements in the AsciiDoc syntax.
Plusieurs exemples se concentrent sur la sortie générée par le backend HTML. AsciiDoc produit une sortie complémentaire lors de la génération de DocBook. La plupart des fonctionnalités étiquetées « |
Paragraphes
Les paragraphes ne nécessitent aucun balisage spécial dans AsciiDoc. Un paragraphe n’est qu’une ou plusieurs lignes de texte consécutives. Pour commencer un nouveau paragraphe, séparez-le par au moins une ligne vide.
Les paragraphes ne nécessitent aucun balisage spécial dans AsciiDoc. Un paragraphe n’est qu’une ou plusieurs lignes de texte consécutives.
Pour commencer un nouveau paragraphe, séparez-le par au moins une ligne vide.
Pour conserver un saut de ligne, terminez la ligne par un espace suivi d'un signe plus. + Cela produit un saut de ligne visible (par exemple, `<br>`) entre les lignes.
Pour conserver un saut de ligne, terminez la ligne par un espace suivi d’un signe plus.
Cela entraîne un saut de ligne visible (par exemple, <br>
) entre les lignes.
Un paragraphe normal. Une séquence de lignes commençant par au moins un espace est un paragraphe littéral. Les paragraphes littéraux sont traités comme du texte préformaté. Le texte est affiché dans une police à largeur fixe et les lignes de fin sont conservées. Un autre paragraphe normal.
Un paragraphe normal.
Une séquence de lignes commençant par au moins un espace est un paragraphe littéral. Les paragraphes littéraux sont traités comme du texte préformaté. Le texte est affiché dans une police à largeur fixe et les lignes de fin sont conservées.
Un autre paragraphe normal.
REMARQUE : un paragraphe d'avertissement attire l'attention du lecteur sur des informations auxiliaires. Son objectif est déterminé par l'étiquette\au début du paragraphe. Voici les autres types de messages intégrés : TIP : Conseil de pro... IMPORTANT : N'oubliez pas... WARNING : Attention à... ATTENTION : Assurez-vous que...
Un paragraphe d’avertissement attire l’attention du lecteur sur des informations auxiliaires. |
Voici les autres types de messages intégrés :
Conseil de pro… |
N’oubliez pas… |
Attention à… |
Assurez-vous que… |
Vous pouvez aussi créer admonition blocks. |
[.lead] Ce texte sera stylé comme un paragraphe principal (c'est-à-dire avec une police plus grande).
Ce texte sera rédigé comme un paragraphe principal (c’est-à-dire avec une police plus grande).
Le style par défaut d’AsciiDoctor donne au premier paragraphe du préambule un style de chapeau. |
Texte formaté
_phrase italique_ __i__lettres italiques *phrase en gras* **s**veux**tt**ers *_expression italique et gras_* **__b__**vieilles lettres italiques**__tt__**ers `phrase monospace` et le``tt``ers `_phrase italique monospace_` et le``__tt__``ers `*expression en gras monospace*` et le``**tt**``ers `*_phrase italique grasse monospace_*` et le``**__tt__**``ers ` passthrough littéral en ligne ` (texte monospace sans substitutions)
phrase italique
ilettres italiques
phrase en gras
sveuxtters
expression italique et gras
bvieilles lettres italiquestters
phrase monospace
et lett
ers
phrase italique monospace
et lett
ers
phrase monospace en gras
et lett
ers
monospace bold italic phrase
et lett
ers
passthrough littéral en ligne
(texte monospace sans substitutions)
Les loups-garous croient-ils aux [petits]#petits caractères# ? [big]##IL## était une fois un boucle infini.
Les loups-garous croient-ils aux petits caractères ?
IL était une fois un boucle infini.
phrase ^super script^ phrase ~indice~
phrase ^super script^
phrase indice
'`guillemets intelligents simples`' "`guillemets intelligents doubles`"
‘guillemets intelligents simples’
“guillemets intelligents doubles”
Entêtes de document
Un en-tête est facultatif. |
L’entête ne doit pas contenir de ligne blanches et doit être séparée du contenu par au moins une ligne blanche. |
//toc::[] = Titre de mon document Mon document fournit...
= Titre de mon document Docteur <[email protected]> Mon document fournit...
= Titre de mon document Doc Writer <[email protected]> v1.0, 01/01/2014 Mon document fournit...
IMPORTANT : Vous ne pouvez pas avoir de ligne de révision sans ligne d’auteur.
= Titre de mon document Doc Writer <[email protected]> v1.0, 01/01/2014 :toc: :imagesdir: assets/images :homepage: http://asciidoctor.org Mon document fournit...
[[titres de section]] == Titres de section (en-têtes)
Type de document d’article
= Titre du document (niveau 0) == Section Niveau 1 === Section Niveau 2 ==== Section Niveau 3 ===== Section du niveau 4 ====== Section niveau 5 == Une autre section de niveau 1
Titre du document (niveau 0)
Section niveau 1
Section niveau 2
Section niveau 3
Section niveau 4
[float] ====== Section Niveau 5 ====
WARNING : lorsque vous utilisez le type de document article (valeur par défaut), vous ne pouvez avoir qu’un seul titre de section de niveau 0 (c’est-à-dire le titre du document) et il doit figurer dans l’en-tête du document.
NOTE : le nombre de signes égal correspond au niveau de titre dans la sortie HTML.
-
Doctype de livre
= Titre du document (niveau 0) == Section niveau 1 === Section niveau 2 ==== Section niveau 3 ===== Section niveau 4 ###### Section niveau 5 = Section niveau 0
Titre du document (niveau 0)
Section niveau 1
Section niveau 2
Section niveau 3
Section niveau 4
[float] ====== Section Niveau 5
Section niveau 0
//// IMPORTANT: There are two other ways to define a section title. Their omission is intentional. They both require more markup and are therefore unnecessary. The setext title syntax (underlined text) is especially wasteful, hard to remember, hard to maintain and error prone. The reader never sees the extra markup, so why type it? Be frugal! ////
[[primitives-nulls]] == Types primitifs et valeurs nulles
sectanchors
-
Lorsque cet attribut de document est défini, une ancre d’icône de section apparaît devant le titre de la section.
sectlinks
-
Lorsque cet attribut de document est défini, les titres de section deviennent des liens.
REMARQUE : les ancres de titre de section dépendent de la feuille de style Asciidoctor par défaut pour s’afficher correctement.
== Fichiers inclus
= Documentation de référence Développeur principal Ceci est la documentation du projet X. include::basics.adoc[] include::installation.adoc[] include::exemple.adoc[]
ATTENTION : Asciidoctor n’insère pas de lignes vides entre les instructions d’inclusion adjacentes pour garder le contenu séparé. Assurez-vous d’ajouter une ligne vide dans le document source pour éviter des résultats inattendus, tels qu’un titre de section avalé.
:asciidoctor-source: https://raw.github.com/asciidoctor/asciidoctor/master \include : {asciidoctor-source}/README.adoc[]
NOTE : L’inclusion de contenu provenant d’un URI est potentiellement dangereuse, elle est donc désactivée si le mode sans échec est SECURE ou supérieur.
En supposant que le mode sans échec est inférieur à SECURE, vous devez également définir l’attribut allow-uri-read
pour autoriser Asciidoctor à lire le contenu d’un URI.
== Règles horizontales et sauts de page
''' --- [.result]
===
<<<
Listes
* Edgar Allen Poe * Sheri S. Tepper * Bill Bryson //^ * Kevin Spacey * Jeremy Piven
-
Edgar Allen Poe
-
Sheri S. Tepper
-
Bill Bryson
-
Kevin Spacey
-
Jérémy Piven
Des lignes vierges sont obligatoires avant et après une liste. |
Vous pouvez séparer deux listes avec un commentaire de ligne, comme le montre l’exemple précédent. |
* niveau 1 ** niveau 2 *** niveau 3 **** niveau 4 ***** niveau 5 * niveau 1
-
niveau 1
-
niveau 2
-
niveau 3
-
niveau 4
-
niveau 5
-
-
-
-
-
niveau 1
Le marqueur de liste non ordonnée peut être modifié à l’aide de block styles. |
- [*] coché - [x] également coché - [ ] non coché - élément de liste normal
-
[*] vérifié
-
[x] également vérifié
-
[ ] non coché
-
élément de liste normal
Les listes de contrôle peuvent utiliser des icônes basées sur des polices et être interactives. |
. . Étape 1 . Étape 2 . Étape 3
-
Étape 1
-
Étape 2 Étape 3
. Étape 1 . Étape 2 .. Étape 2a .. Étape 2b . Étape 3
-
Étape 1
-
Étape 2
-
Étape 2a
-
Étape 2b Étape 3
-
. . level 1 .. level 2 ... level 3 .... level 4 ..... level 5 . level 1
-
niveau 1
-
niveau 2
-
niveau 3
-
niveau 4
-
niveau 5
-
-
-
-
-
niveau 1
Pour les listes ordonnées, Asciidoctor prend en charge les styles de numération tels que lowergreek et decimal-leading-zero .
|
premier terme : définition du premier terme terme de section : définition du deuxième terme
- premier mandat
-
définition du premier terme
- terme de section
-
définition du deuxième terme ====//toc::[]
premier terme :: définition du premier terme terme de section :: définition du deuxième terme
- premier mandat
-
définition du premier terme
- terme de section
-
définition du deuxième terme
[qanda] Qu'est-ce qu'Asciidoctor ?:: Une implémentation du processeur AsciiDoc dans Ruby. Quelle est la réponse à la question ultime ?:: 42
-
Qu’est-ce qu’Asciidoctor ?
Une implémentation du processeur AsciiDoc dans Ruby.
-
Quelle est la réponse à la question ultime ?
42 ==
Operating Systems:: Linux::: . Fedora * Desktop . Ubuntu * Desktop * Server BSD::: . FreeBSD . NetBSD Fournisseurs de cloud :: PaaS ::: . OpenShift . CloudBees IaaS::: . Amazon EC2 . Rackspace
- Systèmes d’exploitation
-
- Linux
-
-
Fedora
-
Bureau
-
-
Ubuntu
-
Bureau
-
Serveur
-
-
- BSD
-
-
BSD gratuit
-
NetBSD
-
- Fournisseurs de cloud
-
- PaaS
-
-
OpenShift
-
Abeilles des nuages
-
- IaaS
-
-
Amazon EC2
-
Espace rack
-
Les listes peuvent être indentées. Les espaces en début de ligne ne sont pas pris en compte. |
* Chaque élément de liste a au moins un paragraphe de contenu, qui peut être renvoyé à la ligne, même en utilisant un retrait négatif. + Des paragraphes ou blocs supplémentaires sont joints en plaçant une suite de liste sur une ligne adjacente aux deux blocs. + list continuation:: a plus sign (+) on a line by itself * Un paragraphe littéral ne nécessite pas de continuation de liste. $ gem install asciidoctor |=== * Les listes AsciiDoc peuvent contenir n'importe quel contenu complexe. [cols="2", options="header"] |Demande |Language |AsciiDoc |Python |Asciidoctor |Rubis |===
-
Chaque élément de liste a au moins un paragraphe de contenu, qui peut être renvoyé à la ligne, même en utilisant un retrait suspendu.
Des paragraphes ou blocs supplémentaires sont joints en mettant a list continuation on a line adjacent to both blocks.
+ list continuation:: a plus sign (+) on a line by itself
-
Un paragraphe littéral ne nécessite pas de continuation de liste.
$ gem install asciidoctor
* Les listes AsciiDoc peuvent contenir n’importe quel contenu complexe. [cols="2", options="header"] |
Demande |
Language |
AsciiDoc |
Python |
Asciidoctor |
Rubis |
== Liens
http://asciidoctor.org - automatique ! http://asciidoctor.org[Asciidoctor] https://github.com/asciidoctor[Asciidoctor @ *GitHub*]
link:index.html[Docs]
[email protected] mailto:[email protected][Discuter d'Arquillian] mailto:[email protected][Abonnez-vous, abonnez-moi, je veux me joindre !] irc://irc.freenode.org/#asciidoctor
http://discuss.asciidoctor.org[Discuss Asciidoctor, role="external", window="_blank"] http://discuss.asciidoctor.org[Discuss Asciidoctor^] http://search.example.com["Google, Yahoo, Bing^", role="teal"]
Les liens avec des attributs (y compris les segments d’objet et de corps sur les liens mailto) sont une fonctionnalité unique à Asciidoctor. Pour les activer, vous devez définir l’attribut linkattrs sur le document. Lorsqu’ils sont activés, vous devez citer le texte du lien s’il contient une virgule.
|
[[bookmark-a]]Les ancres en ligne rendent le contenu arbitraire référençable. anchor:bookmark-b[]Utilisez une référence croisée pour créer un lien vers cet emplacement.
Voir <<paragraphes>> pour savoir comment rédiger des paragraphes. Découvrez comment organiser le document en <<titres de section, sections>>.
Voir Paragraphes pour apprendre à rédiger des paragraphes.
Apprenez à organiser le document en « titres-sections, sections >>.
Se référer au <<document-b.adoc#section-b,Section B>> for more information. À votre retour du <<document-b#section-b,Section B>> !
== Images
image::sunset.webp[] image::sunset.webp[Sunset] [[img-sunset]] .Un couché de soleil sur la montagne image::sunset.webp[Sunset, 300, 200, link="http://www.flickr.com/photos/javh/5448336655"] image::http://asciidoctor.org/images/octocat.webp[GitHub mascot]
Les images sont résolues par rapport à la valeur de attribut de document imagesdir , qui est par défaut une valeur vide. L’attribut imagesdir peut être un chemin absolu, un chemin relatif ou une URL de base. Si la cible de l’image est une URL ou un chemin absolu, le préfixe « imagesdir » n’est pas ajouté.
|
Vous devez utiliser l’attribut imagesdir pour éviter de coder en dur le chemin partagé vers vos images dans chaque macro d’image.
|
image:sunset.webp[Sunset,150,150,role="right"] Quel magnifique coucher de soleil !
Quel magnifique coucher de soleil !
Il existe une variété d’attributs disponibles pour http://asciidoctor.org/docs/user-manual/#put-images-in-their-place [position et cadre des images]. |
Cliquez sur image:icons/play.webp[Play, title="Play"] pour lancer la fête. Cliquez sur image:icons/pause.webp[title="Pause"] lorsque vous avez besoin d'une pause.
Cliquez sur pour lancer la fête.
Cliquez sur lorsque vous avez besoin d’une pause.
= Titre du document :data-uri:
Lorsque l’attribut data-uri est défini, toutes les images du document (y compris les icônes d’avertissement) sont intégrées dans le document sous la forme data URIs.
|
Au lieu de déclarer l’attribut data-uri dans le document, vous pouvez le transmettre comme argument de ligne de commande en utilisant -a data-uri .
|
== Vidéos
video::video_file.mp4[] video::video_file.mp4[width=640, start=60, options=autoplay]
vidéo::rPQoq7ThGAU[youtube]
vidéo::67480300[vimeo]
Vous pouvez contrôler les paramètres vidéo à l’aide de attributs et options supplémentaires sur la macro. |
== Code source
Code de référence tel que `types` ou `méthodes` en ligne.
Code de référence comme « types » ou « méthodes » en ligne.
Indentez la ligne d'un espace pour insérer un extrait de code
Indentez la ligne d'un espace pour insérer un extrait de code
... error : L'opération demandée a renvoyé l'erreur : 1954 Recherche interdite du manuel d'opérations défensives absolument fatal : lancement de l'opération perdu dans le dodécaèdre du destin Voudriez-vous mourir à nouveau ? o/n ....
erreur : L'opération demandée a renvoyé l'erreur : 1954 Recherche interdite du manuel d'opérations défensives absolument fatal : lancement de l'opération perdu dans le dodécaèdre du destin voulez-vous mourir à nouveau ? o/n
.Gemfile.lock ---- GEM distant : https://rubygems.org/ spécifications : asciidoctor (0.1.4) PLATEFORMES rubis DÉPENDANCES asciidoctor (~> 0.1.4) ----
GEM distant : https://rubygems.org/ specs : asciidoctor (0.1.4) PLATEFORMES rubis DÉPENDANCES asciidoctor (~> 0.1.4)
[source,ruby] .app.rb ---- exige 'sinatra' obtenez '/salut' et faites "Bonjour tout le monde !" end ----
nécessite 'sinatra'
obtenez '/salut' et faites
"Bonjour tout le monde !"
end
[source,ruby] ---- require 'sinatra' <1> get '/hi' do <2> "Hello World!" <3> end ---- <1> Library import <2> URL mapping <3> Content for response
nécessite 'sinatra' (1)
obtenez '/salut' et faites (2)
"Bonjour tout le monde !" (3)
end
1 | Importation de bibliothèque |
2 | mappage d’URL |
3 | Contenu de la réponse |
---- ligne de code // <1> line of code # <2> line of code ;; <3> ---- <1> A callout behind a line comment for C-style languages. <2> A callout behind a line comment for Ruby, Python, Perl, etc. <3> A callout behind a line comment for Clojure.
line of code (1) line of code (2) line of code (3)
1 | Une légende derrière un commentaire de ligne pour les langages de style C. |
2 | Une légende derrière une ligne de commentaire pour Ruby, Python, Perl, etc. |
3 | Une légende derrière un commentaire de ligne pour Clojure. |
[source,xml] ---- <section> <title>Section Title</title> <!--1--> </section> ---- <1> Le titre de section est obligatoire.
<section>
<title>Titre de section</title> (1)
</section>
1 | Le titre de section est obligatoire. |
[source,ruby] ---- include::app.rb[] ----
{sourcedir}
:sourcedir: src/main/java [source,java] ---- include::{sourcedir}/org/asciidoctor/Asciidoctor.java[] ----
[source,ruby,indent=0] ---- include::lib/document.rb[lines=5..10] ----
|
[source,xml] <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="viewport"
content="width=device-width, initial-scale=1.0">
Activer la coloration syntaxique
La coloration syntaxique s’active par la déclaration de l’attribut :source-highlighter: pygments Les options valides sont |
== Plus de délimiteurs de bloc
.Historique d'AsciiDoc **** AsciiDoc a été publié pour la première fois en novembre 2002 par Stuart Rackham. Il a été conçu dès le départ comme une syntaxe abrégée pour produire des documents professionnels comme DocBook et LaTeX. ***
Tout bloc peut avoir un titre, positionné au dessus du bloc. Un titre est une ligne de texte commençant par un point. Le point ne peut pas être suivi d’un espace. |
.Exemple de document ==== Voici un exemple de document AsciiDoc : [listing] .... = Titre du document Rédacteur de documents :toc: Ce guide fournit... .... L'en-tête du document est utile, mais pas obligatoire. ===
Voici un exemple de document AsciiDoc :
= Titre du document Rédacteur de documents :toc: Ce guide fournit...
L’en-tête du document est utile, mais pas obligatoire.
[NOTE] ==== Un bloc d'avertissement peut contenir un contenu complexe. .Une liste - un - deux - trois Un autre paragraphe. ====
Un bloc d’avertissement peut contenir un contenu complexe. Une liste
Un autre paragraphe. |
Icônes d’avertissement et de renvoi
Asciidoctor peut "dessiner" des icônes en utilisant Font Awesome et CSS. Pour utiliser cette fonctionnalité, déclarer la valeur |
[citation, Abraham Lincoln, Dédicace au Cimetière National des Soldats] ____ Il y a quatre-vingt-sept ans, nos pères ont donné naissance sur ce continent à une nouvelle nation... ____ [citation d'Albert Einstein] Une personne qui n'a jamais commis d'erreur n'a jamais rien essayé de nouveau. ____ Une personne qui n'a jamais commis d'erreur n'a jamais essayé quelque chose de nouveau. ____
Il y a quatre-vingt-sept ans, nos pères ont fait naître sur ce continent une nouvelle nation…
Dédicace au Cimetière national des soldats
Une personne qui n’a jamais commis d’erreur n’a jamais rien essayé de nouveau.
Une personne qui n’a jamais commis d’erreur n’a jamais rien essayé de nouveau.
"Je considère qu'une petite rébellion de temps en temps est une bonne chose, et aussi nécessaire dans le monde politique que les tempêtes dans le monde physique." -- Thomas Jefferson, Papers of Thomas Jefferson : Volume 11
Je considère qu’une petite rébellion de temps en temps est une bonne chose, et aussi nécessaire dans le monde politique que les tempêtes dans le monde physique.
Documents de Thomas Jefferson : Volume 11
Pour saluer Dick, Asciidoctor reconnaît le texte entre « guillemets aériens » comme un bloc de guillemets.
[, Richard M. Nixon] "" Quand le Président le fait, cela signifie que ce n'est pas illégal. ""
"" Quand le Président le fait, cela veut dire que ce n’est pas illégal. ""
++++ <p> Le contenu d'un bloc relais est transmis à la sortie sans traitement. Cela signifie que vous pouvez inclure du HTML brut, comme celui-ci : </p> <script src="http://gist.github.com/mojavelinux/5333524.js"> </script>
Le contenu d'un bloc relais est transmis à la sortie sans traitement. Cela signifie que vous pouvez inclure du HTML brut, comme celui-ci. Gist intégré :
-- Un bloc ouvert peut être un conteneur anonyme, i peut se faire passer pour n'importe quel autre bloc. -- [source] -- met "Je suis un bloc source !" --
Un bloc ouvert peut être un conteneur anonyme ou se faire passer pour n’importe quel autre bloc.
met "Je suis un bloc source !"
:version: 0.1.4 [source,xml] [subs="verbatim,attributes"] ---- <dependency> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-java-integration</artifactId> <version>{version}</version> </dependency> ----
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-java-integration</artifactId>
<version>0.1.4</version>
</dependency>
== Identifiant, rôle et options de bloc
id
et un role
de bloc[[goals]] [role="incremental"] * Goal 1 * Goal 2
id
et un role
de bloc (Asciidoctor uniquement)[#goals.incremental] * Goal 1 * Goal 2
|
id
) et un role
[[free_the_world]][big goal]_free the world_
id
) et un role
(Asciidoctor uniquement)[#free_the_world.big.goal]_free the world_
[nom du rôle]`texte monospace échappé`
|=== [options="header,footer,autowidth"] |Cell A |Cell B |===
[%header%footer%autowidth] |=== |Cell A |Cell B |===
== Commentaires
// A single-line comment.
Les lignes de commentaire peuvent être utilisées pour diviser des éléments, comme deux listes collées sinon. |
//// A multi-line comment. Notice it's a delimited block. ////
== Tableau
.Titre du tableau |=== |Nom de la colonne 1 |Nom de la colonne 2 |Nom de la colonne 3 (1) (2) |Cellule dans la colonne 1, ligne 1 |Cellule dans la colonne 2, ligne 1 |Cellule dans la colonne 3, ligne 1 |Cellule dans la colonne 1, ligne 2 |Cellule dans la colonne 2, ligne 2 |Cellule dans la colonne 3, ligne 2 |===
1 | Sauf si l’attribut cols est spécifié, le nombre de colonnes est égal au nombre de barres verticales sur la première ligne non vide à l’intérieur des délimiteurs de bloc. |
2 | Lorsqu’une ligne vide suit une seule ligne de titres de colonnes, la ligne des titres de colonnes sera stylisée comme une ligne d’en-tête par défaut. |
[.result] ==== .Titre de la table |
Nom de la colonne 1 |
Nom de la colonne 2 |
Nom de la colonne 3 |
Cellule dans la colonne 1, ligne 1 |
Cellule dans la colonne 2, ligne 1 |
Cellule dans la colonne 3, ligne 1 |
Cellule dans la colonne 1, ligne 2 |
Cellule dans la colonne 2, ligne 2 |
Cellule dans la colonne 3, ligne 2 |
|=== [cols="2*", options="en-tête"] (1) |Nom de la colonne 1 |Nom de la colonne 2 |Cellule dans la colonne 1, ligne 1 |Cellule dans la colonne 2, ligne 1 |Cellule dans la colonne 1, ligne 2 |Cellule dans la colonne 2, ligne 2 |===
1 | Le * dans l’attribut cols est l’opérateur de répétition. Cela signifie répéter la spécification de la colonne pour le reste des colonnes. Dans ce cas, cela signifie répéter le formatage par défaut sur 4 colonnes. Lorsque la ligne d’en-tête n’est pas définie sur une seule ligne, vous devez utiliser l’attribut cols pour définir le nombre de colonnes et les attributs options pour faire de la première ligne un en-tête. |
[.result] |
|Nom de la colonne 1 |Nom de la colonne 2
|Cellule dans la colonne 1, ligne 1 |Cellule dans la colonne 2, ligne 1
|Cellule dans la colonne 1, ligne 2 |Cellule dans la colonne 2, ligne 2
==== .Tableau avec trois colonnes, un en-tête et deux lignes de contenu ---- |
[cols="1,1,2", options="header"] <1> .Applications
|Nom |Catégorie |Déscription
|Firefox |Navigateur |Mozilla Firefox est un navigateur Web open source. Il est conçu pour le respect des normes, les performances et la portabilité.
|Arquillien |Test |Une plate-forme de test innovante et hautement extensible. Permet aux développeurs de créer facilement des tests réels et automatisés.
----
<1> Dans cet exemple, l’attribut |
|Nom |Catégorie |Déscription
|Firefox |Navigateur |Mozilla Firefox est un navigateur Web open source. Il est conçu pour le respect des normes, les performances et la portabilité.
|Arquillien |Test |Une plate-forme de test innovante et hautement extensible. Permet aux développeurs de créer facilement des tests réels et automatisés.
|=== [cols="2,2,5a"] |Firefox |Navigateur |Mozilla Firefox est un navigateur Web open source. Il est conçu pour : * le respect des normes * les performances * la portabilité http://getfirefox.com[Obtenir Firefox] ! |===
[.result] ==== [cols="2,2,5a"] |
Firefox |
Navigateur |
Mozilla Firefox est un navigateur Web open source. Il est conçu pour : * le respect des normes * les performances * la portabilité |
|=== [format="csv", options="header"] Artiste,Piste,Genre Baauer,Harlem Shake,Hip Hop The Lumineers,Ho Hey,Folk Rock |===
[.result] |
Artist,Track,Genre Baauer,Harlem Shake,Hip Hop The Lumineers,Ho Hey,Folk Rock
==== .Tableau à partir de données CSV utilisant un raccourci (Asciidoctor uniquement) ---- ,=== Artiste,Piste,Genre ,=== Artiste,Track,Genre Baauer,Harlem Shake,Hip Hop ,=== ---- [.result] ==== :=== Artiste,Track,Genre Baauer, Harlem Shake, Hip Hop, === ==== .Tableau à partir des données DSV en utilisant un raccourci (Asciidoctor uniquement) ---- === Artiste :Piste :Genre ,=== Artiste,Track,Genre Robyn :Indestructable :Danse :=== ---- [.result] ==== :=== Artiste,Track,Genre Robyn:Indestructable:Danse :=== ==== .Tableau avec cellules formatées, alignées et fusionnées ---- |
|1 >s|2 |3 |4 ^|5 2.2+.|6 .3+<.>m|7 ^|8 |9 2+>|10
---- |
---|
|1 >s|2 |3 |4 ^|5 2.2+.|6 .3+<.>m|7 ^|8 |9 2+>|10
== Macro d’interface graphique
Vous devez définir l’attribut « expérimental » dans l’en-tête du document pour activer ces macros. |
kbd
en ligne)|=== |Raccourci |Objectif |kbd:[F11] |Basculer en mode plein écran |kbd:[Ctrl T] |Ouvrir un nouvel onglet |kbd:[Ctrl Maj N] |Nouvelle fenêtre de navigation privée |kbd :[Ctrl ] |Augmenter le zoom |===
[.result] ==== |
Raccourci |
Objectif |
F11 |
Basculer en mode plein écran |
Ctrl T |
Ouvrir un nouvel onglet |
Ctrl Maj N |
Nouvelle fenêtre de navigation privée |
kbd :[Ctrl ] |
Augmenter le zoom |
menu
en ligne)Pour enregistrer le fichier, sélectionnez le menu :Fichier[Enregistrer]. Sélectionnez menu :Affichage[Zoom > Réinitialiser] pour réinitialiser le niveau de zoom au paramètre par défaut.
Pour enregistrer le fichier, sélectionnez menu :Fichier[Enregistrer].
Sélectionnez menu : Affichage [Zoom > Réinitialiser] pour réinitialiser le niveau de zoom au paramètre par défaut.
btn
en ligne)Appuyez sur le bouton btn:[OK] lorsque vous avez terminé. Sélectionnez un fichier dans le navigateur de fichiers et cliquez sur btn : [Ouvrir].
Appuyez sur le bouton OK lorsque vous avez terminé.
Sélectionnez un fichier dans le navigateur de fichiers et cliquez sur btn : [Ouvrir].
== Attributs et substitutions
page d'accueil : http://asciidoctor.org :docslink : http://asciidoctor.org/docs[Asciidoctor's Docs] :desc : Asciidoctor est un format de document en texte brut mature pour + rédiger des notes documentation, livres, et davantage. + Consultez {homepage}[Asciidoctor]! {desc} Consultez également {docslink} ! {checkedbox} C'est accompli !
Check out Asciidoctor! Asciidoctor is a mature, plain-text document format for writing notes, articles, documentation, books, and more. It’s also a text processor & toolchain for translating documents into various output formats (i.e., backends), including HTML, DocBook, PDF and ePub. Check out Asciidoctor’s Docs too!
|
-
Attributs passés via l’API ou la ligne de commande, et ne se termeinant pas par
@
-
Attributs définis dans le document
-
Attributs passés via l’API ou la ligne de commande et se termeinant par
@
-
Valeur par défaut de l’attribut
Pour faire en sorte qu’un attribut passé par l’API ou la ligne de commande ait une priorité moindre que ceux définis dans le document, il faut ajouter un symbole @ à la fin de la valeur de l’attribut en question.
|
Référence d’attribut | Remplacement | Rendu |
---|---|---|
\{lt} |
< |
< |
\{gt} |
> |
> |
\{amp} |
& |
& |
\{startsb} |
[ |
[ |
\{endsb} |
] |
] |
\{vbar} |
| |
| |
\{caret} |
^ |
^ |
\{asterisk} |
* |
* |
\{tilde} |
~ |
~ |
\{apostrophe} |
' |
' |
\{backslash} |
\ |
\ |
\{backtick} |
` |
` |
\{two-colons} |
:: |
:: |
\{two-semicolons} |
;; |
;; |
Référence d’attribut | Remplacement | Rendu |
---|---|---|
\{empty} |
_rien_ |
|
\{sp}, \{space} |
_espace simple_ |
|
\{nbsp} |
\  |
|
\{zwsp} |
\​ |
|
\{wj} |
\⁠ |
|
\{apos} |
\' |
' |
\{quot} |
\" |
" |
\{lsquo} |
\‘ |
‘ |
\{rsquo} |
\’ |
’ |
\{ldquo} |
\“ |
“ |
\{rdquo} |
\” |
” |
\{deg} |
\° |
° |
\{plus} |
\+ |
+ |
\{brvbar} |
\¦ |
¦ |
Attribut | Déscription |
---|---|
|
Appelle le processeur |
|
Version du processeur |
|
Backend utilisé pour restituer le document |
|
Date de la dernière modification |
|
Date et heure de la dernière modification |
|
Nom du répertoire de documents |
|
Nom du fichier du document |
|
Heure de la dernière modification |
|
Le titre du document |
|
doctype du document (par exemple, article) |
|
Date locale de rendu |
|
Date et heure locales de rendu |
|
Heure locale lors du rendu |
aucun
|
Désactive les substitutions |
normal
|
Effectue toutes les substitutions à l’exception des légendes |
textuellement
|
Remplace les caractères spéciaux et traite les légendes |
caractères spéciaux
|
Replaces |
Citations
|
Applique le formatage de texte |
attributes
|
Remplace les références d’attributs |
replacements
|
Remplace les remplacements de références textuelles et de caractères |
macros
|
Macros de processus |
post_replacements
|
Remplace le caractère de saut de ligne ( |
|=== [caption=""] .Parts{counter2:index:0} |Id de partie |Déscription |PX-{counter:index} |Description de PX-{index} |PX-{counter:index} |Description de PX-{index} |===
[.result] |
|Id de partie |Déscription
|PX-1 |Description de PX-1
|PX-2 |Description de PX-2
==== == Remplacement de texte //// Included in: - user-manual: Text Substitutions: Replacements - quick-ref //// [cols="2,1l,1l,^1,2"] .Remplacements de symboles textuels |
|Nom |Syntax |Remplacement Unicode |Rendu |Notes
|Copyright |(C) |© |© |
|Enregistré |(R) |® |® |
|Marque déposée |(TM) |™ |™ |
|Tiret EM
|--
|—
|--
|Lorsqu’un espace est détecté de chaque côté du tiret cadratin, l’entité de caractère numérique espace fin ( 
) est aussi remplacé dans le document.
|ellipses |... |… |… |
|simple flêche droite |-> |→ |→ |
|double flèche droite |=> |⇒ |⇒ |
|flèche simple gauche |<- |← |← |
|double flèche gauche |<= |⇐ |⇐ |
|apostrophe |Sam's |Sam’s |Sam’s |L’apostrophe de forme verticale est remplacée par l’apostrophe de forme courbe.
TIP: Toute référence d’entité XML nommée, numérique ou hexadécimale est prise en charge. == Texte échappé .Backslash ---- *Stars* n’est pas rendu en texte gras. Les astérisques autour du mot sont conservés. {author} n’est pas résolu par le nom de l’auteur. Les accolades autour du mot sont conservées. Le caractère barre oblique inverse est automatiquement supprimé. ---- [.result] ==== *Stars* n’est pas rendu en texte gras. Les astérisques autour du mot sont conservés. {author} n’est pas résolu par le nom de l’auteur. Les accolades autour du mot sont conservées. Le caractère barre oblique inverse est automatiquement supprimé. ==== .Double dollar ---- *Stars* n’est pas rendu en texte gras. Les astérisques autour du mot sont conservés. & s’affiche sous la forme d’une entité XML au lieu de &. ---- [.result] ==== *Stars* n’est pas rendu en texte gras. Les astérisques autour du mot sont conservés. & s’affiche sous la forme d’une entité XML au lieu de &. ==== .Macro triple plus et passthrough en ligne ---- <u>soulignez-moi</u> s’affiche sous forme de texte souligné. soulignez-moi s’affiche également sous forme de texte souligné. ---- [.result] ==== <u>soulignez-moi</u> s’affiche sous forme de texte souligné. soulignez-moi s’affiche également sous forme de texte souligné. ==== .Backticks
----
[.result]
====
== Table des matières ( ..Document avec Table des matières ---- = Guide du rédacteur AsciiDoc Doc Writer <[email protected]> v1.0, 01/01/2013 :toc : ---- .Document avec Table des matières positionnée à droite ---- = Guide du rédacteur AsciiDoc Doc Writer <[email protected]> v1.0, 01/01/2013 :toc : à droite ---- TIP: La ToC "titre, niveaux et positionnement" peut être personnalisée. == Bibliographie .Références ---- « Pragmatic Programmer » [prag] devrait être une lecture obligatoire pour tous les développeurs. [bibliography] - [] Andy Hunt & Dave Thomas. 'The Pragmatic Programmer: From Journeyman to Master'. Addison-Wesley. 1999. - [] Dan Allen. 'Seam in Action'. Manning Publications. 2008. ---- [.result] ==== « The Pragmatic Programmer » [prag] devrait être une lecture obligatoire pour tous les développeurs. [bibliography] - [] Andy Hunt & Dave Thomas. 'The Pragmatic Programmer: From Journeyman to Master'. Addison-Wesley. 1999. - [] Dan Allen. 'Seam in Action'. Manning Publications. 2008. ==== .Notes de bas de page normale ou réutilisables ---- Une déclaration.footnote : [Clarification concernant cette déclaration.] Une déclaration audacieuse.footnoteref :[avertissement,Ces opinions sont les miennes.] Une autre déclaration en gras.footenoteref :[avertissement] ---- [.result] ==== [.unstyled] |
a| Une déclaration.footnote :[Clarification sur cette déclaration.]
Une autre déclaration en gras.footenoteref :[avertissement]
==== == Compatibilité avec Markdown IMPORTANT: La compatibilité Markdown n’est disponible que par défaut dans Asciidoctor. Vous pouvez configurer AsciiDoc (Python) pour reconnaître cette syntaxe en plaçant le fichier de compatibilité AsciiDoc d’Asciidoctor dans le même répertoire que le document en cours. .Entêtes à la Markdown ---- # Titre du document (Level 0) Section niveau 1 # Section niveau 2 # Section niveau 3 Section niveau 4 # Section niveau 5 ---- [.result] ==== [float] # Titre du document (Level 0) [float] Section niveau 1 [float] Section niveau 2 [float] Section niveau 3 [float] # Section niveau 4 [float] # Section niveau 5 ==== .Bloc de code avec coloration syntaxique
----
get '/hi' do "Hello World!" end ---- [.result]
====
get '/hi' do "Hello World!" end ==== .Citations à la Markdown ---- > I hold it that a little rebellion now and then is a good thing, > and as necessary in the political world as storms in the physical. > — Thomas Jefferson, Papers of Thomas Jefferson: Volume 11 ---- [.result] ==== > Je considère qu’une petite rébellion de temps en temps est une bonne chose, > et aussi nécessaire dans le monde politique que les tempêtes dans le monde physique. > — Thomas Jefferson, Papers of Thomas Jefferson: Volume 11 ==== .Citation avec bloc de contenu à la Markdown ---- > > Quoi de neuf ? > > J’ai Markdown dans mon AsciiDoc ! > > > Comme quoi ? > > * Blockquotes > * Titres > * Fenced code blocks > > > Is there more? > > Yep. AsciiDoc and Markdown share a lot of common syntax already. ---- [.result] ==== > > Quoi de neuf ?> > J’ai Markdown dans mon AsciiDoc !> > > Comme quoi ?> * Citations en bloc * En-têtes > * Blocs de code clôturés > > > Y a-t-il plus ? > > Oui. AsciiDoc et Markdown partage beaucoup de syntaxe en commun. ==== .Filet horizontal à la Markdown ---- --- - - - * * * * * ---- [.result] ==== --- - - * * * * === == Manuel utilisateur et aide Pour en savoir plus sur Asciidoctor et ses capacités, consultez les autres guides Asciidoctor et son Manuel de l’utilisateur. N’oubliez pas non plus de rejoindre la liste de diffusion Asciidoctor, où vous pouvez poser des questions et laisser des commentaires. = AsciiDoc Syntax Quick Reference Dan Allen; Sarah White v1.0.3, 2014-12-28 :description: This guide is a quick reference for the common formatting markup and document elements in the AsciiDoc syntax. :keywords: AsciiDoc, Asciidoctor, syntax, reference, cheatsheet :imagesdir: images :experimental: :table-caption!: :example-caption!: :figure-caption!: :idprefix: :idseparator: - :linkattrs: :docref: http://asciidoctor.org/docs :user-ref: http://asciidoctor.org/docs/user-manual :fontawesome-ref: http://fortawesome.github.io/Font-Awesome :icon-inline: http://asciidoctor.org/docs/user-manual/#inline-icons :icon-attribute: http://asciidoctor.org/docs/user-manual/#size-rotate-and-flip :video-ref: http://asciidoctor.org/docs/user-manual/#video :checklist-ref: http://asciidoctor.org/docs/user-manual/#checklists :list-marker: http://asciidoctor.org/docs/user-manual/#custom-markers :list-number: http://asciidoctor.org/docs/user-manual/#numbering-styles :imagesdir-ref: http://asciidoctor.org/docs/user-manual/#imagesdir :image-attributes: http://asciidoctor.org/docs/user-manual/#put-images-in-their-place :toc-ref: http://asciidoctor.org/docs/user-manual/#table-of-contents :para-ref: http://asciidoctor.org/docs/user-manual/#paragraph :literal-ref: http://asciidoctor.org/docs/user-manual/#literal-text-and-blocks :admon-ref: http://asciidoctor.org/docs/user-manual/#admonition :bold-ref: http://asciidoctor.org/docs/user-manual/#bold-and-italic :quote-ref: http://asciidoctor.org/docs/user-manual/#quotation-marks-and-apostrophes :sub-ref: http://asciidoctor.org/docs/user-manual/#subscript-and-superscript :mono-ref: http://asciidoctor.org/docs/user-manual/#monospace :css-ref: http://asciidoctor.org/docs/user-manual/#custom-styling-with-attributes :pass-ref: http://asciidoctor.org/docs/user-manual/#passthrough-macros :mailinglist: http://discuss.asciidoctor.org AsciiDoc est un langage de balisage mature et léger pour la rédaction de notes, d’articles, de documentation, de livres, de pages Web, de présentations de diapositives et de pages de manuel en texte brut. This guide is a quick reference for the common formatting markup and document elements in the AsciiDoc syntax. [NOTE] ==== Plusieurs exemples se concentrent sur la sortie générée par le backend HTML. AsciiDoc produit une sortie complémentaire lors de la génération de DocBook. La plupart des fonctionnalités étiquetées « == Paragraphes .Normal ---- Les paragraphes ne nécessitent aucun balisage spécial dans AsciiDoc. Un paragraphe n’est qu’une ou plusieurs lignes de texte consécutives. Pour commencer un nouveau paragraphe, séparez-le par au moins une ligne vide. ---- [.result] ==== Les paragraphes ne nécessitent aucun balisage spécial dans AsciiDoc. Un paragraphe n’est qu’une ou plusieurs lignes de texte consécutives. Pour commencer un nouveau paragraphe, séparez-le par au moins une ligne vide. ==== .Sauts de ligne
----
Pour conserver un saut de ligne, terminez la ligne par un espace suivi d’un signe plus. [.result]
====
Pour conserver un saut de ligne, terminez la ligne par un espace suivi d’un signe plus. .Literal ---- Un paragraphe normal. Une séquence de lignes commençant par au moins un espace est un paragraphe littéral. Les paragraphes littéraux sont traités comme du texte préformaté. Le texte est affiché dans une police à largeur fixe et les lignes de fin sont conservées. Un autre paragraphe normal. ---- [.result] ==== Un paragraphe normal. Une séquence de lignes commençant par au moins un espace est un paragraphe littéral. Les paragraphes littéraux sont traités comme du texte préformaté. Le texte est affiché dans une police à largeur fixe et les lignes de fin sont conservées. Un autre paragraphe normal. ==== .Avertissement ---- REMARQUE : un paragraphe d’avertissement attire l’attention du lecteur sur des informations auxiliaires. Son objectif est déterminé par l’étiquette\au début du paragraphe. Voici les autres types de messages intégrés : TIP : Conseil de pro… IMPORTANT : N’oubliez pas… WARNING : Attention à… ATTENTION : Assurez-vous que… ---- [.result] ==== NOTE: Un paragraphe d’avertissement attire l’attention du lecteur sur des informations auxiliaires. Voici les autres types de messages intégrés : TIP: Conseil de pro… IMPORTANT: N’oubliez pas… WARNING: Attention à… CAUTION: Assurez-vous que… ==== NOTE: Vous pouvez aussi créer admonition blocks. .Entête de paragraphe ---- [.lead] Ce texte sera stylé comme un paragraphe principal (c’est-à-dire avec une police plus grande). ---- [.result] ==== [.lead] Ce texte sera rédigé comme un paragraphe principal (c’est-à-dire avec une police plus grande). ==== NOTE: Le style par défaut d’AsciiDoctor donne au premier paragraphe du préambule un style de chapeau. .Plus d’exemple de paragraphes, avertissements et blocs littéraux * Voir ces sections du manuel utilisateur d’AsciiDoctor pour plus d’information et d’exemples. * Paragraphes * Texte littéral et blocs * Avertissements == Texte formaté .Gras, italique et police à chasse fixe ---- phrase italique ilettres italiques *phrase en gras sveuxtters expression italique et gras bvieilles lettres italiquestters
` passthrough littéral en ligne ` (texte monospace sans substitutions) ---- [.result] ==== phrase italique ilettres italiques phrase en gras sveuxtters expression italique et gras bvieilles lettres italiquestters
.Style personnalisé ---- Les loups-garous croient-ils aux [petits]#petits caractères ? [big]IL était une fois un boucle infini. ---- [.result] ==== Les loups-garous croient-ils aux petits caractères ? [big]IL## était une fois un boucle infini. ==== .Indice et exposant ---- phrase ^super script^ phrase indice ---- [.result] ==== phrase ^super script^ phrase indice ==== .Citations courbes ---- ‘guillemets intelligents simples’ “guillemets intelligents doubles” ---- [.result] ==== ‘guillemets intelligents simples’ “guillemets intelligents doubles” ==== .Autres exemples de formatage de texte Voir ces sections du manuel utilisateur d’AsciiDoctor pour plus d’information et d’exemples. * Formatage en gras et italique * Guillemets et apostrophes * Indice et Exposant * Formatage monospace * Style personnalisé avec attributs * Macros relais ** == Entêtes de document IMPORTANT: Un en-tête est facultatif. CAUTION: L’entête ne doit pas contenir de ligne blanches et doit être séparée du contenu par au moins une ligne blanche. .Titre seulement ---- = Titre de mon document Mon document fournit… ---- .Titre et auteur ---- = Titre de mon document Docteur <[email protected]> Mon document fournit… ---- .Titre, auteur et révisions ---- = Titre de mon document Doc Writer <[email protected]> v1.0, 01/01/2014 Mon document fournit… ---- IMPORTANT: Vous ne pouvez pas préciser une révision s’il n’y a pas d’auteur. .Entête de document avec attributs ---- = Titre de mon document Doc Writer <[email protected]> v1.0, 01/01/2014 :toc: :imagesdir: actifs/images :page d’accueil: http://asciidoctor.org ---- |