あとで何度か閲覧をするようなリファレンスやメモをまとめるのに便利なフォーマットはなんだろうかと考える。最近はもっぱらchangelogメモの実践のおかげでサイトの更新頻度が落ちてるけど、メモという記録手法ではMTの見難いエントリボックスから何度も書いたり消したり推敲するのが苦痛なのでしかたないのだ(汗)。
さて、最近ではchangelogのメモも溜まってきて別の問題が……。同じテーマのメモが増えて、何度も書き足したり編集したりして、これがまためんどくさい。編集せずに検索でパッと引いてパッと書けばよいと最初は思っていたが、テーマが同じだと同じところに書いたり表を作ったりしたくなるのが人情というもので、結局メモをまとめたメモみたいなのを作ったり……。そのまとまった文章をどういう風なフォーマットで書くのがよいかというのが今日の話です。
結論から言えば、今のところの一番の候補はプレーンテキスト。CUI環境での閲覧や編集を考えた時、HTMLとかXMLとかTeXとかめんどくさ過ぎ。GUIならMozillaのComposerでビジュアルにhtmlを編集していくのも悪く無いけど、何しろ重い……。それでも色がついたり画像を貼りこめるのはとても魅力的なので2番目の候補。そして3番目の候補がTeXで様様なフォーマットに変換したり印刷用に整ったドキュメントを作るには扱いやすい。
これら3つのフォーマットは一応ツールを使って変換することが可能です。tthやlatex2htmlとかhtml2textとかを使えば、htmlとTeXで変換できるのでタグを埋めていくのが苦痛でなければこれらを使ってもいいんだけど、軟弱な僕にとってはそれは苦痛なのです……。プレーンテキストからうまく変換できるツールがなんか無いものかと探し回ると、結構古いツールですが、plain2というのを見つけました。ちょっと試してみたらこれがなかなか良い出来栄えで、十分使えるではないですか。罫線で引いたテーブルを変換できたり、リストや見出し番号に対応できたりとか、これは便利じゃ!
オリジナルのplain2ではHTMLテーブルを出力できないのですが、HTMLテーブルも出力できるようにパッチを作ってる人がいるようで感謝であります。(下記リンク)
結論:plain2を使えばプレーンテキストで書いておいて、必要があればHTMLにしたりLaTeXにしたりすることが簡単にできるので、画像を多用しないのならプレーンテキストで書いた方が編集の負荷がかからなくて良い。
r2.54にHTMLテーブル拡張のパッチを当てたWindowsネイティブ向けにもコンパイルできます。cygwinのgcc 3.3.1で-mno-cygwinフラグをつけてコンパイルしました。この手順どおりやれば問題なくパッチ当ててコンパイルできたけど、僕の環境では/src/macro.cの11行目あたりの#include <varargs.h>を#include "varargs.h"と書き換えないといけないようです。
plain2のファンページ?
http://shika.aist-nara.ac.jp/products/plain2/plain2-j.html
plain2のユーザーマニュアル
http://www.asahi-net.or.jp/~vw4k-kbys/plain2/plain2.html
plain2のHTMLテーブル拡張
http://www.asahi-net.or.jp/~vw4k-kbys/plain2/
罫線を引くVimの拡張(これも便利じゃ)
http://www.vector.co.jp/soft/unix/writing/se266948.html?site%3Dn