SmartDox 0.3.0をリリースしました。
本バージョンでは細かい機能拡張を行なっています。内容についてはブログで紹介していく予定です。
機能
SmartDox 0.3.0では以下のオプションを提供しています。
| オプション | 機能 |
|---|---|
| -html5 | HTML5生成(試験的) |
| -html4 | HTML4生成 |
| -html3 | HTML3生成 |
| -plain | プレインテキスト生成 |
| PDF生成 | |
| -latex | LaTeX生成 |
| -blogger | Blogger用のHTML生成 |
インストール
プログラムの配布は、Scala用のプログラム配布ツールconscriptを使っています。
conscriptをインストールした後、以下のようにしてSmartDoxをインストールします。
$ cs asami/dox
以下の2つのコマンドがインストールされます。
- dox
- SmartDoxコマンド
- sdoc
- SmartDocコマンド(互換用)
依存プロダクト
SmartDoxでは、以下のプロダクトに依存しています。
| プロダクト | 使用する機能 |
|---|---|
| LaTeX | PDF生成 |
| Graphviz | 画像生成 |
| Ditaa | 画像生成 |
プロダクトに依存する機能を使わない場合は必要ありません。
LaTeX
platexコマンドとdvipdfmxコマンドが実行可能になっていれば基本的にはOKです。
Mac OS上でmacportsを使ってインストールしたLaTeXで動作確認しています。他の環境の場合、スタイルファイルなどがない可能性があります。
Graphviz
dotコマンドが実行可能になっていればOKです。
Mac OS上でmacportsを使ってインストールしたGraphvizで動作確認しています。
Ditaa
ditaaコマンドが実行可能になっているか、optlocalsharejavaditaa09.jarのJarファイルが存在していればOKです。
Mac OS上でmacportsを使ってDitaaをインストールすると、optlocalsharejavaditaa09.jarに配置されます。このditaa09.jarを決め打ちで使用しています。(いずれパラメタで指定可能にする予定です。)
それ以外の環境では、シェルスクリプトなどでditaaコマンド(インストールされているJarファイルを呼び出す)を作成してください。
使い方
まだマニュアルがないので、文書フォーマットは org-modeを参考にしてください。あまり難しい文法を使わなければ大体大丈夫だと思います。
org-mode形式で作成した文書から以下のようにしてHTMLやPDF、プレインテキストに変換してください。
$ dox -html4 mydoc.dox
$ dox -pdf mydoc.dox
$ dox -plain mydoc.dox