テキスト整形ルール
通常は入力した文章がそのまま出力されます。
これに加えて、特定のルールによるテキスト整形を行うことができます。以下では、プラグインについてはよく使われるものだけを簡略に説明しています。プラグインのオプションなど詳細な説明については
プラグイン一覧
を参照してください。(上メニューのヘルプからも行けます)
目次
ブロック要素
- 要するに行頭に存在する要素。ブロック要素のプラグインは行頭に存在しなければならない。
- ブロック要素となるプラグインは#~の形式になっています。
インライン要素についての説明はこちら
引用文
> インライン要素
行頭で > を指定すると、引用文になります。引用文は >、>>、>>> とレベルを上げられます。
リスト構造
- インライン要素
行頭で - を指定すると、番号なしリストになります。番号なしリストは -、--、--- とレベルを上げられます。
+ インライン要素
行頭で + を指定すると、番号付きリストになります。番号付きリストは +、++、+++ とレベルを上げられます。
: 定義語 | 説明文
行頭を : で始め、| 記号で区切ると、定義リストになります。定義リストは 段階がありません。
- 行中に | がないと定義リストにはなりません。
整形済みテキスト
行頭が半角空白で始まる行は整形済みテキストとなります。行の自動折り返しは行なわれません。
- 整形済みテキストは、すべての子要素を文字列として扱います。
表組み
| インライン要素 | インライン要素 |
行頭から | でインライン要素を区切ることで表組みになります。
- 各要素の先頭に下記の記述子を指定できます。
BGCOLOR(色指定): COLOR(色指定): SIZE(サイズ指定): LEFT: CENTER: RIGHT:
- 要素の背景色・文字色・文字サイズ・表示位置を指定します。デフォルトは左寄せになります。
表組みの | 各セルの要素の配置に | 関するサンプル |
左寄せ | センタリング | 右寄せ |
右寄せ | 左寄せ | センタリング |
見出し
* インライン要素
行頭で * を記述すると、見出しになります。見出しは *、**、*** と段階を増やせます。
目次
#contents()
行頭で contents を記述すると、見出しに基づいて目次を作成します。一般的に contents はページの最初のほうに記述します。
- 詳しくはプラグイン一覧のcontentsにて。
右寄せ・センタリング・左寄せ
#right(){インライン要素} #center(){インライン要素} #right(){インライン要素}
と記述する事で、インライン要素が右寄せ、センタリング、左寄せされます。
水平線
---------------------------------------------
行頭で4つ以上の - を書くと水平線になります。
#hr()
括弧内にwidth,height,colorのパラメーターを入れられます。
添付画像の貼り付け
#ref(添付画像ファイル名)
または
#ref(添付画像ファイル名,ファイルのあるページ名)
と記述すると、画像を表示します。
- #ref には、カンマで区切った3つ目以降の欄を用いてパラメータを指定できます。詳しくはプラグイン一覧からどうぞ。
フォーム
#comment()
コメントを挿入するためのフォームが埋め込まれます。
他に
他に
#comment_num() #comment_num2() #pcomment()
がコメントフォームプラグインです。他にも投票フォームやメールフォーム、検索フォームなどを埋め込めますが、多すぎるので詳しくはプラグイン一覧へどうぞ。
インライン要素
- インライン要素は、必ずブロック要素の子要素になっています。
- 要するに普通のテキスト全てと&~からなるプラグインの事。
改行
&br()
行中に書くと、そこで改行されます。
強調・斜体
''インライン要素''
行中のインライン要素を '' ではさむと、インライン要素が
強調表示
になります。
'''インライン要素'''
行中のインライン要素を ''' ではさむと、インライン要素が
斜体表示
になります。
文字サイズ
&size(サイズ){インライン要素}
行中に &size を書くとインライン要素の文字サイズを指定することができます。
文字色
&color(文字色,背景色){インライン要素};
行中に &color と書くとインライン要素の文字色 (←crimson)と背景色 (←blue,crimson)を指定することができます。背景色は省略できます。
- 色の指定は、次のいずれかの形式で行ないます。
- 色を意味するキーワード(red, blueなど)
- #16進数6桁
- #16進数3桁
取消線
%%インライン要素%%
行中のインライン要素を%%ではさむと、インライン要素に取消線が付きます。
注釈
((インライン要素))
行中でインライン要素を (( と )) ではさむと、注釈(*1)が作成され、行中に注釈へのリンクが貼られます。
画像の貼り付け
&ref(画像URL)
とすることでインライン要素で画像を貼り付けられる。
ルビ構造
&ruby(ルビ){インライン要素}
行中で &ruby を書くとインライン要素に対するルビをふることができます。ルビに対応していないブラウザではルビが本文中に ( と ) に囲まれて表示されます。
- ルビ構造のルビにはインライン要素を記述します。ただし、ルビの特性上、期待通りの表示になるとは限りません。
- ルビ構造をルビ構造の子要素にはできません(ネストはできません)。
- 注釈内や文字サイズを小さくしている部分での使用は、ルビが判読できなくなるので避けてください。
アンカーの設定
&aname(アンカー名) または anchor(アンカー名) &aname(アンカー名){インライン要素} または anchor(アンカー名){インライン要素}
行中で &aname を記述するとリンクのアンカーを設定することができます。リンクの飛び先にしたい位置に記述します。
&link_anchor(アンカー名)
等でアンカーに対するリンクを貼る事が出来ます。詳しくはプラグイン一覧へどうぞ。後述する[[ ]]のリンクでも飛べます。
カウンタ表示
&counter()
行中で &counter を記述するとそのページにアクセスした人の数を表示することができます。
オンライン表示
&online()
ページ名
[[トップページ]]
行中で [[ ]] で囲まれた文字列はページ名になります。
- ページ名の中には、"#&()<> を含めることはできません。
- すでに存在するページであればそのページへのリンクが自動的に貼られます。存在しない場合はそのページを新規作成するためのリンクが貼られます。
[[ヘルプ#アンカー名]]
とすると、ヘルプの中の「アンカー名」というアンカーを探してリンクします。
[[トップかと思いきやそうでもない>ヘルプ]]
この形式の文字列の中で、> で2つの文字列を区切ると右側の要素へのリンクになります。
リンク
[[リンク名>http://うんにゃらかんにゃら]]
上に挙げた方法でwiki外へのリンクも貼る事が出来ます。
- リンク名には、全角文字や半角空白文字を含めることができます。
http://www.example.com/ https://www.example.com/ ftp://ftp.example.com/ news://news.example.com/ foo@example.com
- 行中に直接、URLを記述した場合は自動的にそのURLに対するリンクが貼られます。
- 記述したURLが画像ファイルである場合も画像は表示されません。
タブコード
&t
行中で &t と書くと、タブコードに置換されます。
通常、フォーム内ではキーボードからタブコードを直接入力できない(*2)ので、タブコードを入力したい位置に&tを記述すると、保存時にタブコードに置換します。
タブコード タブコード
タブコード タブコード
- タブコードは、記事が書き込まれるときに置換されて記録されます。
ページ名置換文字
&page() &fpage()
行中で &page; 及び &fpage; と書くと、編集中のページ名に置換されます。
- ページ名置換文字は、記事が書き込まれるときに置換されて記録されます。
日時置換文字
&date() &time() &now()
- 行中で &date; と書くと、更新時の日付に置換されます
- 行中で &time; と書くと、更新時の時刻に置換されます
- 行中で &now; と書くと、更新時の日時に置換されます
- &date;、 &time;、 &now;は、記事が書き込まれるときに置換されて記録されます。
&lastmod() &lastmod(ページ名)
- 行中で 2009年12月09日 (水) 02時17分40秒と書くと、そのページの最終更新日時に置換されて出力されます。
- ページ名を指定すると、その指定されたページの最終更新日時に置換されて出力されます。
- &_date;、 &_time;、 &_now;、 &lastmod;は、記事が表示されるときに置換されて出力されます。
その他
コメントアウト
// コメント
行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。また
#co(){ コメント }
と入力すると複数行に渡ってコメントアウトできる。
以上、PukiwikiのFormatingRuleを参考に、@wiki構文のルールを解説しました。(出来てるつもりです)