Siwikiについて >> 整形ルール
テキスト整形のルール
通常は入力した文章がそのまま出力されます。
- HTMLのタグは効果がありません。書かれた文章はそのまま(「<font color="red">text</font>」といった形のまま)表示されます
- 段落と段落の区切りには空行をはさんで下さい。空行をはさまず、連続している複数の行は同じ段落と解釈されます (連結して表示されます)これに加えて、特定のルールによるテキスト整形を行うことができます。
ブロック要素
- ブロック要素は、インライン要素と他のブロック要素を子要素にすること
ができます。は、原則として出来ません。ただし、段落、見出し、水平線、#から始まるブロック要素は他のブロック要素を子要素にすることはできません。 - 空行はトップレベルのブロック要素の区切りになります。空行が現われると、すべてのブロック要素は終了します。
段落
インライン要素 ~ インライン要素他のブロック要素を明示しない限り、段落となります。行頭で ~ を指定した場合も段落になります。行頭書式の文字(~、-、+、:、>、|、#、//)を通常の文字として段落の先頭に書きたい場合は、行頭に~を記述して書くことができます。
- 段落の先頭は1文字分字下げされます。但し、番号なしリスト構造、番号付きリスト構造、引用文内の段落では字下げされません。定義リスト内の段落の先頭は1文字分字下げされます。
- 段落は、新たなブロック要素が現われるまで継続します。
- 段落は、他のブロック要素の子要素になることができます。
- 段落は、他のブロック要素を子要素にすることはできません。
引用文
> インライン要素行頭で > を指定すると、引用文になります。引用文は >、>>、>>> の3レベルあります。
- 引用文の中は、ブロック要素を明示しない限り、段落となります。
- 引用文は、空行が現われるまで継続します。
- 引用文内の段落は、新たな引用文またはブロック要素が現われるまで継続します。
- 引用文は、他のブロック要素の子要素になることができます。他の引用文の子要素にする場合は、レベルを1段増やして記述します。リスト構造の子要素にする場合はレベルを1段増やさずに記述します。
- 引用文は、他のブロック要素を子要素にすることができます。引用文の子要素となるリスト構造はレベルを1段増やさずに記述します。
- リスト構造内の引用文から脱出する場合で、リスト構造を継続する場合は、<、<<、<<<を行頭に記述します。
リスト構造
- ブロック要素行頭で - を指定すると、番号なしリストになります。番号なしリストは -、--、---、…のように記述できます。
- 番号なしリストは、他のブロック要素の子要素になることができます。他のリスト構造の子要素にする場合は、レベルを1段増やして記述します。引用文の子要素にする場合は、レベルを増やさずに記述します。
+ ブロック要素行頭で + を指定すると、番号付きリストになります。番号付きリストは +、++、+++、…のように記述できます。
- 番号付きリストは、他のブロック要素の子要素になることができます。他のリスト構造の子要素にする場合は、レベルを1段増やして記述します。引用文の子要素にする場合は、レベルを増やさずに記述します。
: 定義語 | 説明文行頭を : で始め、| 記号で区切ると、定義リストになります。定義リストは :、::、::: の3段階あります。定義リストの定義語、説明文は省略することができます。複数の連続した定義リストを記述し、2つ目以降の定義語を省略することで1つの定義語に対する複数の説明文を記述することができます。
- 行中に | がないと定義リストにはなりません。
- 定義語・説明文は、ブロック要素を記述することができます。
整形済みテキスト行頭が半角空白で始まる行は整形済みテキストとなります。行の自動折り返しは行なわれません。
- 整形済みテキストは、他のブロック要素の子要素になることができます。
- 整形済みテキストは、他のブロック要素を子要素にすることができません。
- 整形済みテキストは、すべての子要素を文字列として扱います。
表組み
| インライン要素 | インライン要素 |行頭から | でインライン要素を区切ることで表組みになります。
- 各要素の先頭に下記の記述子を指定できます。
LEFT: CENTER: RIGHT: BGCOLOR(色): COLOR(色): SIZE(サイズ):
- 要素の表示位置及び背景色・文字色・文字サイズ(px単位)を指定します。デフォルトは左寄せになります。
表組みの 各セルの要素の配置に 関するサンプル 左寄せ センタリング 右寄せ 右寄せ 左寄せ センタリング
- 要素の表示位置及び背景色・文字色・文字サイズ(px単位)を指定します。デフォルトは左寄せになります。
- 行末にcを記述すると、書式指定行となります。書式指定行では、次の記述子が指定できます。
LEFT: CENTER: RIGHT: BGCOLOR(色): COLOR(色): SIZE(サイズ):
- 記述子の後ろに数値を記述すると、セル幅がpx単位で指定できます。
- 行末にhを記述すると、ヘッダ行(thead)になります。
- 行末にfを記述すると、フッタ行(tfoot)になります。
- 行末にtを記述すると、タブ(\t)と'|'がセパレータになります。
- 行末にaを記述すると、tableの属性になります。
- 行末にgを記述すると、<colgroup>の指定行となります。
- 行末にhtを記述すると、タブ(\t)と'|'がセパレータになり、かつ、ヘッダ行(thead)になります。
- セル内のインライン要素の先頭に~を付けると、ヘッダ(th)になります。
- セル内に > を単独で記述すると右のセルと連結します(colspan)。
- セル内に ~ を単独で記述すると上のセルと連結します(rowspan)。
- 表組みは、他のブロック要素の子要素になることができます。
- 表組みは、他のブロック要素を子要素にすることができません。
CSV形式の表組み
,データ,データ,…行頭でカンマ(,)を記述し、インライン要素をカンマ区切りで記述すると表組みになります。
- インライン要素はダブルクォーテーション(")で囲むことができます。ダブルクォーテーションで囲むことで、カンマ(,)を含むインライン要素を記述できます。
- ダブルクォーテーション(")で囲んだデータの中で、ダブルクォーテーションを2つ("")続けることで、ダブルクォーテーション(")を含むインライン要素を記述できます。
- インライン要素の代わりにイコールを2つ(==)記述すると、colspanを意味します。
- インライン要素の左に1つ以上の半角空白文字を記述すると右寄せに、インライン要素の左右に1つ以上の半角空白文字を記述するとセンタリングになります。
- 表組みは、他のブロック要素の子要素になることができます。
- 表組みは、他のブロック要素を子要素にすることができません。
見出し
* インライン要素行頭で * を記述すると、見出しになります。見出しは *、**、***
- 見出しは、他のブロック要素の子要素になることはできません。見出しが現われると他のブロック要素は終了します。
- 見出しは、他のブロック要素を子要素にすることはできません。
目次
#contents行頭で #contents を記述すると、見出しに基づいて目次を作成します。一般的に #contents はページの最初のほうに記述します。
- 目次は、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。
- 目次は、他のブロック要素を子要素にすることはできません。
左寄せ・センタリング・右寄せ
LEFT:インライン要素 CENTER:インライン要素 RIGHT:インライン要素行頭で LEFT:、 CENTER:、 RIGHT: を記述すると、インライン要素が左寄せ、センタリング、右寄せされます。
- LEFT:、CENTER:、RIGHT:は、他のブロック要素の子要素になることができます。
- LEFT:、CENTER:、RIGHT:は、他のブロック要素を子要素にすることができません。
水平線
====行頭で4つ以上の - を書くと水平線になります。
- 水平線は、他のブロック要素の子要素になることはできません。水平線が現われると他のブロック要素は終了します。
- 水平線は、他のブロック要素を子要素にすることはできません。
#hr
行頭で #hr を記述すると、区切り線になります。区切り線は上位のブロック要素の幅の60%の長さの水平線がセンタリングされて引かれます。 - 区切り線は、他のブロック要素の子要素になることができます。
- 区切り線は、他のブロック要素を子要素にすることはできません。
行間開
#br行頭で #br を記述すると、ブロック要素間またはブロック要素内で行間を開けることができます*
#brをブロック要素の直後の空行の次に指定すればブロック要素間の行間、ブロック要素の直後に指定すればそのブロック要素内での行間を開けることになります。#brは、行末改行と違って、次の行の行頭書式を無効にはしません
。- 行間開けは、他のブロック要素の子要素になることができます。
- 行間開けは、他のブロック要素を子要素にすることはできません。
添付ファイル・画像の貼り付け
#ref(添付ファイル名) #ref(ファイルのURL)行頭で #ref を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。
- #ref には、カンマで区切って下記のパラメタを指定できます。パラメタを省略した場合はデフォルト値となります。
添付ファイルのページ
添付ファイルが存在するページ名を指定します。デフォルトは現在のページです。このパラメタを指定する場合は、添付ファイル名の次に記述します。left center right
- ファイルへのリンク・画像を表示する位置を指定します。デフォルトではセンタリングされます。
wrap nowrap
- ファイルへのリンク・画像を枠で囲むかどうかを指定します。デフォルトは囲みません。
around
- テキストの回り込みを指定します。デフォルトでは回り込みを行ないません。
nolink
- デフォルトでは添付ファイルへのリンクが張られますが、nolinkを指定するとリンクを張りません。
代替文字列
- ファイル名の代わりに表示する文字列や画像の代替文字列を指定できます。指定しない場合は、ファイル名になります。
- 代替文字列には文字列以外のインライン要素を含めることはできません。ページ名、文字列以外のインライン要素を記述しても文字列として扱われます。
- このパラメタを指定する場合は、最後に記述します。
- #refは、他のブロック要素の子要素になることができます。
- #refは、他のブロック要素を子要素にすることはできません。
テキストの回り込みの解除
#clear行頭で #clear を記述すると、 #ref で指定したテキストの回り込みを解除します。 #clear を指定しなくても、記事の末尾でテキストの回り込みが自動的に解除されます。
- #clearは、他のブロック要素の子要素になることができます。
- #clearは、他のブロック要素を子要素にすることができません。
フォーム
#comment();行頭で #comment を記述すると、コメントを挿入するためのフォームが埋め込まれます。
#news(n);行頭で #news(n); を記述すると、ニュースを n 個表示することができます。このニュースは、日付が未来のものがあれば、Upcomming eventとして二段組で表示されます。
インライン要素
- インライン要素は、必ずブロック要素の子要素になっています。
- 行頭書式でブロック要素を明示しない場合は、段落の子要素となります。
- 行頭書式でブロック要素を明示した場合は、指定したブロック要素の子要素になります。
- 特定のインライン要素は、他のインライン要素を子要素にすることができます。
- インライン要素はブロック要素を子要素にすることはできません。
- インライン要素となるプラグイン及びユーザー定義は &~; の形式になっています。
- インライン要素となるプラグインに対してオプションと子要素を指定する場合は、 &プラグイン名(オプション){子要素}; の形式になります。
文字列
文字列文字列はインライン要素です。
- 文字列は、他のインライン要素の子要素になることができます。
- 文字列は、他のインライン要素を子要素にすることができません。
改行
インライン要素~行末に~を書くと行末改行になります。行末改行はブロック要素内での改行になります。
- 行末改行の次の行の行頭書式は無効になり、文字列として扱われます。
- 行末改行は、他のインライン要素の子要素になることはできません。
- 行末改行は、他のインライン要素を子要素にすることはできません。
- 行末改行は、定義リストの定義語、表組みの要素、#で始まるブロック要素のパラメタの中では使用できません。
&br;
行中に
を書くと、そこで改行されます。行末の ~ と違い、定義リストの定義語や表組の要素、# で始まるブロック要素のパラメタの中でも使用できます。
- 行中改行は、他のインライン要素の子要素になることができます。
- 行中改行は、他のインライン要素を子要素にすることはできません。
強調・斜体
''インライン要素''行中のインライン要素を '' ではさむと、インライン要素が 強調表示 になります。
- 強調は、他のインライン要素の子要素になることができます。
- 強調は、他のインライン要素を子要素にすることができます。
'''インライン要素'''
行中のインライン要素を ''' ではさむと、インライン要素が 斜体表示 になります。
- 斜体は、他のインライン要素の子要素になることができます。
- 斜体は、他のインライン要素を子要素にすることができます。
文字サイズ
&size(サイズ){インライン要素};行中に &size を書くとインライン要素の文字サイズを指定することができます。サイズはピクセル単位(px)で指定します。例えば20を指定すると、20ピクセルの文字の大きさになります。
- 文字サイズは、他のインライン要素の子要素になることができます。
- 文字サイズは、他のインライン要素を子要素にすることができます。
文字色
&color(文字色,背景色){インライン要素};行中に &color と書くとインライン要素の文字色と背景色を指定することができます。背景色は省略できます。
- 色の指定は、次のいずれかの形式で行ないます。
- 色を意味するキーワード(red, blueなど)
- #16進数6桁
- #16進数3桁
- 文字色は、他のインライン要素の子要素になることができます。
- 文字色は、他のインライン要素を子要素にすることができます。
取消線
%%インライン要素%%行中のインライン要素を%%ではさむと、インライン要素に取消線が付きます。
- 取消線は、他のインライン要素の子要素になることができます。
- 取消線は、他のインライン要素を子要素にすることができます。
注釈
- 注釈は、他のインライン要素の子要素になることができます。親要素は注釈文ではなく、注釈へのリンクに反映されます。
- 注釈は、他のインライン要素を子要素にすることができます。子要素は注釈文に反映されます。
- 注釈は、*をクリックするとあらわれます。
添付ファイル・画像の貼り付け(インライン)
&ref(添付ファイル名);&ref(ファイルのURL);行中で &ref を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。
- &ref には、カンマで区切って下記のパラメタを指定できます。パラメタを省略した場合はデフォルト値となります。
添付ファイルのページ
添付ファイルが存在するページ名を指定します。デフォルトは現在のページです。このパラメタを指定する場合は、添付ファイル名の次に記述します。nolink
- デフォルトでは添付ファイルへのリンクが張られますが、nolink を指定するとリンクを張りません。
代替文字列
- ファイル名の代わりに表示する文字列や画像の代替文字列を指定できます。指定しない場合は、ファイル名になります。
- 代替文字列には文字列以外のインライン要素を含めることはできません。ページ名、文字列以外のインライン要素を記述しても文字列として扱われます。
- このパラメタを指定する場合は、最後に記述します。
- &ref は、他のインライン要素の子要素になることができます。
- &ref は、他のインライン要素を子要素にはできません。
ルビ構造
&ruby(ルビ){インライン要素};行中で &ruby を書くとインライン要素に対するルビをふることができます。ルビに対応していないブラウザではルビが本文中に ( と ) に囲まれて表示されます。
- ルビ構造のルビにはインライン要素を記述します。ただし、ルビの特性上、期待通りの表示になるとは限りません。
- ルビ構造は、他のインライン要素の子要素になることができます。
- ルビ構造は、他のインライン要素を子要素にすることができます。
- ルビ構造をルビ構造の子要素にはできません(ネストはできません)。
- 注釈内や文字サイズを小さくしている部分での使用は、ルビが判読できなくなるので避けてください。
アンカーの設定
&aname(アンカー名); &aname(アンカー名){インライン要素};行中で &aname を記述するとリンクのアンカーを設定することができます。リンクの飛び先にしたい位置に記述します。
- アンカー名は、半角アルファベットから始まる半角アルファベット・数字・ハイフン・アンダースコアからなる文字列を指定します。
- アンカー名の中には、全角文字や半角空白文字、半角記号を含めることはできません。
- アンカー設定は、他のインライン要素の子要素になることができます。
- アンカー設定は、他のインライン要素を子要素にすることができます。
カウンタ表示
&counter; &counter(オプション);行中で &counter を記述するとそのページにアクセスした人の数を表示することができます。
- &counter には次のオプションを指定できます。オプションを省略した場合はtotalが指定されたものとみなされます。
today
- 今日のアクセス数を表示します。
yesterday
- 昨日のアクセス数を表示します。
total
- アクセス総数を表示します。
- 今日のアクセス数を表示します。
- カウンタ表示は、他のインライン要素の子要素になることができます。
- カウンタ表示は、他のインライン要素を子要素にはできません。
オンライン表示(実装しません)
オンライン表示は、デフォルトではサポートしませんが、プラグインで開発可能です。
WikiName(実装しません)
WikiName
Wikiでよくある上記の記述で自動リンク作成機能は、サポートしません。リンクの作成は、下記にあるように明示的に記述する必要があります。
ページ名
[[ぷきうぃき]]行中で [[ と ]] で囲まれた文字列はページ名になります。
- ページ名の中には、全角文字、記号、数字、半角空白文字を含めることができます。
- ページ名の中には、"#&<> を含めることはできません。
- すでに存在するページであればそのページへのリンクが自動的に貼られます。存在しない場合はページ名の後ろに?が自動的に付き、そのページを新規作成するためのリンクが貼られます。
[[ページ名#アンカー名]]
- ページ名にアンカー名をつけることもできます。
- ページ名は、他のインライン要素の子要素になることができます。
- ページ名は、他のインライン要素を子要素にはできません。
InterWiki
[[InterWikiName:ページ名]]行中のページ名形式の文字列の中で、: で2つの文字列を区切るとInterWikiになります。:の前にはInterWikiNameのページで定義したInterWikiNameを、: の後ろにはページ名を記述します。
[[InterWikiName:ページ名#アンカー名]]ページ名の後ろにアンカー名をつけることもできます。
- InterWikiNameの中には、全角文字を含めることができます。
- InterWikiNameの中には、半角空白文字を含めるができます。
- InterWikiは、他のインライン要素の子要素になることができます。
- InterWikiは、他のインライン要素を子要素にはできません。
リンク
[[リンク名:URL]]行中のInterWikiNameの形式の文字列の中で、: の前に任意のリンク名を、: の後ろにURLを記述すると、そのリンク名でURLに対するリンクを貼ることができます。
- リンク名には、全角文字や半角空白文字を含めることができます。メールアドレスを指定する場合は、mailto:を書かずにアドレスだけを記述します。
http://www.example.com/ https://www.example.com/ ftp://ftp.example.com/ news://news.example.com/ foo@example.com
行中に直接、URLを記述した場合は自動的にそのURLに対するリンクが貼られます。 - 記述したURLが画像ファイルである場合は、その画像を表示します。
- リンクは、他のインライン要素の子要素になることができます。
- リンクは、他のインライン要素を子要素にはできません。
エイリアス
[[エイリアス名>ページ名]]行中のページ名形式の文字列の中で、> で2つの文字列を区切るとエイリアスになります。 > の前にはエイリアス名を、> の後ろにはページ名を記述します。
- エイリアスはPukiWiki内のページ名とは別のエイリアス名で、指定したページへのリンクを貼ります。
[[エイリアス名>ページ名#アンカー名]] [[エイリアス名>#アンカー名]]ページ名にアンカー名を付け加えてアンカーへのリンクを貼ることができます。ページ名とアンカー名の間には#をつけます。カレントページのアンカーへリンクを貼る場合はページ名を省略することができます。
[[エイリアス名>http://www.example.com/]] [[エイリアス名>https://www.example.com/]] [[エイリアス名>ftp://ftp.example.com/]] [[エイリアス名>news://news.example.com/]] [[エイリアス名>foo@example.com]] [[エイリアス名>InterWikiName:ページ名]] [[エイリアス名>InterWikiName:ページ名#アンカー名]]
エイリアスをURLやInterWikiと組み合わせることもできます。
[[エイリアス名:http://www.example.com/]] [[エイリアス名:https://www.example.com/]] [[エイリアス名:ftp://ftp.example.com/]] [[エイリアス名:news://news.example.com/]] [[エイリアス名:foo@example.com]]
URLを指定する場合は、>の代わりに:も使用できます。
- エイリアス名の中には、全角文字を含めることができます。
- エイリアス名の中には、半角空白文字を含めることができます。
- 階層化されたページでは、ページ名を相対指定することができます。
- エイリアスは、他のインライン要素の子要素になることができます。
- エイリアスは、他のインライン要素を子要素にできます。
日時置換文字
&date; &time; &now;
- 行中で &date; と書くと、更新時の日付に置換されます
- 行中で &time; と書くと、更新時の時刻に置換されます
- 行中で &now; と書くと、更新時の日時に置換されます
- &date;、 &time;、 &now;は、記事が書き込まれるときに置換されて記録されます。
- &date;、 &time;、 &now;は、他のインライン要素の子要素になることができます。
- &date;、 &time;、 &now;は、他のインライン要素を子要素にはできません。
&_date; &_time; &_now;
- 行中で &_date; と書くと、表示時の日付に置換されて出力されます。
- 行中で &_time; と書くと、表示時の時刻に置換されて出力されます。
- 行中で &_now; と書くと、表示時の日時に置換されて出力されます。
&lastmod; &lastmod(ページ名);
- 行中で &lastmod; と書くと、そのページの最終更新日時に置換されて出力されます。
- ページ名を指定すると、その指定されたページの最終更新日時に置換されて出力されます。
- &_date;、 &_time;、 &_now;、 &lastmod;は、記事が表示されるときに置換されて出力されます。
- &_date;、 &_time;、 &_now;、 &lastmod;は、他のインライン要素の子要素になることができます。
- &_date;、 &_time;、 &_now;、 &lastmod;は、他のインライン要素を子要素にはできません。
文字参照文字
文字参照は、SGMLで定義されている文字参照文字(©や®など)のほか、下記の独自の文字参照文字が使用できます。
&heart; ⌣ &bigsmile; &huh; &oh; &wink; &sad; &worried;
- 行中で&heart;と書くと、ハートマーク に置換されて出力されます。
- 行中で⌣と書くと、に置換されて出力されます。
- 行中で&bigsmile;と書くと、に置換されて出力されます。
- 行中で&huh;と書くと、 に置換されて出力されます。
- 行中で&oh;と書くと、 に置換されて出力されます。
- 行中で&wink;と書くと、 に置換されて出力されます。
- 行中で&sad;と書くと、 に置換されて出力されます。
- 行中で&worried;と書くと、 に置換されて出力されます。
- 文字参照文字は、表示されるときに置換されます。
- 文字参照文字は、他のインライン要素の子要素になることができます。
- 文字参照文字は、他のインライン要素を子要素にはできません。
数値参照文字
&u(10進数); &ux(16進数);
行中で &u( と ); の間に10進数を、&ux( と );の間に16進数を書くと、Unicodeを数値参照して表示します。キーボードから直接入力できない文字やJIS第3水準・第4水準の文字などの表示に使用します。たとえば、内田百&u(38290);と入力すると、内田百閒と表示されます。
- 数値参照文字は、表示されるときに置換されます。
- 数値参照文字は、他のインライン要素の子要素になることができます。
- 数値参照文字は、他のインライン要素を子要素にはできません。
- 16進数は半角小文字で指定する必要があります(XHTML 1.0 第2版から小文字に限定されました)。
その他
コメント行
// コメント行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。
- コメント行は、他の要素と無関係に行単位でどの位置にも記述できます。
- コメント行は、前後の他の要素に何ら影響を及ぼしません。
ページナビ
#page_navi;CMS処理で関連付けられたページリンクを作成する。
HTMLのダイレクトインクルード
#include_html(fname)HTMLでの記述されたファイルfnameをインクルードします。ファイルは予めページの添付としてアップロードしておく必要があります。
特殊な文字
Siwikiのコマンドに用いられている '{', '}', '[', ']'等を他のインラインコマンドと同時に用いる場合には、そのままで表示されないことがある。
現在は、下のように記載すれば、表示される。
- − : -
- + : +
- &vbar; : |
- { : {
- } : }
- &lbracket; : [
- &rbracket; : ]
インデント
ブロック要素をインデントしたい場合には、行頭に '_'を入れるとブロック全体を右にずらします。'_'は複数記載することが可能です。