「Asciidoc」の版間の差分

出典: フリー教科書『ウィキブックス(Wikibooks)』
削除された内容 追加された内容
傍注・脚注などの追加
47 行 47 行


ともかく上記コマンドでファイル「sample.html」が作成されるので、あとはこれを通常のwebブラウザで閲覧すれば、閲覧できる。
ともかく上記コマンドでファイル「sample.html」が作成されるので、あとはこれを通常のwebブラウザで閲覧すれば、閲覧できる。

* 注意1
実行環境によって、表示が多少、違う可能性があります。

* 注意2
また、本wikiでの表示は、実際のasciidocの表示とは、微妙に異なります。

asciidocで作成されるHTMLファイルのソースコードが長いので、本wikiではソースの短縮のために(wikiサーバーの負担軽減のためです)、擬似的にwikiで似た表示を再現しているので、実際のasciidocとの表示とは差異があります。



== 文法 ==
== 文法 ==
75 行 84 行


なお、エスケープシーケンスそのものを表示したい場合、2つ続けて「//」のように入力することで、だいたい、どの言語でも上手く表示されます。
なお、エスケープシーケンスそのものを表示したい場合、2つ続けて「//」のように入力することで、だいたい、どの言語でも上手く表示されます。

== 傍注・脚注などの追加 ==
たとえば 「<ref>ああああ</ref>」 みたいな傍注・脚注みたいなのを、asciidoc 用語ではフットノートと言います。

<references/>

フットノートを表示するにはキーワード「 \footnote:[] 」を使います。

ソース例
<pre>
ルビーは赤い。footnote:[ルビーとは宝石のこと]

ジャバは黒い.footnote:disclaimer[コーヒー豆でジャバというのがある]

ジャバは外国産.footnote:disclaimer[]
</pre>

;実行結果

ルビーは赤い。<ref>ルビーとは宝石のこと</ref>

ジャバは黒い.<ref>コーヒー豆でジャバというのがある</ref>

ジャバは外国産.<ref>コーヒー豆でジャバというのがある</ref>

(※以上、実行結果)


そして、ブラウザのページ最下部に、

<references/>

のような脚注があります。

2022年5月31日 (火) 04:23時点における版

何のためのソフトか

対象者は、

  1. テキストエディタだけだと、表とか表示できなくて不満。
  2. かといって、ワードとかだと、テキストエディタで編集できなくて不満。
  3. そこで、HTMLみたいに、テキストエディタで編集できて、なおかつwebブラウザなどで表示できるソフトが欲しい

と思う人向け。

なので、このasciidoc は、拡張子「adoc」のテキストファイルをHTMLに変換するソフトがついている。

なお、「だったら、じゃあHTMLを直接編集すれで十分では? asciidocは不要では?」と思う人は、そうすればいい。

実際、今、あなたが読んでいるwikiでも、asciidocなど使わないで編集されている。


準備と基本の操作方法

インストール方法

Fedora の場合、コマンド

sudo dnf install asciidoc

をする必要がある。(これだけで十分かどうかは未確認。)

asciidoc とは別に、派生ソフトで asciidoctor というのがあるが、微妙に仕様の異なる別ソフトである。

本書では asciidoc のほうを説明する。

短い方の asciidoc は Python で実装されている。

長い方の asciidoctor は Ruby で実装されている。


出力方法

HTMLに出力したい場合、コマンド

asciidoc ファイル名.adoc

である。

何も出力形式を指定しない場合、HTMLファイルが新規に出力される。ソースのadocファイルはそのまま残る。

たとえば、ファイル名が拡張子込みで「sample.adoc」なら、コマンドは

asciidoc sample.adoc

となる。

ともかく上記コマンドでファイル「sample.html」が作成されるので、あとはこれを通常のwebブラウザで閲覧すれば、閲覧できる。

  • 注意1

実行環境によって、表示が多少、違う可能性があります。

  • 注意2

また、本wikiでの表示は、実際のasciidocの表示とは、微妙に異なります。

asciidocで作成されるHTMLファイルのソースコードが長いので、本wikiではソースの短縮のために(wikiサーバーの負担軽減のためです)、擬似的にwikiで似た表示を再現しているので、実際のasciidocとの表示とは差異があります。


文法

箇条書き

こめ印「 * 」 を使って、箇条書きを作れる。

* 箇条書きの出だし
** ああああ
*** いいい

実行結果

  • 箇条書きの出だし
  • ああああ
  • いいい

このように、箇条書きは、Wiki文法とだいたい同じ。

エスケープシーケンス

もし、こめ印そのものを表示したいのに、箇条書きと認識して反応してしまう場合、エスケープシーケンス「\」を先頭につけくわえるなどすればいい。他の制御文字も、だいたい同様の対処法で上手く行くらしい。

なお、asciidoc のエスケープシーケンスは、バックスラッシュ「\」です。他の多くの言語でもエスケープシーケンスはバックスラッシュですので、プログラマー基礎知識として覚えよう。

「エスケープシーケンス」とは何かについては、手短かに言うと、制御文字そのものを、制御文字としてではなく、単なる表示文字として出力させたい場合に使う特別な制御文字のことがエスケープシーケンスです。

「エスケープシーケンス」とは何かについては、これ以上は詳しくは説明しません。標準的なプログラム言語の入門書に書いてあります。

なお、エスケープシーケンスそのものを表示したい場合、2つ続けて「//」のように入力することで、だいたい、どの言語でも上手く表示されます。

傍注・脚注などの追加

たとえば 「[1]」 みたいな傍注・脚注みたいなのを、asciidoc 用語ではフットノートと言います。

  1. ^ ああああ

フットノートを表示するにはキーワード「 \footnote:[] 」を使います。

ソース例

ルビーは赤い。footnote:[ルビーとは宝石のこと]

ジャバは黒い.footnote:disclaimer[コーヒー豆でジャバというのがある]

ジャバは外国産.footnote:disclaimer[]
実行結果

ルビーは赤い。[1]

ジャバは黒い.[2]

ジャバは外国産.[3]

(※以上、実行結果)


そして、ブラウザのページ最下部に、

  1. ^ ルビーとは宝石のこと
  2. ^ コーヒー豆でジャバというのがある
  3. ^ コーヒー豆でジャバというのがある

のような脚注があります。