Docutils

Docutilsであそぼう!

Author: Kazuo Moriwaka

docutils とは..? (1/2)

docutils とは..? (2/2)

reStructuredText とは..? (1/2)

reStructuredText とは..? (2/2)

基本的なreSTの例
タイトル
========================

ふつうの文章は普通にかきます。

一行あけると別の
段落になります。

1. 箇条書き
2. 先頭の数字は人手で書きます。

   + 入れ子にする時はインデントします
   + 順序つきと順序なしのリストが使えます

3. 入れ子から戻る時は空行をいれます。

タイトル

ふつうの文章は普通にかきます。

一行あけると別の 段落になります。

  1. 箇条書き
  2. 先頭の数字は人手で書きます。
    • 入れ子にする時はインデントします
    • 順序つきと順序なしのリストが使えます
  3. 入れ子から戻る時は空行をいれます。

reST参考リンク

標準付属ツール (1/2)

rst2html

rst2latex

rst2xml

標準付属ツール (2/2)

pep2html

rst-mode.el

その他のツール

docutils の svn treeから拾ってくる

よそから拾ってくる

docutilsを使うPythonプログラム

  • wikiページをreSTで書けます
  • attachment との動作も1.3系からはいいかんじ
  • wikiページをreSTで書けます
  • imageのとりこみなどの統合はいまいち
  • よくしりません。スマソ
  • ドキュメントフォーマットとして使えるらしい

ハマりポイント

空行は大事

インデントは大事

リンクの書き方がわかりにくい

* rest2web_
.. _rest2web: http://www.voidspace.org.uk/python/rest2web/index.html

でもエラーメッセージをよく読めばだいたい解決

実際に使って気になった制限

気になった制限は。。

reSTには章番号やページの概念がない

表の項目中でアラインメントがない

rst2XXX

rst2XXXの オプション

-i 入力漢字コード
-o 出力漢字コード
--use-latex-toc 目次をlatexのマクロで書く(latex)
--use-latex-docinfo latexのmaketitleで著者や日付を処理する(latex)

使用例

rst2latex -i euc-jp -o euc-jp \
          --use-latex-toc --use-latex-docinfo < infile > outfile
rst2html -i euc-jp -o euc-jp  < infile > outfile
rst2s5 -i euc-jp -o euc-jp  < infile > outfile

日本語latex用に

rst2latex は英語環境なlatexソースを吐くのでsedで置換

s!\\documentclass\[10pt,a4paper,english\]{report}!\\documentclass{jreport}!
s/\\usepackage\[DIV12\]{typearea}//
s/\\usepackage\[.*\]{inputenc}//
s/\\usepackage{babel}//
s/\\usepackage{ae}//
s/\\usepackage{color}//
s/\\usepackage{amsmath}//
s/png/eps/

最近とこれから