AsciiDoc 1 文書の構成
AsciiDocのドキュメントは、「ドキュメントヘッダ」、「セクション」、
「パラグラフ」、「ブロック」で構成されます。
ドキュメントヘッダ (Document header)
ドキュメントヘッダは、文書のタイトル、著者の情報を記載します。
とりあえず文書を作成するときは必要ないので、ここでは詳細な説明は省略します。
セクション (Section)
ドキュメントヘッダを付ける、付けないにしても、以降に登場するのが、
セクションです。前回のブログ
AsciiDoc Introduction
に説明していますので、そちらを参照してください。
パラグラフとブロック (Paragraph and Block)
ドキュメントの内容は、パラグラフとブロックで構成します。
パラグラフは文書のかたまりで空行で1つのパラグラフが終わります。
AsciiDocのパラグラフの書式は以下のとおりです。
-
normal (通常)
-
literal (文字通り)
-
verse (詩)
-
quote (引用)
-
admonition (注意) (TIP/NOTE/IMPORTANT/WARNING/CAUTION)
-
listing (リスト)
normal (通常) パラグラフ
文字通り、通常のパラグラフです。(ここの文章のような)。
最初の行は左端から始めます。空行までが1つのパラグラフになります。
通常パラグラフは字下げ(インデント)されることはありません。
literal (文字通り) パラグラフ
literalパラグラフ。すなわち、書いたままの文書を
等幅フォント(monospaced font)で表示します。
パラグラフの最初の行の先頭に、スペースまたは、タブを入れると、
literalパラグラフになります。
記述例
ここの部分は、literalパラグラフ。 1行めの先頭は、スペースでインデントしています。 記載したままで表示されます。
表示結果
ここの部分は、literalパラグラフ。
1行めの先頭は、スペースでインデントしています。
記載したままで表示されます。
[literal] を使うことで、literalパラグラフを
明示的に表すこともできます。
記述例
[literal] ここの部分は、literalパラグラフ。 スペースでインデントしなくても、[literal]を使えば、 記載したままで表示されます。
表示結果
ここの部分は、literalパラグラフ。 スペースでインデントしなくても、[literal]を使えば、 記載したままで表示されます。
verse (詩) パラグラフ と、quote (引用) パラグラフ
改行を記述したまま表示します。また、著者、引用元を強調して表示します。
記述例
[verse, 松尾芭蕉, 奥の細道より] 五月雨を 集めて早し 最上川
表示結果
五月雨を
集めて早し
最上川
奥の細道より
— 松尾芭蕉
— 松尾芭蕉
一方、quoteパラグラフは、著者/引用元を、右寄せで表します。
記述例
[quote, ウィンストン・チャーチル, イギリスの政治家 ノーベル文学賞受賞 1874~1965] 悲観主義者はすべての好機の中に困難をみつけるが、 楽観主義者はすべての困難の中に好機を見いだす
表示結果
悲観主義者はすべての好機の中に困難をみつけるが、
楽観主義者はすべての困難の中に好機を見いだす
イギリスの政治家 ノーベル文学賞受賞 1874~1965
— ウィンストン・チャーチル
— ウィンストン・チャーチル
admonition (注意) パラグラフ
パラグラフの先頭に注意を促すマークをおく書き方です。
マークには、Note,Tip,Important,Warning,Cautionがあります。
記述例
[NOTE] This is an example note. [TIP] This is an example tip. [IMPORTANT] This is an example important. [WARNING] This is an example warning. [CAUTION] This is an expamle caution.
表示結果
Note
|
This is an example note. |
Tip
|
This is an example tip. |
Important
|
This is an example important. |
Warning
|
This is an example warning. |
Caution
|
This is an expamle caution. |
TODO
-
admonition アイコン
-
list パラグラフ
-
ブロックの説明
0 件のコメント:
コメントを投稿