AsciiDocで文書を書くと、なんとなくそれらしく見えます。
便利。
AsciiDoc is 何
AsciiDocは、HTMLやMarkdownのようなマークアップ言語の一つで、「ここは見出し」「ここは補足事項」などと意味づけする事で、それらしい文章を作ってくれます。「Markdownより高い表現力」「HTMLより高い可読性」が特徴で、表の作成なども標準仕様として提供されています。
- 表記例
何を使って書くか
"AsciiDoc"とはいっても、あくまでテキストデータなので、特別に必須となるソフトが存在するわけではありません。
それこそ「メモ帳」やvi,Emacs,秀丸・・何でも「書くこと」はできます。
が、実際に文書を書くとなると、前項目でお見せした表記例左側のような情報のみで書き続ける事は難しいと思います。
もちろん「そんな物いらねえ、俺はメモ帳だけで頑張るんだ！」という方は頑張っていただいても良いのですが、、自分はいやです。
個人的にはIntelliJ IDEA Community + 各種プラグインが良い感じ
JetBrainsのサイトからダウンロード出来るIntelliJ IDEA Community Editionと、IntelliJへ追加するプラグインの"AsciiDoc"及び"RedPen Plugin"を組み合わせた環境が使いやすかったです。
IntelliJをインストール後、File > Settings...から"Plugins"を選択。「Browse repositories...」の入力欄へそれぞれプラグイン名を入れて「Install」をクリックするだけと、非常に簡単です。
わりと厳しいredpen
"redpen"プラグインを導入する事で、専属の赤ペン先生も雇えます。
意味のない繰り返しや、ですます調・である調の混在など、本当に目ざとく指摘してくれます。
・・が、ちょっとこの先生、厳しすぎる。
File > Settings... > Editor > RedPen
からルールの設定が出来るので、調度良いレベル・内容で指摘してくれるように調整しましょう。
AsciiDocでドキュメントを書いてみた（２）では、その辺りのルールについていじってみた結果や、記述したドキュメントをPDFなどの形式で出力する方法等について書いてみたいと思います。