AsciiDoc Introduction

AsciiDocを使う理由

AsciiDocを簡単に説明しますと、 テキストファイルをHTML,PDF,EPUB,unix manページなどの多くの 形式に変換するツールです。

私は、文章を作成するのに、単純なテキストフォーマットを 使うのが好きです。 理由は、文章の作成に集中することができる、 編集が簡単、プログラミングで使い慣れている エディタが使えることです。 そこで、テキストフォーマットから、HTMLなどのフォーマットに 変換してくれるツールを探していました。 偶然発見したのが、AsciiDocです。 使い方を調べてみると、本の執筆にも使われているくらい 本格的なツールだとわかりました。

実際、AsciiDocを利用して執筆された本を挙げます。

Ruby ベストプラクティス

AsciiDocで書いて、DocBook XMLを生成し、 dblatexを使ってPDFにレンダリングしたと、 著者自身が、言っています。

Progamming iOS 4

AsciiDocホームページ (http://www.methods.co.nz/asciidoc/index.html)
「Documents written using AsciiDoc」より。
他にもたくさんのAsciiDoc使用例がリストアップされています。

AsciiDocを使ってみよう

ということで、AsciiDocを使ってみようと思ってwebを 検索すると、日本語での紹介例があまり見つかりません。 仕方がないので、自分で使って情報を発信することにしました。 このブログの作成にAsciiDocを使って、使い方を学習し紹介していきます。 おそらく日本語で使った場合の問題にも遭遇すると 思いますので、その解決にもトライしたいです。

まず手始めに、このページで使った、書式を紹介します。

セクションとタイトル (Sections and Titles)

セクションのタイトルは、2行で書きます。 行の左端から書きます。 1行目がセクションのタイトルで、2行目にセクションの タイトルであることを示す記号を書きます。記号の個数は、1行目の セクションのタイトルと同じ長さの下線に見えるようにします。 こんな感じです。(プロポーショナルフォントの表示では、 1行目と2行目の長さが異なって見えるかもしれません)

   Introduction
   ============

セクションのレベルは、0 (top level)から、4 (bottom level) まで 対応していて、記号の種類により、レベルを決めます。

セクションのレベルと記号の区別

    Level 0 (top level):     ======================
    Level 1:                 ----------------------
    Level 2:                 ~~~~~~~~~~~~~~~~~~~~~~
    Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
    Level 4 (bottom level):  ++++++++++++++++++++++

この文章が書いてあるセクションは、レベル2 で記述は次のとおりです。

    セクションとタイトル (Sections and Titles)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1行でタイトルを記述する方法もあります。レベルは記号の数で 決まるので、記号の種類を覚えられない場合は、 こちらのほうが使い勝手がよいと思います。

    = Document Title (level 0) =
    == Section title (level 1) ==
    === Section title (level 2) ===
    ==== Section title (level 3) ====
    ===== Section title (level 4) =====

(END)

---

Last updated 2012-02-04 04:25:35 JST