okilab.jp > プロジェクト > ドキュメント > 和訳 > WikiCreole: Creole 1.0 (和訳)
この文書は、WikiCreole Wikiにおいて公開されている、WikiCreole: Creole 1.0を和訳したものです。同ページの2007/06/18 21:15:40時点のものを原文としています。
この文書は、原文と同様、Creative Commons BY-SA 1.0の元で公開されます。
文書名WikiCreole: Creole 1.0 (和訳)
原文WikiCreole: Creole 1.0
和訳者塚本 牧生 <tsukamoto@gmail.com>
公開者okilab.jp
ライセンスCreative Commons BY-SA 1.0(原文に準拠)

WikiCreole: Creole 1.0

これはクレオールのv1.0仕様として提案(2007-05-09)されたもので、2007-06-13までは議論の下にあります。更なる情報として、クレオール1.0へのロードマップCreole 1.0の投票、そして考えも参照してください。クレオール0.7は破棄されているのでご注意ください。

Creole 0.6からの変更点:

  • ブレットリスト(bullet list、順序なしリスト)のハイフンはアスタリスクに置き換えられました
  • interwikiリンクが追加されました
  • プレースホルダーには3つの角括弧<<<>>>を、2文字の代わりに使います
  • エスケープ文字をコアに追加します(Creole 1.0の投票で要求されました)
  • エスケープ文字が変更されたため、これは続く文字だけをエスケープします(Creole 1.0の投票で要求されました)
  • nowikiエスケープを3重の曲括弧で閉じるのは、これがエスケープ文字でカバーされるので、削除されました
  • URLの前にチルダを置くと、これがリンクになるのを防ぎます。

ボールドとイタリック

ボールド(太字)とイタリック(斜体)テキストはパラグラフ、リストアイテム、表のセル内で使用できます。ボールドおよび/またはイタリックテキストの内側に現れるリンクは、これもボールドおよび/またはイタリックになるべきです。ボールド/イタリックテキストはパラグラフ、リストアイテム、表のセルの終わりで終了します -- したがって、これらの複数にまたがることはできません。

ボールド

クレオール:

 **bold** 

推奨されるXHTML:

 <strong>bold</strong> 

出力例: bold

論拠:スター(*)はライン上でテキストを強調するのに最も多く使われているシンボルです。クレオールでは、そう解析されるべきではないところで偶然に解析されることを避けるために、二重のシンボルが使われます。その他の詳細

イタリック

http:またはftp:の直後ではイタリック処理は無視してください。

クレオール:

 //italics// 

推奨されるXHTML:

 <em>italics</em> 

出力例: italics

論拠: スラッシュ(/)は傾斜しているイタリックに似ており、したがって直感的で覚えやすいです。その他の詳細

クレオール:

ボールドとイタリックは //ラインを
またぐ// ことができます。

しかし、 //パラグラフを...

...またぐ// ことはできません。

推奨されるXHTML:

<p>
ボールドとイタリックは <em>ラインを
またぐ</em> ことができます。
</p>
<p>
しかし、 //パラグラフを...
</p>
<p>
...またぐ// ことはできません。
</p>

出力例:

ボールドとイタリックは ラインを
またぐ
ことができます。

しかし、 パラグラフを...

...またぐ ことはできません。

ボールドイタリック

クレオール:
**//ボールドイタリック//**
//**ボールドイタリック**//
//こうする **ことも** できます。//

推奨されるXHTML:

<strong><em>ボールドイタリック</em></strong>
<em><strong>ボールドイタリック</strong></em>
<em>こうする <strong>ことも</strong> できます。</em>

出力例:

Bold italics
Bold italics
This is also good

許容できないもの:

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

リスト

ボールド、イタリック、リンク、nowikiをリストアイテム内で使えますが、これらは複数のリストアイテムにまたがることはできません。 *または#文字の前後の空白は任意ですが、しかし後ろの空白は、リスト要素をボールドテキストではじめる時には必要です。 リスト要素は行末で終わりますが、\\で強制的に改行を含ませることもできます。 5段階までのネスト(入れ子)の深さをサポートすることが推奨されます。 *または#(任意に空白が前にあってもよい)で始まらない行でリストは終了します。

