Original: http://powerman.name/doc/asciidoc

POWERMAN
"У кожномо з нас спить гений ...
але його сон стає все глибше кожен день."

Реферат

Це шпаргалка для AsciiDoc - “Текстовий генератор документів” скрипт. Шпаргалка доступна для різних версій (через деякі синтаксичні зміни розмітки)  та використання різних стилів CSS. Ось список з Ось список з усіма доступними шпаргалками для різных версій AsciiDoc та використання різних стилів CSS (включено також GitHub).

Цей cheatsheet для AsciiDoc AsciiDoc 8.6.9, використовується default css.

Ця сторінка була перекладена:

Заголовок документа

Головний заголовок
==================
Optional Author Name <optional@author.email>
Optional version, optional date
:Author:    AlternativeWayToSetOptional Author Name
:Email:     <AlternativeWayToSetOptional@author.email>
:Date:      AlternativeWayToSetOptional date
:Revision:  AlternativeWayToSetOptional version

Атрибути

У AsciiDoc є багато попередньо визначених атрибутів, а також ви можете додати свої власні. Щоб отримати значення атрибута, використовуйте синтаксис {attributename}.

Author is {author}

Version is {revision}

Автор: Алекс Ефрос

Версія 2.2.2

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

Мене звуть Алекс Ефрос

Line
with bad attribute {qwe} will be
deleted

рядок видалений

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

Екранування: {qwe} and {qwe}

Заголовки

Рівень 1
--------
Текст.

Рівень 2
~~~~~~~
Текст.

Рівень 3
^^^^^^^
Текст.

Рівень 4
+++++++
Текст.

Level 1

Текст.

Level 2

Текст.

Level 3

Текст.

Level 4

Текст.

== Рівень 1
Текст.

=== Рівень 2
Текст.

==== Рівень 3
Текст.

===== Рівень 4
Текст.

Level 1

Текст.

Level 2

Текст.

Level 3

Текст.

Level 4

Текст.

Пункти

.Optional Title

Usual
paragraph.
Необов'язковий заголовок

Звичайний абзац.

.Optional Title

 Literal paragraph.
  Must be indented.
Необов'язковий заголовок
Буквальний абзац.
 Необхідно відступити.
.Optional Title

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

Not a code in next paragraph.
Необов'язковий заголовок
die 'connect: '.$dbh->errstr;

Немає коду в наступному абзаці.

.Optional Title
NOTE: This is an example
      single-paragraph note.
Note
Необов'язковий заголовок
Це приклад примітки з одного абзацу.
.Optional Title
[NOTE]
This is an example
single-paragraph note.
Note
Необов'язковий заголовок
Це приклад примітки з одного абзацу.
TIP: Tip.
Tip Порада.
IMPORTANT: Important.
Important Важливо.
WARNING: Warning.
Warning Увага.
CAUTION: Caution.
Caution Обережно.

Блоки

.Optional Title
----
*Listing* Block

Use: code or file listings
----
Необов'язковий заголовок
*Listing* Block

Use: код або список файлів
.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";
----
Необов'язковий заголовок
# *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
****
*Sidebar* Block

Use: sidebar notes :)
****
Необов'язковий заголовок

Sidebar Блок

Use: sidebar notes :)

.Optional Title
==========================
*Приклад* Block

Use: examples :)

Default caption "Приклад:"
can be changed using

 [caption="Custom: "]

before example block.
==========================
Приклад 1. Необов'язковий заголовок

Приклад Блок

Використування: прикладів :)

Заголовок "Приклад:" можна змінити за допомогою

[caption="Custom: "]

блок перед прикладом.

.Optional Title
[NOTE]
===============================
*NOTE* Block

Use: multi-paragraph notes.
===============================
Note
Необов'язковий заголовок

NOTE Блок

Використовуйте: нотатки з багатьма абзацами.

////
*Comment* block

Use: hide comments
////
++++
*Passthrough* Block
<p>
Use: backend-specific markup like
<table border="1">
<tr><td>1<td>2
</table>
++++
*Через* Блок

Використовуйте: спеціальну розмітку для бекенда, як

12
 .Optional Title
 ....
 *Literal* Block

 Use: workaround when literal
 paragraph (indented) like
   1. First.
   2. Second.
 incorrectly processed as list.
 ....
Необов'язковий заголовок
*Буквальний* Блок

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

Quote Block

Use: cite somebody

cite source
— cite author

Текст

forced +
line break

форсований
переклад рядка

normal, _italic_, *bold*, +mono+.

``double quoted'', `single quoted'.

normal, ^super^, ~sub~.

normal, italic, bold, mono.

“double quoted”, ‘single quoted’.

normal, super, sub.

Command: `ls -al`

+mono *bold*+

`passthru *bold*`

Команда: ls -al

mono bold

passthru *bold*

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

Шлях: /some/filez.txt, .b

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

червоний текст на жовтому кольорі великий всі жирні

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

символи: nibmr

// 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''

втекли: _italic_, _italic_, t__e__st, t__e__st, bold, <b>normal</b> &#182; `not single quoted' ``not double quoted''

Якщо вам потрібно буде використовувати пробіл у url/path, ви повинні замінити його на %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].

Параграф або блок 1.

Параграф або блок 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"]

Перший додому images/icons/home.png , другий будинок Alt text .

images/icons/home.png
Figure 1. Зображення
Alt text
Ескіз пов'язаний з повним зображенням

My screenshot

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

// include::footer.txt[]

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

Це приклад того, як можна включити файли. Прокоментували, оскільки таких файлів немає. :)

