Traduction 1001-soldes.com ©2017 Tous droits réservés| Source : http://powerman.name/doc/asciidoc

AsciiDoc cheatsheet AsciiDoc -Feuille de route

Alex Efros Alex Efros
< powerman@powerman.name >
version 2.2.2 version 2.2.2
Table of Contents Table des matières

Résumé

En tête de document

Les attributs

En-têtes

Niveau 1

    Niveau 2

Niveau 1

    Niveau 2

Abstract Résumé

This is a cheatsheet for AsciiDoc - “Text based document generation” script. Il s'agit d'une feuille de cheats pour AsciiDoc - Script "génération de document basé sur le texte". The cheatsheet available for different AsciiDoc versions (because of some markup syntax changes) and using different css styles. Le cheatsheet disponible pour différentes versions AsciiDoc (en raison de certains changements de syntaxe de balisage) et en utilisant différents styles css. Here is list with all available cheatsheets for different AsciiDoc version and using different css styles (GitHub included) . Voici une liste avec toutes les trucs de cheats disponibles pour différentes versions d'AsciiDoc et en utilisant différents styles css (GitHub inclus) .

This cheatsheet is for AsciiDoc 8.6.9 , using default css . Cette fiche de cheats est pour AsciiDoc 8.6.9 , en utilisant par défaut css .

Document header En-tête de document

Main Header 
=========== 
Optional Author Name <optional@author.email> 
Optional version, optional date 
:Author: AlternativeWayToSetOptional Author Name 
:Email: <AlternativeWayToSetOptional@author.email> 
:Date: AlternativeWayToSetOptional date 
:Revision: AlternativeWayToSetOptional version 

Attributes Les attributs

There a lot of predefined attributes in AsciiDoc, plus you can add your own. Il y a beaucoup d'attributs prédéfinis dans AsciiDoc, plus vous pouvez ajouter le vôtre. To get attribute value use {attributename} syntax. Pour obtenir une valeur d'attribut, utilisez la syntaxe {attributename}.

 Author is {author} 

Version is {revision} 

Author is Alex Efros L'auteur est Alex Efros

Version is 2.2.2 La version est 2.2.2

:My name: Alex Efros 
My name is {myname} 

My name is Alex Efros Je m'appelle Alex Efros

:Line 
with bad attribute {qwe} will be deleted 

Line deleted Ligne supprimée

 Escaped: \{qwe} and +++{qwe}+++ 

Escaped: {qwe} and {qwe} Échappé: {qwe} et {qwe}

Headers En-têtes

Level 1 
------- 
Text. 

Level 2 
~~~~~~~ 
Text. 

Level 3 
^^^^^^^ 
Text. 

Level 4 
+++++++ 
Text. 

Level 1 Niveau 1

Text. Texte.

Level 2 Niveau 2

Text. Texte.

Level 3 Niveau 3

Text. Texte.

Level 4 Niveau 4

Text. Texte.

== Level 1 
Text. 

=== Level 2 
Text. 

==== Level 3 
Text. 

===== Level 4 
Text.
                              

Level 1 Niveau 1

Text. Texte.

Level 2 Niveau 2

Text. Texte.

Level 3 Niveau 3

Text. Texte.

Level 4 Niveau 4

Text. Texte.

Paragraphs Paragraphes

.Optional Title 
Usual paragraph. 
Optional Title Titre facultatif

Usual paragraph. Paragraphe habituel.

.Optional Title 
Literal paragraph. Must be indented. 
Optional Title Titre facultatif
 Literal paragraph. Must be indented. 


.Optional Title 
[source,perl] 
die 'connect: '.$dbh->errstr; 

Not a code in next paragraph. 
Optional Title Titre facultatif
 die 'connect: ' . die 'connect:' . $dbh -> errstr ; $ dbh -> errstr ;

Not a code in next paragraph. Pas un code dans le prochain paragraphe.

.Optional Title 
NOTE: This is an example
single-paragraph note. 
Remarque
Optional Title Titre facultatif
This is an example single-paragraph note. Il s'agit d'un exemple de note à un seul paragraphe.
.Optional Title 
[NOTE] 
This is an example 
single-paragraph note. 
Remarque
Optional Title Titre facultatif
This is an example single-paragraph note. Il s'agit d'un exemple de note à un seul paragraphe.
TIP: Tip. 
Pointe Tip. Pointe.
IMPORTANT: Important. 
Important Important. Important.
WARNING: Warning. 
Attention Warning. Attention.
CAUTION: Caution. 
Mise en garde Caution. Mise en garde.

