1. トップ
  2. 書き方
  3. wiki基本構文一覧


編集コメント†部分編集

編集コメントとして記述した文章は、通常のページ表示時には表示されず、しかし編集画面や編集履歴画面を開くと確かに書かれている、というものになります。
編集コメントには一行のみと複数行の2つの書き方があります。


// 行の先頭に / スラッシュ記号を2つ連続で記述すると、その行全体が編集コメントになります


/*
 /* と */ で囲まれた文章は複数行編集コメントになります
 何行でも複数行編集コメントとして記述できますが、入れ子構造にはできません
 行の途中だろうがなんだろうがおかまいなしに複数行コメント構文を検知し見つけ次第その部分を抹消します
*/

HTMLの仕様としてのコメントタグ <!-- -->と 違い、上記のように編集コメントとして記述した文章は、通常のページ表示はもちろん通常ページ表示中のHTMLソースにも全く表示されなくなります。


改行と段落†部分編集


段落・改行・文章の扱いをまとめると……
【1行以上連続した「文章の行」のまとまりを段落として扱い、段落の内と外との間には余白が設けられ、段落内の行と行の間に改行が付される】
……となります。
改行はwiki構文の中でも一番重要な要素ですが、同時に一番理解しづらいかもしれない要素でもあります。以下で順番に詳しく説明します。

文章の行と文章でない行†部分編集

行のうち、「何もかかれていない空白の行」と「それだけで一行を占有する構文」を使っている行 以外 が「文章の行」となります。
「それだけで一行を占有する構文」は例えば表(テーブル)、見出し、リスト構造、一行プラグイン、複数行プラグイン、などです。これらは行の先頭に特定の記号を用いる構文でもあります*0
上記以外のもの、'' 強調構文 '' や  &color(色変更プラグイン);   のように使える場所が行の先頭に限定されず一行の中で何回でも使える構文と、構文でないただの文字のみで構成された行が「文章の行」と判定されます。


段落†部分編集

文章の行をひとまとまりの塊、段落として扱い、上下に余白を差し込みます。この余白は、文章の行それ自体の高さとは関係なく一定の高さを持ちます。
文章でない行がいくら連続していてもそれは段落としては扱われず、したがって段落による余白も入りません。
段落周囲の余白の大きさの初期設定は 12px となっています(設定変更可能)。

HTML出力としては段落全体が <p> と </p> で囲まれる形になります。

[+] なぜ改行と段落とを別々に考えるか

もとをたどればHTMLがインターネットがどうこうという以前の語学の話になります。意味のうえで1つにまとまった文章のかたまり、あるいは改行で区切られた文章のかたまり、前者が意味段落で後者が形式段落……といったふうに。学校の国語の勉強で習った記憶は残っているでしょうか?
またSEO:検索エンジン対策の面でも段落<p>と改行<br>はいろいろあったりします。<br>による連続改行はNGだとか検索エンジンによる文書把握を考慮して段落<p>を適切に用いるべきだとか。

しかし基本的には書きやすさと読みやすさを優先してなんとなくで使い分けてしまっても良いかもしれません。ネタバレ防止のために空白行や &br; を連続で使って無理やり改行を入れても構いません*1
cWikiでは好きなように書けるようになっています。
だから自由に好きに書いても良いのです。

なお、現実的な問題として端末ごとの見やすさがあります。ガラケー・スマートフォンなど画面が小さい端末を使ってページを表示させたとき、あまりに改行が多いとかえって読みづらくなってしまうケースがあります。逆に大きい画面を持つPCやタブレットを使ったときにページを表示させたときも、改行と行の長さのバランスが悪いと読みづらくなってしまうケースがあります。自分の感覚だけでなく周囲の利用者の意見も考慮して段落・改行の使い方を決めていくと良いでしょう。


改行†部分編集

段落の中で、文章の行が連続しているときに行と行の間に改行が入ります。先頭および末尾には改行は入りません。初期設定では文章の末尾に ~(チルダ) を付ける必要はありません。
空白の行すなわち何も書かれていない行は上記のとおり文章の行としては扱われませんが、空白の行が3つ以上続いた場合に、例外的に行数に応じて改行が入ります。3行なら改行1回分、19行なら改行17回分となります。

