reStructuredText(reST)
reSTの書式リファレンス
文書のタイトルとサブタイトル
文書のタイトルとサブタイトルを示すには、文書の先頭で、 英数字以外の文字( = - ` : ' " ~ ^ _ * + # < > )で装飾した行を書く。 最初に出てきた装飾された行が文書のタイトルに、 次に出てきた異なる文字で装飾された行がサブタイトルになる。
op 0~2の整数 htype 0~255の整数 hlen 0~16の整数 hops 0~255の整数 xid 4オクテットの文字列 secs 0~65,535の整数 flags 0~65,535の整数 ciaddr IPアドレスを表す文字列(dotted decimal) yiaddr IPアドレスを表す文字列(dotted decimal) siaddr IPアドレスを表す文字列(dotted decimal) giaddr IPアドレスを表す文字列(dotted decimal) chaddr 16オクテットまでの文字列(長さはhlenに従う) sname 64オクテットまでの文字列 file 128オクテットまでの文字列 options オプションコードと値の文字列からなるタプルを含むリスト こんなのも書ける?
文字スタイル
普通の文字、 斜体 、 太文字 、 等幅 。 スタイル指定の前後は、空白で区切ることが重要。 '*' や '`' のエスケープは、バックスラッシュ( '\' )で行う。 *こんな感じ*。
リスト
定義リスト
- コマンド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)])
カテゴリー:技術