Wiki Creole 1.0 の文法

更新日: 2010/06/26


本ページは、Wiki Creole 1.0 最終版 (2007年7月4日) の仕様を翻訳したものである。但し、仕様策定に至る理由についての説明部分は省略しているし、この他にも若干の省略がある。完全な文書を読みたいならば原文を参照していただきたい。原文はCreative Commonsライセンスで公開されており、本翻訳もそれを継承しているので、読者による訳文の流用は自由である。

ボールドとイタリック

ボールドとイタリック・テキストは段落、リストの項目、表のセルの内部で使うことができる。ボールドまたはイタリック・テキストの内部に現れるリンクは、ボールドまたはイタリックになるべきである。ボールドとイタリックのテキストは段落、リストの項目と表のセルの終端で終了する。従って、それら複数にまたがることはできない。

ボールド

Creole:

**bold**

XHTMLでの推奨:

<strong>bold</strong>

出力例:bold

イタリック

http: またはftp:の直後ならば//のイタリック処理を無視せよ。

Creole:

//イタリック//

XHTMLでの推奨:

<em>イタリック</em>

出力例:イタリック

Creole:

ボールドとイタリックは行を//またが
ることができる//べきだ。

しかし、//段落を。。

。。またがることができて//はならない。

XHTMLでの推奨:

<p>ボールドとイタリックは行を<em>またが
ることができる</em>べきだ。
</p>
<p>
しかし、<em>段落を。。</em>
</p>
<p>
。。またがることができて<em>はならない。</em>
</p>

出力例:

ボールドとイタリックは行をまたが
ることができる
べきだ。

しかし、段落を。。

。。またがることができてはならない。

ボールド・イタリック

Creole:

**//ボールド・イタリック//**
//**ボールド・イタリック**//
//これも**また**正しい//

XHTMLでの推奨:

<strong><em>ボールド・イタリック</em></strong>
<em><strong>ボールド・イタリック</strong></em>
<em>これも<strong>また</strong>正しい</em>

出力例:
ボールド・イタリック
ボールド・イタリック
これもまた正しい

受け入れられない:

**//ボールド・イタリック**//
//**ボールド・イタリック//**

見出し

3つのレベルの見出しサイズのみが要求されている。閉じの(右側の)等号はオプションであり、両方がバランスする必要はなく、生成される見出しの種類に影響を与えない。左側の等号の前での空白は許される。閉じの等号の後ろには空白文字のみが許される。見出しの中でのマークアップの解析はオプションである。

Creole:

= レベル1(最大) =
== レベル2 ==
=== レベル3 ===
==== レベル4 ====
===== レベル5 =====
====== レベル6 ======
=== これもレベル3
=== これもレベル3 =
=== これもレベル3 ==
=== **解析** //しない// ===

XHTMLでの推奨:

<h1>レベル1(最大)</h1>
<h2>レベル2</h2>
<h3>レベル3</h3>
<h4>レベル4</h4>
<h5>レベル5</h5>
<h6>レベル6</h6>
<h3>これもレベル3</h3>
<h3>これもレベル3</h3>
<h3>これもレベル3</h3>
<h3>**解析** //しない//</h3>

リンク(内部、外部、Wiki間)

リンクは段落(さらにボールドやイタリック・テキストの内部)、リスト項目や表のセルの内部に現れることができる。リンクがボールドまたはイタリック・テキストの一部になっているならば、リンクもボールドまたはイタリックになる。リンクの内部のイメージはサポートされなければならない。リンクの中の他のマークアップの解析は必須ではない(オプション)

