Référence rapide du syntax AsciiDoc
AsciiDoc est une norme légère de formatage de texte permettant d’écrire des articles, de la documentation, des livres, des pages web, des diaporamas ou même des pages de man
à partir d’un simple texte, enrichi de symboles de présentation. This guide is a quick reference for the common AsciiDoc document and text formatting markup.
Les exemples donnés se concentrent sur le format de sortie HTML de la commande AsciiDoctor. Il est toutefois possible de produire des PDF, des ePub ou encore du DocBook. |
Paragraphes
Paragraphs don't require any special markup in AsciiDoc. A paragraph is just one or more lines of consecutive text. To begin a new paragraph, separate it by at least one blank line. Newlines within a paragraph are not displayed.
Paragraphs don’t require any special markup in AsciiDoc. A paragraph is just one or more lines of consecutive text.
To begin a new paragraph, separate it by at least one blank line. Newlines within a paragraph are not displayed.
A normal paragraph. A paragraph offset by at least one space becomes a literal paragraph. All lines in a literal paragraph must be adjacent. A literal paragraph is displayed as preformatted text. The text is shown in a fixed-width font. Spaces and newlines, like the ones in this sentence, are preserved. Another normal paragraph.
A normal paragraph.
A paragraph offset by at least one space becomes a literal paragraph. All lines in a literal paragraph must be adjacent.
A literal paragraph is displayed as preformatted text. The text is shown in a fixed-width font. Spaces and newlines, like the ones in this sentence, are preserved.
Another normal paragraph.
NOTE: An admonition paragraph draws the reader's attention to auxiliary information. Its purpose is determined by the label at the beginning of the paragraph. Here are the other built-in admonition types: TIP: Pro tip... IMPORTANT: Don't forget... WARNING: Watch out for... CAUTION: Ensure that...
An admonition paragraph draws the reader’s attention to auxiliary information. Its purpose is determined by the label at the beginning of the paragraph. |
Here are the other built-in admonition types:
Pro tip… |
Don’t forget… |
Watch out for… |
Ensure that… |
Vous pouvez aussi créer admonition blocks. |
[.lead] This text will be styled as a lead paragraph (i.e., larger font).
This text will be styled as a lead paragraph (i.e., larger font).
Le style par défaut d’AsciiDoctor donne au premier paragraphe du préambule un style de chapeau. |
Texte formaté
bold *constrained* & **un**constrained italic _constrained_ & __un__constrained bold italic *_constrained_* & **__un__**constrained monospace `constrained` & ``un``constrained monospace bold `*constrained*` & ``**un**``constrained monospace italic `_constrained_` & ``__un__``constrained monospace bold italic `*_constrained_*` & ``**__un__**``constrained
bold constrained & unconstrained
italic constrained & unconstrained
bold italic constrained & unconstrained
monospace constrained
& un
constrained
monospace bold constrained
& un
constrained
monospace italic constrained
& un
constrained
monospace bold italic constrained
& un
constrained
`{cpp}` is valid syntax in the programming language by the same name. `+WHERE id <= 20 AND value = "{name}"+` is a SQL WHERE clause.
C++
is valid syntax in the programming language by the same name.
WHERE id <= 20 AND value = "{name}"
is a SQL WHERE clause.
La signification du backtick (` ) et du plus (+ ) a changé dans Asciidoctor 1.5.0. Les backticks ne font que rendre le texte à espacement fixe, tandis que les plus transmettent le texte sans appliquer de formatage. Voir le page de migration pour plus de détails.
|
Werewolves are allergic to #cassia cinnamon#. Did the werewolves read the [.small]#small print#? Where did all the [.underline]#cores# run off to? We need [.line-through]#ten# make that twenty VMs. [.big]##O##nce upon an infinite loop.
Werewolves are allergic to cassia cinnamon.
Did the werewolves read the small print?
Where did all the cores run off to?
We need ten make that twenty VMs.
Once upon an infinite loop.
^super^script phrase ~sub~script phrase
superscript phrase
subscript phrase
"`double curved quotes`" '`single curved quotes`' Olaf's desk was a mess. All of the werewolves`' desks were a mess. Olaf had been with the company since the `'60s.
“double curved quotes”
‘single curved quotes’
Olaf’s desk was a mess.
All of the werewolves’ desks were a mess.
Olaf had been with the company since the ’60s.
Entêtes de document
Les champs d’entête sont optionnels. |
L’entête ne doit pas contenir de ligne blanches et doit être séparée du contenu par au moins une ligne blanche. |
= My Document's Title My document provides...
= My Document's Title Doc Writer <[email protected]> My document provides...
AsciiDoctor permet de préciser plusieurs auteurs sur la ligne d’entête d’auteur. Il suffit de les séparer par un point-virgule. |
= My Document's Title Doc Writer <[email protected]> v1.0, 2014-01-01 My document provides...
Vous ne pouvez pas préciser une révision s’il n’y a pas d’auteur. |
= My Document's Title Doc Writer <[email protected]> v1.0, 2018-04-11 :toc: :imagesdir: assets/images :homepage: https://asciidoctor.org My document provides...
Titres de section
= Document Title (Level 0) == Level 1 Section Title === Level 2 Section Title ==== Level 3 Section Title ===== Level 4 Section Title ====== Level 5 Section Title == Another Level 1 Section Title
Document Title (Level 0)
Level 1 Section Title
Level 2 Section Title
Level 3 Section Title
Level 4 Section Title
Level 5 Section Title
Another Level 1 Section Title
Lorsque vous utiliser le doctype par défaut (article), vous ne pouvez avoir qu’un seul titre de niveau 1 dans le document, et il doit être positionné dans l’entête du document. |
Le nombre de signe "égal" devant les titres de section précise leur niveau comme en HTML. Par exemple, Section de niveau 1 devient un titre <h2> en HTML.
|
= Document Title (Level 0) == Section Level 1 === Section Level 2 ==== Section Level 3 ===== Section Level 4 ====== Section Level 5 = Section Level 0
Document Title (Level 0)
Section Level 1
Section Level 2
Section Level 3
Section Level 4
Section Level 5
Section Level 0
[#primitives-nulls] == Types primitifs et valeurs nulles
sectanchors
-
Quand cet attribut de document est déclaré, une icône apparait devant chaque titre de section portant une ancre vers cette section.
sectlinks
-
Quand cet attribut est déclaré, les titres de section deviennent des liens. Cela permet au lecteur d’enregistrer un marque-page sur cette section.
Les ancres de titre de section dépendent du style par défaut d’AsciiDoctor pour leur affichage. |
Fichiers inclus
= Reference Documentation Lead Developer This is documentation for project X. include::basics.adoc[] include::installation.adoc[] include::example.adoc[]
AsciiDoctor n’insert pas de ligne blanches entre deux directives d’inclusion. Il vous revient d’ajouter des lignes blanches après les directives si vous le souhaitez (or lorsqu’une inclusion précède un titre, vous le souhaitez sûrement). |
include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/README.adoc[]
Inclure du contenu depuis une adresse est potentiellement dangereux, et cette fonctionnalité est donc désactivée par défaut en mode sûr (SECURE et au delà). Le mode safe nécessite également l’ajout de l’attribut d’entête :allow-url-read: pour que la directive soit interprêtée.
|
Saut de ligne
Rubies are red, + Topazes are blue. [%hardbreaks] Ruby is red. Java is black.
Rubies are red,
Topazes are blue.
Ruby is red.
Java is black.
before ' after
before
'
after
<<<
Listes
* Edgar Allen Poe * Sheri S. Tepper * Bill Bryson
-
Edgar Allen Poe
-
Sheri S. Tepper
-
Bill Bryson
- Edgar Allen Poe - Sheri S. Tepper - Bill Bryson
-
Edgar Allen Poe
-
Sheri S. Tepper
-
Bill Bryson
Il doit y avoir une ligne blanche avant et après une liste pour la séparer des autres blocs. |
Il est possible de séparer deux listes consécutives en insérant une ligne blanche suivie d’une ligne de commentaire après la première liste. La convention est d’utiliser //- comme ligne de commentaire afin d’indiquer aux autres auteurs qu’il s’agit d’une séparation de listes.
|
* level 1 ** level 2 *** level 3 **** level 4 ***** level 5 * level 1
-
level 1
-
level 2
-
level 3
-
level 4
-
level 5
-
-
-
-
-
level 1
Il est possible de changer le type de puce d’une liste à puces via {user}#custom-markers[block styles]. |
. Step 1 . Step 2 . Step 3
-
Step 1
-
Step 2
-
Step 3
Vous pouvez choisir de numéroter les éléments d’une liste, mais les index doivent alors se suivre. |
. Step 1 . Step 2 .. Step 2a .. Step 2b . Step 3
-
Step 1
-
Step 2
-
Step 2a
-
Step 2b
-
-
Step 3
. level 1 .. level 2 ... level 3 .... level 4 ..... level 5 . level 1
-
level 1
-
level 2
-
level 3
-
level 4
-
level 5
-
-
-
-
-
level 1
Pour les listes ordonnées, AsciiDoctor supporte des {user}#numbering-styles[numeration styles] tels que lowergrek (grecque minuscule) et decimal-leading-zero (décimal à zéro apparent).
|
* [*] checked * [x] also checked * [ ] not checked * normal list item
-
checked
-
also checked
-
not checked
-
normal list item
Les listes à cocher peuvent utiliser {user}#checklist[des icônes inclues dans une police de caractère et être interactives]. |
first term:: definition of first term second term:: definition of second term
- first term
-
definition of first term
- second term
-
definition of second term
first term:: definition of first term second term:: definition of second term
- first term
-
definition of first term
- second term
-
definition of second term
[qanda] What is Asciidoctor?:: An implementation of the AsciiDoc processor in Ruby. What is the answer to the Ultimate Question?:: 42
-
What is Asciidoctor?
An implementation of the AsciiDoc processor in Ruby.
-
What is the answer to the Ultimate Question?
42
Operating Systems:: Linux::: . Fedora * Desktop . Ubuntu * Desktop * Server BSD::: . FreeBSD . NetBSD Cloud Providers:: PaaS::: . OpenShift . CloudBees IaaS::: . Amazon EC2 . Rackspace
- Operating Systems
-
- Linux
-
-
Fedora
-
Desktop
-
-
Ubuntu
-
Desktop
-
Server
-
-
- BSD
-
-
FreeBSD
-
NetBSD
-
- Cloud Providers
-
- 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. |
* Every list item has at least one paragraph of content, which may be wrapped, even using a hanging indent. + Additional paragraphs or blocks are adjoined by putting a list continuation on a line adjacent to both blocks. + list continuation:: a plus sign (`{plus}`) on a line by itself * A literal paragraph does not require a list continuation. $ gem install asciidoctor * AsciiDoc lists may contain any complex content. + [cols="2", options="header"] |=== |Application |Language |AsciiDoc |Python |Asciidoctor |Ruby |===
-
Every list item has at least one paragraph of content, which may be wrapped, even using a hanging indent.
Additional paragraphs or blocks are adjoined by putting a list continuation on a line adjacent to both blocks.
- list continuation
-
a plus sign (
+
) on a line by itself
-
A literal paragraph does not require a list continuation.
$ gem install asciidoctor
-
AsciiDoc lists may contain any complex content.
Application Language AsciiDoc
Python
Asciidoctor
Ruby
Liens
https://asciidoctor.org - automatic! https://asciidoctor.org[Asciidoctor] https://github.com/asciidoctor[Asciidoctor @ *GitHub*]
link:++https://example.org/?q=[a b]++[URL with special characters] link:https://example.org/?q=%5Ba%20b%5D[URL with special characters]
// link:\\server\share\whitepaper.pdf[Whitepaper]
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/#fedora
http://discuss.asciidoctor.org[Discuss Asciidoctor, role="external", window="_blank"] http://discuss.asciidoctor.org[Discuss Asciidoctor^] https://example.org["Google, Yahoo, Bing^", role="teal"]
Les attributs de lien (y compris l’objet et le contenu d’un lien courriel mailto:) sont une fonctionnalité d’AsciiDoctor seulement. Pour les activer, il faut déclarer l’attribut d’entête de document :linkattrs: . Depuis la version 1.5.7 cela se fait automatiquement si le signe égal suit une virgule. Lorsqu’ils sont activés, vous devez mettre les textes de lien entre guillemets s’ils contiennent une virgule.
|
[[bookmark-a]]Inline anchors make arbitrary content referenceable. [#bookmark-b]#Inline anchors can be applied to a phrase like this one.# anchor:bookmark-c[]Use a cross reference to link to this location. [[bookmark-d,last paragraph]]The xreflabel attribute will be used as link text in the cross-reference link.
// See <<paragraphs>> to learn how to write paragraphs. See paragraphs>> to learn how to write paragraphs. Learn how to organize the document into <<section-titles,sections>>.
See paragraphs>> to learn how to write paragraphs.
Learn how to organize the document into sections.
Refer to <<document-b.adoc#section-b,Section B>> for more information. See you when you get back from <<document-b#section-b,Section B>>!
Images
Les images sont cherchées dans le dossiers déclaré via l’attribut de document {user}#setting-the-location-of-images[imagesdir], qui est nul par défaut. Vous êtes encouragé à déclarer un attribut de document :imagesdir:
afin de vous éviter de répéter la partie commune des chemins de vos images.
L’attribut de document imagesdir
peut être un chemin absolu, relatif, ou une URL. Lorsque le chemin d’une image est une URL ou un chemin absolu, le préfix :imagesdir:
n’est pas inclu.
image::sunset.webp[] image::sunset.webp[Sunset] .A mountain sunset [#img-sunset] [caption="Figure 1: ",link=https://www.flickr.com/photos/javh/5448336655] image::sunset.webp[Sunset,300,200] image::https://asciidoctor.org/images/octocat.webp[GitHub mascot]
Click image:icons/play.webp[Play, title="Play"] to get the party started. Click image:icons/pause.webp[title="Pause"] when you need a break.
Click to get the party started.
Click when you need a break.
Deux fois deux-points collés au mot-clé image (i.e., image:: ) indiquent d’inclure l’image dans son popre bloc (c’est à dire d’en faire une figure), alors qu’un seul deux-points (donc image: ) indique une image en plein texte, traitée comme un caractère. (Toute les macros suivent ce principe, ex : toc:: )
|
image:sunset.webp[Sunset,150,150,role="right"] What a beautiful sunset!
What a beautiful sunset!
Il y a toute une variété d’attributs disponibles pour le {user}#putting-images-in-their-place[positionnement des images]. |
= Document Title :data-uri:
Lorsque l’attribut :data-uri: est déclaré, toutes les images du document — y compris les icônes d’avertissement — sont embarquées sous forme de 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, end=140, options=autoplay]
video::rPQoq7ThGAU[youtube]
video::67480300[vimeo]
Vous pouvez contrôler les réglages de la vidéo en utilisant des {user}#video[attributs et leurs options] à l’appel de la macro. |
Code source
Reference code like `types` or `methods` inline. Do not pass arbitrary ``Object``s to methods that accept ``String``s!
Reference code like types
or methods
inline.
Do not pass arbitrary Object
s to methods that accept String
s!
Output literal monospace text such as `+{backtick}+` by enclosing the text in pluses, then again in backticks.
Output literal monospace text such as {backtick}
by
enclosing the text in pluses, then again in backticks.
Indent the line one space to insert a code snippet
Indent the line one space to insert a code snippet
.... error: The requested operation returned error: 1954 Forbidden search for defensive operations manual absolutely fatal: operation initiation lost in the dodecahedron of doom would you like to die again? y/n ....
error: The requested operation returned error: 1954 Forbidden search for defensive operations manual absolutely fatal: operation initiation lost in the dodecahedron of doom would you like to die again? y/n
.Gemfile.lock ---- GEM remote: https://rubygems.org/ specs: asciidoctor (1.5.6.1) PLATFORMS ruby DEPENDENCIES asciidoctor (~> 1.5.6.1) ----
GEM remote: https://rubygems.org/ specs: asciidoctor (1.5.6.1) PLATFORMS ruby DEPENDENCIES asciidoctor (~> 1.5.6.1)
.app.rb [source,ruby] ---- require 'sinatra' get '/hi' do "Hello World!" end ----
require 'sinatra'
get '/hi' do
"Hello World!"
end
[source,ruby] ---- require 'sinatra' // <1> get '/hi' do // <2> "Hello World!" // <3> end ---- <1> Library import <2> URL mapping <3> HTTP response body
require 'sinatra' (1)
get '/hi' do (2)
"Hello World!" (3)
end
1 | Library import |
2 | URL mapping |
3 | HTTP response body |
---- line of 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 | 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. |
[source,xml] ---- <section> <title>Section Title</title> <!--1--> </section> ---- <1> The section title is required.
<section>
<title>Section Title</title> (1)
</section>
1 | The section title is required. |
[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"> This is normal content.
<meta name="viewport"
content="width=device-width, initial-scale=1.0">
This is normal content.
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
.AsciiDoc history **** AsciiDoc was first released in Nov 2002 by Stuart Rackham. It was designed from the start to be a shorthand syntax for producing professional documents like DocBook and 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... .... The document header is useful, but not required. ====
Here’s a sample AsciiDoc document:
= Title of Document Doc Writer :toc: This guide provides...
The document header is useful, but not required.
[NOTE] ==== An admonition block may contain complex content. .A list - one - two - three Another paragraph. ====
An admonition block may contain complex content. A list
Another paragraph. |
Icônes d’avertissement et de renvoi
AsciiDoctor peut "dessiner" des icônes en utilisant la police de caractères Font Awesome et du CSS. Pour utiliser cette fonctionnalité, déclarer la valeur Les icônes peuvent également être utilisées en {user}#inline-icons[plein texte] et être {user}#size-rotate-and-flip[stylisées]. |
[quote, Abraham Lincoln, Address delivered at the dedication of the Cemetery at Gettysburg] ____ Four score and seven years ago our fathers brought forth on this continent a new 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. ____ [quote, Charles Lutwidge Dodgson, 'Mathematician and author, also known as http://en.wikipedia.org/wiki/Lewis_Carroll[Lewis Carroll]'] ____ If you don't know where you are going, any road will get you there. ____
Four score and seven years ago our fathers brought forth on this continent a new nation…
Address delivered at the dedication of the Cemetery at Gettysburg
A person who never made a mistake never tried anything new.
A person who never made a mistake never tried anything new.
If you don’t know where you are going, any road will get you there.
Mathematician and author, also known as Lewis Carroll
"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
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.
Papers of Thomas Jefferson: Volume 11
++++ <p> Content in a passthrough block is passed to the output unprocessed. That means you can include raw HTML, like this embedded Gist: </p> <script src="https://gist.github.com/mojavelinux/5333524.js"> </script> ++++
Content in a passthrough block is passed to the output unprocessed. That means you can include raw HTML, like this embedded Gist:
-- An open block can be an anonymous container, or it can masquerade as any other block. -- [source] -- puts "I'm a source block!" --
An open block can be an anonymous container, or it can masquerade as any other block.
puts "I'm a source block!"
:version: 1.5.6.1 [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>1.5.6.1</version>
</dependency>
Identifiant, rôle et options de bloc
[[goals]] [role="incremental"] * Goal 1 * Goal 2
[#goals.incremental] * Goal 1 * Goal 2
|
[[free_the_world]][big goal]_free the world_
[#free_the_world.big.goal]_free the world_
[.rolename]`monospace text`
|=== [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
.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 |===
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 |
1 | Unless the cols attribute is specified, the number of columns is equal to the number of cell separator characters on the first (non-blank) line between the block delimiters. |
2 | When a blank line follows the first non-blank line, the cell in the first line get promoted to the table header. |
[%header,cols=2*] (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 |===
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 | The * in the cols attribute is the repeat operator.
It means repeat the column specification across the remaining columns.
In this case, we are repeating the default formatting across 2 columns.
When the cells in the header are not defined on a single line, you must use the cols attribute to set the number of columns in the table and the %header option (or options=header attribute) to promote the first row to the table header. |
[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. |===
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 | In this example, the cols attribute has two functions.
It specifies that this table has three columns, and it sets their relative widths. |
[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]! |===
Firefox |
Browser |
Mozilla Firefox is an open-source web browser. It’s designed for:
|
[%header,format=csv] |=== Artist,Track,Genre Baauer,Harlem Shake,Hip Hop The Lumineers,Ho Hey,Folk Rock |===
Artist | Track | Genre |
---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
The Lumineers |
Ho Hey |
Folk Rock |
,=== Artist,Track,Genre Baauer,Harlem Shake,Hip Hop ,===
Artist | Track | Genre |
---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
|=== include::customers.csv[] |===
:=== Artist:Track:Genre Robyn:Indestructable:Dance :===
Artist | Track | Genre |
---|---|---|
Robyn |
Indestructable |
Dance |
[cols="e,m,^,>s", width="25%"] |=== |1 >s|2 |3 |4 ^|5 2.2+^.^|6 .3+<.>m|7 ^|8 |9 2+>|10 |===
1 |
2 |
3 |
4 |
5 |
|
|
|
8 |
|||
9 |
|
Macro d’interface graphique
Vous devez déclarer l’attribut :experimental: dans l’entête du document pour activer ces fonctionnalités.
|
|=== |Shortcut |Purpose |kbd:[F11] |Toggle fullscreen |kbd:[Ctrl+T] |Open a new tab |kbd:[Ctrl+Shift+N] |New incognito window |kbd:[\ ] |Used to escape characters |kbd:[Ctrl+\]] |Jump to keyword |kbd:[Ctrl + +] |Increase zoom |===
Shortcut | Purpose |
---|---|
F11 |
Toggle fullscreen |
Ctrl+T |
Open a new tab |
Ctrl+Shift+N |
New incognito window |
\ |
Used to escape characters |
Ctrl+] |
Jump to keyword |
Ctrl++ |
Increase zoom |
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.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 substitutions
:url-home: https://asciidoctor.org :link-docs: https://asciidoctor.org/docs[documentation] :summary: 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[{startsb}✔{endsb}] Check out {url-home}[Asciidoctor]! {summary} Be sure to read the {link-docs} too! {checkedbox} That's done!
:url-home: https://asciidoctor.org :link-docs: documentation :summary: 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: [✔] Check out {url-home}[Asciidoctor]! {summary} Be sure to read the {link-docs} too! {checkedbox} That’s done! |
-
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.
|
Attribute name | Replacement text | Appearance |
---|---|---|
|
nothing |
|
|
nothing |
|
|
single space |
|
|
  |
|
|
​ |
|
|
⁠ |
|
|
' |
' |
|
" |
" |
|
‘ |
‘ |
|
’ |
’ |
|
“ |
“ |
|
” |
” |
|
° |
° |
|
+ |
+ |
|
¦ |
¦ |
|
| |
| |
|
& |
& |
|
< |
< |
|
> |
> |
|
[ |
[ |
|
] |
] |
|
^ |
^ |
|
* |
* |
|
~ |
~ |
|
\ |
\ |
|
` |
` |
|
:: |
:: |
|
;; |
;; |
|
C++ |
C++ |
[1] Some replacements are Unicode characters, whereas others are numeric character references (e.g., "). These character references are used whenever the use of the Unicode character could interfere with the AsciiDoc syntax or confuse the renderer (i.e., the browser). It’s up to the converter to transform the reference into something the renderer understands (something both the man page and PDF converter handle).
[2] Asciidoctor does not prevent you from reassigning predefined attributes. However, it’s best to treat them as read-only unless the output format requires the use of a different encoding scheme. These attributes are an effective tool for decoupling content and presentation.
[3] Asciidoctor allows you to use any of the named character references (aka named entities) defined in HTML (e.g., € resolves to €). However, using named character references can cause problems when generating non-HTML output such as PDF because the lookup table needed to resolve these names may not be defined. Our recommendation is avoid using named character references—with the exception of those defined in XML (i.e., lt, gt, amp, quot and apos). Instead, use numeric character references (e.g., €).
[4] The Zero Width Space (ZWSP) is a code point in Unicode that shows where a long word can be split if necessary.
[5] The word joiner (WJ) is a code point in Unicode that prevents a line break at its position.
Attribute | Description | Example Value |
---|---|---|
|
Set if the current processor is Asciidoctor. |
|
|
Asciidoctor version. |
|
|
The backend used to select and activate the converter that creates the output file.
Usually named according to the output format (e.g., |
|
|
The generic backend on which the backend is based.
Typically the backend value minus any trailing numbers (e.g., the basebackend for |
|
|
|
|
|
|
|
|
Full path of the directory that contains the source document. Empty if the safe mode is SERVER or SECURE (to conceal the file’s location). |
|
|
Full path of the source document. Truncated to the basename if the safe mode is SERVER or SECURE (to conceal the file’s location). |
|
|
File extension of the source document, including the leading period. Introduced in 1.5.6. |
|
|
Root name of the source document (no leading path or file extension). |
|
|
|
|
|
Document type (article, book or manpage). |
|
|
|
|
|
Set if content is being converted to an embeddable document (body only). |
|
|
File extension of the output file name (without leading period). |
|
|
Syntax used when generating the HTML output (html or xhtml). |
|
|
Date when the document was converted.[2] |
|
|
Date and time when the document was converted.[2] |
|
|
Time when the document was converted.[2] |
|
|
Year when the document was converted.[2] |
|
|
Full path of the output directory. (Cannot be referenced in the content. Only available to the API once the document is converted). |
|
|
Full path of the output file. (Cannot be referenced in the content. Only available to the API once the document is converted). |
|
|
File extension of the output file (starting with a period) as determined by the backend ( |
|
|
Numeric value of the safe mode setting. (UNSAFE=0, SAFE=10, SERVER=10, SECURE=20). |
|
|
Textual value of the safe mode setting. |
|
|
Set if the safe mode is UNSAFE. |
|
|
Set if the safe mode is SAFE. |
|
|
Set if the safe mode is SERVER. |
|
|
Set if the safe mode is SECURE. |
|
|
Full path of the home directory for the current user.
Truncated to |
|
[1] Only reflects the last modified time of the source document file. It does not consider the last modified time of files which are included.
[2] If the SOURCE_DATE_EPOCH environment variable is set, the value assigned to this attribute is built from a UTC date object that corresponds to the timestamp (as an integer) stored in that environment variable.
This override offers one way to make the conversion reproducible.
See https://reproducible-builds.org/specs/source-date-epoch/ for more information about the SOURCE_DATE_EPOCH environment variable.
Otherwise, the date is expressed in the local time zone, which is reported as a time zone offset (e.g., -0600
) or UTC if the time zone offset is 0).
To force the use of UTC, set the TZ=UTC
environment variable when invoking Asciidoctor.
none
|
Disables substitutions |
normal
|
Performs all substitutions except for callouts |
verbatim
|
Replaces special characters and processes callouts |
specialchars , specialcharacters
|
Replaces |
quotes
|
Applies text formatting |
attributes
|
Replaces attribute references |
replacements
|
Substitutes textual and character reference replacements |
macros
|
Processes macros |
post_replacements
|
Replaces the line break character ( |
[caption=""] .Parts{counter2:index:0} |=== |Part Id |Description |PX-{counter:index} |Description of PX-{index} |PX-{counter:index} |Description of PX-{index} |===
Part Id | Description |
---|---|
PX-1 |
Description of PX-1 |
PX-2 |
Description of PX-2 |
== Remplacement de texte
Name | Syntax | Unicode Replacement | Rendered | Notes |
---|---|---|---|---|
Copyright |
(C) |
© |
© |
|
Registered |
(R) |
® |
® |
|
Trademark |
(TM) |
™ |
™ |
|
Em dash |
-- |
— |
— |
Only replaced if between two word characters, between a word character and a line boundary, or flanked by spaces. When flanked by space characters (e.g., |
Ellipsis |
... |
… |
… |
|
Single right arrow |
-> |
→ |
→ |
|
Double right arrow |
=> |
⇒ |
⇒ |
|
Single left arrow |
<- |
← |
← |
|
Double left arrow |
<= |
⇐ |
⇐ |
|
Typographic apostrophe |
Sam's |
Sam’s |
Sam’s |
The typewriter apostrophe is replaced with the typographic (aka curly) apostrophe. |
TIP: Toute entité XML (nommée, numérique ou hexadécimale) est supportée. |
== Texte échappé
\*Stars* is not rendered as bold text. The asterisks around the word are preserved. \{author} is not resolved to the author name. The curly brackets around the word are preserved. `A\--Z` connects A to Z in monospace using two dashes. The dashes are not replaced by an em dash. In these cases, the backslash character is automatically removed.
*Stars* is not rendered as bold text. The asterisks around the word are preserved.
{author} is not resolved to the author name. The curly brackets around the word are preserved.
A--Z
connects A to Z in monospace using two dashes.
The dashes are not replaced by an em dash.
In these cases, the backslash character is automatically removed.
`+Text inside {plus} characters+` is not formatted. However, special characters like +<+ and +>+ are still escaped.
Text inside {plus} characters
is not formatted.
However, special characters like < and > are still escaped.
*Stars* is not rendered as bold text. The asterisks around the word are preserved.
& renders as an XML entity instead of &.
underline me is underlined.
underline me is also underlined.
Text in {backticks}
renders exactly as entered, in monospace
.
The attribute reference is not resolved.
== Notes de bas de page
A statement.footnote:[Clarification about this statement.] A bold statement!footnote:disclaimer[Opinions are my own.] Another bold statement.footnote:disclaimer[]
== Compatibilité avec Markdown
Les syntaxes compatibles avec Markdown ne sont disponibles qu’avec AsciiDoctor.
# Document Title (Level 0) ## Section Level 1 ### Section Level 2 #### Section Level 3 ##### Section Level 4 ###### Section Level 5
Document Title (Level 0)
Section Level 1
Section Level 2
Section Level 3
Section Level 4
Section Level 5
```ruby require 'sinatra' get '/hi' do "Hello World!" end ```
require 'sinatra'
get '/hi' do
"Hello World!"
end
> 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
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.
Papers of Thomas Jefferson: Volume 11
> > What's new? > > I've got Markdown in my AsciiDoc! > > > Like what? > > * Blockquotes > * Headings > * Fenced code blocks > > > Is there more? > > Yep. AsciiDoc and Markdown share a lot of common syntax already.
What’s new?
I’ve got Markdown in my AsciiDoc!
Like what?
Blockquotes
Headings
Fenced code blocks
Is there more?
Yep. AsciiDoc and Markdown share a lot of common syntax already.
--- - - - *** * * *
== Manuel utilisateur et aide
Pour en apprendre plus sur AsciiDoctor vous pouvez consulter les autres guides et le {user}[manuel utilisateur] Vous pouvez également rejoindre la liste de diffusion d’AsciiDoctor, où vous pouvez vos questions et laisser des commentaires.