順序なしリストとボールドについて: **(前後に任意で空白があるものを含む)で始まり、この行において直後に何らかのリスト要素が続く行は、ネストした順序なしリスト要素として扱われます。それ以外は、ボールドテキストとして扱われます。ボールドおよび/あるいはイタリックはリスト上の複数行にまたがることができないことにも注意してください。

順序なしリスト

クレオール:

* アイテム 1
** アイテム 1.1
* アイテム 2

推奨されるXHTML:

<ul>
<li>アイテム 1
  <ul>
  <li>アイテム 1.1</li>
  </ul>
</li>
<li>アイテム 2</li>
</ul>

出力例:

論拠: Wikiエンジンの大多数はブレットリスト(順序なしリスト)の指示にアスタリスク(*)を使用します。 サブリストを複数のアスタリスクにするアプローチは、最初のWikiのサブリストの記法です。 サブリストのレベルが行頭の空白の数で決められる場合のように、ユーザーは行頭の空白を数える必要はありません。 もし書き手が希望するならば、クレオールマークアップを明瞭なものにするために、行頭に空白を入れるのは自由です。 その他の詳細

順序つきリスト

クレオール:


# アイテム 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

論拠: 番号記号(#)は大半のWikiで順序つきリストとして使われています。その他の詳細

見出し

3つの異なるサイズのレベルの見出しだけが要求されます。閉じる(右側の)等号は任意で、バランスをとる必要はなくて、発生する見出しの種類に影響を与えません。左側の等号の前には空白は許されません。閉じる等号の後には空白文字だけが許されます。見出し内のマークアップの解析は任意です。

クレオール:

= レベル1 (largest) =
== レベル2 ==
=== レベル3 ===
==== レベル4 ====
===== レベル5 =====
====== レベル6 ======
=== これもレベル3
=== これもレベル3 =
=== これもレベル3 ==
=== **解析** //されません// ===

推奨されるXHTML:

<h1>レベル1 (largest)</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のヘッダのマークアップとして最も一般的です。より小さな見出しにより多くの等号としているので、小見出しがよりインデントされるのは、マークアップだけでも視覚効果を得やすくします。多くのWikiエンジンでは必要としないので、クレオールをより柔軟に、閉じる等号は任意とします。その他の詳細

リンク - 内部、外部、Interwiki

リンクはパラグラフ内にも(ボールドやイタリックテキストの内部でも)、リストアイテム内にも、そして表のセル内にも現れることができます。リンクは、ボールドまたはイタリックテキストの一部であれば、やはりボールドまたはイタリックになります。最低限、リンク内の画像はサポートされなければなりません。リンク内の他のマークアップの解析は要求されません(任意です)。

自由な位置にあるURLは検出され、リンクに変換されるべきです。URLの末尾にある句読点(,.?!:;"')は、URLの一部とみなすべきではありません。

もしあなたのWikiがInterwikiリンクをサポートするなら、他のWikiへのリンクは、Wiki名と、ページ名の先頭にコロンを置くように作成されるべきです。例えば、[[WikiCreole:Creole1.0]]というリンクは、このWikiCreoleWikiのクレオール仕様にリンクします。

クレオール:

[[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

論拠: ほぼすべてのWikiが四角括弧([[]])をリンクの作成に使います。二重の四角括弧は四角括弧をリンクに変換される恐れなく自由に使うことを許します。その他の詳細

パラグラフ

1行またはそれ以上の空行がパラグラフの終わりです。リスト、表、nowikiブロックもパラグラフの終わりになります。

クレオール:

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

これは追加テキストです。

推奨されるXHTML:

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

<p>これは追加テキストです。</p>

出力例: これは私のテキストです。

これは追加テキストです。

論拠: 新しいパラグラフを始めるのにマークアップタグは不要であるべきです。その他の詳細

改行

\\ (wikiスタイル)で改行です。

クレオール:

これは一行目で\\そしてこれは二行目。

推奨されるXHTML:

これは一行目で<br />
そしてこれは二行目。

出力例:

これは一行目で
そしてこれは二行目。

クレオール:

* これは単一のリストアイテムで
パラグラフが続く?

推奨されるXHTML:

<ul>
<li>これは単一のリストアイテムで</li>
</ul>
<p>
パラグラフが続く
</p>

出力例:

パラグラフが続く

論拠: blogスタイル vs. wikiスタイル
blogスタイルとwikiスタイル(レガシースタイル)の改行のどちらを使うかについては長い議論がありました。我々は、当初blogスタイルの改行(改行があれば行を改める)を推奨していたのを変えて、クレオール0.3からはWikiスタイルの改行を推奨することを決めました。Wikiは強制的な改行の記法 \\ をサポートしなければいけません

クレオール0.3スタイル(blogスタイル)の改行を実装したエンジン開発者には、その実装を無駄にするのではなく、管理者が自分のインストールしたものをどちらのモードで走らせるかを選択できるようなオプションを追加することを奨励します。こうすることで、blogスタイルの改行をもっと経験してもらいたいと望んでいます。blogスタイルの改行モードでも、強制改行記法はサポートされなければいけません。こうすることで、人々が強制改行文字を持つWikiからテキストをコピーした時に、改行は適切に移行されます。その他の詳細

Nowiki(整形済み)

これはインラインでもブロックでも動作します。Wikiマークアップは、これらの文字列の間では処理されません、他の場所ではエスケープキャラクタとして使われるチルダでさえもです(下記参照)。ブロックとしては、1行内に三重の曲大括弧が開始位置として、別の行に三重の曲大括弧が終了位置として、先頭に空白を含まずにあります。ブロック内では、文字は等幅で表示されます。インラインnowikiテキストでは、wiki実装者はこのテキストを通常通りに表示するか等幅で表示するか決めることができます。

クレオール:

{{{
//これ// は **整形** され [[ません]] 
}}}

推奨されるXHTML:

<pre>
//これ// は **整形** され [[ません]]
</pre>

出力例:

//これ// は **整形** され [[ません]]

クレオール:

マークアップの例: {{{** <i>これ</i> ** }}}

推奨されるXHTML:

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

出力例:

マークアップの例: ** <i>これ</i> **

nowiki内の閉じ大括弧

nowikiまたは整形済み部分の終了タグとみなされる位置に閉じ大括弧を含めるには、インラインでもブロックでも機能する追加ルールが一つあります: 三重の閉じ曲括弧の前にチルダを置くとエスケープされます(nowikiでは他のチルダはエスケープにならないにも拘らずです)。

{{{
閉じ大括弧を含むインラインのnowiki: {{{if (a>b) { b = a; ~}}}.

三重の閉じ大括弧を含む行を持つ整形済みブロック:

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

論拠: ユーザーにはWikiエンジンによって整形されないテキストの入力方法があるべきです。三重の曲括弧( {{{}}} )は、その視認性と、"code"それ自体の中でも出現しそうにないことから選ばれました。nowiki全般の中でチルダがエスケープされないことは、コード例を使うのを助けますし、それはもっとも頻繁な使用例でしょう。nowiki内で、三重の曲大括弧をチルダでエスケープすることで、nowikiをエスケープすることは、全体的なスケープのルールと矛盾しませんし、新しくもありません。その他の詳細;

水平線

複数のハイフンの前後の空白は任意ですが、それらの間には空白は許されません。この行には(空白を除けば)4つのハイフンだけでなければなりません。

クレオール:

 ---- 
推奨されるXHTML:
 <hr /> 

論拠: すべてのWYSIWYGではないWikiが、水平線を指示するのに複数のハイフン(----)を使っています。その他の詳細

画像(インライン)

クレオール:

 {{myimage.png|this is my image}} 

推奨されるXHTML:

 <img src="myimage.png" alt="this is my image"/> 

論拠: 最も共通的な画像マークアップは、リンクと矛盾ない同じ内部構造を持った、二重の曲括弧( {{}} )でした。その他の詳細

すべてのセルは単一のパイプで区切られます。行の最初のセルの前には空白は許されません。最後のパイプは任意です。リンク、ボールド、イタリック、改行、そしてnowikiを表のセルに埋め込めます。パイプの直後にある等号は見出しを定義します。見出しは横方向または縦方向にアレンジできます。比較の詳細は表のマークアップのリストにあります。

クレオール:

|=カラム1の見出し |=カラム2の見出し  |
|セル 1.1         |セル 1.2内に\\2行 |
|セル 2.1         |セル 2.2          |

推奨されるXHTML:

<table>
<tr>
<th>カラム1の見出し</th>
<th>カラム2の見出し</th>
</tr>
<tr>
<td>セル1.1</td>
<td>セル1.2内に\\2行</td>
</tr>
<tr>
<td>セル2.1</td>
<td>セル2.2</td>
</tr>
</table>

出力例:
カラム1の見出し カラム2の見出し
セル1.1 セル1.2内に
2行
セル2.1 セル2.2

論拠: 大半のWiki単一または二重のパイプを表のセルを区切るのに使います。単一のパイプ(|)は二重のパイプより空間をうまく使えますし早く入力でき、そしてパイプは表のセル内では頻出しません。その他の詳細

Placeholder

より進んだものである時は、プレースホルダが現れるので、ユーザは一つ以上の記法を見て混乱することがなくなります(Wiki開発者にとっては任意です)。

ノート: これとAdditionsにあるplug-inの記法で混乱しないように。

クレオール:

 <<<x>>> 

論拠: これは主として、Mixed Creoleモードの実装を事実上不可能にしてしまう、MediaWikiの特殊文字の大規模な使用のために開発されました。角括弧(<<<>>>)をマークアップに使用するWikiはわずかにしかありません。このマークアップはユーザによって入力されるよりむしろWikiエンジンによって生成され、したがって二重の角括弧によるマークアップはユーザが入力するような拡張要素のために予約しておくことにし、二文字ではなく三文字を使用します。その他の詳細.

エスケープ文字

nowikiと整形済み以外の場所では、エスケープ文字はその直後に与えられた、英字(a-zまたはA-Z)、数字(0-9)あるいは空白(空白または改行)以外の文字だけをエスケープします。

もしWikiがCamelCaseをサポートするなら、CamelCaseフレーズの前に置かれたチルダは、そのようなフレーズがリンクになるのを防ぐことが推奨されます。もしWikiがCamelCaseをサポート *しない* なら、コンテンツをあるWikiエンジンから別のものに移しやすいように、CamelCaseフレーズの前のチルダは表示されないことが推奨されます。URLの前にチルダを置いた場合も、URLはリンクにならないべきです。

コード例:

CamelCaseLink
~CamelCaseLink

出力例:

CamelCaseLink
CamelCaseLink

論拠: ある人がテキスト内でしばしばキーボードキャラクターが必要になるとすると、テキストを意図通りに働かせるための三重曲大括弧に迷わされることが多くなるでしょう。したがって、エスケープ文字は人々をインラインのnowikiで迷わされることから助け、エスケープ文字を代わりに使えるようにします。あまり登場しない文字という関係から、チルダが選択されており、したがって改行のバックスラッシュとは衝突しません。これは必ずしも入力しやすくはありませんが、しかしこれはそうしばしば使う必要もなく、したがってこの意味で適してもいます。この方法で、スター(アスタリスク)、スラッシュ、そして他の原文に現れたマークアップ文字が、それ自身として表示されるように簡単にエスケープできます。理由

クレオール:
//[[Important page|この リンクは イタリックに なります]]//
**[[Important page]]**
//**[[Important page]]**//

推奨されるXHTML:

<em><a href="http://www.examplewiki.com/Important_Page">この リンクは イタリックに なります</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>

出力例: この リンクは イタリックに なります
Important page
Important page

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

クレオール:
* **ボールド** アイテム
* //イタリック// アイテム
# [[certain page]]に ついての アイテム
# {{{ //これ// は **処理** [[されません]] }}}

推奨されるXHTML:

<ul>
<li><strong>ボールド</strong> アイテム</li>
<li><em>イタリック</em> アイテム</li>
</ul>
<ol>
<li><a href="http://www.examplewiki.com/certain_page">certain page</a>に ついての アイテム</li>
<li><tt>//これ// は **処理** [[されません]]</tt></li>
</ol>

出力例:

  1. certain pageに ついての アイテム
  2. //これ// は **処理** [[されません]]