開発用のドキュメントと、提出用のドキュメントと二つ書かなければならないことがある。どちらも似たような内容だが体裁が異なる。だがそのためにコストをかけるというのは非効率的だ。

Picture 155.png

テスト文書

 

この手のソフトウェアは数多く存在するが、開発ドキュメントの管理にWikiエンジン(DokuWikiなど)を使っているなら、これの利用はありかも知れない。

今回紹介するオープンソース・ソフトウェアはtxt2tags、一つのテキストフォーマットから各種文書形式に変換するソフトウェアだ。

txt2tagsはすでに7年も開発が行われているソフトウェアで、テキスト文書から各種ドキュメントに変換する機能がある。特にWiki(Wikipedia/MediaWiki形式)、gWiki(Google Code向けWiki)、DokuWIki、MoinMoinのWiki系フォーマットに対応しているのが利点だ。

Picture 156.png

HTMLでの生成例

 

他にもHTML、XHTML、SGMLといったマークアップ言語や、Loutやtexといった形式、man形式での出力もできる。txt2tagsで書く形式はそれほど見づらいものではなく、テキストとして十分見やすいものになっている。

テーブル組みや画像の埋め込み、リストなどにも対応しているので、大抵の文書は問題なく描けるのではないだろうか。プログラミングの最適化はDRY(Don’t repeat yourself)にある。文書でもその心がけで臨まれたい。

 

txt2tags

 http://txt2tags.sourceforge.net/index.html

SourceForge.net: txt2tags text converter

 http://sourceforge.net/projects/txt2tags