reStructuredText(reST)

reSTの書式リファレンス


文書のタイトルとサブタイトル

文書のタイトルとサブタイトルを示すには、文書の先頭で、 英数字以外の文字( = - ` : ' " ~ ^ _ * + # < > )で装飾した行を書く。 最初に出てきた装飾された行が文書のタイトルに、 次に出てきた異なる文字で装飾された行がサブタイトルになる。

  • 箇条書き
  • これで
  • できる?

見出し

英数字以外の文字で添線引きした行は、見出しとなる。 文字の種類や数に意味は無く、文書中に出てきた順でネストが下がる。

見出し 2.1

こんな感じで

見出し 2.1.1

深くなっていく

見出し 2.2

ネスト戻り

段落

空行で区切った文は、

段落になる。

インデント

空白で

字下げした段落は

インデントとして扱われる

例えば

こんな感じ

文字スタイル

普通の文字、 斜体太文字等幅 。 スタイル指定の前後は、空白で区切ることが重要。 '*''`' のエスケープは、バックスラッシュ( '\' )で行う。 *こんな感じ*。

リンク

これは、 注釈形式のリンク です。

これは、 インライン形式のリンク です。

Wikiサイト内へのリンク。例えば フロントページ へのリンクです。

箇条書き

番号付きリスト

  1. あめんぼ
  2. あかいな
  3. あかさたな

    1. 入れ子にする場合は
    2. 段を下げて
    3. 上下に空行を入れて書きます
  4. 元のレベル

番号付きリストの番号は、手入力で増やさなければいけない (自動的に増やしてくれない)

番号無しリスト

  • あめんぼ
  • あかいな
  • あかさたな
    • 入れ子にする場合は
    • 段を下げて
    • 上下に空行を入れて書きます
  • 元のレベル

リスト

定義リスト

コマンド1
モンゴルからスカラープールへ。 ナイルの砂塵よりテクタイトを探知する技師を訪ねよう。 4Uサイズのアタッシュケースを磁北に向け、 グレートブラボーボックスのアースをとって構える。 月の運行に手拍子で参加。
コマンド2
ナヴァホの聖地へはテロートマトンで行こう。 続出するバグは助手のトラウマが原因であり、 激励こそ最良のメンテナンスである。 グレートブラボーボックスの拡張スロットに、 アモール・バッファーを差し込む。 心をイヨマンテの矢じりに置く。
最終コマンド
スカラープールからペルーへは、 ヒエロニムスの回路を通る。 トパーズ18フォンツにホピ族の母をかくまう事は可能だ。 デラワーカメラでスナップショットを一枚。 一億年前のリセットを思う。 銅線コイルのトーテムに一礼する。

上記のように、文字スタイルの指定も可能

フィールドリスト

鉄則1:神経経路は列挙せず混沌へ
鉄則2:神的啓示は枚挙せず通過せず
鉄則3:人的迷路はコペンハーゲン解釈

オプションリスト

-a コマンドラインオプション "a"
-b file オプションは、引数と長い記述を 持つことができます
--long 長いオプションを書くことも
--input=file 長いオプションは引数を持つことも
/V DOS/V MSスタイルのオプションも書けます

グリッドテーブル

ヘッダー1 ヘッダー2 ヘッダー3
ボディ 行1 桁2 桁2
ボディ 行2 複数桁にまたがったセル
ボディ 行3 複数行に またがった セル
  • ブロックを
  • 内包した
  • セル
ボディ 行4

シンプルテーブル

入力 出力
A B A xor B

整形済みテキスト

前の段落が"::"で終わり、字下げされた段落は、整形済みテキストとして扱われる。 例えば:

#!/usr/bin/env python
import random

an = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'
ln = 12

print ''.join([an[random.randrange(len(an))] for n in range(ln)])

イメージ

ページに添付されたイメージを表示する。

moindude.png

<img>タグの各種パラメタも指定可能。

Moin野郎

インラインの moindude イメージ表示。


カテゴリー:技術

reST (最終更新日時 2007-08-29 06:59:11 更新者 おさ)