Help:ブログ記事/ブログリスト
出典: Help Wiki
| ブログ記事/ブログリスト | |
|---|---|
| 区分 | パーサーフック |
| 対象 | 全利用者 |
| 実装状況 | 全プロジェクト |
ブログ記事を利用したブログリストでは、通常のウィキの記事にブログのリストを埋め込むことができます。これはブログのリストページと似たようなものであり、<bloglist> という拡張機能タグを使用します。
メインページ、コミュニティポータル、コンテストページなど、異なるコンテンツページにあわせられるように、埋め込みリストにはカスタマイズできるパラメータがいくつか用意されています。
最初はこの機能が複雑に見えるかもしれませんが、それぞれのパラメータにはデフォルトの設定があるので、あとは必要な分だけ必要なパラメータを設定すればよいのです。たとえば、<bloglist></bloglist> というコードだけでも、それぞれのウィキでの全ての投稿をリストしたものになります。
目次 |
[編集] 基本書式
この拡張機能の基本的な書式は以下の通りです:
<bloglist パラメータ1=設定1 パラメータ2="スペースつきの設定" p3=s3 p4=s4> <category>カテゴリ1</category> <category>カテゴリ2</category> <author>作者1</author> <author>作者2</author> </bloglist>
[編集] カテゴリと作者
カテゴリと作者は、他のパラメータとは異なって複数の入力を取るため書式が異なることに注意してください。
作者とカテゴリを同時に指定すると、選択されたカテゴリ内の選択された作者による投稿が表示されます。
[編集] 拡張機能への入力
- category
- これは、どのカテゴリにある投稿をリストにするか指定します。
- これは、"or"セレクタになります。つまり、複数のカテゴリが指定されていた場合、それぞれのカテゴリのうちどれか一つにでも属していればその記事はリストに追加されることになります。もしこれが未指定の場合、カテゴリがつけられていない投稿も含め全てのカテゴリの記事をデフォルトとして表示します。
- 使用例:
<category>カテゴリ1</category> <category>カテゴリ2</category> <category>カテゴリ3</category>
- author
- これは、どの作者の投稿をリストにするか指定します。
- これも"or"セレクタになります。つまり、複数の作者が指定されていた場合、それぞれの作者のうちどれか一人によるものであればその記事はリストに追加されることになります。もしこれが未指定の場合、全ての作者の記事をデフォルトとして表示します。
- 使用例:
<author>作者1</author> <author>作者2</author> <author>作者3</author>
- count
- これは、表示される投稿の数を指定します。
- 整数値を指定してください。未指定の場合、5がデフォルトで設定されます。
- 使用例:
<bloglist count=3>
- summary
- これは、リストにブログの本文を表示するかどうかを指定します。これは全文を表示することを意図しているわけではなく、一定の長さの文章はカットされることに注意してください。
- 指定できるのは
trueもしくはfalseで、デフォルトではfalseになっています。もしtrueにすると、記事の本文のうち最初の200文字[1]が表示されます。 - 使用例:
<bloglist summary=true>
- summarylength
- これは、
summary=trueになっている場合に表示されるテキストの長さを指定します。 - 使用例:
<bloglist summary=true summarylength=300>
- type
- これは、出力のスタイルを選択します。
- 指定できるのは
boxもしくはplainで、未指定の場合はデフォルトとしてboxが選択されます。 - 使用例:
<bloglist type=plain>
- title
- これは、上の type が box のときにボックスのタイトルして表示される文字列を指定します。文字列にスペースを含む場合、"(ダブルクオーテーション)で囲まなければなりません。
- 使用例:
<bloglist title="HogeHoge's Blog">
- style
- これは、他のパラメータでは指定できないスタイリングを提供するもので、一般的なCSSのスタイルと同様に動作します。
- 未指定の場合は空欄扱いとなります。
- 使用例:
<bloglist style="float:right;clear:left;">
- order
- これは、投稿をどのようにソートするかを指定します。
- 指定できるのは
dateもしくはauthorで、未指定の場合はデフォルトとしてdateが選択されます。 - 使用例:
<bloglist order=date>
- ordertype
- これは、ソートの順番を指定します。
- 指定できるのは
descendingもしくはascendingで、未指定の場合はデフォルトとしてdescendingが選択されます。 - 使用例:
<bloglist ordertype=descending>
- timestamp
- これは、タイムスタンプを表示するかどうかを指定します。
- 指定できるのは
trueもしくはfalseで、未指定の場合はデフォルトとしてfalseが選択されます。 - 使用例:
<bloglist timestamp=true>
[編集] サンプルコード
<bloglist count=3 summary=true summarylength=250 type=plain title="サンプルコード" timestamp=true order=date> <category>ブログ</category> <category>Hoge</category> <author>Angela</author> <author>Tommy6</author> <author>TOR</author> </bloglist>
[編集] その他
- 指定されたパラメターに該当する投稿が見つからない場合、以下のようなメッセージが表示されます。 "一つも投稿が見つかりませんでした。 記事を投稿する"
[編集] 脚注
- ↑ 200バイトなのか200文字なのかは不明。
