ソース表示: WikiPlugins #108441

[[PageNavi(NavigationList)]]

= 拡張文法 =

[[PageOutline(start=2, depth=9)]]

== 文法 ==

{{{
[[PluginName]]
[[PluginName(arg1, arg2, arg3...)]]
}}}

== 一覧 ==

=== BR ===
 * 引数
   * clear={left|right|both}

 * 例:
{{{
文中で強制改行を[[BR]]かけます。
回り込みの解除用にも[[BR(clear=left)]]使えますが、注意が必要です。
}}}

文中で強制改行を[[BR]]かけます。
回り込みの解除用にも[[BR(clear=left)]]使えますが、注意が必要です。

どうしても特定の場所で改行したい場合に使えます。
通常は空行で段落を分割することをおすすめします。

clear=right, clear=all は今のところ殆ど役に立ちません。
これを使うと、(現在のHTMLの構造の関係で)改行後の文字列が
サイドバーの下に落ちてしまいます。

=== !PageBreak ===
 * 引数: なし
 * 例:
{{{
↓PDF作成時および印刷時はこの場所で
[[PageBreak]]
↑改ページされます。
}}}

↓PDF作成時および印刷時はこの場所で
[[PageBreak]]
↑改ページされます。

印刷/PDF生成時の改行場所を指定します。特定の場所で改ページしたい場合に使えます。

=== !PageOutline ===

 * 引数
   * start=N - N にツリーの表示を開始するヘッダレベルを指定します。(default=1)
   * depth=N - N に表示する深さを指定します。(default=3)
   * type={ordered|unordered} - ツリーアイテムに数字を振るかどうかを選択します (default=ordered)
 * 例:
{{{
[[PageOutline]]
[[PageOutline(start=2, depth=9, type=unordered)]]
}}}

挿入位置にナビゲーション用見出し一覧を生成します。
[[PageOutline]]
[[PageOutline(start=2, depth=9, type=unordered)]]

=== Include ===

 * 引数: ページ名
 * 例:
{{{
[[include(WikiPlugins)]]
}}}

他のページを現在の位置に埋め込みます。
読み込みのネストは最大4段までに制限されています。

