新規にodtwriterを使用し始めるにあたっては、各自のマシンにdocutilsおよびPygmentsという2つのパッケージをインストールしておく必要がある。ただし後者のパッケージは、構文強調表示機能を使用する場合にだけ必要となる。Ubuntuの場合は「sudo apt-get install python-docutils python-pygments」というコマンドを実行するだけで両方のパッケージをインストールすることができる。次にodtwriter本体をインストールするが、その手順としては、最新版リリースをダウンロードしたものを解凍してから下記のコマンドを実行すればいい。
python setup.py build sudo python setup.py install
odtwriterを実行する際の構文指定にも特に難しい点はなく、rst2odt.pyコマンドにソースとなるテキストファイルとターゲットとなるODTドキュメントを指定するだけで、必要な変換作業が行われる。
rst2odt.py text.txt document.odt
また多くのコマンドライン形式ツールと同様に、odtwriterもフラグ指定をサポートしているが、そのうちの2つは最低限押さえておいた方がいいだろう。その1つは構文強調表示に関するものであり、この機能はデフォルトでオフにされているので、odtwriterで実行させるには「--add-syntax-highlighting」フラグを指定しておく必要がある。
rst2odt.py --add-syntax-highlighting text.txt document.odt
これによりPythonの構文強調表示がソーステキストにおけるコードブロック(リテラルブロックとしてのマーキング部)に適用される。他のプログラミング言語におけるコードブロックについては、いわゆるディレクティブをソーステキストに追加することで、当該言語(または字句解析プログラム)による強調表示機能を有効化させる必要がある。
.. sourcecode:: on .. sourcecode:: Java
odtwriterによる構文強調表示機能は、実際にはPygmentsユーティリティが担っているため、同ユーティリティがサポートしている言語ならばそのまま使用することができる。サポート対象の言語およびその省略名はPygmentsのWebサイトで確認して頂きたい。
