Référence rapide de 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. Ce guide est une référence rapide pour le balisage de formatage courant et les éléments de document dans la syntaxe AsciiDoc.
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 « |
Paragraphs
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 produit 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 normale
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 normale.
NOTE: 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 d’avertissements intégrés : TIP : Conseil de pro... IMPORTANT: N'oubliez pas... WARNING : Attention à... CAUTION: Assurez-vous que...
Un paragraphe d’avertissement attire l’attention du lecteur sur des informations auxiliaires. |
Voici les autres types d’avertissements intégrés :
Conseil de pro… |
N’oubliez pas… |
Attention à… |
Assurez-vous que… |
Vous pouvez aussi créer admonition blocks. |
[.lead] Ce texte sera formatté avec le style de chapeau (ie police plus grande).ņ
Ce texte sera formatté avec le style de chapeau (ie police plus grande).
Le style par défaut d’AsciiDoctor donne au premier paragraphe du préambule un style de chapeau. |
Texte Formatté
_italic phrase_ __i__talic le__tt__ers *phrase en gras* **s**veux**tt**ers *_Gras / Italique_* **__b__**vieilles lettres italiques**__tt__**ers `monospace phrase` and le``tt``ers `_monospace italic phrase_` and le``__tt__``ers `*monospace bold phrase*` and le``**tt**``ers `*_monospace bold italic phrase_*` and le``**__tt__**``ers `+inline literal passthrough+` (monospace text without substitutions)
_ expression italique_
italic letters
phrase en gras
sveuxtters
expression italique et gras
bvieilles lettres italiquestters
monospace phrase
and lett
ers
monospace italic phrase
and lett
ers
monospace bold phrase
and lett
ers
monospace bold italic phrase
and lett
ers
inline literal passthrough
(monospace text without 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`' "`double smart quotes`"
‘guillemets intelligents simples’
“double smart quotes”
L’en-tête du 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 explique...
= Titre de mon document Doc Writer <[email protected]> Mon document explique...
= Titre de mon document Doc Writer <[email protected]> v1.0, 2014-01-01 Mon document explique...
Vous ne pouvez pas avoir une ligne de révision sans la ligne d’auteur. |
= Titre de mon document Doc Writer <[email protected]> v1.0, 2014-01-01 :toc: :imagesdir: assets/images :homepage: http://asciidoctor.org Mon document explique...
Titres de section (Headers)
= # Titre du document (Level 0) == Section 1e niveau === Section niveau 2 ==== Section niveau 3 ===== Section du niveau 4 ====== Section niveau 5 == Une autre section 1e niveau
# Titre du document (Level 0)
Section niveau 1
Section niveau 2
Section niveau 3
Section niveau 4
Section niveau 5
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. |
Le nombre de signes égal correspond au niveau de titre dans la sortie HTML. |
= # Titre du document (Level 0) == Section niveau 1 === Section niveau 2 ==== Section niveau 3 ===== Section niveau 4 ###### Section niveau 5 = Section niveau 0
# Titre du document (Level 0)
Section niveau 1
Section niveau 2
Section niveau 3
Section niveau 4
Section niveau 5
Section niveau 0
[[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.
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évélopeur principale This is documentation for project X. include::basics.adoc[] include::installation.adoc[] include::example.adoc[]
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[]
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
'''
<<<
Listes
* Edgar Allen Poe * Sheri S. Tepper * Bill Bryson //^ * Kevin Spacey * Jeremy Piven
-
Edgar Allen Poe
-
Sheri S. Tepper
-
Bill Bryson
-
Kevin Spacey
-
Jeremy Piven
Les lignes vides 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. |
* level 1 ** level 2 *** level 3 **** level 4 ***** level 5 * level 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 styles de bloc. |
- [x] également coché - [ ] non coché - élément de liste normal
-
[*] vérifié
-
[x] également vérifié
-
[ ] non coché
-
élément de liste normale
Les listes de contrôle peuvent utiliser des icônes basées sur des polices et être interactiveshttp://asciidoctor.org/docs/user-manual/#checklists. |
. É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 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 terme
-
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 terme
-
définition du premier terme
- terme de section
-
définiiton du deuxième terme
[qanda] Qu'est-ce qu'Asciidoctor ?:: Une implémentation du processeur AsciiDoc en Ruby. Quelle est la réponse à la question ultime ?:: 42
-
C’est quoi Asciidoctor?
Une implémentation du processeur AsciiDoc en Ruby.
-
Quelle est la réponse à la question ultime ?
42
Operating Systems:: Linux::: . Fedora * Desktop . Ubuntu * Desktop * Server BSD::: . FreeBSD . NetBSD Cloud Providers:: PaaS::: . OpenShift . CloudBees IaaS::: . Amazon EC2 . Rackspace
- Système d’exploitation
-
- Linux
-
-
Fedora
-
Bureau
-
-
Ubuntu
-
Bureau
-
Serveur
-
-
- BSD
-
-
FreeBSD
-
NetBSD
-
- Fournisseurs de cloud
-
- PaaS
-
-
OpenShift
-
CloudBees
-
- IaaS
-
-
Amazon EC2
-
Rackspace
-
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"] |===
-
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"] |
== Liens
link:http://asciidoctor.org[asciidoctor.org] link:http://asciidoctor.org[Asciidoctor] link:https://github.com/asciidoctor[Asciidoctor @ *GitHub*]
link:index.html[Docs]
[email protected] mailto:[email protected][Discuss Arquillian] mailto:[email protected][Subscribe, Subscribe me, I want to join!] irc://irc.freenode.org/#asciidoctor
http://discuss.asciidoctor.org[Discuss Asciidoctor, role="external", window="_blank"] http://discuss.asciidoctor.org[Discussions sur 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.
anchor:bookmark-b []Utilisez une référence croisée pour créer un lien vers cet emplacement.
Voir <<paragraphes>> pour apprendre à écrire des paragraphes. Apprenez à organiser le document en <<section-titres,sections>>.
Voir [paragraphes] pour apprendre à écrire des paragraphes.
Apprenez à organiser le document en 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[Couché de soleil] [[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 beau coucher de soleil !
Quel beau 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 l'image:icons/play.webp[Play, title="Play"] pour commencer la fête. Cliquez sur l'image:icons/pause.webp[title="Pause"] lorsque vous avez besoin d'une pause.
Cliquez sur l’ pour commencer la fête.
Cliquez sur l’ 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]
video::rPQoq7ThGAU[youtube]
video::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 tel que 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 remote: https://rubygems.org/ specs: asciidoctor (0.1.4) PLATFORMS ruby DEPENDENCIES asciidoctor (~> 0.1.4) ----
GEM remote: https://rubygems.org/ specs: asciidoctor (0.1.4) PLATFORMS ruby DEPENDENCIES asciidoctor (~> 0.1.4)
[source,ruby] .app.rb ---- require 'sinatra' get '/hi' do "Bonjour le monde!" end ----
require 'sinatra'
get '/hi' do
"Bonjour 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
require 'sinatra' (1)
get '/hi' do (2)
"Bonjour le monde!" (3)
end
1 | Library import |
2 | URL mapping |
3 | Content for response |
---- 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.
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.
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: src/main/java [source,java] ---- include::{sourcedir}/org/asciidoctor/Asciidoctor.java[] ----
[source,ruby,indent=0] ---- include::lib/document.rb[lines=5..10] ----
-
Lorsqu'
indent
vaut 0, l’indentation du code est retirée (les tabulations sont remplacées par des séries de 4 espaces). -
Lorsqu'
indent
est supérieur à 0, l’indentation est retirée (comme indiqué ci-dessus) puis remontée au niveau indiqué (en espaces simples).
[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 |
More Delimited Blocks
.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. |
.Sample document ==== Here's a sample AsciiDoc document: [listing] .... = Title of Document Doc Writer :toc: This guide provides... .... L'en-tête du document est utile, mais pas obligatoire. ===
Here’s a sample AsciiDoc document:
= Title of Document Doc Writer :toc: This guide provides...
L’en-tête du document est utile, mais pas obligatoire.
[NOTE] ==== Un bloc d'avertissement peut contenir un contenu complexe. .A list - one - two - three Another paragraph. ====
Un bloc d’avertissement peut contenir un contenu complexe.
Another paragraph. |
Admonition and callout icons
Asciidoctor can "draw" icons using Font Awesome and 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... ____ [quote, Albert Einstein] A person who never made a mistake never tried anything new. ____ A person who never made a mistake never tried anything new. ____
Il y a quatre-vingt-sept ans, nos pères ont donné naissance sur ce continent à une nouvelle nation…
Dédicace au Cimetière National des Soldats
A person who never made a mistake never tried anything new.
A person who never made a mistake never tried anything new.
"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.
Papers of Thomas Jefferson: Volume 11
Pour saluer Dick, Asciidoctor reconnaît le texte entre « guillemets aériens » comme un bloc de guillemets.
[, Richard M. Nixon] "" When the President does it, that means that it's not illegal. ""
"" 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 :
-- An open block can be an anonymous container, or it can masquerade as any other block. -- [source] -- mets "Je suis un bloc source!" --
An open block can be an anonymous container, or it can masquerade as any other block.
mets "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>
Block Id, Role and Options
id
et un role
de bloc[[objectifs]] [role="incremental"] * objectif 1 * objectif 2
id
et un role
de bloc (Asciidoctor uniquement)[#goals.incremental] * Goal 1 * Goal 2
|
id
) and role
[[free_the_world]][big goal]_free the world_
id
) and role
(Asciidoctor only)[#free_the_world.big.goal]_free the world_
[rolename]`texte monospace échappé`
options
|=== [options="header,footer,autowidth"] |Cell A |Cell B |===
[%header%footer%autowidth] |=== |Cell A |Cell B |===
Commentaires
// A single-line comment.
Les commentaires sur une seule ligne peuvent être utilisés pour diviser des éléments, tels que deux listes adjacentes. |
//// A multi-line comment. Notice it's a delimited block. ////
Tables
.Table Title |=== |Name of Column 1 |Name of Column 2 |Name of Column 3 (1) (2) |Cell in column 1, row 1 |Cell in column 2, row 1 |Cell in column 3, row 1 |Cell in column 1, row 2 |Cell in column 2, row 2 |Cell in column 3, row 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] ==== .Table Title |
Name of Column 1 |
Name of Column 2 |
Name of Column 3 |
Cell in column 1, row 1 |
Cell in column 2, row 1 |
Cell in column 3, row 1 |
Cell in column 1, row 2 |
Cell in column 2, row 2 |
Cell in column 3, row 2 |
|=== [cols="2*", options="header"] (1) |Name of Column 1 |Name of Column 2 |Cell in column 1, row 1 |Cell in column 2, row 1 |Cell in column 1, row 2 |Cell in column 2, row 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] |
|Name of Column 1 |Name of Column 2
|Cell in column 1, row 1 |Cell in column 2, row 1
|Cell in column 1, row 2 |Cell in column 2, row 2
==== .Table with three columns, a header, and two rows of content ---- |
[cols="1,1,2", options="header"] <1> .Applications |Name |Category |Description
|Firefox |Browser |Mozilla Firefox is an open-source web browser. It’s designed for standards compliance, performance, portability.
|Arquillian |Testing |An innovative and highly extensible testing platform. Empowers developers to easily create real, automated tests.
----
<1> Dans cet exemple, l’attribut |
|Name |Category |Description
|Firefox |Browser |Mozilla Firefox is an open-source web browser. It’s designed for standards compliance, performance, portability.
|Arquillian |Testing |An innovative and highly extensible testing platform. Empowers developers to easily create real, automated tests.
|=== [cols="2,2,5a"] |Firefox |Browser |Mozilla Firefox is an open-source web browser. It's designed for: * standards compliance * performance * portability http://getfirefox.com[Get Firefox]! |===
[.result] ==== [cols="2,2,5a"] |
Firefox |
Browser |
Mozilla Firefox is an open-source web browser. It’s designed for: * standards compliance * performance * portability |
|=== [format="csv", options="header"] Artist,Track,Genre Baauer,Harlem Shake,Hip Hop The Lumineers,Ho Hey,Folk Rock |===
[.result] |
Artiste,Track,Genre Baauer,Harlem Shake,Hip Hop The Lumineers,Ho Hey,Folk Rock
==== .Table from CSV data using shorthand (Asciidoctor only) ---- ,=== Artiste,Track,Genre Baauer,Harlem Shake,Hip Hop ,=== ---- [.result] ==== ,=== Artiste,Track,Genre Baauer,Harlem Shake,Hip Hop ,=== ==== .Table from DSV data using shorthand (Asciidoctor only) ---- :=== Artiste:Track:Genre Robyn:Indestructable:Dance :=== ---- [.result] ==== :=== Artiste,Track,Genre Robyn:Indestructable:Dance :=== ==== .Table with formatted, aligned and merged cells ---- |
|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
Macros UI
You must set the experimental attribute in the document header to enable these macros.
|
kbd
macro)|=== |Shortcut |Purpose |kbd:[F11] |Toggle fullscreen |kbd:[Ctrl+T] |Open a new tab |kbd:[Ctrl+Shift+N] |New incognito window |kbd:[Ctrl + +] |Increase zoom |===
[.result] ==== |
Shortcut |
Purpose |
F11 |
Toggle fullscreen |
Ctrl+T |
Open a new tab |
Ctrl+Shift+N |
New incognito window |
Ctrl++ |
Increase zoom |
menu
macro)To save the file, select menu:File[Save]. Select menu:View[Zoom > Reset] to reset the zoom level to the default setting.
To save the file, select
.Select
to reset the zoom level to the default setting.btn
en ligne)Press the btn:[OK] button when you are finished. Select a file in the file navigator and click btn:[Open].
Press the OK button when you are finished.
Select a file in the file navigator and click Open.
== Attributs et Remplacements
:homepage: http://asciidoctor.org :docslink: http://asciidoctor.org/docs[Asciidoctor's Docs] :desc: 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. :checkedbox: pass:normal[`[✔]`] 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! |
-
Attribute passed to the API or CLI that does not end in
@
-
Attribute defined in the document
-
Attribute passed to the API or CLI that ends in
@
-
Intrinsic attribute value (default values)
To make an attribute value that is passed to the API or CLI have a lower precedence than an assignment in the document, add an @ symbol to the end of the attribute value.
|
Référence d’attributs | Replacement | Rendu |
---|---|---|
\{lt} |
< |
< |
\{gt} |
> |
> |
\{amp} |
& |
& |
\{startsb} |
[ |
[ |
\{endsb} |
] |
] |
\{vbar} |
| |
| |
\{caret} |
^ |
^ |
\{asterisk} |
* |
* |
\{tilde} |
~ |
~ |
\{apostrophe} |
' |
' |
\{backslash} |
\ |
\ |
\{backtick} |
` |
` |
\{two-colons} |
:: |
:: |
\{two-semicolons} |
;; |
;; |
Référence d’attributs | Replacement | Rendu |
---|---|---|
\{empty} |
_nothing_ |
|
\{sp}, \{space} |
_single space_ |
|
\{nbsp} |
\  |
|
\{zwsp} |
\​ |
|
\{wj} |
\⁠ |
|
\{apos} |
\' |
' |
\{quot} |
\" |
" |
\{lsquo} |
\‘ |
‘ |
\{rsquo} |
\’ |
’ |
\{ldquo} |
\“ |
“ |
\{rdquo} |
\” |
” |
\{deg} |
\° |
° |
\{plus} |
\+ |
+ |
\{brvbar} |
\¦ |
¦ |
Attribute | Description |
---|---|
|
Calls the processor |
|
Version of the processor |
|
Backend used to render document |
|
Last modified date |
|
Last modified date and time |
|
Name of document directory |
|
Name of document file |
|
Last modified time |
|
The title of the document |
|
Document’s doctype (e.g., article) |
|
Local date when rendered |
|
Local date and time when rendered |
|
Local time when rendered |
aucun
|
Désactive les remplacements |
normal
|
Effectue toutes les substitutions à l’exception des légendes |
verbatim
|
Remplace les caractères spéciaux et traite les légendes |
specialcharacters
|
Replaces |
Citations
|
Applique le formatage de texte |
Attributs d’entité intégrés |
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} |Part Id |Description |PX-{counter:index} |Description of PX-{index} |PX-{counter:index} |Description of PX-{index} |===
[.result] |
|Part Id |Description
|PX-1 |Description of PX-1
|PX-2 |Description of PX-2
==== == Remplacement de text //// Included in: - user-manual: Text Substitutions: Replacements - quick-ref //// [cols="2,1l,1l,^1,2"] .Remplacements de symboles textuels |
|Name |Syntax |Unicode Replacement |Rendered |Notes
|Copyright |(C) |© |© |
|Registered |(R) |® |® |
|Trademark |(TM) |™ |™ |
|Em dash
|--
|—
|--
|When space is detected on either side of the em dash, the thin space numeric character entity ( 
) is also substituted into the document.
|ellipses |... |… |… |
|right single arrow |-> |→ |→ |
|right double arrow |=> |⇒ |⇒ |
|left single arrow |<- |← |← |
|left double arrow |<= |⇐ |⇐ |
|apostrophe |Sam's |Sam’s |Sam’s |The vertical form apostrophe is replaced with the curved form apostrophe.
TIP: Toute référence d’entité XML nommée, numérique ou hexadécimale est prise en charge. == Escaping Text .Barre oblique ---- *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 ---- underline me renders as underlined text. underline me also renders as underlined text. ---- [.result] ==== underline me renders as underlined text. underline me also renders as underlined text. ==== .Backticks
----
[.result]
====
== Table des matières (ToC) .Document avec Table de matières ---- = AsciiDoc Writer’s Guide Doc Writer <[email protected]> v1.0, 2013-01-01 :toc: ---- .Document avec table des matières à droite ---- = AsciiDoc Writer’s Guide Doc Writer <[email protected]> v1.0, 2013-01-01 :toc: right ---- TIP: The ToC "title, levels, and positioning" can be customized. == Bibliographie .Références ---- « 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. ---- [.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 en pas de pages standards et répétés ---- Une déclaration.[1] A bold statement.[2] Une autre déclaration en gras.footenoteref:[avertissement] ---- [.result] ==== [.unstyled] |
a| Une déclaration.[3]
Une autre déclaration en gras.footenoteref:[avertissement]
==== == La compatibilité 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. .Titres de niveau de style 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 démarqué avec coloration syntaxique
----
[.result]
====
.Citation en style markdown ---- > 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 ---- [.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 en style markdown avec contenu du bloc ---- > > 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 * Titres de niveau > * Blocs de code clôturés > > > Y a-t-il plus ? > > Oui. AsciiDoc et Markdown partage beaucoup de syntaxe en commun. ==== .Markdown-style horizontal rules ---- --- - - - * * * * ---- [.result] ==== --- - - * * * ==== == Manuel utlisateur 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: Ce guide est une référence rapide pour le balisage de formatage courant et \ les éléments de document dans la syntaxe AsciiDoc. :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. Ce guide est une référence rapide pour le balisage de formatage courant et les éléments de document dans la syntaxe AsciiDoc. [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 « == Paragraphs .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. + .Attributs litéraux intégrés ---- 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 normale ---- [.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 normale. ==== .Avertissement ---- NOTE: 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 d’avertissements intégrés : TIP : Conseil de pro… IMPORTANT: N’oubliez pas… WARNING : Attention à… CAUTION: Assurez-vous que… ---- [.result] ==== NOTE: Un paragraphe d’avertissement attire l’attention du lecteur sur des informations auxiliaires. Voici les autres types d’avertissements 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. .Style de chapeau ---- [.lead] Ce texte sera formatté avec le style de chapeau (ie police plus grande).ņ ---- [.result] ==== [.lead] Ce texte sera formatté avec le style de chapeau (ie police plus grande). ==== NOTE: Le style par défaut d’AsciiDoctor donne au premier paragraphe du préambule un style de chapeau. .Plus d’exemples de Paragraphes, Avertisesements, et Bloc litérales * Voir ces sections du manuel utilisateur d’AsciiDoctor pour plus d’information et d’exemples. * Paragraphs * Texte Literal and Blocs * Admonitions == Texte Formatté .Gras, Italique, et Espace mono ---- italic phrase italic letters *phrase en gras sveuxtters Gras / Italique bvieilles lettres italiquestters
[.result] ==== _ expression italique_ italic letters phrase en gras sveuxtters expression italique et gras bvieilles lettres italiquestters
.Personalizer ---- 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. ==== .Exposant et indice ---- phrase ^super script^ phrase indice ---- [.result] ==== phrase ^super script^ phrase indice ==== .Citations courbes ---- ‘guillemets intelligents simples’ “double smart quotes” ---- [.result] ==== ‘guillemets intelligents simples’ “double smart quotes” ==== .Autres exemples de formatage de texte Voir ces sections du manuel utilisateur d’AsciiDoctor pour plus d’information et d’exemples. * Bold and Italic Formatting * Guillemets et apostrophes * Indice et Exposant * Formatage monospace * Style personnalisé avec attributs * Macros de transfert ** == L’en-tête du 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 explique… ---- .Titre et ligne d’auteur ---- = Titre de mon document Doc Writer <[email protected]> Mon document explique… ---- .Titre, ligne d’auteur, et ligne de révision ---- = Titre de mon document Doc Writer <[email protected]> v1.0, 2014-01-01 Mon document explique… ---- IMPORTANT: Vous ne pouvez pas avoir une ligne de révision sans la ligne d’auteur. .Entête de document avec attributs ---- = Titre de mon document Doc Writer <[email protected]> v1.0, 2014-01-01 :toc: :imagesdir: assets/images :homepage: http://asciidoctor.org ---- |