自由にあるURLを検出してリンクに変更するべきである。URLの末端のひとつだけの句読点記号(,.?!:;"')をURLの一部と考えてはならない。

あなたのwikiがwiki間リンクをサポートするならば、wikiの名前とページタイトルの前のコロンを入れることで他のwikiへのリンクを作成するべきである。例えば、[[WikiCreole:Creole1.0]]はこのWikiCreole wikiのCreole仕様へのリンクになるだろう。

Creole:

[[link]]
[[MyBigPage|Go to my page]]
[[http://www.wikicreole.org/]]
http://www.rawlink.org/, http://www.another.rawlink.org
[[http://www.wikicreole.org/|Visit the WikiCreole website]]
[[Weird Stuff|**Weird** //Stuff//]]
[[Ohana:WikiFamily]]

XHTMLでの推奨:

<a href="http://www.examplewiki.com/link">link</a>
<a href="http://www.examplewiki.com/MyBigPage">Go to my page</a>
<a href="http://www.wikicreole.org/">http://www.wikicreole.org/</a>
<a href="http://www.rawlink.org/">http://www.rawlink.org/</a>, <a href="http://www.another.rawlink.org">http://www.another.rawlink.org</a>
<a href="http://www.wikicreole.org/">Visit the WikiCreole website</a>
<a href="http://www.examplewiki.com/Weird_Stuff">**Weird** //Stuff//</a>
<a href="http://wikiohana.net/cgi-bin/wiki.pl/WikiFamily">Ohana:WikiFamily</a>

出力例:
link
Go to my page
http://www.wikicreole.org/
http://www.rawlink.org/, http://www.another.rawlink.org
Visit the WikiCreole website
**Weird** //Stuff//
Ohana:WikiFamily

段落

ひとつまたはそれ以上の空白行で段落を終了する。リスト、表、整形済みのブロックも段落を終了する。

Creole:

これは私のテキストです。

これは次のテキストです。

XHTMLでの推奨:

<p>これは私のテキストです。</p>
<p>これは次のテキストです。</p>

出力例:

これは私のテキストです。

これは次のテキストです。

改行

改行のための\\(wiki風)

Creole:

これは最初の行で、\\さらにこれが2つめの行です。

XHTMLでの推奨:

これは最初の行で、<br />
さらにこれが2つめの行です。

出力例:

これは最初の行で、
さらにこれが2つめの行です。

リスト

リスト(箇条書き)項目は行の先頭が * または # から開始する。* または # の前後の空白はオプションであるが、リストの要素がボールド・テキストから開始するならば、後ろに空白が必要である。リストの項目は、 * または # から始まる行、次の項目または下位のリスト、空白行、見出し、表または整形済みブロックで終了する。段落のように、複数行に跨ったり \\ で強制する改行を含むことができる。少なくとも5段階の深さのネスティングをサポートすることが推奨される。ボールド、イタリック、リンクならびに整形済みをリスト項目の中で使うことができるが、それらは複数のリスト項目に跨ることはできない。

番号なし箇条とボールドについて:上の行の任意のリスト要素の直後の(オプションである前後の空白を含めて)** から開始される行は、ネストした番号なし箇条として処理されるであろう。そうでなければ、それはボールドテキストの開始として処理されるであろう。

番号なしリスト

Creole:

* 項目1
** 項目1.1
* 項目2

XHTMLでの推奨:

<ul>
<li>項目1
  <ul>
  <li>項目1.1</li>
  </ul>
</li>
<li>項目2</li>
</ul>

出力例:

番号付きリスト

Creole:

# 項目1
## 項目1.1
# 項目2

XHTMLでの推奨:

<ol>
<li>項目1
  <ol>
  <li>項目1.1</li>
  </ol>
</li>
<li>項目2</li>
</ol>

出力例:

  1. 項目1
    1. 項目1.1
  2. 項目2

水平線

ハイフンの前後の空白はオプションであるが、それらの間には空白は許されない。4つのハイフンは、その行の(空白を除く)唯一の文字でなければならない。

Creole:

----

XHTMLでの推奨:

<hr />

インライン・イメージ

Creole:

{{myimage.png|これは私の画像です。}}

XHTMLでの推奨:

<img src="myimage.png" alt="これは私の画像です。" />

すべてのセルをひとつのパイプで分離する。行の先頭のセルの前には先行する空白を許し、行の最後には続行する空白を許す。最後のパイプはオプションである。表のセルの内部にリンク、ボールド、イタリック、改行および整形済みを埋め込むことができる。パイプの直接後ろに続く等号は見出しを定義する。見出しは水平または垂直に配置できる。表のマークアップのリストに詳細の比較がある。

Creole:

|=Heading Col 1 |=Heading Col 2         |
|Cell 1.1       |Two lines\\in Cell 1.2 |
|Cell 2.1       |Cell 2.2               |

XHTMLでの推奨:

<table>
<tr>
<th>Heading Col 1</th>
<th>Heading Col 2</th>
</tr>
<tr>
<td>Cell 1.1</td>
<td>Two lines<br />in Cell 1.2</td>
</tr>
<tr>
<td>Cell 2.1</td>
<td>Cell 2.2</td>
</tr>
</table>

出力例:

Heading Col 1 Heading Col 2
Cell 1.1 Two lines
in Cell 1.2
Cell 2.1 Cell 2.2

整形済み(非wiki)

整形済みはインラインまたはブロックとして働くことができる。すべてのwikiのマークアップは、(下に示すように)他の箇所ではエスケープ文字として使用されるチルダでさえも、これらの文字の間で解釈されない。ブロックとしては、先行する空白のない3つの波括弧だけの行が開きとなり、他の3つの波括弧だけの行が閉じのためになければならない。ブロックの内部では、文字はモノスペースで表示される。インラインの整形済みテキストについては、wikiの実装者がこのテキストを標準またはモノスペースのどちらで表示するかを決定することができる。

Creole:

{{{
//This// does **not** get [[formatted]] 
}}}

XHTMLでの推奨:

<pre>
//This// does **not** get [[formatted]]
</pre>

出力例:

//This// does **not** get [[formatted]]

Creole:

マークアップの一例: {{{** this ** }}}

XHTMLでの推奨:

マークアップの一例: <tt>** &lt;i&gt;this&lt;/i&gt; **</tt>

出力例:

マークアップの一例: ** <i>this</i> **

整形済みにおける閉じ括弧

整形済みの終了タグと考えられそうな箇所に閉じ括弧を含めるために、二つの追加規則がある:

Creole:閉じ括弧をもつインラインの整形済み:{{if (a>b) { b = a; }}}。3つの括弧を含む行をもつ整形済みブロック:

{{{
if (x != NULL) {
  for (i = 0; i < size; i++) {
    if (x[i] > 0) {
      x[i]--;
  }}}
}}}

エスケープ文字

エスケープ文字はチルダ(~)である。整形済みとURLの外部では、エスケープ文字は直後の文字、空白(文字または行送り)でないことを前提、のみをエスケープする。次に続く文字はそのままで可視化され、いかなるCreoleマークアップの一部でもありえない。

エスケープ文字はリンクの直後のURLを自動的に変換することや、wikiエンジンにサポートされる任意の類似の機構を無力化する。

コード例:

~#1
http://www.foo.com/~bar/
~http://www.foo.com/
CamelCaseLink
~CamelCaseLink

出力例:

#1
http://www.foo.com/~bar/
http://www.foo.com/
CamelCaseLink
CamelCaseLink

プレースホルダー

なにか先進のことがあるとき、ユーザがひとつより多くの文法をみて混乱しないように、プレースホルダが現れる。(wiki開発者のためのオプション)

これを、追加にあるプラグインの文脈と混同しないように注意すること。

Creole:

<<<×>>>

理由づけ:これは主にMediaWikiが特殊な文字を広範囲に渡って使用しており、Creoleのミックスモードを実装することが不可能になっているために開発された。角括弧(<<<×>>>)をマークアップに使っているwikiは数少ない。このマークアップはユーザがタイプ入力するよりも、むしろwikiエンジンに生成される。そこで、2つの角括弧によるマークアップをユーザが入力する拡張要素のために保留する目的で、2つのマークアップ文字ではなく3つの文字を使用している。

ボールドまたはイタリック

Creole:

//[[Important page|this link is italicized]]//
**[[Important page]]**
//**[[Important page]]**//

XHTMLでの推奨:

<em><a href="http://www.examplewiki.com/Important_Page">this link is italicized</a></em>
<strong><a href="http://www.examplewiki.com/Important_page">Important page</a></strong>
<em><strong><a href="http://www.examplewiki.com/Important_page">Important page</a></strong></em>

リストの中のボールド、イタリック、リンクと整形済み

Creole:

* **bold** item
* //italic// item
# item about a [[certain page]]
# {{{ //this// is **not** [[processed]] }}}

XHTMLでの推奨:

<ul>
<li><strong>bold</strong> item</li>
<li><em>italic</em> item</li>
</ul>
<ol>
<li>item about a <a href="http://www.examplewiki.com/certain_page">certain page</a></li>
<li><tt>//this// is **not** [[processed]]</tt></li>
</ol>

原文、参考


Copyright Creative Commons