AsciiDoc文書作成環境を考える

今回はAsciiDoc文書作成環境を考えてみます。(前回の話より先にこっちを書けよ!という…)
話中に出るアプリケーション等の関連リンクは最後の方に纏めて記述します。

さて、文書パーサーとして「Asciidoctor」を利用する事を考えると、選択肢として次の様な物が候補として挙がることになるだろう。

  1. お気に入りのエディタ + 「Asciidoctor環境」

  2. マイクロソフト「Visual Studio Code (VSCode)」 + 「Asciidoc拡張機能」

  3. 「AsciidocFX」等の専用エディタ

どの方法を採っても「Windows」、「Mac」そして「Linux」に環境を構築できる。(3の専用エディタの場合、WindowsやMac専用というものはあるかもしれないが…)
インターネットを見渡すと今のトレンドは2の「VSCode」を利用する場合だと思う。

OSが「Linux」の場合、1の「Asciidoctor環境」が一番構築難易度が低い、2や3の場合でもそれ程、難しい作業ではないと思う(インストール方法やFEPの種類によって日本語入力で苦労するかもしれないが…)。

「Windows」や「Mac」の場合、コマンドライン(CLS)で処理する環境を構築する必要がない分、2や3のエディタ経由の環境の方が楽に構築できる。1の「Asciidoctor環境」は基盤の「Ruby」環境構築の良し悪しでOSのメンテナンス効率が変わってくる(なかなか悩ましい…)。

「Asciidoc」を個人で利用する場合は自分の好みで選べば良いと思います。企業等で利用する場合は管理者の利便性や利用者の自由度、出力書類(最終成果物)の完成度等のバランスを考えて選択する必要があると思います。

専用もしくはカスタマイズ・エディタを利用する場合、予め必要な属性や拡張機能を定義できるという利得があります。企業利用の場合は全員の環境設定を同じようにすれば出来上がる書類の体裁をコントロールできます。個人利用の場合、初期設定は好みで調整すれば良いでしょう。

これからはじめようという人(特に「Windows」ユーザー)はネットでの情報収集が容易なので「VSCode」を利用するのがお勧めです。但し、図形描画の「kroki」は外部サーバーにデータを渡し変換するので注意が必要です。
本日確認した所、「Asciidoctor.js」を無効にして「Asciidoctor Diagram」を利用する手順が難解になっていたので設定ファイルの内容が分かる人でないとセキュリティーをしっかり確保した運用が難しくなっていました。

性能の良いパソコンを利用している人は「AsciidocFX」が良いでしょう。欠点はインターフェースが日本語化されていない点と「JAVA」で構築されたアプリケーションの為、他の方法よりCPUパワーやメモリーを必要とする事です。(「AsciidoctorJ」を利用しています。)

「AsciidocFX」では、「Asciidoctor」のCLS環境導入は必要はありません。ただし、後述する図形変換に利用する外部アプリケーションは必要に応じて導入してください。

ここで、紹介したエディタでも内部的に利用している「Asciidoctor環境」を解説しておきます。「Asciidoctor」は「Asciidocter」本体とその拡張機能によって構成されています。

  • Asciidoctor(本体、「HTML」、「DocBook XML」と「man page」の変換サービス)

  • Asciidoctor PDF(「PDF」変換サービス)

  • Asciidoctor Epub3(電子ブック変換サービス)

  • Asciidoctor Diagram(埋込テキスト図の変換サービス)

  • Asciidoctor reveal.js(プレゼンテーションスライド変換サービス)

CLS環境では必要に応じて拡張機能を導入しておく必要があり、利用時もそれをコマンドで指定する必要があります。

注意として、「Asciidoctor Diagram」の一部の図(PlantUML等)は外部のアプリケーションソフト利用しています。
「PlantUML」等の「 dot記法」採用している物の利用には「Graphviz」を導入しておく必要があります。また、「Mermaid」を利用する場合は「mermaid-cli」を導入しておく必要があります。
これらは「VSCode」や「AsciidocFX」を利用する場合も同様です。図の変換に失敗した場合はこれらの導入が正しく行われているか確認すると良いでしょう。(私は「Mermaid」は利用せず「PlantUML」中心に作業しているので「Graphviz」のみ導入しています。「Mermaid」も嫌いではないのですけど……「Node.js」の環境作成に悩んでて……)

なんにせよ試行錯誤は必要です。


ここからは今回の参考にしたウェブサイトのリンクを貼って置きます。

「Windows」ユーザーは「農林水産技術会議事務局 筑波産学連携支援センター」様で環境構築の流れが確認できます。


「VSCode」はこちらから導入できます。

「VSCode」の拡張機能タブから導入できますが、参考までに「Asciidoc拡張機能」のサイト

「AsciidocFX」の導入はこちらから

「Asciidocter」本家


テキスト→図の変換アプリケーション

「Graphviz」

「Mermaid」


今回はここまで。

追伸:「VSCode」を薦めてはいるけど、マイクロソフトさんの回し者ではありません。「Atom」が更新されなくなったのが痛いのです…orz。

いいなと思ったら応援しよう!