- 追加された行はこの色です。
- 削除された行はこの色です。
*reStructuredText [#h8ab1cc6]
[[かぎマニュアルズ]] >
以下を参照してください.
#contents
- [[reStructuredTextとは]]
- [[reStructuredTextリファレンス]]
[[reStructuredText]]とは,テキストを書く際の約束ごとのようなものです.実体はテキストファイルです.メモ帳でも簡単に作成できます.普通のテキストファイルとちょっと違うのは,構造化情報を持たせることができる,という点です.
**どうやってつくるのか [#u8f065c3]
メモ帳などの普通のテキストエディタで,普通に保存すればいいです.拡張子は気にしなくてかまいませんが,テキストファイルですから「.txt」としておけば良いでしょう(普通は勝手にそうなりますね).重要なのは書き方です.
そしてその,[[reStructuredText]]という約束に基づいたテキストファイルを,たとえばHTMLに変換すると,その約束に基づいた構造が保たれたまま変換されます.変換には [[rst2hooktail>http://coisme.no-ip.org/~koi/rst2hooktail.html]] を使ってください.ただしこれは,スタイルやTeX数式処理など,物理のかぎしっぽ用カスタマイズが施されています(文書構造そのものは[[reStructuredText]]に基づいています).
**構造化とは [#u13600d6]
「Structured Text」とは「構造化されたテキスト」の意味でが,厳密な構造ではなく,自由度の高い,ある一定のパターンを含んでいるというべきでしょうか.そのパターンを解析するコンバータで変換してはじめて,XHTMLやLaTeXフォーマットのような厳密な構造を出力できます.
*簡易リファレンス [#g98c211a]
[[reStructuredText]]にしたがって文書を書く際の約束を,簡易的に説明します.
**章立て [#mdb2d67d]
章立てとは,文書の構造を保つためになくてはならないものです.
最低限,「タイトル」,「節」,「小節」くらいを覚えておきましょう.
[[reStructuredText]]では,
==========================
タイトル
==========================
節 1
--------------------------
小節 1.1
^^^^^^^^^^^^^^^^^^^^^^^^^^
小節 1.2
^^^^^^^^^^^^^^^^^^^^^^^^^^
節 2
--------------------------
小節 1.2
^^^^^^^^^^^^^^^^^^^^^^^^^^
という感じで,章立てを記述します.
ご覧の通り,見出し文の下部に「----」を付けたりして,
その文が見出しであることを示します.
必ずしもこの例で示した通りの記号を用いる必要はありません.
が,一つの文書において同じレベルの見出しには,
同じ記号を用いる必要があります.
さらに少々節などを加える場合は,同様に適当な見出し記号を追加します.
**段落 [#q4d21bb4]
連続した行は,途中で改行が入っても一つの段落とみなされます.
という感じで,章立てを記述します.
ご覧の通り,見出し文の下部に「----」を付けたりして,
その文が見出しであることを示します.
は一つの段落として,途中に改行を含めず表示されます.
という感じで,章立てを記述します.
ご覧の通り,見出し文の下部に「----」を付けたりして,
その文が見出しであることを示します.
のように,途中で空白行が入ると,その上と下は違う段落として表示されます.
**箇条書き(リスト) [#z21242cc]
箇条書きするには,
- このように
- 書くと
- 箇条書きされます
のように,行頭を「-」で書きます.この他に「*」と「+」の記号が使えます.
**番号付きリスト [#z83cd06a]
箇条書きに番号を付けたい場合,
1. このように
2. 書くと
3. 箇条書きされます
のように書きます.また,
3. このように
4. 書くと
5. 箇条書きされます
のように,中途半端な番号からはじめることもできます.
**定義リスト [#d4db8a0e]
定義リストとは「用語」と「その説明」をリストするものです.
用語1
ここに用語の説明を書きます
用語2
ここにその用語の説明を
書いて行きます.
のように,説明部分をインデントを設けて記述して行きます.
**文字装飾 [#rd506246]
文字を斜体にしたい場合
ここが普通の *斜体にしたい文字* 文章です.
のように,斜体にしたい部分を「*」と「*」で括ります.
このとき,「*」と通常の文章の間にはスペースが入っている必要があります.
また,太字にしたい場合は
ここが普通の **斜体にしたい文字** 文章です.
のように,「**」と「**」で括ります.
同様に「**」と通常の文章の間にはスペースを入れます.
**リンク [#nc527202]
文字にリンクを張りたい場合
ちなみにこういった任意定数は,初期条件に依って決まります.
この例題について詳しくは, 物理のかぎしっぽ_ をご覧ください.
.. _物理のかぎしっぽ: http://www12.plala.or.jp/ksp/
のように,リンクを張りたい文字列に
物理のかぎしっぽ_
と最後に「_」を付け,そのリンク先を
.. _物理のかぎしっぽ: http://www12.plala.or.jp/ksp/
とうふうに記述します.リンク先記述部分は,文書中のどこにあっても構いません.
リンクを張りたい文字列と地の文との間には,スペースを入れます.
**表組み [#p6727763]
表をつくりたい場合,
+------------+------------+-----------+
| 見出し 1 | 見出し 2 | 見出し 3 |
+============+============+===========+
| 内容 | 内容 | 内容 |
+------------+------------+-----------+
| 内容 | 複数セルにわたる内容 |
+------------+------------+-----------+
のような,テキストで表した簡易的な表組みをしておきます.
**画像 [#m9859d81]
文書に画像を挿入するには,挿入したい場所に
.. image:: 画像ファイル名
と書きます.画像の縦横などの詳細を含めるには
.. image:: 画像ファイル名
:height: 100
:width: 200
:alt: 代替テキスト
とします.heightおよびwidthはピクセル値です.
さらに,文中に画像を含めることもできます.それには
この |適当な名前| という画像は,なになにです.
.. |適当な名前| image:: 画像ファイル名
のようにします.
#br
#br
#topicpath