AsciiDoc шпаргалка

Alex Efros
<powerman@powerman.name>
версия 2.2.2

Содержание

Аннотация

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

Атрибуты

Заголовки

Уровень 1

Уровень 2

Уровень 1

Уровень 2

Аннотация

Это шпаргалка для AsciiDoc – “Генерация документов на основе текста” скрипт. Шпаргалка доступна для различных версий AsciiDoc (из – за некоторых изменений разметки синтаксиса) с использованием различных стилей CSS. Вот список всех существующих шпаргалок для разных версий AsciiDoc с использованием различных стилей CSS (GitHub включено).

Это шпаргалка для AsciiDoc 8.6.9 , используется CSS по умолчанию.

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

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

Атрибуты

Есть много предопределенных атрибутов в AsciiDoc, также вы можете добавить свои атрибуты. Чтобы получить значение атрибута, используйте {attributename} синтаксис.

Author is {author}

 

Version is {revision}

Автор Alex Efros

Версия 2.2.2

:My name: Alex Efros

My name is {myname}

Меня зовут Alex Efros

Line

with bad attribute {qwe} will be

deleted

Линия удалена

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

Сбежал: {qwe} и {qwe}

Заголовки

Level 1

-------

Text.

 

Level 2

~~~~~~~

Text.

 

Level 3

^^^^^^^

Text.

 

Level 4

+++++++

Text.

Уровень 1

Текст.

Уровень 2

Текст.

Уровень 3

Текст.

Уровень 4

Текст.

== Level 1

Text.

 

=== Level 2

Text.

 

==== Level 3

Text.

 

===== Level 4

Text.

Уровень 1

Текст.

Уровень 2

Текст.

Уровень 3

Текст.

Уровень 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

----

Необязательное название

*Cписок* Блоков

 

Применение: список кодов и файлов

.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";

----

Необязательное название

# *Источник* блока

# Применение: выделение список кодов

# (требуется ` источник-выделение` или `pygmentize`)

use DBI;

my $dbh = DBI->connect('...',$u,$p)

    or die "connect: $dbh->errstr";

.Optional Title

****

*Sidebar* Block

 

Use: sidebar notes 🙂

****

Необязательное название

Боковая панель Блок

Применение: заметки на боковой панели 🙂

.Optional Title

==========================

*Example* Block

 

Use: examples 🙂

 

Default caption "Example:"

can be changed using

 

 [caption="Custom: "]

 

before example block.

==========================

Пример 1. Необязательное название

Пример блока

Применение: примеры 🙂

По умолчанию заголовок "Пример:" может быть изменен с помощью

[caption="Custom: "]

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

.Optional Title

[NOTE]

===============================

*NOTE* Block

 

Use: multi-paragraph notes.

===============================

Note

Необязательное название

ПРИМЕЧАНИЕ Блока

Применение: заметки из нескольких абзацев.

 

////

*Comment* block

 

Use: hide comments

////

 

++++

*Passthrough* Block

<p>

Use: backend-specific markup like

<table border="1">

<tr><td>1<td>2

</table>

++++

*Транзитный* Блок

Применение: бэкэнд-специфические разметки как

1

2

 

 .Optional Title

 ....

 *Literal* Block

 

 Use: workaround when literal

 paragraph (indented) like

   1. First.

   2. Second.

 incorrectly processed as list.

 ....

Необязательное название

*Буквальный* Блок

 

Применение: временное решение при буквальном

абзаце (с отступом) как

  1. Первый.

  2. Второй.

неправильно обрабатывается как список.

.Optional Title

[quote, cite author, cite source]

____

*Quote* Block

 

Use: cite somebody

____

Необязательное название

Блок Цитата

Применение: цитировать кого-то

цитировать источника

 цитировать автора

Текст

forced +

line break

принудительный
разрыв строки

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

 

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

 

normal, ^super^, ~sub~.

обычный, курсив, жирный, моно.

 в двойных кавычках”, ‘в одинарных кавычках’.

обычный, суперподписка.

Command: `ls -al`

 