Blocks Blocs

.Optional Title
---- 
*Listing* Block 
Use: code or file listings 
---- 
Optional Title Titre facultatif
*Listing* Block Use: code or file listings 
.Optional Title 
[source,perl]
----
# *Source* block 
# Use: highlight code listings 
# (require `source-highlight` or 
`pygmentize`) 
use DBI;
my $dbh = DBI->connect('...',$u,$p)
or die "connect: $dbh->errstr"; 
---- 
Optional Title Titre facultatif
 # *Source* block# * Source * bloc
# Use: highlight code listings # Utiliser: mettre en surbrillance les listes de codes
# (require `source-highlight` or `pygmentize`) # (nécessite `source-highlight` ou` pygmentize`)
use DBI ; utiliser DBI ;
my $dbh = DBI -> connect ( '...' , $u , $p ) my $ dbh = DBI -> connect ( '...' , $ u , $ p )
    or die "connect: $dbh->errstr" ; ou die "connect: $ dbh-> errstr" ;
.Optional Title 
**** 
*Sidebar* Block 
Use: sidebar notes :) 
**** 
Optional Title Titre facultatif

Sidebar Block Bloc de barrière latérale

Use: sidebar notes :) Utilisation: notes de la barre latérale :)

.Optional Title 
========================== 
*Example* Block 
Use: examples :) 
Default caption "Example:" can be changed using 
[caption="Custom: "] 
before example block. 
========================== 
Example 1. Optional Title Exemple 1. Titre facultatif

Example Block Exemple de bloc

Use: examples :) Utilisation: exemples :)

Default caption "Example:" can be changed using La légende par défaut "Exemple:" peut être modifiée en utilisant

 [caption="Custom: "] 

before example block. avant bloc d'exemple.

.Optional Title [NOTE] 
=============================== 
*NOTE* Block 
Use: multi-paragraph notes. 
=============================== 
Remarque
Optional Title Titre facultatif

NOTE Block NOTE Bloc

Use: multi-paragraph notes. Utilisation: notes multi-paragraphes.

 //// 
*Comment* block 
Use: hide comments 
//// 
 ++++ 
*Passthrough* Block 
<p> 
Use: backend-specific markup like 
<table border="1"> 
<tr><td>1<td>2 
</table> 
++++ 
*Passthrough* Block * Passthrough * Block

Use: backend-specific markup like Utilisation: marge spécifique au backend comme

1 1 2 2
.Optional Title 
.... 
*Literal* Block 

Use: workaround when literal 
paragraph (indented) like 
1. First. 
2. Second. 
incorrectly processed as list. 
.... 
Optional Title Titre facultatif
*Literal* Block 
Use: workaround when literal paragraph (indented) like 
1. First. 
2. Second. 
incorrectly processed as list. 
.Optional Title 
[quote, cite author, cite source] 
____ 
*Quote* Block 
Use: cite somebody 
____ 
Optional Title Titre facultatif

Quote Block Bloc de devis

Use: cite somebody Utilisation: cite quelqu'un

cite source citer la source
— cite author - cite l'auteur

Text Texte

forced + line break 

forced forcé
line break saut de ligne

normal, _italic_, *bold*, +mono+. 
``double quoted'', `single quoted'. 
normal, ^super^, ~sub~. 

normal, italic , bold , mono . normal, italique , gras , mono .

“double quoted”, 'single quoted'. "Double cité", "unique cité".

normal, super , sub . normal, super , sous .

Command: `ls -al` 
+mono *bold*+ 
`passthru *bold*` 

Command: ls -al Commande: ls -al

mono bold

passthru *bold*

Path: '/some/filez.txt', '.b' 

Path: /some/filez.txt , .b Chemin: /some/filez.txt , .b

[red]#red text# [yellow-background]#on yellow# 
[big]#large# [red yellow-background big]
*all bold* 

red text on yellow large all bold texte rouge sur jaune grand en gras

Chars: n__i__**b**++m++[red]##r## 

Chars: n i b m r Chars: n i b m r

// Comment 
(C) (R) (TM) -- ... -> <- => <= &#182; 

© ® ™ — … → ← ⇒ ⇐ ¶ © ® ™ - ... → ← ⇒ ⇐ ¶

'''' 

Escaped: 
\_italic_, +++_italic_+++, 
t\__e__st, +++t__e__st+++, 
+++<b>bold</b>+++, $$<b>normal</b>$$ 
\&#182; 
\`not single quoted' 
\`\`not double quoted'' 

Escaped: _italic_, _italic_, t__e__st, t__e__st, bold , <b>normal</b> &#182; Échappé: _italic_, _italic_, t__e__st, t__e__st, bold , <b> normal </ b> & # 182; `not single quoted' ``not double quoted'' `not single citated '` `not double coted' '