Списки

.Bulleted
* bullet
* bullet
  - bullet
  - bullet
* bullet
** bullet
** bullet
*** bullet
*** bullet
**** bullet
**** bullet
***** bullet
***** bullet
**** bullet
*** bullet
** bullet
* bullet
Маркірований
  • куля

  • куля

    • куля

    • куля

  • куля

    • куля

    • куля

      • куля

      • куля

        • куля

        • куля

          • куля

          • куля

        • куля

      • куля

    • куля

  • куля

.Bulleted 2
- bullet
  * bullet
Маркірований 2
  • куля

    • куля

.Ordered
. number
. number
  .. letter
  .. letter
. number
.. loweralpha
.. loweralpha
... lowerroman
... lowerroman
.... upperalpha
.... upperalpha
..... upperroman
..... upperroman
.... upperalpha
... lowerroman
.. loweralpha
. number
упорядкований
  1. номер

  2. номер

    1. лист

    2. лист

  3. номер

    1. нижня альфа

    2. нижня альфа

      1. нижній роман

      2. нижній роман

        1. верхня альфа

        2. верхня альфа

          1. верхівка

          2. верхівка

        3. верхня альфа

      3. lowerroman

    3. loweralpha

  4. номер

.Ordered 2
a. letter
b. letter
   .. letter2
   .. letter2
       .  number
       .  number
           1. number2
           2. number2
           3. number2
           4. number2
       .  number
   .. letter2
c. letter
упорядкований 2
  1. лист

  2. лист

    1. лист2

    2. лист2

      1. номер

      2. номер

        1. номер2

        2. номер2

        3. номер2

        4. номер2

      3. номер

    3. лист2

  3. лист

.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
Позначено
Термін 1

Визначення 1

Термін 2

Визначення 2

Термін 2.1

Визначення 2.1

Термін 2.2

Визначення 2.2

Термін 3

Визначення 3

Термін 4

Визначення 4

Термін 4.1

Визначення 4.1

Термін 4.2

Визначення 4.2

Термін 4.2.1

Визначення 4.2.1

Термін 4.2.2

Визначення 4.2.2

Термін 4.3

Визначення 4.3

Term 5

Визначення 5

.Labeled 2
Term 1;;
    Definition 1
    Term 1.1::
        Definition 1.1
Позначено 2
Термін 1

Визначення 1

Термін 1.1

Визначення 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
Позначено горизонтально
Термін 1

Визначення 1

Термін 2

Визначення 2

Term 2.1

Визначення 2.1

Term 2.2

Визначення 2.2

Термін 3

Definition 3

Термін 4

Definition 4

Term 4.1

Визначення 4.1

Term 4.2

Визначення 4.2

Term 4.2.1

Визначення 4.2.1

Term 4.2.2

Визначення 4.2.2

Term 4.3

Визначення 4.3

Термін 5

Визначення 5

[qanda]
.Q&A
Question 1::
    Answer 1
Question 2:: Answer 2
Q&A
  1. Питання 1

    Відповідь 1

  2. Питання 2

    Відповідь 2

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

.. letter
. number

* bullet
- bullet
Indent is optional
  • куля

    • інша куля

      1. номер

        1. знову номер

          1. лист

            1. знову лист

            2. лист

        2. номер

    • куля

  • куля

.Break two lists
. номер
. номер

Independent paragraph break list.

. номер

.Header break list too
. номер

--
. List block define list boundary too
. номер
. номер
--

--
. номер
. номер
--
Розбити два списки
  1. номер

  2. номер

Незалежний список розбиття абзацу.

  1. номер

Заголовок перерв списку теж
  1. номер

  1. Перелік блоків визначає також межу списку

  2. номер

  3. номер

  1. номер

  2. номер

.Continuation
- bullet
continuation
. number
  continuation
* bullet

  literal continuation

.. letter
+
Non-literal continuation.
+
----
any block can be

included in list
----
+
Last continuation.
Продовження
  • продовження кулі

    1. продовження кулі

      • куля

        literal continuation
        1. лист

          Нелітерне продовження.

          будь-який блок може бути

          включено до списку

          Останнє продовження.

.List block allow sublist inclusion
- bullet
  * bullet
+
--
    - bullet
      * bullet
--
  * bullet
- bullet
  . number
    .. letter
+
--
      . number
        .. letter
--
    .. letter
  . number
Перелік блоків дозволяє включити до підключення
  • куля

    • куля

      • куля

      • куля

    • куля

  • куля

    1. номер

      1. лист

        1. номер

        1. лист

      2. лист

    2. номер

Таблиці

Ви можете заповнити таблицю з файлу CSV за допомогою include:: макроси всередині таблиці.

.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
|=======================
Таблиця 1. Таблиця прикладів
Колонка 1 Колонка 2 Колонка 3

6

Три пункти

d

1

Пункт 1

a

2

Пункт 2

b

3

Пункт 3

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
|======
Таблиця 2. CSV data, 15% кожен стовпець

1

2

3

4

a

b

c

d

A

B

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 FName LName Адреса Телефон

1

Vasya

Pupkin

London

+123

2

X

Y

A,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

|====
Таблиця 3. Багаторядкові комірки, рядок/стовпчик

Дата

Тривалість

середній час

Примітки

22-Авг-08

10:24

157

Розробив MSHR (макс. Стійкий серцевий ритм), зайнявшись важким для цього інтервалом.

22-Авг-08

152

Повернутися назад із попереднім інтервалом.

24-Авг-08

ніхто