構造化テキスト
文書などを記述するときに、HTMLやプレーンテキスト以外に「構造化テキスト」という聞きなれないフォーマットで記述することができます。この「構造化テキスト」での記述方法を覚えると、少ない労力で読みやすい文書を作成することができるので、おすすめです。
takanori
ここでは、文書、ニュース記事をテキストで記述してHTMLで表示するための、構造化テキストの書き方について説明します。
目次をみると結構たくさん構造化テキストの書き方がありますが、とりえあずはこれだけ覚えておけば十分だと思います。あとは必要に応じて覚えていくか、表を書きたいときはその部分だけHTMLで記述するなどして対処すればよいと思います。
同じ深さで、空行を一行入れると段落になります。
HTMLの <p> タグで囲まれます。
書き方:
一つ目の段落。
改行しただけでは、段落はわかれない。
二つ目の段落
一行で書かれた文章は、それに続いて字下げされた段落があることによって、見出しになります。見出しの大きさは字下げの深さによって決まります。
見出しはHTMLの <h1> 〜 <h6> タグで表現されます。
また、字下げには半角空白のみが使用できます。全角空白を使用しても字下げされているとは認識されないので注意してください。
書き方:
見出しレベル1
段落1
段落1
見出しレベル2
段落2
段落2
文字列を * で囲むと強調 <em> で、** で囲むとさらに強い強調 <strong> で表現されます。
例:
これは 強調 です。
これは さらに強い強調 です。
書き方:
これは *強調* です。
これは **さらに強い強調** です。
文字列を _ で囲むと、アンダーライン(HTMLの <u> タグ)で表現します。
例:
これは アンダーライン です。
書き方:
これは _アンダーライン_ です。
文字列を ' で囲むと、HTMLの <code> タグで表現します。また、<, >, & 等の文字は正しくエスケープされます。
例:
variables = &variables
書き方:
variables = '&variables'
行の先頭に * , - , o 等を記述することにより、 <ul> で表現されます。
例:
書き方:
- Zope
- CMF
- CMF Photo
- CMF Forum
* Plone
先頭の文字を半角の数字や英字で記述することにより、番号つきのリスト <ol> で表現されます。
また、数字や英字の実際の値とは関係なく、先頭から数字がふられます。
例:
- Zope
- CMF
- CMF Photo
- CMF Forum
- Plone
書き方:
1.Zope
A.CMF
B.CMF Photo
a.CMF Forum
5 Plone
定義部分となる文字列と、説明を -- でつなぐと、 <dl> で表現されます。
例:
- Emacs
- Editting MACroS
- Mule
- MUltiLingual Enhancement to GNU Emacs
- Meadow
- Multilingual Enhancement to gnu Emacs
with ADvantages Over Windows
書き方:
Emacs
-- Editting MACroS
Mule --
MUltiLingual Enhancement to GNU Emacs
Meadow -- Multilingual Enhancement to gnu Emacs
with ADvantages Over Windows
リンクは対象とる文字列を " で囲み、 : に続いてリンクの対象となるURLを記述します。
URLには当然絶対パス、相対パス、mailto:等も記述できます。
また、例を見てわかるとおり、内部リンク以外へのリンクの場合はリンクの種類を表すアイコンが付いて、わかりやすくなっています。
例:
書き方:
- "一つ上の階層への相対パス(内部リンク)":../
- "朝日.com(外部リンク)":http://www.asahi.com
- "メールはこちら(mailto)":mailto:takanori@csk-inet.or.jp
- "Firefox(ftp)":ftp://ftp.mozilla.org/pub/mozilla.org/firefox/
[ と ] で囲むことによって、この文章の目次のようなページ内リンクを作成することができます。
参照先となるアンカーは .. [ と ] で同じ文字列を囲みます。
例:
Zope[footnote] を使ってこのサイトは構築されています。
[footnote] Z Object Publishing Environment
書き方:
Zope[note] を使ってこのサイトは構築されています。
.. [note] Z Object Publishing Environment
インラインで画像を表示する <img> タグで表現されます。
'"' で囲った部分が alt に指定されますが、日本語は使用できないようです。
例:
"Mozilla Firefox":img:http://www.mozilla.org/images/product-firefox.png
表を作る場合は、桁数をそろえてカラムを | で分割し、行を |-----| や |======| で分割します。
例:
Browser
|
version
|
URL
|
Firefox
|
0.10.1
|
http://www.mozilla.org/products/firefox/
|
MSIE
|
6.0
|
http://www.microsoft.com/
|
Opera
|
7.53
|
http://opera.livedoor.com/
|
書き方:
|-----------------------------------------------------------|
|Browser|version |URL |
|===========================================================|
|Firefox|**0.10.1**|http://www.mozilla.org/products/firefox/|
|-----------------------------------------------------------|
|MSIE |**6.0** |http://www.microsoft.com/ |
|-----------------------------------------------------------|
|Opera |**7.53** |http://opera.livedoor.com/ |
|-----------------------------------------------------------|
整形済テキスト <pre> は行の最後が '::' で終わり、字下げした段落が続くとその段落は整形済テキストとして表現されます。
また、整形済テキストの中では、リスト等の構造化テキストの表現は無視され、'<', '>', & も自動的にエスケープされます。
例:
ここから下は整形済みテキスト:
- <a href="URL">URL</a>
改行もそのまま改行になります。
- 箇条書きのつもり
書き方:
ここから下は整形済みテキスト::
- <a href="URL">URL</a>
改行もそのまま改行になります。
- 箇条書きのつもり
HTMLタグを挿入したい場合は、そのままタグを記述すれば表示されます。
例:
打ち消し線
青い文字
書き方:
<strike> _打ち消し線_ </strike><br />
<font color="blue">青い文字</font>