HTML出力としては文章の末尾に <br> が挿入される形になります。


改行ルールの変更†部分編集

PukiWikiなど多くのWikiでは様々な理由から編集時に入力された改行をページ表示時に改行として扱わず、末尾に ~(チルダ) がある場合のみ改行を入れるなどの仕組みになっています。
cWikiでは上記の通り行末チルダ等を要さずに入力された改行をページ表示時に改行として扱う方式を標準としていますが、これは設定で変更することもできますし、また #setbr プラグインを使うことで一時的に切り替えることもできます。
他のWikiの経験者が多いとき、他のWikiで書いた記事をそのまま移植するときなどはこれらによって改行ルールを変えてしまったほうが良いかもしれません。


#setbrによる改行ルールの変更†部分編集

#setbr( オプション )

#setbr( オプション ) だけの行を記述することにより、以降の改行ルールを一時的に変更できます。
「オプション」として指定できる値は以下の通りです。オプションを指定しない場合は改行ルールを別の方式に切り替わります。

  • normal
  • default
    • いずれも、改行ルールが初期状態に戻ります
      標準では チルダ不要に、チルダ必須の方式に変更している場合はその通りになります
  • cjk
  • yes
  • true
  • on
    • いずれも、編集時に入力された改行がそのままページ表示時にも改行として扱われる、改行にチルダを要さない状態になります
  • pukiwiki
  • no
  • false
  • off
    • いずれも、編集時に入力された改行はページ表示時に改行として扱われない、改行にはチルダ必須の状態になります

なお、#setbrは見た目は一行プラグインのような形式になっていますが内部的にはプラグインではなくwiki基本構文を処理するプログラムのうちの改行解析部分が用いる特殊な記述になっています。


~(チルダ)の機能†部分編集

チルダには2つの機能があります。
1つは改行ルールを変更しているときの改行を制御する機能、もう1つは複数行にわたって記述された「文章の行」以外を連結する機能です。


「文章の行」の場合†部分編集

上記のとおり、改行ルールを変更している場合に、文章の末尾に記述するとページを表示したときに改行に変換する機能です。
&br; や3つ以上連続した空白行でも代用できます。


「文章の行」以外の場合†部分編集

「文章の行」以外の末尾にチルダを記述すると、末尾にチルダが記述された行と、その次の行とが連結され、改行が無かったものとして処理されます。
この機能は改行ルールの影響を受けません。どちらの改行ルールであってもこの挙動が維持されます。

#region( ~
   start ~
)

このように書くと……

#region(     start  )

と書くのと同じ結果になります。
この場合、プラグインのオプションの先頭および末尾の半角スペースはあらかじめ取り除かれますのでいずれもオプションとして "start" を指定したことになります。

一行プラグインなどで非常に長いオプションを記述する場合などにこの機能を使って記述しておくと、あとで編集内容を確認するとき、再び編集するときにわかりやすくなるかもしれません。


整形済みテキスト†部分編集


行の先頭に半角スペースを記述すると、その行は「整形済みテキスト」になります。
整形済みテキストの行が複数行連続している場合はまとめて1つの整形済みテキストになります*2
以下は説明を兼ねたサンプルです。


整形済みテキストとはその名の通り整形済み、体裁がすでに整えられている、したがって書かれた内容をそのまま表示するものです
''基本構文を使っても'' &color(red, blue){ プラグインを使っても }; %%% 見た目そのままに %%% 表示されるだけです
[[ このようにリンク形式で記述しても > トップページ ]] リンクは貼られませんしAutoLinkなども働きません

先頭のスペース以外は何も書かれていない空の行でも整形済みテキストとして機能します

唯一、&#x2f;のような数値文字参照だけはしっかり反映されます