If you'll need to use space in url/path you should replace it with %20. Si vous devez utiliser l'espace dans url / chemin, vous devez le remplacer par% 20.

[[anchor-1]] 
Paragraph or block 1. 

anchor:anchor-2[] 
Paragraph or block 2. 

<<anchor-1>>, 
<<anchor-1,First anchor>>, 
xref:anchor-2[], 
xref:anchor-2[Second anchor]. 

Paragraph or block 1. Paragraphe ou bloc 1.

Paragraph or block 2. Paragraphe ou bloc 2.

link:asciidoc[This document] 
link:asciidoc.html[] 
link:/index.html[This site root] 
 http://google.com 
http://google.com[Google Search] 
mailto:root@localhost[email admin] 
First home 
image:images/icons/home.png[] 
, second home 
image:images/icons/home.png[Alt text] . 

.Block image 
image::images/icons/home.png[] 
image::images/icons/home.png[Alt text] 

.Thumbnail linked to full image 
image:/images/font/640-screen2.gif[ 
"My screenshot",width=128, 
link="/images/font/640-screen2.gif"] 

First home Première maison images / icônes / home.png , second home , deuxième maison Texte Alt . .

images / icônes / home.png
Figure 1. Block image Figure 1. Bloquer l'image
Texte Alt
Thumbnail linked to full image Miniature liée à l'image complète

Ma capture d'écran

This is example how files 
can be included. 
It's commented because 
there no such files. :) 

// include::footer.txt[] 

// [source,perl] 
// ---- 
// include::script.pl[] 
// ---- 

This is example how files can be included. Voici comment les fichiers peuvent être inclus. It's commented because there no such files. Il est commenté parce qu'il n'y a pas de tels fichiers. :) :)

Lists Listes

.Bulleted 
* bullet 
* bullet 
  - bullet 
  - bullet 
* bullet 
** bullet 
** bullet 
*** bullet 
*** bullet 
**** bullet 
**** bullet 
***** bullet 
***** bullet 
**** bullet 
*** bullet 
** bullet 
* bullet 
Bulleted Bulleted
  • bullet balle

  • bullet balle

    • bullet balle

    • bullet balle

  • bullet balle

    • bullet balle

    • bullet balle

      • bullet balle

      • bullet balle

        • bullet balle

        • bullet balle

          • bullet balle

          • bullet balle

        • bullet balle

      • bullet balle

    • bullet balle

  • bullet balle

.Bulleted 2 
- bullet 
  * bullet 
Bulleted 2 Bulle 2
  • bullet balle

    • bullet balle

.Ordered 
. number 
. number 
  .. letter 
  .. letter 
. number 
.. loweralpha 
.. loweralpha 
... lowerroman 
... lowerroman 
.... upperalpha 
.... upperalpha 
..... upperroman 
..... upperroman 
.... upperalpha 
... lowerroman 
.. loweralpha 
. number 
Ordered Commandé
  1. number nombre

  2. number nombre

    1. letter lettre

    2. letter lettre

  3. number nombre

    1. loweralpha Loweralpha

    2. loweralpha Loweralpha

      1. lowerroman lowerroman

      2. lowerroman lowerroman

        1. upperalpha uphéralpha

        2. upperalpha uphéralpha

          1. upperroman upperroman

          2. upperroman upperroman

        3. upperalpha uphéralpha

      3. lowerroman lowerroman

    3. loweralpha Loweralpha

  4. number nombre

.Ordered 2 
a. letter 
b. letter 
   .. letter2 
   .. letter2 
       . number 
       . number 
          1. number2 
          2. number2 
          3. number2 
          4. number2 
       . number 
   .. letter2 
