====== ページ一覧プラグイン ======

---- plugin ----
description: 見栄えの良い表または番号なしリストのページ一覧（前任の作者：Esther Brunner, Gina Häußge, Michael Klier）
author     : Matthias Schulte, Michael Hamann
email      : michael@content-space.de
type       : syntax, helper
lastupdate : 2014-05-26
compatible : rincewind, adora belle, weatherwax, binky, ponder stibbons
depends    : 
conflicts  :
similar    : 
tags       : formatting, list, tables, page

downloadurl: https://github.com/dokufreaks/plugin-pagelist/tarball/master
sourcerepo : https://github.com/dokufreaks/plugin-pagelist
bugtracker : https://github.com/dokufreaks/plugin-pagelist/issues
donationurl: 
----

===== 概要 =====

ページ一覧プラグインは、wikiページの一覧を引数とし、それらについての情報をきれいにフォーマットした表を提供します。
プラグインには、ページ一覧の情報と形式を制御するための多数のフラグがあります。
[[ja:plugin:blog|ブログ]]・[[plugin:discussion|Discussion]]・[[plugin:editor|Editor]]・[[ja:plugin:tag|タグ]]・[[plugin:task|Task]]・[[plugin:dir|Dir]]プラグインという人気のヘルパープラグインとして、特別なページ参照一覧を提供できます。

===== 構文 =====

内部リンクの番号なしリストを ''%%<pagelist>%%'' タグで単純にラップします。
下の例のように、特定の内部のページ参照を提供するかそれらを供給するプラグインを持っています：

  <pagelist&[flags]>
    * [[..:blog:|Blog Plugin]]
    * [[..:discussion:|Discussion Plugin]]
    * [[..:editor:|Editor Plugin]]
    * [[..:tag:|Tag Plugin]]
    * [[..:wrap|Wrap Plugin|This is shown in the description cell]]
  </pagelist>

^ [flags] | フラグはページ一覧の外観を変更するために使用します。[[#フラグ]]を参照。 | 任意項目 |

==== フラグ ====

^ 設定 ^ デフォルト ^^ 代替 ^^
| ''style'' ^ ''default'' | 水平線付きの表 ^ ''table'', ''list'' or ''simplelist'' | 標準の DokuWiki 表、一覧形式 |
| ''showheader'' ^ ''noheader'' | ページ一覧表の見出し行を隠す ^ ''header'' | 見出し行を表示 |
| ''showdate'' ^ ''date'' | 作成日・最終更新日を表示 ^ ''nodate'' | 日付を隠す |
| ''showuser'' ^ ''user'' | 作成者・編集者を表示 ^ ''nouser'' | ユーザーを隠す |
| ''showdesc'' ^ ''nodesc'' | 説明を隠す ^ ''desc'' | 説明を表示（メタデータから） |
| ''showcomments'' ^ ''nocomments'' | コメント数を隠す ^ ''comments'' | コメント数を表示（[[plugin:discussion|議論プラグイン]]がインストールされている場合） |
| ''showtags'' ^ ''notags'' | タグを隠す ^ ''tags'' | タグを表示（[[ja:plugin:tag|タグプラグイン]]がインストールされている場合） |
| ''showfirsthl'' ^ ''firsthl'' | 最初の見出しを表示 ^ ''nofirsthl'' | ページ名を表示 |
| ''rsort/sort''        ^ ''nosort''    | ページのソートなし ^ ''rsort/sort'' | ページ名の（逆）アルファベット順にページをソート |

==== 例 ====

  <pagelist&header&comments>
      //表示ページの番号なしリスト//
  </pagelist>

上記の例では、ページ一覧は、見出し行とコメント数（[[plugin:discussion|議論プラグイン]]がインストールされている場合）と共に表に記載されるページの情報を表示します。
ユーザー（またはプラグイン）は一覧に表示するページを指定する必要があります。

===== 設定 =====

プラグインは、管理者メニュー内の設定管理画面を使用して設定できます。
例えば[[ja:plugin:blog|ブログプラグイン]]のアーカイブ部品のような、ページ一覧プラグインのヘルパー部品を使用しているプラグインにも、設定内容は適用されます。

^ ''style'' | 一覧形式（デフォルト、リスト、テーブル） |
^ ''showheader'' | 表見出しの表示 |
^ ''showdate'' | 日付項目の表示（隠す、作成日、修正日） |
^ ''showuser'' | ユーザー項目の表示（隠す、作成者、編集者） |
^ ''showdesc'' | ページの最初の段落から作った短い説明の表示 (隠す、最大160文字、最大500文字） |
^ ''showcomments'' | コメントの表示（[[plugin:discussion|議論プラグイン]]が必要） |
^ ''showlinkbacks'' | リンクバックの表示（[[http://foosel.org/snippets/dokuwiki/linkback|リンクバックプラグイン]]が必要） |
^ ''showtags'' | タグの表示（[[ja:plugin:tag|タグプラグイン]]が必要） |
^ ''sort''     | ページ名でソート |

===== ヘルパープラグイン =====

自分のプラグインでページ一覧プラグインの機能を簡単に利用できます。
以下は基本的なコード例です：

<code php>
  $pages = array(
    array('id' => 'wiki:dokuwiki'),
    array('id' => 'wiki:syntax'),
  );
  $pagelist =& plugin_load('helper', 'pagelist');
  if (!$pagelist) return false; // failed to load plugin
  $pagelist->startList();
  foreach ($pages as $page){
    $pagelist->addPage($page);
  }
  $renderer->doc .= $pagelist->finishList();
</code>


===== バグと機能要求 =====

バグや機能要求は[[https://github.com/dokufreaks/plugin-pagelist/issues|バグトラッカー]]へお願いします。

===== 詳細資料 =====

  * [[https://github.com/dokufreaks/plugin-pagelist/tree/master|Git リポジトリ]]
  * [[https://github.com/dokufreaks/plugin-pagelist/issues|バグトラッカー]]

===== 変更履歴 =====

{{rss>https://github.com/dokufreaks/plugin-pagelist/commits/master.atom date}}

===== 翻訳 =====


===== 議論 =====

ここはプラグインに関する一般的な議論のための場所です。
バグや機能要求は、このページにリンクされたバグトラッカーへ提出して下さい。

[[plugin:pagelist#discussion|Discussion]] を参照してください。