拡張文法

Outline

1. 文法
2. 一覧
   1. BR
   2. PageOutline
   3. Include
   4. Embed
   5. Thumb
   6. LinkAttach
   7. Footnote
   8. LineComment
   9. TitleIndex
   10. RecentChanges
   11. ReleaseList

文法

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

一覧

BR

• 引数
  • clear={left|right|both}

• 例:

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

文中で強制改行を
かけます。 回り込みの解除用にも
使えますが、注意が必要です。

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

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

PageOutline

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

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

挿入位置にナビゲーション用見出し一覧を生成します。

Outline

1. 拡張文法
   1. 文法
   2. 一覧
      1. BR
      2. PageOutline
      3. Include
      4. Embed
      5. Thumb
      6. LinkAttach
      7. Footnote
      8. LineComment
      9. TitleIndex
      10. RecentChanges
      11. ReleaseList

Outline

• 文法
• 一覧
  • BR
  • PageOutline
  • Include
  • Embed
  • Thumb
  • LinkAttach
  • Footnote
  • LineComment
  • TitleIndex
  • RecentChanges
  • ReleaseList

Include

• 引数: ページ名
• 例:

  [[include(WikiGuide)]]
  

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

Embed

• 引数
  • 添付ファイル名
  • caption=キャプション文字列
  • float={right|left}
• 例:

  [[Embed(hello.rb)]]
  [[Embed(sflogo.png, caption=SourceForge.jp のロゴ)]]
  [[Embed(sflogo.png, float=right)]]
  

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

def hello(name)
  puts "Hello, #{name}!"
end

hello "world"

SourceForge.jp のロゴ

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

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

Thumb

• 引数
  • 添付ファイル名
  • caption=キャプション文字列
  • float={right|left}
  • size={small|default|large|NNNxNNN}
• 例:

  [[Thumb(slashdot-jp.png, size=240x240, caption=Konqueror で /.j)]]
  

Konqueror で /.j

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

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

LinkAttach

• 引数
  • 添付ファイル名
  • caption=表示に使う文字列
• 例:

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

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

Footnote

• 引数
  • 脚注として表示したい文字列
• 例:

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

内容は1行で好きなように書けます。*1

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

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

LineComment

• 引数:
  • rows=数値
  • direction={above|below}
• 例:

  [[LineComment]]
  

• ganndamu
  -- amuro (2011-04-07 15:04:29 JST)
• ほど
  -- なる (2008-04-03 10:52:25 JST)
• 挿入するフォーマットが変わりました
  -- sugi (2008-02-05 01:38:35 JST)
• こんにちわ (nabeshin - 2008-01-18 18:53:38 JST)
• aaa (tosnoz - 2008-01-07 14:08:44 JST)
• ああ ( - 2008-01-06 12:31:37 JST)

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

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

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

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

TitleIndex

• 引数 (最初の "識別子=" は省略できます。省略した場合、数値ならば 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)]]
  

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

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

RecentChanges

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

  [[RecentChanges(10)]]
  [[RecentChanges(FAQ/)]]
  [[RecentChanges(prefix=FAQ/, max=1024)]]
  

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

オプションは TitleIndex と同じです。

ReleaseList

• 引数: なし
• 例:

  [[ReleaseList]]
  

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

1. *1ただし現在カンマは入りません