c. letter 
Ordered 2 Commandé 2
  1. letter lettre

  2. letter lettre

    1. letter2 lettre2

    2. letter2 lettre2

      1. number nombre

      2. number nombre

        1. number2 numéro 2

        2. number2 numéro 2

        3. number2 numéro 2

        4. number2 numéro 2

      3. number nombre

    3. letter2 lettre2

  3. letter lettre

.Labeled 
Term 1:: 
    Definition 1 
Term 2:: 
    Definition 2 
    Term 2.1;; 
        Definition 2.1 
    Term 2.2;; 
        Definition 2.2 
Term 3:: 
    Definition 3 
Term 4:: Definition 4 
Term 4.1::: Definition 4.1 
Term 4.2::: Definition 4.2 
Term 4.2.1:::: Definition 4.2.1 
Term 4.2.2:::: Definition 4.2.2 
Term 4.3::: Definition 4.3 
Term 5:: Definition 5 
Labeled Étiqueté
Term 1 Terme 1

Definition 1 Définition 1

Term 2 Terme 2

Definition 2 Définition 2

Term 2.1 Terme 2.1

Definition 2.1 Définition 2.1

Term 2.2 Terme 2.2

Definition 2.2 Définition 2.2

Term 3 Terme 3

Definition 3 Définition 3

Term 4 Terme 4

Definition 4 Définition 4

Term 4.1 Terme 4.1

Definition 4.1 Définition 4.1

Term 4.2 Terme 4.2

Definition 4.2 Définition 4.2

Term 4.2.1 Terme 4.2.1

Definition 4.2.1 Définition 4.2.1

Term 4.2.2 Terme 4.2.2

Definition 4.2.2 Définition 4.2.2

Term 4.3 Terme 4.3

Definition 4.3 Définition 4.3

Term 5 Terme 5

Definition 5 Définition 5

.Labeled 2 
Term 1;; 
        Definition 1 
        Term 1.1:: 
            Definition 1.1 
Labeled 2 Étiqueté 2
Term 1 Terme 1

Definition 1 Définition 1

Term 1.1 Terme 1.1

Definition 1.1 Définition 1.1

[horizontal]
.Labeled horizontal
Term 1:: Definition 1 
Term 2:: Definition 2 
[horizontal] 
    Term 2.1;; 
        Definition 2.1 
    Term 2.2;; 
        Definition 2.2 
Term 3:: 
    Definition 3 
Term 4:: Definition 4 
[horizontal] 
Term 4.1::: Definition 4.1 
Term 4.2::: Definition 4.2 
[horizontal] 
Term 4.2.1:::: Definition 4.2.1 
Term 4.2.2:::: Definition 4.2.2 
Term 4.3::: Definition 4.3 
Term 5:: Definition 5 
Labeled horizontal Etiqueté horizontalement
Term 1 Terme 1

Definition 1 Définition 1

Term 2 Terme 2

Definition 2 Définition 2

Term 2.1 Terme 2.1

Definition 2.1 Définition 2.1

Term 2.2 Terme 2.2

Definition 2.2 Définition 2.2

Term 3 Terme 3

Definition 3 Définition 3

Term 4 Terme 4

Definition 4 Définition 4

Term 4.1 Terme 4.1

Definition 4.1 Définition 4.1

Term 4.2 Terme 4.2

Definition 4.2 Définition 4.2

Term 4.2.1 Terme 4.2.1

Definition 4.2.1 Définition 4.2.1

Term 4.2.2 Terme 4.2.2

Definition 4.2.2 Définition 4.2.2

Term 4.3 Terme 4.3

Definition 4.3 Définition 4.3

Term 5 Terme 5

Definition 5 Définition 5

[qanda] 
.Q&A Question 1:: 
         Answer 1 
Question 2:: Answer 2 
Q&A Q & R
  1. Question 1 question 1

    Answer 1 Réponse 1

  2. Question 2 question 2

    Answer 2 Réponse 2

.Indent is optional 
- bullet 
    * another bullet 
        1. number 
        . again number 
           a. letter 
           .. again letter 

.. letter 
. number 

* bullet 
- bullet
Indent is optional Le retrait est facultatif
  • bullet balle

    • another bullet autre balle

      1. number nombre

        1. again number nouveau numéro

          1. letter lettre

            1. again letter nouvelle lettre

            2. letter lettre

        2. number nombre

    • bullet balle

  • bullet balle

