本文 編集 履歴 ソース 差分 最近の更新 VikiWikiとは

VikiWiki - WikiCreoleStyleHelpPage

Creole v1.0の仕様(2007-Jul-04)です。今後二年間はこのままの仕様とします。もっと詳しく知りたい方はRoadmap to Creole 1.0?、Creole 1.0 Poll?、reasoning?も見てください。あなたのWikiエンジンの実装のCreoleの適合度はCreole 1.0 Test Cases?でチェックしてください。

Creole 0.6?からの変更点:

[{TableOfContents title='Overview'}]

ボールドとイタリック

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

ボールド

クレオール: **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>

出力例:

ボールドイタリック こうする ことも できます。

許容できないもの:

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

見出し

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>

リンク - 内部、外部、Interwiki

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

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

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

クレオール:

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

パラグラフ

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

クレオール:

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

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

推奨されるXHTML:

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

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

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

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

改行

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

クレオール:

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

推奨されるXHTML:

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

出力例:

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

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

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

リスト

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

順序なしリスト

クレオール:

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

推奨されるXHTML:

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

出力例:

順序つきリスト

クレオール:

# アイテム 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で順序つきリストとして使われています。その他の詳細?

水平線

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

クレオール: ---- 推奨されるXHTML: <hr />

画像(インライン)

クレオール: 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

Nowiki(整形済み)

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

クレオール:

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

推奨されるXHTML:

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

出力例:

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

クレオール:

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

推奨されるXHTML:

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

出力例:

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

nowiki内の閉じ大括弧

nowikiまたは整形済み部分の終了タグとみなされる位置に閉じ大括弧を含めるには、2つの追加ルールがあります。

整形済みブロックでは、マーカーは先頭にスペースがあってはいけないので、整形済みブロック中の3つの閉じ括弧がある行は、少なくとも1つのスペースに続くようにするべきです。レンダリングされた結果は1つのスペースが取り除かれています。

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

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

エスケープ文字

~)です。nowikiと整形済み、URL以外の場所では、エスケープ文字はその直後に与えられた、空白(空白または改行)以外の文字だけをエスケープします。 後続の文字は、そのまま表記されて、どのクレオールのマークアップの一部になりません。

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

すぐにリンク、およびwikiエンジンによってサポートされたどんな同様のメカニズムにも続いて、拡張文字はURLの自動変換を無効にします。

エスケープ文字は、Wikiエンジンでサポートされたリンクや同様のメカニズムの直後に続くURLの自動変換を無効にします。(キャメルケースのWikiワード、著作権の表記など)

コード例:

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

出力例:

#bhCamelCaseLink

Placeholder

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

クレオール: <<<x>>>

ボールと及び/またはイタリックリンク

クレオール:

//[[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. //これ// は **処理** [[されません]]