1. トップ
  2. 書き方

記事およびコメントを書く際には、もちろん普通に文章を書くこともできますが、 wiki基本構文wikiプラグイン を使って文字を修飾したり表を作ったりと特殊な機能を使うことも可能です。
基本的には PukiWikiの文法・機能を踏襲していますが 違うところも多いため他のWiki構文に慣れている方も一度はご確認下さい。


まず最初に†部分編集

wikiの書き方は「行」が基本です。
文章かどうかの判定は行単位。表(テーブル)は一行ごとに表の枠の数を調べて表として結合するかどうか判定。各種リスト構造も引用も一行ごとに判定。一行プラグイン・複数行プラグインも行単位で判定。
これを頭の片隅に置いておくと記事を書くときも構文を知るときも少し楽になるかもしれません。

wiki基本構文、プラグイン、どちらも記述はとくに断りがない限りはすべて 半角の記号文字および英数文字 を使用します。
表示が期待通りにならないときはまずこの点を疑ってみてください。


wiki基本構文†部分編集

改行、太字、リンク付け、リスト構造などをいろいろな記号を使うことにより少しの手間で表現できます。
wiki基本構文 ひとつひとつの使い方こちら>wiki基本構文 をご覧下さい。


[+] なんでwiki基本構文とプラグインとで分かれてるの?

利用頻度( &plugin(){}; などと書くのは手間がかかる)、HTML構造との親和性、この2つが理由と考えています。
2016年現在すでに廃れてしまっていますが、太字、斜体、下線、打ち消し線、などはそれぞれ固有のHTMLタグを持っていました。リンク、表(テーブル)、リスト構造などは今もそのまま固有のHTMLタグを持っています。個別のHTMLタグを持っている要素には個別の記述方法を割り当てれば、HTMLを理解している人にとってはwiki文法も理解しやすく、またそうでない人もHTML構造を間接的に理解でき意識できるようになる、かもしれません。さらにwiki文法はHTMLを書きやすくするための文法であるのだから、PukiWikiではそのHTMLの基本要素であるHTMLタグをあらわすものをwiki基本構文とした……との理解のもと、やはり同様に考え、同様のやり方を採用しています。

プラグインはその名の通り簡単に付け外しできるものです。cWikiにおいても基本的にはいずれのプラグインも付け外しでき、また、プラグインが実現する機能は様々ですが、それは単独固有のHTMLタグ・HTML構文というわけではありません*0

このようなよくわからない理由によって、wiki基本構文とプラグインに分かれています。

[+] でもよく考えると

たとえば &br; &hr; &img(); などは、それぞれ単独で <br> <hr> <img>というHTMLタグが存在していたりもします。該当するのはこれくらいといえばこれくらいですが……


プラグイン†部分編集

プラグインには4つの種類があり、それぞれ書き方と有効範囲が異なっています。
それぞれのプラグインの種類名から、プラグインの一覧・プラグインごとの使い方を確認できます。

各プラグインの説明ページでは使い方の説明とともに以下のようなかたちで書式が掲示されています。

書式: &color( 文字色指定 [, 背景色指定 ] ){ 色変更を適用させる文章 };

この書式において ( )(丸括弧)で囲まれた範囲はオプショングループ1、{ }(大括弧)で囲まれた範囲はオプショングループ2と呼びます。
オプショングループとは、1つ以上のオプションを ,(カンマ)区切りで指定するための括りです。
オプションとは、プラグインの動作を設定するためのキーワードやプラグインの対象となる文章など、プラグインに引き渡す命令のようなものです。
また、この書式において [ ](角付き括弧)で囲まれた範囲は、書かなくてもいいけど書いてもいい、任意のオプションであることをあらわします。
たとえば上記の例の場合、「文字色指定」は必須のオプションで、「背景色指定」は任意のオプションとなります*1


アクションプラグイン
editやcomment_insertなど、URLに cmd=ほにゃらら と付いているものがこれです。
文章中に直接書くことはほとんど無いでしょう。
行内プラグイン
行の内側に書くプラグインです。文章の構成要素の1つと言い換えることもできます。
書き方は & 記号、プラグイン名、 ; セミコロン が基本です。&color(red,white){文章}; のように丸括弧・大括弧を併用する場合もあれば、いずれも省略できる &br; のような場合もあります。
行内プラグインの中にいくつも行内プラグインを書く、表(テーブル)の中に書く、などもできますが行をまたいで書くことはできません。
一行プラグイン
一行丸ごとを占めるプラグインです。文章の先頭に # 記号を、次いで プラグイン名を書き、さらに必要に応じて () や {} を併用します。
性質上wiki基本構文や行内プラグインの内部に書くことはできません。
複数行プラグイン
一行プラグインと似ていますが、 #プラグイン名(start) と #プラグイン名(end) で囲まれた範囲がプラグインの対象になります。典型的には #region など。

wiki基本構文やプラグインに使われる記号そのものを書きたいときは†部分編集

数値文字参照 と呼ばれる書き方を使いましょう。たとえばwiki基本構文に使われている記号は以下の通りです。

記号 書き方 記号 書き方
# &#x23; ; &#x3b;
% &#x25; < &#x3c;
& &#x26; = &#x3d;
' &#x27; > &#x3e;
( &#x28; ? &#x3f;
) &#x29; @ &#x40;
* &#x2a; [ &#x5b;
+ &#x2b; ] &#x5d;
, &#x2c; ` &#x60;
- &#x2d; { &#x7b;
. &#x2e; | &#x7c;
/ &#x2f; } &#x7d;
: &#x3a; ~ &#x7e;


  • *0 容易に付け外しできないコアの機能なのに諸々の都合上やむなくプラグイン形式で作成している機能もいくつかありますが
  • *1 この例では実際には文字色指定を省略しても「色変更を適用される文章」はそのまま問題なく表示されるため、必須と呼ぶのはすこしおかしいかもしれませんが……省略した場合は&color;プラグインとして機能していないということでもあります。あまり気にしないで下さい。

このページのタグ一覧 タグ編集 タグ検索
登録済みタグはありません