=== Embed ===

 * 引数
   * 添付ファイル名
   * caption=キャプション文字列
   * float={right|left}
 * 例:
{{{
[[Embed(hello.rb)]]
[[Embed(https://static.osdn.jp/magazine/magazine-h23.png)]]
[[Embed(magazine-300x88.png, caption=OSDN Magazine のロゴ)]]
[[Embed(magazine-300x88.png, float=right)]]
}}}

可能な限りファイルを展開した形で現在の位置に埋め込みます。
画像、各種ソースコード、diff, テキスト、 PDF、Flash 等に対応しています。
"ページ名:ファイル名" とすると、他のページのファイルも読み込むことが出来ます。
ファイル名に http(s) から始まる絶対URLを指定することにより、外部の画像も埋め込み表示が可能です。

[[Embed(hello.rb)]]
[[Embed(https://static.osdn.jp/magazine/magazine-h23.png)]]
[[Embed(magazine-300x88.png, caption=OSDN Magazine のロゴ)]]

caption= を指定すると画像にキャプションをつける事が出来ます。
'''このオプションを指定すると画像はインライン表示出来なくなります。'''
キャプションが指定された場合、標準ではセンタリングして表示されます。

[[Embed(magazine-300x88.png, float=right)]]

float を指定すると左か右に寄せ、文章を回り込ませる事が出来ます。
(ただし、現状clearすることは出来ません。)

=== Thumb ===

 * 引数
   * 添付ファイル名
   * caption=キャプション文字列
   * float={right|left}
   * size={small|default|large|NNNxNNN}
 * 例:
{{{
[[Thumb(slashdot-jp.png, size=240x240, caption=Konqueror で スラド)]]
}}}

[[Thumb(slashdot-jp.png, size=240x240, caption=Konqueror で スラド)]]

画像を自動的にサムネイル化して埋め込みます。
オプションは基本的に Embed と同じですが、画像ファイル以外を渡す事は出来ません。

size= にサイズを渡すとサムネイルのサイズを指定することが出来ます。
"small" (128x128), "default" (300x300), "large" (480x480), 
もしくは ''任意の数字''x''任意の数字'' (例えば 123x456)の様な文字列が指定できます。
省略時は default です。実際の画像は指定に内接する最大の矩形になります。

=== !LinkAttach === #linkattach

 * 引数
   * 添付ファイル名
   * caption=表示に使う文字列
 * 例:
{{{
添付ファイルを [[LinkAttach(slashdot-jp.png)]] の様に文中から
リンクします。caption を書くとファイル名の代わりにその内容が
[[LinkAttach(slashdot-jp.png, caption=表示されます)]]。
}}}

添付ファイルを [[LinkAttach(slashdot-jp.png)]] の様に文中から
リンクします。caption を書くとファイル名の代わりにその内容が
[[LinkAttach(slashdot-jp.png, caption=表示されます)]]。


=== Footnote === #footnote-desc

 * 引数
   * 脚注として表示したい文字列
 * 例:
{{{
 内容は1行で好きなように書けます。[[Footnote(ただし現在カンマは入りません)]]
}}}

内容は1行で好きなように書けます。[[Footnote(ただし現在カンマは入りません)]]

最下部に脚注を表示し、そこへのリンクを埋め込みます。
ただし、文法上今のところ半角のカンマ "," を入れることは出来ません。

各種リンクは解釈されますが、今のところインラインスタイルは使うことが出来ません。

=== !LineComment ===

 * 引数:
   * rows=数値
   * direction={above|below}
 * 例:
{{{
[[LineComment]]
}}}

[[LineComment]]
  * test[[BR]]-- [id:tmskmr tmskmr] (2017-12-29 01:27:56 JST)
  * ssss[[BR]]-- [id:noboru_saito noboru_saito] (2014-09-09 23:23:38 JST)
  * 1[[BR]]-- anonymous (2012-06-08 15:14:48 JST)
  * ああ[[BR]]-- anonymous (2012-05-03 20:25:41 JST)
  * こんちわ。[[BR]]-- [id:akitsukada akitsukada] (2010-08-29 22:22:38 JST)
  * 改行される?[[BR]]-- 名前が (2009-09-19 00:53:36 JST)
  * ほど[[BR]]-- なる (2008-04-03 10:52:25 JST)
  * 挿入するフォーマットが変わりました[[BR]]-- [id:sugi sugi] (2008-02-05 01:38:35 JST)
  * こんにちわ ([id:nabeshin nabeshin] - 2008-01-18 18:53:38 JST)
  * aaa ([id:tosnoz tosnoz] - 2008-01-07 14:08:44 JST)
  * ああ ( - 2008-01-06 12:31:37 JST)

1行コメントボックスを表示します。
コメントを投稿した場合、この次の行に箇条書きで追加されます。
このボックスからの記入は '''権限設定を無視し、誰でも書く事が出来ます''。

現在インライン要素扱いですが、これをインラインで文中に入れた場合、
正しく表示されません。また、記入されたコメントは次の行に挿入されます。

rows に数値を指定すると複数行の入力ボックスを表示します。入力時の改行は![[BR]]に変換されます。

direction に above を指定すると、!LineComment の次の行ではなく、前の行に追加するようになります。

=== !TitleIndex === #titleindex-desc

 * 引数 (最初の "識別子=" は省略できます。省略した場合、数値ならば max, それ以外は prefix として扱われます)
   * max=最大表示数 (ディフォルト1024)
   * prefix=リストするページをprefixのみにする
   * exclude=リストから除外するページのprefix
 * 例:
{{{
[[TitleIndex(10)]]
[[TitleIndex(FAQ/)]]
[[TitleIndex(prefix=FAQ/, max=1024)]]
[[TitleIndex(prefix=FAQ/, prefix=Help/, exclude=FAQ/member)]]
}}}

[TitleIndex ページ一覧]の表示に使われています。

prefix と exclude は複数け書けます(順番は関係ありません)。
prefix を書かなければ全てのページになります。

=== !PageNavi ===

 * 引数
   * ページ構造を示すリストを保持するページ
 * 例:
{{{
[[PageNavi(NavigationList)]]
}}}
   * 引数に与える!NavigationList:
{{{
 * [プロジェクトWikiに関する文書]
   * [WikiSyntax Wiki の文法]
   * [WikiLinks リンクの種類と文法]
   * [WikiBlockProcessor ブロックプロセッサ]
   * [WikiPlugins 拡張文法]
   * [WikiSideBar サイドバー]
   * [WikiAffiliateSetting プロジェクトWikiでの広告設定]
}}}

[[PageNavi(NavigationList)]]

「上のページ」「前のページ」「次のページ」を表示するページナビゲーションバーを埋め込みます。引数には[NavigationList]のような、各ページの遷移構造のリストを保持するWikiページを与えます。


引数に与えたWikiページ内に含まれないページの場合、ナビゲーションバーは表示されません。

=== !RecentChanges ===

 * 引数 (最初の "識別子=" は省略できます。省略した場合、数値ならば max, それ以外は prefix として扱われます)
   * max=最大表示数 (ディフォルト60)
   * prefix=リストするページをprefixに絞る
   * exclude=リストから除外するページのprefix
 * 例:
{{{
[[RecentChanges(10)]]
[[RecentChanges(FAQ/)]]
[[RecentChanges(prefix=FAQ/, max=1024)]]
}}}

[RecentChanges 最近の更新]の表示に使われています。

オプションは [#titleindex-desc TitleIndex] と同じです。

=== !ReleaseList ===

 * 引数:
   * プロジェクト名 (省略可能)
 * 例:
{{{
[[ReleaseList(sevenzip)]]
}}}
[[ReleaseList(sevenzip)]]

最新リリースファイル一覧のボックスを表示します。
プロジェクト名を指定すると別のプロジェクトを表示することも出来ます。
今のところ見た目のカスタマイズは出来ません。
ほぼ幅いっぱいに表示されるので、サイドバーに使うと良いかもしれません。

=== !RecentTickets ===

 * 引数:
   * limit=表示数 (省略可能。省略時10)
 * 例:
{{{
[[RecentTickets(limit=3)]]
}}}

最近更新のあったチケット一覧を表示します。

=== !RecentActivity ===

 * 引数:
   * max=表示数 (省略可能。省略時10)
   * style={list,table} (省略可能。省略時list)
 * 例:
{{{
[[RecentActivity(max=5)]]
}}}

最近の活動履歴を表示します。style は list の場合 !RecentChanges などと同じリスト形式、table にすると表の形式になります。

=== !RecentBlog ===

 * 引数: なし
 * 例:
{{{
[[RecentBlog]]
}}}

作業部屋に対応したブログエントリ一覧を表示します(プロジェクトには対応していません)。

=== !RecentCommit ===

 * 引数: なし
 * 例:
{{{
[[RecentCommit]]
}}}

最近のレポジトリのコミット一覧を表示します(プロジェクトには対応していません)。

=== !RepositoryInfo ===

 * 引数: なし
 * 例:
{{{
[[RepositoryInfo]]
}}}

作業部屋のレポジトリURLやコードブラウザへのリンクボタン表示します(プロジェクトには対応していません)。

=== !RepositoryReadme ===

 * 引数: なし
 * 例:
{{{
[[RepositoryReadme]]
}}}

コードレポジトリの内の README ファイルを展開して表示します(プロジェクトには対応していません)。

=== !ProjectName ===

 * 引数: なし
 * 例:
{{{
[[ProjectName]]
}}}

プロジェクトや作業部屋の名前を埋め込みます。プロジェクトの場合、各国語の翻訳があれば適切に選択されます。

=== !ProjectDescription ===

 * 引数: なし
 * 例:
{{{
[[ProjectDescription]]
}}}

プロジェクトや作業部屋の説明文を埋め込みます。プロジェクトの場合、各国語の翻訳があれば適切に選択されます。

=== paste ===
 * 引数:
   * コピペ番号 (コピペURLの末尾の数字)
 * 例:
{{{
[[paste(1)]]
}}}
[[paste(1)]]

[http://osdn.jp/pastebin/ OSDNコピペ]に登録されたコピペを埋め込みます。コピペ番号は必須です。

[[PageNavi(NavigationList)]]