出力されるHTMLとしては、<pre>になる……予定でしたが、素直に<pre>を使用すると長すぎる行があったときに好ましくない表示となってしまうため、サーバ側で適宜処理したうえで<div>に押し込む形になっています。


注釈†部分編集

丸括弧を2つずつ使って (( このように )) 囲まれた範囲は注釈となります。
すなわちこれのことです→*3
注釈として記述した内容は順番にページ下部*4に移動され、注釈を記述した箇所にはアスタリスク(米印)と番号に変換され、また同時にそれぞれアンカーとリンクが付け加えられ相互に移動できるようになります。それぞれのリンクを選択すると、選択した注釈の内容、あるいは注釈が記述された場所の、背景色が変わります。

付されるアンカーは、注釈を記述した箇所は #note_link_n 、注釈の実体は #note_body_n (nは自動で割り振られる番号)になります。役に立つことはあまりないかもしれませんが、このアンカーに対して [[ > ]] リンク構文を使ってリンクを貼る事も可能です。


文字を斜体に†部分編集


左右それぞれ3つの ' (シングルクォーテーション)で囲まれた文章は ''' 斜体表示 ''' になります。
アルファベット等の斜体と比べて日本語の斜体は見辛くなってしまうケースが多いため、日本語の文章を対象に使うのは避けた方が良いかもしれません。


文字を太字に†部分編集


左右それぞれ2つの ' (シングルクォーテーション)で囲まれた文章は '' 強調表示として太字に '' なります。
多用すると見づらくなってしまいますが、要所を強調したい時は便利です。


文字に下線を†部分編集


左右それぞれ3つの % (パーセント)で囲まれた文章には %%% 下線(アンダーライン) %%% が付きます。
強調表示(太字)と使い分ける、あるいは併用すると良いでしょう。


文字に打ち消し線を†部分編集


左右それぞれ2つの % (パーセント)で囲まれた文章には %% 打ち消し線 %% が付きます。
打ち消し線よりも ((注釈構文)) や &color(); プラグイン、 &tooltip(); プラグインなどを使った方が良い場面も。


区切り線†部分編集


4つ以上の - (ハイフン)記号のみが記述された行は区切り線(水平線)になります。


場合によっては *見出し の使用を検討した方が良いかもしれません。

4つ以上であれば4つでも124個でも全く同じ区切り線に変換されます。
編集中の目印・区切りとしても便利なときがあり、その場合はハイフンの数を少し増やすと良いでしょう。

出力されるHTMLとしては、<hr>になります。


リンク†部分編集


2つずつの [[ と ]] (角括弧)で囲んだ範囲はリンクとして扱われます。
リンク、別名アンカーとは、特定のページ、特定のURL、ページ内の特定の位置へ移動するための案内表示のようなものです。


基本†部分編集

[[ トップページ ]]
[[ http://cwiki.lames.jp/ ]]

[[ と ]] で囲まれた範囲が HTTP / HTTPS / FTP / FTPS / IRC のいずれかのURL形式であった場合はそのURLに対する、そうでない場合はその名前のページに対するwiki内の、リンクが生成されます。

URLに対するリンクであった場合、外部サイトである場合には out マークが付され、また同時にリンク先のURLがクッション用のURLになります。実際に見てみた方が速いでしょう。こんな風になります https://ja.wikipedia.org/  

wiki内のページに対するリンクであった場合、そのページ名を持つページが存在していれば通常のリンクが、存在していない場合には通常と違い赤文字のリンクが生成されます。こんな風になります 存在していないページ
ページが存在しているかどうかは、wikiのキャッシュ機能が無効になっている場合はページ表示時に毎回確認されます。有効になっている場合にはページを保存したりコメントを書き込んだ時点にのみ確認され、その後にリンク対象のページが作成されたりあるいは削除されたりしても、その結果はリンクには反映されず、反映させるためにはリンクが記述されたページ・コメントを編集する、上部メニューからページのキャッシュを削除する、あるいは初期状態では1日1回のwiki自動更新プログラムの実行を待つしかありません。キャッシュ機能は初期状態では有効になっています。

リンク対象の先頭および末尾の半角スペースは自動的に除去されます。
先頭および末尾の半角スペースを持つリンク先を記述したい場合は、URLエンコーディングにより + あるいは %20 に変換して記述して下さい。

出力されるHTMLとしては、<a>タグになります。


別名リンク†部分編集

[[ 表紙 > トップページ ]]
[[ ウィキペディア > http://cwiki.lames.jp/ ]]

このように [[ ]] 内に > (大なり記号)で分けられた2つの文章・URLを記述すると、> の左側が表示名に、> の右側がリンク先になります。こんな風に 表紙 ウィキペディア
外部リンクであった場合やwiki内ページの存否については通常の [[ ]] リンク構文と同様です。


ページ内リンク†部分編集

[[ #基本 ]]
[[ 基本の見出し > 書き方/wiki基本構文/10.リンク#基本 ]]
[[ https://ja.wikipedia.org/wiki/%E6%97%A5%E6%9C%AC%E8%AA%9E#.E6.96.87.E3.81.AE.E6.88.90.E5.88.86 ]]

このように、[[ ]] 内にリンク先として # (番号記号)で始まる、あるいは # を含む文章ないしURLを記述すると、 # 以降の文字はページ内リンクとして処理されます。「ページの一番上へ」リンクのようなものです。
cWikiでは全ての見出しは [#id] 形式で指定された文字列と見出し名そのものの2つのIDを持っています。縦に長いページに対してリンクを張るときはページ内リンクを用いると利用者にとって便利かもしれません。


IRCのURLって見たこと無いんだけど?†部分編集

irc:// server / channel

みたいな形式で記述できるURLらしいです。
おそらく9割9分の利用者はみたことないと思います。

IRCチャットクライアントを内蔵しているブラウザを使用していると、この形式のURLを選択すると自動的にチャットクライアントが起動したりするようです。標準で対応しているブラウザとして有名なのがfirefoxだとか。


引用†部分編集


先頭に > (大なり記号)を記述した行は、引用として扱われます。引用は以下のような特徴を持ちます。

  • 連続した引用行はまとめて1つの引用として扱われる
  • 先頭の > の数によって入れ子構造(多層構造)を表現可能
  • 内部の改行は無視され、しかし改行以外の各種構文は使用可能
> %%%引用開始%%%
> ここから
>> ''引用部分''
> ここまで
> %%%引用開始%%% &br();
> ここから
>> ''引用部分''
> ここまで

このように記述すると、こうなります。

引用開始 ここから
引用部分
ここまで
引用開始
ここから
引用部分
ここまで

引用の中に改行を入れたいときは &br; を使いましょう。
なお、法的に厳密に見た場合、引用は 改行も含めて できるだけ引用元すなわち原典と同じように整えるべき、となります。読みやすさ等のために改行を追加したり一部を強調したりなど手を加えたときは、その旨を併記するとより良い「引用」になります。
また引用構文を用いる際は引用元の併記も大事です。

出力されるHTMLとしては、<quote>になります。


見出し†部分編集


基本†部分編集

先頭に * (アスタリスク・米印)を、その後に文章を、記述した行は見出しとして扱われます。
見出しは意味のうえで、また読みやすさのうえで、ページ全体を区切るものですが、同時に索引(インデックス)にもなり、 #content プラグインの処理を左右し、部分編集の基準にもなり、さらにページ内リンクの対象にもなります。
多すぎず少なすぎず適度に使いましょう。

出力されるHTMLとしては、<h1> から <h6> になります。


見出しレベル3†部分編集

見出しレベル4†部分編集

見出しレベル5†部分編集
見出しレベル6†部分編集

見出しは先頭に連続して記述した * の数によってレベル1からレベル6いずれかのレベルを持ちます。7個以上書くと見出しとして扱われずただの文章の行になります。また、行の先頭の * とその後の文章の間に半角スペースが存在する場合この半角スペースは無かったものとして抹消されます。


ページ内索引†部分編集

#content プラグインはページ内の全ての見出しの情報を利用して索引を生成します。


ページ内リンクのあて先†部分編集

見出しは以下のように

* 見出し名 [#見出しID]

という形式で記述することもでき、ここで指定した「見出しID」が、その見出しが持つページ内リンクのあて先の1つになります。もう一つのあて先は「見出し名」そのものです。プレビュー時やページの更新時に見出しIDが指定されていない、あるいは他の見出しとIDが重複している場合、見出しIDが自動的に(再)生成されます。

#include プラグインにより他のページを呼び出したとき、呼び出したページの見出しはそっくりそのまま表示され、重複確認は入らず、 #content プラグインの動作にも影響を与えません。


リスト構造†部分編集


先頭に - (ハイフン)あるいは + (プラス) いずれかの記号を記述した行はそれぞれ 番号なしのリスト構造、番号つきのリスト構造になります。
この2つのリスト構造はいずれも以下の特徴を持ちます。

  • 連続したリスト構造はまとめて1つのリスト構造として扱われる
  • 先頭の + および - の数によって入れ子構造(多層構造)を表現可能
  • 先頭の + および - はどちらかに統一する必要はない

  1. このような
    1. 階層構造で
      • 情報を分類したり
      • 整理したり
      • 見やすく整えたり
    2. することが
    3. 可能です
  2. リスト構造の右側部分には
    wiki基本構文などを使うことができます
  3. 場合によってはリスト構造を用いない方が読みやすいこともありますので注意

出力されるHTMLとしては、<ul> <ol> および <li> になります。


定義リスト†部分編集


先頭に : (コロン)を記述し、コロン以後に | (縦線・パイプ) で区切られた2つの文章を持つ行は定義リスト構造として扱われます。
この定義リスト構造は、番号なしリスト構造・番号つきリスト構造と似ていますが、縦線を区切りにして左側を定義されるものとし、右側をその説明や内容とする、意味の上では一行で完結するリスト構造になっています。


:番号なしリスト構造|行の先頭にハイフン記号 &br(); 連番がつかない単純なリスト
:番号つきリスト構造|行の先頭にプラス記号 &br(); 自動的に連番が振られる単純なリスト
:定義リスト構造|行の先頭にコロン記号、区切りに縦線記号 &br(); 自動的に連番が振られる単純なリスト

こう書くと


番号なしリスト構造
行の先頭にハイフン記号
連番がつかない単純なリスト
番号つきリスト構造
行の先頭にプラス記号
自動的に連番が振られる単純なリスト
定義リスト構造
行の先頭にコロン記号、区切りに縦線記号
縦線記号を区切りにしたペアを表現するリスト

こうなります。

生成されるHTMLとしては、<dl> <dt> <dd> タグになります。


[+] 「定義リスト」の名前および用法について

<dl>タグはHTML5以前は Definition List すなわち定義リスト構造と定義され会話の表現などに応用できるものの基本的には用語リストなどに用いるものであり、タグ名<dl>はその頭文字でした。
それがHTML5では Description List すなわち説明リスト・記述リストに変更され、内容は特に定義されない柔軟なタグになっています。また単語・用語などを定義したい場合は<dfn>タグを用いること、ともなっています。

このため「定義リスト」という呼び方および定義リストとしての用法は現在のHTMLの仕様に沿っていないといえば確かに沿っていないのですが……そもそもどう扱うべきか、どう使ってもらうべきか、の時点で迷ってしまった結果、とりあえずでHTML4.01のやり方およびPukiWikiを踏襲しています。

なお<dl>タグは本来はHTML5以前でもHTML5でも1つの<dt>タグ(縦線の左側)に対して複数の<dd>タグ(縦線の右側)を記述できるものですが、そもそもどう扱うかの方針を定められていないことからcWikiとしての構文仕様を定められておらず、結果、1つの<dt>に対して1つの<dd>を当てはめるだけの、より用語リスト的な仕様になっています。


表(テーブル)†部分編集


先頭に | (縦線・パイプ)を記述した行は表(テーブル)として扱われます。
表の構文の仕組みは少し、いやかなり複雑です。


  1. 表は | で内容が区切られ、それぞれのマス(セル)として扱われます
    • | 記号そのものを記述したいときは &#x7c; と記述しましょう
  2. それぞれのマスの先頭で以下の修飾子を記述することで対象のマスのみを修飾できます
    修飾子は大文字・小文字を区別せず、したがって CENTER: も center: も CenTer: も同じ意味になります
    修飾子は複数同時に記述でき、たとえば「 center: size(17): color(red): マスの内容 」のように記述できます
    : (コロン)の記号そのものをマスの中に記述したいときは、そのまま記述すると以下のような修飾子と誤って処理されてしまうため、 &#x3a; と記述しましょう
    1. LEFT:
      • マスの中身を左寄りに配置します
    2. CENTER:
      • マスの中身を中央に配置します
    3. RIGHT:
      • マスの中身を右寄りに配置します
    4. COLOR( [色指定] ):
    5. BGCOLOR( [色指定] ):
      • 背景色を変更します 色指定は COLOR: と同様です
    6. SIZE( [サイズ指定] ):
  3. 最後の | から行の末尾までは基本的に無かったものとして抹消されます
    • 例外として、最後の | のあとに h / f / c のいずれかを記述した場合は
      それぞれ ヘッダ行・フッタ行・書式一括指定行となります
      • 書式一括指定行は、以降の表構文の記述のうちヘッダ行・フッタ行を除く全ての行に対して、書式一括指定行の中で指定した修飾子を適用します
        • 書式一括指定行による修飾は、マス自身に記述された修飾子により上書きされます
        • 書式一括指定行による修飾は、より後の書式一括指定行による修飾により上書きされます
          20行ごとに書式を一括で指定・変更するというような使い方も可能です
        • 書式一括指定行に単純に数字のみを記述すると、マスの幅をその数値としてpx単位で指定したことになります
      • ヘッダ行は、どこに書いても表の一番上に配置されます
        ヘッダ行を複数記述した場合、記述した順番に表の一番上に配置されます
        また、書式一括指定行による修飾を受けません
      • フッタ行は、ヘッダ行と同様に、ただし表の一番下に配置されます
  4. マスの内容として > (大なり記号)のみを記述すると、そのマスのすぐ右のマスとが連結されます
    マスの内容として ~ (チルダ)のみを記述すると、そのマスのすぐ上のマスとが連結されます
    これらを組み合わせると 縦2個 横3個のマスを連結したマスなども作ることができます
    • マスの連結は四角形のかたちでのみ連結でき、例えば 凸 のかたちには連結できません
    • 書式一括指定行のマスに > を記述すると、そのマスのすぐ右のマスの書式指定をコピーする、という意味になります
      • 書式一括指定行のマスの > による連結は連続して行うことができます

表の構文はできることが多いため仕組みも複雑になっています。
上記の構文ルールを見ながら実際に試してみると理解が早まるかもしれません。
表全体に修飾を適用したいときは #style プラグインを併用するのも良いでしょう。

出力されるHTMLとしては、<table>および<table>関連タグになります。


URLのリンク付け†部分編集


HTTP / HTTPS / FTP / FTPS / IRCのいずれかのURLは [[ > ]] リンク構文を使わなくても、自動的にリンクが生成されます。

https://ja.wikipedia.org/

とだけ書くと

https://ja.wikipedia.org/  

こんな風になります。

表示名を変えたいときは [[ > ]] リンク構文を使いましょう。



  • *0 複数行の編集コメントは行の先頭に記号を用いる種類の構文ではありませんが、各種の処理に先立って処理され、複数行の編集コメント構文の内側の文章は以後の処理の中で「無かったこと」扱いになります
  • *1 もっともネタバレ防止には #region プラグインや &tooltip(){}; プラグインを用いる方が便利かもしれませんが
  • *2 たいした意味はありませんが
  • *3 多用するとかえって読みづらくなりますのでご注意下さい
  • *4 タグ一覧のすぐ上の場所

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