2009年1月4日日曜日

reStructuredTextのススメ

reStructuredText(以下、RST)をご存知でしょうか?
軽量マークアップ言語に属するものです。wikiに似ていると思ってくださったらイメージしやすいでしょうか。RSTの書式に沿って書いたプレーンテキストをHTMLやPDFといった形式に変換できるのです。
書式や技術については詳しいサイトがいろいろありますのでここでは詳しく書きません。Googleで検索してみてください。

RSTを使うと何がいいか?どんな風に幸せになれるのか?というと、やはり”ワープロソフトを使わなくても美しいスタイルの文書が作成できる”ということではないでしょうか。
ワープロソフトは編集している最中からスタイルを画面上に反映させようとしますので、動作が重くなりがちだと思います。(もちろん、下書きモードなども用意されていますが、いちいちモードを切り替えるのが好きな人は少ないんじゃないかと思います。)
RSTはプレーンテキストで書きます。なのでいつもコードを書いているその使いやすいエディタから離れることなく書くことができます。

RSTを変換するツールはvimのプラグインVSTDocutilsがありますが、rst2a.comというサイトで簡単に変換することができますので、サイトの使い方をご紹介します。



サイトのトップページです。Createを選択します。















ファイルをアップロードするか、直接サイトでRSTを書くかを選べます。
もうすでにRSTが作成されているのであればファイルアップロードでいいのですが、結構文法に厳格なようで先に紹介したVSTやDocutilsなどで変換ができたファイルでも、このサイトではエラーで変換できない場合があるようですので直接編集をおすすめします。




左側のテキストエリアで編集します。
右側のLegendにはRST書式の書き方が表示されています。
出来上がったら、Convert To:で出力形式をPDFかHTMLを選ぶことができます。ここではHTMLを選択します。









すると右側の画面がHTML Exportに変わりました。ここで出力するHTMLのスタイルを選ぶことができます。
ここではcrngamesを選んでいます。
あとはDownloadボタンを押して完了です。








別ウィンドウでHTMLファイル開かれます。見事完成しました。
PDFの場合にはファイル保存ダイアログが表示されます。







僕はすっかりRSTの虜になってしまい、今ではいろんな手順書やスケジュールを記載したメールまでRSTで書いています。こんな風になってしまったのはGoogle App EngineのHack-a-thonでチューターをなさったvoluntasさんにRSTを紹介されてしまったからです。
voluntasさんの会社では社内文書の公式フォーマットとしてRSTが使われているそうですよ。

■Thanks
voluntas
https://twitter.com/voluntas


■参考サイト
rst2a.com
http://rst2a.com/

VST : Vim reStructured Text
http://www.vim.org/scripts/script.php?script_id=1334

Docutils
http://docutils.sourceforge.net/index.html

プレーンテキストからビジュアルな文書を生成できるreStructuredTextとrst2a
http://sourceforge.jp/magazine/08/05/07/0124234

0 件のコメント: