FormattingRules の履歴(No.1)

最終更新:

テキスト整形のルール

通常は入力した文章がそのまま出力されます。

これに加えて、特定のルールによるテキスト整形を行うことができます。以下では、プラグインについてはよく使われるものだけを簡略に説明しています。



ブロック要素

段落

インライン要素

他のブロック要素を明示しない限り、段落となります。

~ インライン要素

行頭で ~ を指定した場合も段落になります。行頭書式の文字(~、-、+、:、>、|、#、//)を通常の文字として段落の先頭に書きたい場合は、行頭に~を記述して書くことができます。

引用文

> インライン要素

行頭で > を指定すると、引用文になります。引用文は >、>>、>>> の3レベルあります。

リスト構造

- インライン要素

行頭で - を指定すると、番号なしリストになります。番号なしリストは -、--、--- の3レベルあります。

+ インライン要素

行頭で + を指定すると、番号付きリストになります。番号付きリストは +、++、+++ の3レベルあります。

: 定義語 | 説明文

行頭を : で始め、| 記号で区切ると、定義リストになります。定義リストは :、::、::: の3段階あります。定義リストの定義語、説明文は省略することができます。複数の連続した定義リストを記述し、2つ目以降の定義語を省略することで1つの定義語に対する複数の説明文を記述することができます。

整形済みテキスト

行頭が半角空白で始まる行は整形済みテキストとなります。行の自動折り返しは行なわれません。

表組み

| インライン要素 | インライン要素 |

行頭から | でインライン要素を区切ることで表組みになります。

CSV形式の表組み

,データ,データ,…

行頭でカンマ(,)を記述し、インライン要素をカンマ区切りで記述すると表組みになります。

見出し

* インライン要素

行頭で * を記述すると、見出しになります。見出しは *、**、*** の3段階あります。

目次

#contents

行頭で #contents を記述すると、見出しに基づいて目次を作成します。一般的に #contents はページの最初のほうに記述します。

左寄せ・センタリング・右寄せ

LEFT:インライン要素
CENTER:インライン要素
RIGHT:インライン要素

行頭で LEFT:、 CENTER:、 RIGHT: を記述すると、インライン要素が左寄せ、センタリング、右寄せされます。

水平線

---------------------------------------------

行頭で4つ以上の - を書くと水平線になります。

#hr

行頭で #hr を記述すると、区切り線になります。区切り線は上位のブロック要素の幅の60%の長さの水平線がセンタリングされて引かれます。

行間開け

#br

行頭で #br を記述すると、ブロック要素間またはブロック要素内で行間を開けることができます*2

添付ファイル・画像の貼り付け

#ref(添付ファイル名)
#ref(ファイルのURL)

行頭で #ref を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。

テキストの回り込みの解除

#clear

行頭で #clear を記述すると、 #ref で指定したテキストの回り込みを解除します。 #clear を指定しなくても、記事の末尾でテキストの回り込みが自動的に解除されます。

フォーム

#comment

行頭で #comment を記述すると、コメントを挿入するためのフォームが埋め込まれます。

#pcomment

行頭で #pcomment を記述すると、コメントを挿入するためのフォームが埋め込まれます。 #comment とは異なり、コメントは別ページに記録されます。また、コメントに対するレスポンスを階層状に表示します。

#article

行頭で#articleを記述すると、簡易掲示板のフォームが埋め込まれます。

#vote(選択肢1,選択肢2,...)

行頭で #vote を記述すると、簡易投票フォームが埋め込まれます。

インライン要素

文字列

文字列

文字列はインライン要素です。

改行

インライン要素~

行末に~を書くと行末改行になります。行末改行はブロック要素内での改行になります。

&br;

行中に &br; を書くと、そこで改行されます。行末の ~ と違い、定義リストの定義語や表組の要素、# で始まるブロック要素のパラメタの中でも使用できます。

強調・斜体

''インライン要素''

行中のインライン要素を '' ではさむと、インライン要素が 強調表示 になります。

'''インライン要素'''

行中のインライン要素を ''' ではさむと、インライン要素が 斜体表示 になります。

文字サイズ

&size(サイズ){インライン要素};

行中に &size を書くとインライン要素の文字サイズを指定することができます。サイズはピクセル単位(px)で指定します。例えば20を指定すると、20ピクセルの文字の大きさになります。

文字色

&color(文字色,背景色){インライン要素};

行中に &color と書くとインライン要素の文字色背景色を指定することができます。背景色は省略できます。

取消線

%%インライン要素%%

行中のインライン要素を%%ではさむと、インライン要素に取消線が付きます。

注釈

((インライン要素))

行中でインライン要素を (( と )) ではさむと、注釈*3が作成され、行中に注釈へのリンクが貼られます。

添付ファイル・画像の貼り付け

&ref(添付ファイル名);
&ref(ファイルのURL);

行中で &ref を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。

ルビ構造

&ruby(ルビ){インライン要素};

行中で &ruby を書くとインライン要素に対するルビをふることができます。ルビに対応していないブラウザではルビが本文中に ( と ) に囲まれて表示されます。

アンカーの設定

&aname(アンカー名);
&aname(アンカー名){インライン要素};

行中で &aname を記述するとリンクのアンカーを設定することができます。リンクの飛び先にしたい位置に記述します。

カウンタ表示

&counter;
&counter(オプション);

行中で &counter を記述するとそのページにアクセスした人の数を表示することができます。

オンライン表示

&online;

行中で &online を記述すると現在アクセス中の人数を表示することができます。

バージョン表示

&version;

行中で &version を記述するとPukiWikiのバージョンを表示することができます。

WikiName

WikiName

行中で、1つ以上の大文字→1つ以上の小文字→1つ以上の大文字→1つ以上の小文字の組合わせからなる半角//文字列はWikiNameになります。

ページ名

[[ぷきうぃき]]

行中で [[ と ]] で囲まれた文字列はページ名になります。

[[ページ名#アンカー名]]

InterWiki

[[InterWikiName:ページ名]]

行中のページ名形式の文字列の中で、: で2つの文字列を区切るとInterWikiになります。:の前にはInterWikiNameのページで定義したInterWikiNameを、: の後ろにはページ名を記述します。

[[InterWikiName:ページ名#アンカー名]]

リンク

[[リンク名:URL]]

行中のInterWikiNameの形式の文字列の中で、: の前に任意のリンク名を、: の後ろにURLを記述すると、そのリンク名でURLに対するリンクを貼ることができます。

http://www.example.com/
https://www.example.com/
ftp://ftp.example.com/
news://news.example.com/
foo@example.com

エイリアス

[[エイリアス名>ページ名]]

行中のページ名形式の文字列の中で、> で2つの文字列を区切るとエイリアスになります。 > の前にはエイリアス名を、> の後ろにはページ名を記述します。

エイリアスはPukiWiki内のページ名とは別のエイリアス名で、指定したページへのリンクを貼ります。

[[エイリアス名>ページ名#アンカー名]]
[[エイリアス名>#アンカー名]]
[[エイリアス名>http://www.example.com/]]
[[エイリアス名>https://www.example.com/]]
[[エイリアス名>ftp://ftp.example.com/]]
[[エイリアス名>news://news.example.com/]]
[[エイリアス名>foo@example.com]]
[[エイリアス名>InterWikiName:ページ名]]
[[エイリアス名>InterWikiName:ページ名#アンカー名]]
[[エイリアス名:http://www.example.com/]]
[[エイリアス名:https://www.example.com/]]
[[エイリアス名:ftp://ftp.example.com/]]
[[エイリアス名:news://news.example.com/]]
[[エイリアス名:foo@example.com]]

タブコード

&t;

行中で &t; と書くと、タブコードに置換されます。

通常、フォーム内ではキーボードからタブコードを直接入力できない*4ので、タブコードを入力したい位置に&t;を記述すると、保存時にタブコードに置換します。

ページ名置換文字

&page;
&fpage;

行中で &page; 及び &fpage; と書くと、編集中のページ名に置換されます。ページ名が階層化されたページで「hogehoge/hoge」となっている場合、 &page; は「hoge」に、 &fpage; は「hogehoge/hoge」に置換されます。階層化されていないページでは、 &page; も &fpage; も同じになります。

日時置換文字

&date;
&time;
&now;
&_date;
&_time;
&_now;
&lastmod;
&lastmod(ページ名);

文字参照文字

文字参照は、SGMLで定義されている文字参照文字(©や®など)のほか、下記の独自の文字参照文字が使用できます。

&heart;
⌣
&bigsmile;
&huh;
&oh;
&wink;
&sad;
&worried;

数値参照文字

&#10進数;
&#x16進数;

行中で &# と ; の間に10進数を、&#x と ;の間に16進数を書くと、Unicodeを数値参照して表示します。キーボードから直接入力できない文字やJIS第3水準・第4水準の文字などの表示に使用します。たとえば、内田百閒と入力すると、内田百閒と表示されます。

その他

コメント行

// コメント

行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。



*1 インライン要素となるプラグインやユーザ定義とは異なり、ブロック要素となるプラグインでは終端に;を付加する必要はありません。プラグインによっては正常に動作しなくなる場合があります。
*2 #brをブロック要素の直後の空行の次に指定すればブロック要素間の行間、ブロック要素の直後に指定すればそのブロック要素内での行間を開けることになります。#brは、行末改行と違って、次の行の行頭書式を無効にはしません
*3 注釈のサンプル
*4 クリップボードからの貼り付けの場合はタブコードを直接入力できます。