著者: Alex Efros <powerman@powerman.name>

日本語版: 飯坂 剛一 <iisaka51@gmail.com>

はじめに

このチートシートは AsciiDoc - 『テキストベースドキュメント生成ツール』 のためのものです。

AsciiDocはバージョンにより書式と使用している CSSスタイルシートが異なることがあります。

各バージョン別のチートシートはオリジナルサイトで参照することができます。

このチートシートは デフォルトのCSS を使った AsciiDoc 8.6.9 のためのものです。

ドキュメントヘッダ (必須)

= タイトル
著者の名前(省略可)<メールアドレス(省略可能)>
バージョンや作成日(省略可)
:Author:    著者の別の記述方法
:Email:     <著者のメールアドレスの別の記述方法>
:Date:      作成日を別の記述方法
:Revision:  バージョンの別の記述方法

アトリビュート

AsciiDoc にはたくさんの設定済みのアトリビュートがあり、 これにあなたが用意したアトリビュートを追加することができます。

アトリビュートは {アトリビュート名} の書式で 設定されている値を参照することができます。

アトリビュートでは大文字と小文字、空白文字は無視されます。

著者は {author}

バージョンは {revision}

著者は Alex Efros

バージョンは 2.2.2

:My name: Alex Efros
わたしの名前は {myname}

わたしの名前は Alex Efros

定義されていない
変な {qwe}
アトリビュートを含む行は削除されます。

定義されていない アトリビュートを含む行は削除されます。

エスケープ: \{qwe} もしくは +++{qwe}+++

エスケープ: {qwe} もしくは {qwe}

ヘッダ

レベル 1
-------
テキスト.

レベル 2
~~~~~~~
テキスト.

レベル 3
^^^^^^^
テキスト.

レベル 4
+++++++
テキスト.

レベル 1

テキスト.

レベル 2

テキスト.

レベル 3

テキスト.

レベル 4

テキスト.

== レベル 1
Text.

=== レベル 2
Text.

==== レベル 3
Text.

===== レベル 4
Text.

レベル 1

Text.

レベル 2

Text.

レベル 3

Text.

レベル 4

Text.

== レベル 1 ==
Text.

=== レベル 2 ===
Text.

==== レベル 3 ====
Text.

===== レベル 4 =====
Text.

レベル 1

Text.

レベル 2

Text.

レベル 3

Text.

レベル 4

Text.

注
訳注:
ヘッダは行頭のイコール記号(=)に続けて記述する方が、 レベルを表すラインを使い分ける必要がないので簡単になるだけでなく、 表記されたテキストがすっきりとして読みやすくなります。 また、"== ヘッダタイトル ==" のようにヘッダタイトルの前後に記述できます。

パラグラフ

.タイトル(省略可)

通常の
パラグラフ
タイトル(省略可)

通常の パラグラフ

.タイトル(省略可)

 リテラルパラグラフ
 記述したままを表示させたいときは
 空白文字でインデントします。
タイトル(省略可)
リテラルパラグラフ
記述したままを表示させたいときは
空白文字でインデントします。
.タイトル(省略可)
[source,perl]
die 'connect: '.$dbh->errstr;

次のパラグラフにある文字列は、
コードとして処理されません。
タイトル(省略可)
die 'connect: '.$dbh->errstr;

次のパラグラフにある文字列は、 コードとして処理されません。

.タイトル(省略可)
NOTE: これはシングルパラグラフの
      ノートを記述例です。
注
タイトル(省略可)
これはシングルパラグラフの ノートを記述例です。		 
.タイトル(省略可)
[NOTE]
これはシングルパラグラフの
ノートを記述例です。
注
タイトル(省略可)
これはシングルパラグラフの ノートを記述例です。		 
TIP: 補足
補足
 補足 
IMPORTANT: 重要.
重要
 重要. 
WARNING: 警告.
警告
 警告. 
CAUTION: 注意.
注意
 注意.

ブロック

.タイトル(省略可)
----
*リスティング* ブロック

用途: コードもしくはファイルの表示(リスティング)
----
タイトル(省略可)
*リスティング* ブロック

