reStructuredText入門

Contents

reStructuredText とは

reStructuredTextは、HTMLのような構造化されたテキストを、 タグなどをつかわずに、見栄えが通常のプレーンテキストで書けるように 工夫された書き方のルールである。

例えば、HTMLで文書のタイトルを表すには、:

<title>reStructuredText入門</title>

と書く。しかしreStructuredTextでは、:

====================
reStructuredText入門
====================

と書く。一見して分かりやすいのか、直感的なのかといえば reStucturedTextの方に分があるだろう。

もう一つの利点は、文字や記号のエスケープをしなくてもよい 文法があること。HTMLでは、< や > などは &lt; と &gt; などと記述 しなければならない。つまり、:

HTMLでは、< や > などは &lt; と &gt; などと記述する。

しかし、reStructuredTextではそのままで、:

reStructuredTextでは、< や > などは < と > と記述する。

これは、文中に<やら>やら空白の連続が沢山でてくるソースコードなんかを そのまま貼り付けたい場合はとても助かる。

入手

以下のソフトウェアをダウンロードしてインストールする。

ソフトウェア ダウンロード先
ActivePython http://www.activestate.com/
DocUtils http://docutils.sourceforge.net/

最新版は、バージョンが 0.4 (2006-09-04)。このサイトも 0.4 で 構築されている。ただし、日本語の入った表(たとえば上の表)は 漢字(というかCJK文字)の文字幅の情報が Python 2.4 からしか 利用できないようなので、Python 2.3 以前のバージョンではうまくいかない (その他の機能はOK)。

インストール

  1. ActivePython

    基本的に上記のダウンロードサイトでは、インストーラつきで ソフトウェアを提供しているので、インストーラの指示に従うだけでよい。

  2. DocUtils

    上記のダウンロードサイトからは、ソースコードと日本語テーブルパッチを ダウンロードする。試した DocUtils の版は 0.4。

  3. インストール

    展開したトップディレクトリにて、:

    # python install.py
    

    でインストールが可能。

XREA にインストール

reStructuredText は HTML に変換可能なので、もちろん Web のページも 記述が可能。もちろんこのページもreStructuredTextで書かれている。

手元で HTML に変換してから、Web サーバにアップロードしてもいいけれど、 CGI などで、on the fly で HTML に変換して使いたい、という個人的な 要求のため、web サーバにインストール、インストーラ(CGI)を作成しました。

ただし、上記の理由で Python が 2.4 以上でないとうまく動かない 機能があるので、もしお使いのサーバのバージョンが古ければ、 ( XREAサーバのソフトウェア情報 で確認できる) XREA にバージョンアップしてもらうように要望を出そう。

上記のサイトとこのサイトから次のコードを入手する。

  1. docutils-0.4.tar.gz
  2. docutils-0.4.install.cg

この二つのファイルを XREA の HTML のトップディレクトリなどに ftp で アップロードする。

ただし、2. の .cg のファイルは、ファイル名の最後の .cg を .cgi に 変更して、実行可能なパーミッションにしておく。

あとは Web ブラウザでこの CGI を実行すれば、ファイルを展開し、パッチを あて、インストールし、必要なデータファイルをコピーする。

関連サイト