.Break two lists 
. number 
. number 

Independent paragraph break list. 

. number 

.Header break list too 
. number 

-- 

. List block define list boundary too 
. number 
. number 
-- 

-- 
. number 
. number 
-- 

Break two lists

Casser deux listes

  1. number nombre

  2. number nombre

Independent paragraph break list. Liste de pause de paragraphe indépendante.

  1. number nombre

Header break list too Liste des raccourcis aussi
  1. number nombre

  1. List block define list boundary too Le bloc de liste définit également la limite de la liste

  2. number nombre

  3. number nombre

  1. number nombre

  2. number nombre

 .Continuation 
- bullet 
continuation 
. number continuation 
* bullet 

literal continuation 

.. letter 
+ 
Non-literal continuation. 
+ 
---- 
any block can be 
included in list 
---- 
+ 
Last continuation. 
Continuation Continuation
  • bullet continuation continuation de balle

    1. number continuation Continuité du nombre

      • bullet balle

         literal continuation 
        1. letter lettre

          Non-literal continuation. Continuité non littérale.

           any block can be included in list 

          Last continuation. Dernière continuation.

.List block allow sublist inclusion 
- bullet 
  * bullet 
+ 
-- 
    - bullet 
      * bullet 

-- 
  * bullet 
- bullet 
  . number 
    .. letter 
+ 
-- 
      . number 
        .. letter 
-- 
    .. letter 
  . number 
List block allow sublist inclusion Le bloc de liste permet l'inclusion de la liste
  • bullet balle

    • bullet balle

      • bullet balle

      • bullet balle

    • bullet balle

  • bullet balle

    1. number nombre

      1. letter lettre

        1. number nombre

        1. letter lettre

      2. letter lettre

    2. number nombre

Tables les tables

You can fill table from CSV file using include:: macros inside table. Vous pouvez remplir le tableau du fichier CSV en utilisant include:: macros dans la table.

.An example table
[options="header,footer"] 
|======================= 
|Col 1|Col 2      |Col 3 
|1    |Item 1     |a 
|2    |Item 2     |b 
|3    |Item 3     |c 
|6    |Three items|d 
|======================= 
Table 1. An example table Tableau 1. Tableau d'exemple
Col 1 Col 1 Col 2 Col 2 Col 3 Col 3

6 6

Three items Trois éléments

d

1 1

Item 1 Objet 1

a une

2 2

Item 2 Point 2

b b

3 3

Item 3 Point 3

c c

.CSV data, 15% each column 
[format="csv",width="60%",cols="4"] 
[frame="topbot",grid="none"] 
|====== 
1,2,3,4 
a,b,c,d 
A,B,C,D 
|====== 
Table 2. CSV data, 15% each column Tableau 2. Données CSV, 15% par colonne

1 1

2 2

3 3

4 4

a une

b b

c c

d

A UNE

B B

C C

D

[grid="rows",format="csv"] 
[options="header",cols="^,<,<s,<,>m"] 
|=========================== 
ID,FName,LName,Address,Phone 
1,Vasya,Pupkin,London,+123 
2,X,Y,"A,B",45678 
|=========================== 
ID ID FName FName LName LName Address Adresse Phone Téléphone

1 1

Vasya Vasya

Pupkin Pupkin

London Londres

+123

2 2

X X

Y Y

A,B UN B

45678

.Multiline cells, row/col span 
|==== 
|Date |Duration |Avg HR |Notes 
|22-Aug-08 .2+^.^|10:24 | 157 | 
Worked out MSHR (max sustainable 
heart rate) by going hard 
for this interval. 

|22-Aug-08 | 152 | 
Back-to-back with previous interval. 

|24-Aug-08 3+^|none 

|==== 
Table 3. Multiline cells, row/col span Tableau 3. Cellules multilignes, rangée / col

Date Rendez-vous amoureux

Duration Durée

Avg HR Moy HR

Notes Remarques

22-Aug-08 22-août-08

10:24 10:24

157 157

Worked out MSHR (max sustainable heart rate) by going hard for this interval. A travaillé sur le MSHR (fréquence cardiaque maximale maximale) en durant cet intervalle.

22-Aug-08 22-août-08

152 152

Back-to-back with previous interval. Back-to-back avec l'intervalle précédent.

24-Aug-08 24-août-08

none aucun