このページでは、この Wiki エンジンの Wiki ルールについて説明しています。ちなみに、このページ自体が、本 Wiki Engine を使って生成されています。
目次
コンテンツを作成する際にWiki文法というものに従って書いて作成します。ご存じない方のために簡単に説明しますと（すでにご存知の方はこの部分を飛ばしてください）、イメージとしてはブログに記事を書く場合と似ています。
たとえばブログは難しいことを考えずにテキストを打ち込んで、ちょっと整えればちゃんと記事になってくれます。自分でHTMLを書く場合と比べると簡単です。Wiki文法でコンテンツを用意する場合も似たようなイメージです。
上記の例での、「ちょっと書き足す」際の書き方のルールがWikiルールです。簡単な例で説明してみましょう。
吾輩は猫である 夏目漱石 吾輩（わがはい）は猫である。名前はまだ無い。 どこで生れたかとんと見当（けんとう）がつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。吾輩はここで始めて人間というものを見た。
と、キーボードから打ち込んだとしましょう。すると、
吾輩は猫である
夏目漱石
吾輩（わがはい）は猫である。名前はまだ無い。
どこで生れたかとんと見当（けんとう）がつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。吾輩はここで始めて人間というものを見た。
と表示されます。しかしそのまま表示したのでは面白くありませんので、以下のようにちょっと手を加えてみたいと思ったとします。
その場合にキーボードから入力するものは以下のようになります。少しだけ書き換わっていることに注意してください。
*吾輩は猫である CENTER:夏目漱石 ---- 吾輩（わがはい）は猫である。名前はまだ無い。 どこで生れたかとんと見当（けんとう）がつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。吾輩はここで始めて人間というものを見た。
説明は後ほど行いますので、今は「何かちょっと書き足すだけで何かが起こるらしい」という点に注目してください。
表示すると以下のようになります、
吾輩は猫である
吾輩（わがはい）は猫である。名前はまだ無い。
どこで生れたかとんと見当（けんとう）がつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。吾輩はここで始めて人間というものを見た。
どうでしょうか、（このレイアウトのセンスがどうかという点はさておいて）ちょっと書き足しただけで簡単にそれなりのものが出来上がってしまいました。
まずは詳細な説明をする前に、ルールを簡単に一覧にしてみたいと思います。
難しいものではありませんので、これらを眺めながら実際に試していただければそれだけで覚えられると思います。
* 大見出しとして表示されます ** 中見出しとして表示されます *** 小見出しとして表示されます
大見出しとして表示されます
中見出しとして表示されます
小見出しとして表示されます
LEFT:この文書は左揃えで表示されます。 CENTER:この文書は中央揃えで表示されます。 RIGHT:この文書は右揃えで表示されます。 ''この部分は強調文字になります'' '''この部分は斜体になります''' %%この部分は取り消し線表示されます%% ((この部分は注釈あつかいになり、その場所では表示されず文末に表示されます))
> こうやって書くと字下げ（引用表現）されます >> こうやって書くとさらに字下げされます >>> こうやって書くとさらにさらに字下げされます
こうやって書くと字下げ（引用表現）されますこうやって書くとさらに字下げされますこうやって書くとさらにさらに字下げされます
- リスト（項目が列挙されたもの）になります -- リストの中にリストがあるもの（入れ子になったもの）になります --- さらにその中のリストになります
+ 番号付きリストになります ++ 番号付きリストの中にある番号付きリストになります +++ さらにその中に番号つきリストになります
:見出し付きリスト|見出し付きのリスト内容
ハイフンを四つかくと水平線が（横に長い区切り線）が表示されます
----
以下のように入力すれば表になって表示されます。
|内容|内容|内容|内容|内容| |内容|内容|内容|内容|内容| |内容|内容|内容|内容|内容|
あるいはこのような入力も表として表示されます
,内容,内容,内容,内容,内容, ,内容,内容,内容,内容,内容, ,内容,内容,内容,内容,内容,
| 内容 | 内容 | 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 | 内容 | 内容 |
リンク先のURLもしくはEMAIL文字列をそのまま書いておけば、自動的に認識されてリンクが貼られます。たとえば、http://4dd.co.jp/ と書けば、<a href="http://4dd.co.jp/">http://4dd.co.jp/</a>となります。
リンク文字列として表示する文字列、リンク先を自分で設定してリンクを貼ることが出来ます。書式とその場合の処理結果は以下の通りです
[[リンク名>URLもしくはEMAIL文字列]]
<a href="http://www.4dd.co.jp">リンク名</a>
WikiにはWikiの内部ページに対してリンクを貼る機能があります。外部向けと違うのはWiki内部での「ページ名」あるいはWikiName（これについてはここでは知らなくても問題ありません）でリンクがれて便利な点です。
[[ページ名]]
[[別名>ページ名]]
WikiName文字列
独自の機能であるプラグインも、同様の方法で文章内に記述を行って埋めこみます。具体的にどのようなプラグインがあるかについては、プラグインのページを参照してください。以下には、プラグインの一般系だけを示しておきます。
&プラグイン名(引数){インライン要素};
#プラグイン名(引数)
ここからは専門的な説明になります。理解できなくても Wiki は十分に使えますので、解らなければ飛ばしてください。
Wiki の文法は、ブロック要素とインライン要素の二つに大別されます。ブロック要素は段落やリストなどの構文構造、インライン要素は強調やリンクなどの文修飾です。それ以外にはコメントがあり、これは行頭で // を指定する事により、その行をコメントすることが可能です。
また拡張機能としてプラグインが提供されており、ブロック要素として利用可能なプラグインと、インライン要素として可能なプラグイン、両方で利用可能なプラグインがあります。プラグインに関しては プラグインルールをご覧下さい。
尚、下記の説明文中のHTMLの例では、実際に出力される属性値等までは記述していませんので、ご注意下さい。
ブロック要素は特に明記が無い場合には、他のブロック要素及び、インライン要素を子要素に持つことが出来ます。また、空行により、ブロック要素は区切られます。つまり、テーブルやリスト等の繰り返し構造を持つもの以外の段落や引用等は空行が出現するまで、一つのブロック要素と判別されます。
インライン要素
指定の無いインライン要素は全て段落となります。また行頭で~を指定した場合には、他のブロック要素の開始文字(,-,+,:,|,#) をエスケープすることが可能です。
HTML での表示は以下のようになります。
<p>インライン要素</p>
> インライン要素
>で始まる行は引用となります。引用は>を三つまで重ねる事で三段階指定が可能です。
HTML での表示は以下のようになります。
<blockquote>インライン要素</blockquote>
リストには、以下の三つのタイプがあります。
- インライン要素
-で始まる行はリストとなります。リストは-を三つまで重ねる事で三段階指定が可能です。
HTML での表示は以下のようになります。
<ul> <li>インライン要素</li> </ul>
+ インライン要素
+で始まる行はリストとなります。リストは+を三つまで重ねる事で三段階指定が可能です。
HTML での表示は以下のようになります。
<ol> <li>インライン要素</li> </ol>
-と+によるリストは複合指定も可能です。
インライン要素|インライン要素
上記の指定で、:と|で囲まれたインライン要素が定義語、|の後のインライン要素が説明文となる定義リストとなります。
複数行の指定では定義語を省略する事が可能です。
HTML での表示は以下のようになります。
<dl> <dt>インライン要素</dt> <dd>インライン要素</dd> </dl>
テキスト
空白で始まる行は整形済みテキストとなります。空白以降はどのようなテキストであっても、そのまま表示されます。インライン要素を指定しても変換されないので、注意してください。
HTML での表示は以下のようになります。
<pre>インライン要素</pre>
* インライン要素
* で始まる行は見出しとなります。見出しは*を三つまで重ねることによって、三段階指定が可能です。
HTML での表示は以下のようになります。
<h2>インライン要素</h2>
テーブルの指定には二つの方式があります。
|インライン要素|インライン要素|インライン要素|
|と|で区切られたインライン要素は全体として一つのテーブルとなります。以下の拡張指定が可能です。また複数指定も可能です。
サイズには数字が指定可能です。色には、アルファベットによる色指定もしくは、#で始まる16進数指定が可能です。また、インライン要素の変わりに以下の拡張指定が可能です。以下は単独で指定しなければなりません。
,インライン要素,インライン要素,インライン要素,
,と,で区切られたインライン要素は全体として一つのテーブルとなります。以下の拡張指定が可能です。また複数指定も可能です。
インライン要素の変わりに以下の拡張指定が可能です。以下は単独で指定しなければなりません。
==を指定することで、右の行の要素と連結します。連続してこれを指定すると複数行の連結も可能です。
どちらの指定方式でも HTML での表示は以下のようになります。
<table> <tbody> <tr> <td>インライン要素</td> <td>インライン要素</td> <td>インライン要素</td> </tr> </tbody> </table>
----
四つ以上の-で始まる行は罫線となります。この後にどのようなテキストを書いても無視されます。
HTML での表示は以下のようになります。
<hr/>
LEFT: インライン要素
CENTER: インライン要素
RIGHT: インライン要素
LEFT:,CENTER:,及び RIGHT:で始まる行は、位置指定テキストとなります。各々左寄せ、中央寄せ、及び右寄せとなります。
HTML での表示は以下のようになります。
<div align="left">インライン要素</div>
<div align="center">インライン要素</div>
<div align="right">インライン要素</div>
FLEFT(幅): ブロック要素
FRIGHT(幅): ブロック要素
FLEFT,及び FRIGHT で始まる行は、位置指定テキストとなります。但し LEFT: 及び RIGHT: と異なるのは、CSS の float:left 及び float:right を出力する点となります。
描画に大きな影響を与えますので、この利用の後は clear プラグインを利用して適切に float をクリアして下さい。また、幅は省略可能な引数で、ピクセル数にて幅指定が可能です。
HTML での表示は以下のようになります。
<div style="float:left;">ブロック要素</div>
<div style="float:right;">ブロック要素</div>
#プラグイン名(引数)
#で始まり、プラグイン名を指定すると、指定のプラグインが呼び出されます。()で囲む事により、引数を指定する事も可能です。
()だけを指定し、引数を指定しない場合はプラグインとして処理されません。また、引数はカンマで区切る事で複数指定も可能です。引数がない場合に、()は省略可能です。
引数に利用可能な文字は、",#,＆;,(,),[,],<,>,カンマ,改行<strong>以外</strong>の文字です。各々のプラグインの機能については、[[プラグインルール>plugin.html]のページをご覧下さい。尚、指定したプラグインが提供されていない場合には、そのまま入力したものが表示されます。
インライン要素はブロック要素の構成要素となります。
テキスト
特に文字修飾をしないテキストです。そのまま表示されます。
''インライン要素''
'''インライン要素'''
''でインライン要素を囲むと強調に、'''で囲むと斜体になります。
HTML での表示は以下のようになります。
<strong>インライン要素</strong>
<em>インライン要素</em>
%%インライン要素%%
%%でインライン要素を囲むと取り消し線となります。
HTML での表示は以下のようになります。
<del>インライン要素</del>
((インライン要素))
((と))でインライン要素を囲むと注釈となります。注釈は、本文中に注釈へのリンクを作成し、文末にまとめて注釈が表示されます。
HTML での表示は以下のようになります。
<a href="#注釈のNAME">(*注釈番号)</a> : (本文) <hr/> <a id="注釈のNAME">インライン要素</a>
リンクには以下の5つの指定が可能です。
[[ページ名]]
とで囲まれた文字列はページ名となります。そのページ名のWikiページが存在すればそれに対するリンクが、なければ、?が表示された上で、そのページ名で新規ページを作成するリンクが生成されます。
HTML での表示は以下のようになります。
<a href="ページ閲覧URL">ページ名</a>
[[別名>ページ名]]
上記のページ名に対し、別名を指定します。。
HTML での表示は以下のようになります。
<a href="ページ閲覧URL">別名</a>
[[リンク名>URLもしくはEMAIL文字列]]
[[リンク名:URLもしくはEMAIL文字列]]
URLもしくはEMAIL文字列に対して、リンク名を指定します。
HTML での表示は以下のようになります。
<a href="URLもしくはEMAIL">リンク名</a>
EMAIL文字列の場合には、mailto:が付加されます。
WikiName文字列
アルファベットの大文字一文字以上で始まり、その後にアルファベット小文字が続く文字列が連続するうような文字列はWikiNameとなります。そのWikiNameのページが存在すればそれに対するリンクが、なければ、?が表示された上で、そのWikiNameで新規ページを作成するリンクが生成されます。
HTML での表示は以下のようになります。
<a href="ページ閲覧URL">WikiName</a>
URLもしくはEMAIL文字列
URLもしくはEMAIL文字列を指定します。
HTML での表示は以下のようになります。
<a href="URLもしくはEMAIL">URLもしくはEMAIL</a>
EMAIL文字列の場合には、mailto:が付加されます。
＆プラグイン名(引数){インライン要素};
＆で始まり、プラグイン名を指定すると、指定のプラグインが呼び出されます。()で囲む事により、引数を指定する事も可能です。()だけを指定し、引数を指定しない場合はプラグインとして処理されません。また、引数はカンマで区切る事で複数指定も可能です。引数がない場合に、()は省略可能です。また、{}で囲む事により、インライン要素を子要素にする事も可能です。子要素がない場合に、{}は省略可能です。
引数に利用可能な文字は、",#,＆,(,),[,],<,>,カンマ,改行 以外 の文字です。各々のプラグインの機能については、プラグインルールのページをご覧下さい。尚、指定したプラグインが提供されていない場合には、そのまま入力したものが表示されます。