用途: コードもしくはファイルの表示(リスティング)
.タイトル(省略可)
[source,perl]
----
# *ソース(source)* ブロック
# 用途: ソースコードのハイライト表示
# (`source-highlight` もしくは `pygmentize` が必要です)
use DBI;
my $dbh = DBI->connect('...',$u,$p)
    or die "connect: $dbh->errstr";
----
タイトル(省略可)
# *ソース(source)* ブロック
# 用途: ソースコードのハイライト表示
# (`source-highlight` もしくは `pygmentize` が必要です)
use DBI;
my $dbh = DBI->connect('...',$u,$p)
    or die "connect: $dbh->errstr";
.タイトル(省略可)
****
*サイドバー* ブロック

用途: サイドバー形式のノート (^^)
****
タイトル(省略可)

サイドバー ブロック

用途: サイドバー形式のノート (^^)

.タイトル(省略可)
==========================
*例示(Example)* ブロック

用途: 例示 (^^;

デフォルトのキャプションは"Example:"になります。
次のようにして変更できます。

 [caption="Custom: "]

これを例示ブロックの前に置きます。
==========================
例 1. タイトル(省略可)

例示(Example) ブロック

用途: 例示 (^^;

デフォルトのキャプションは"Example:"になります。 次のようにして変更できます。

[caption="Custom: "]

これを例示ブロックの前に置きます。

.タイトル(省略可)
[NOTE]
===============================
*ノート* ブロック

用途: マルチパラグラフのノード

別のパラグラフ

===============================
注
タイトル(省略可)

ノート ブロック

用途: マルチパラグラフのノード

別のパラグラフ

 
////
*コメント* ブロック

用途: コメント。asciidocはテキストを処理しない
////
 
*パススルー* ブロック
++++
<p>
用途: バックエンドのマークアップの書式を記述する
<table border="1">
<tr><td>1<td>2
</table>
++++

パススルー ブロック

用途: バックエンドのマークアップの書式を記述する

12 
 .タイトル(省略可)
 ....
 *リテラル* ブロック
 ·
 用途: 書いたままに表示させたいとき
 パラグラフ (インデント付き) を表示するときなど
    1. はじめに.
    2. 次に.
 リストとして処理するとうまくいかない
 ....
タイトル(省略可)
*リテラル* ブロック
·
用途: 書いたままに表示させたいとき
パラグラフ (インデント付き) を表示するときなど
   1. はじめに.
   2. 次に.
リストとして処理するとうまくいかない
.タイトル(省略可)
[quote, author, cite source]
____
*引用* ブロック

用途: 誰かの著作を引用するとき
____
タイトル(省略可)

引用 ブロック

用途: 誰かの著作を引用するとき

cite source
— author
訳注:

デフォルトではアイコンのイメージは展開されません。 次のようにiconsのアトリビュートをコマンドラインで有効にします。

asciidoc -a icons asciidoc-869.txt

アイコンはカレントディレクトリのimages/icons にあるものとして処理されます。 異なるディレクトリを参照する場合は次のようにして、 ディレクトリを指示します。

asciidoc -a icons -a iconsdir=~/Pictures/icons asciidoc-869.txt

テキスト

強制的に +
改行

強制的に
改行

標準, _イタリック_, *ボールド*, +モノ(monospaceフォント)+.

``ダブルクォート'', `シングルクォート'.

標準, ^上付き^, ~下付き~.

標準, イタリック, ボールド, モノ(monospaceフォント).

『ダブルクォート』, 「シングルクォート」.

標準, 上付き, 下付き.

コマンド表示: `ls -al`

+モノ(monospaceフォント) *ボールド*+

`passthru *option*`

コマンド表示: ls -al

モノ(monospaceフォント) ボールド

passthru *option*

PATH表示: '/some/filez.txt', '.b'

PATH表示: /some/filez.txt, .b

[red]#赤いテキスト# [yellow-background]#黄色い背景#
[big]#さらに文字を大きく# [red yellow-background big]*そしてボールド(全部)*

赤いテキスト 黄色い背景 さらに文字を大きく そしてボールド(全部)

文字単位で指定: n__i__**b**++m++[red]##r##

文字単位で指定: nibmr

// コメント   asciidoc はテキストを処理しない
 
(C) (R) (TM) -- ... -> <- => <= &#182;

© ® ™ — … → ← ⇒ ⇐ ¶

''''
 
エスケープ:
\_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やパス中に空白文字を記述したいときは、 空白文字を%20と記述する必要があります。

[[anchor-1]]
パラグラフもしくはブロック1

anchor:anchor-2[]
パラグラフもしくはブロック2

<<anchor-1>>,
<<anchor-1,最初のアンカー>>,
xref:anchor-2[],
xref:anchor-2[2つ目のアンカー].

パラグラフもしくはブロック1

パラグラフもしくはブロック2

[anchor-1], 最初のアンカー, [anchor-2], 2つ目のアンカー.

link:asciidoc[このドキュメント]
link:asciidoc.html[]
link:/index.html[このサイトのトップ]

このドキュメント asciidoc.html このサイトのトップ

http://google.com
http://google.com[グーグル検索]
mailto:root@localhost[管理者のメールアドレス]

http://google.com グーグル検索 管理者のメールアドレス

はじめのホーム
image:images/icons/home.png[]
, 次のホーム
image:images/icons/home.png[代替テキスト]
.

.ブロックイメージ
image::images/icons/home.png[]
image::images/icons/home.png[代替テキスト]

.イメージをサムネイル表示
image:images/640-screen2.gif["My screenshot",
width=128,link="images/640-screen2.gif"]

はじめのホーム images/icons/home.png , 次のホーム 代替テキスト .

images/icons/home.png
図 1. ブロックイメージ
代替テキスト
イメージをサムネイル表示

My screenshot 

これはファイルがどのように
インクルードさするかを示す例です。
ファイルが存在していないので
コメントにしていますが... (^^;

// include::footer.txt[]

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

これはファイルがどのように インクルードさするかを示す例です。 ファイルが存在していないので コメントにしていますが… (^^;

リスト

.バレットリスト
* バレット
* バレット
  - バレット
  - バレット
* バレット
** バレット
** バレット
*** バレット
*** バレット
**** バレット
**** バレット
***** バレット
***** バレット
**** バレット
*** バレット
** バレット
* バレット
バレットリスト

  • バレット

  • バレット

    • バレット

    • バレット

  • バレット

    • バレット

    • バレット

      • バレット

      • バレット

        • バレット

        • バレット

          • バレット

          • バレット

        • バレット

      • バレット

    • バレット

  • バレット 

.バレットリスト 2
- バレット
  * バレット
バレットリスト 2

  • バレット

    • バレット 

.オーダーリスト
. ナンバー
. ナンバー
  .. レター
  .. レター
. ナンバー
.. 英数字小文字
.. 英数字小文字
... ローマ数字小文字
... ローマ数字小文字
.... 英数字大文字
.... 英数字大文字
..... ローマ数字大文字
..... ローマ数字大文字
.... 英数字大文字
... ローマ数字小文字
.. 英数字小文字
. ナンバー
オーダーリスト

  1. ナンバー

  2. ナンバー

    1. レター

    2. レター

  3. ナンバー

    1. 英数字小文字

    2. 英数字小文字

      1. ローマ数字小文字

      2. ローマ数字小文字

        1. 英数字大文字

        2. 英数字大文字

          1. ローマ数字大文字

          2. ローマ数字大文字

        3. 英数字大文字

      3. ローマ数字小文字

    3. 英数字小文字

  4. ナンバー 

.オーダーリスト 2
a. レター
b. レター
   .. レター2
   .. レター2
       .  ナンバー
       .  ナンバー
           1. ナンバー2
           2. ナンバー2
           3. ナンバー2
           4. ナンバー2
       .  ナンバー
   .. レター2
c. レター
オーダーリスト 2

  1. レター

  2. レター

    1. レター2

    2. レター2

      1. ナンバー

      2. ナンバー

        1. ナンバー2

        2. ナンバー2

        3. ナンバー2

        4. ナンバー2

      3. ナンバー

    3. レター2

  3. レター 

.ラベルリスト
用語 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
ラベルリスト
用語 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 

.ラベルリスト 2
用語 1;;
    定義 1
    用語 1.1::
        定義 1.1
ラベルリスト 2
用語 1

定義 1

用語 1.1

定義 1.1 

[horizontal]
.ラベルリスト(行単位)
用語 1:: 定義 1
用語 2:: 定義 2
[horizontal]
    用語 2.1;;
        定義 2.1
    用語 2.2;;
        定義 2.2
用語 3::
    定義 3
用語 4:: 定義 4
[horizontal]
用語 4.1::: 定義 4.1
用語 4.2::: 定義 4.2
[horizontal]
用語 4.2.1:::: 定義 4.2.1
用語 4.2.2:::: 定義 4.2.2
用語 4.3::: 定義 4.3
用語 5:: 定義 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 

[qanda]
.Q&A
質問 1::
    回答 1
質問 2:: 回答 2
Q&A

  1. 質問 1

    回答 1

  2. 質問 2

    回答 2 

.インデントはオプション
- バレット
    * another バレット
        1. ナンバー
        .  again ナンバー
            a. レター
            .. again レター

.. レター
. ナンバー

* バレット
- バレット
インデントはオプション

  • バレット

    • another バレット

      1. ナンバー

        1. again ナンバー

          1. レター

            1. again レター

            2. レター

        2. ナンバー

    • バレット

  • バレット 

.リストの分割
. ナンバー
. ナンバー

はじめに出現するパラグラフはリストを分割します。

. ナンバー

.ヘッダもリストを分割します。
. ナンバー

--
. リストブロックの記述もリストを分割します。
. ナンバー
. ナンバー
--

--
. ナンバー
. ナンバー
--
リストの分割

  1. ナンバー

  2. ナンバー

はじめに出現するパラグラフはリストを分割します。

  1. ナンバー

ヘッダもリストを分割します。

  1. ナンバー

  1. リストブロックの記述もリストを分割します。

  2. ナンバー

  3. ナンバー

  1. ナンバー

  2. ナンバー 

.継続(Continuation)
- バレット
行を開けずに記述すると
. ナンバー
  リストは継続します。
* バレット

 改行して空白に続けて記述すると、
 書いたままに記述でき、
 リストは継続します

.. レター
+
プラス記号(+)はリスクを分割しません
+
----
リストの中に

ブロックを記述できます。
----
+
最後の継続
継続(Continuation)

  • バレット 行を開けずに記述すると

    1. ナンバー リストは継続します。

      • バレット 

        改行して空白に続けて記述すると、
書いたままに記述でき、
リストは継続します

        1. レター

          プラス記号(+)はリスクを分割しません

          リストの中に

ブロックを記述できます。

          最後の継続

.リストブロックはサブリストを含むことができます。
- バレット
  * バレット
+
--
    - バレット
      * バレット
--
  * バレット
- バレット
  . ナンバー
    .. レター
+
--
      . ナンバー
        .. レター
--
    .. レター
  . ナンバー
リストブロックはサブリストを含むことができます。

  • バレット

    • バレット

      • バレット

      • バレット

    • バレット

  • バレット

    1. ナンバー

      1. レター

        1. ナンバー

        1. レター

      2. レター

    2. ナンバー

テーブル

CSVフォーマットで記述されたファイルは、 テーブルの中で include:: マクロを使って取り込むことができます。

.表の例
[options="header,footer"]
|=================================
|カラム 1|カラム 2      |カラム 3
|1       |アイテム 1    |a
|2       |アイテム 2    |b
|3       |アイテム 3    |c
|合計6   |Three items   |d
|=================================
表 1. 表の例
カラム 1 カラム 2 カラム 3

合計6

Three items

d

1

アイテム 1

a

2

アイテム 2

b

3

アイテム 3

c

 
.データ形式はCSV, 各カラム幅は表示域の15% (60 ÷ 4 = 15)
[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% (60 ÷ 4 = 15)

1

2

3

4

a

b

c

d

A

B

C

D

 
[grid="rows",format="csv"]
[options="header",cols="^,<,<s,<,>m"]
|===========================
ID,名,姓,住所,電話
1,Vasya,Pupkin,London,+123
2,X,Y,"A,B",45678
|===========================
ID 名 姓 住所 電話

1

Vasya

Pupkin

London

+123

2

X

Y

A,B

45678

 
.複数セル, row/col スパンの定義
|====
|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. 複数セル, row/col スパンの定義

Date

Duration

Avg HR

Notes

22-Aug-08

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

none