+mono *bold*+

 

`passthru *bold*`

команда: ls -al

моно жирный

Проходный *жирный*

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

Сбежал: _курсив_, _курсив_, t__e__st, t__e__st, жирный, <b>обычный</b> &#182; `не в одинарных кавычках' ``не в двойных кавычках''

Макрос: ссылки, изображения и включать

Если Вам необходимо использовать пробел в URL/путь вы должны заменить его на %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.

[якорь-1], Первый якорь , [якорь-2], Второй якорь .

link:asciidoc[This document]

link:asciidoc.html[]

link:/index.html[This site root]

Этот документ asciidoc.html Это корень сайта

http://google.com

http://google.com[Google Search]

mailto:root@localhost[email admin]

http://google.com Google Поиск эл. почта администратора

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

Рисунок 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

Упорядоченный

  • номер

  • номер

    • буква

    • буква

  • номер

    • loweralpha

    • loweralpha

      • lowerroman

      • lowerroman

        • upperalpha

        • upperalpha

          • upperroman

          • upperroman

        • upperalpha

      • lowerroman

    • loweralpha

  • номер

.Ordered 2

a. letter

b. letter

   .. letter2

   .. letter2

       .  number

       .  number

           1. number2

           2. number2

           3. number2

           4. number2

       .  number

   .. letter2

c. letter

Упорядоченный 2

  • буква

  • буква

    • буква2

    • буква2

      • номер

      • номер

        • номер2

        • номер2

        • номер2

        • номер2

      • номер

    • буква2

  • буква

.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

Термин 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

Термин 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

 

Термин 

Определение 5

 

[qanda]

.Q&A

Question 1::

    Answer 1

Question 2:: Answer 2

Вопросы и Ответы

  • Вопрос 1

Ответ 1

  • Вопрос 2

Ответ 2

.Indent is optional

- bullet

    * another bullet

        1. number

        .  again number

            a. letter

            .. again letter

 

.. letter

. number

 

* bullet

- bullet

Отступ необязательна

  • маркер

    • другой маркер

      • номер

        • еще номер

          • буква

            • еще буква

            • буква

        • номер

    • маркер

  • маркер

.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

--

Перерыв два списка

  • номер

  • номер

Независимый список конец абзаца.

  • номер

Также заголовок конец абзаца

  • номер

  • Также блок списка определяет границу списка

  • номер

  • номер

  • номер

  • номер

.Continuation

- bullet

continuation

. number

  continuation

* bullet

 

  literal continuation

 

.. letter

+

Non-literal continuation.

+

----

any block can be

 

included in list

----

+

Last continuation.

Продолжение

  • продолжение маркированного списка

    • продолжение номера

      • маркер

буквальное продолжение

        • маркер

Небуквальное продолжение.

любой блок может быть включен в список

Последнее продолжение.

.List block allow sublist inclusion

- bullet

  * bullet

+

--

    - bullet

      * bullet

--

  * bullet

- bullet

  . number

    .. letter

+

--

      . number

        .. letter

--

    .. letter

  . number

Блок списка позволяет включение подсписка

  • маркер

    • маркер

      • маркер

      • маркер

    • маркер

  • маркер

    • номер

      • буква

        • номер

        • буква

      • буква

    • номер

Таблицы

Вы можете заполнить таблицу из 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

1

Предмет 1

a

2

Предмет 2

b

3

Предмет 3

c

6

Три предмета

d

 

 

 

.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 дата, 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

Имя

Фамилия

Адрес

Телефон

1

Вася

Пупкин

Лондон

+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. Многострочные клетки, стр/кол спан

Дата

Длитель.

Сред. HR

Примечания

22-Авг-08

10:24

157

Работать над MSHR (макс. устойчивый сердечного ритма) пройдя жесткий для данного интервала.

22-Авг-08

152

Спиной к спине с предыдущего интервала.

24-Авг-08

нет

 

 

Источник: http://powerman.name/doc/asciidoc

Вернуться на главную страницу

Posted on

Leave a Reply