DokuWiki

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。
====== Catlist プラグイン ======

---- plugin ----
description: ページと名前空間の再帰的な一覧 
author     : Félix Faisant 
email      : xcodexif@xif.fr 
type       : Syntax
lastupdate : 2015-07-08
compatible : Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun
depends    : 
conflicts  : 
similar    : nspages, dir, dirlisting, nstoc, pagequery, pagelist, pageindex, pglist
tags       : list create page namespace tree recurse links listing navigation
downloadurl: http://dev.xif.fr/catlist/catlist-2015-07-08.zip

----

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

このプラグインは、様々な形式（一覧、行...）で再帰的にページと名前空間を一覧表示します。
ページや名前空間や正規表現の内容を除外することもできます。
見出しをカスタマイズするオプションもあります。
権限があれば、名前空間にある「ページ追加」ボタンで簡単にページ作成できます。

===== スクリーンショット =====

右側に Bootstrap を使用したサイドバーの例が[[http://www.tributieimposte.it/portaleiuc/doku.php|ここ]]にあります。

{{http://dev.xif.fr/catlist/screenshot_both.png?nolink}}

列を使用した例：

{{http://dev.xif.fr/catlist/screenshot_columns.png?nolink}}

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

凡例：''[必須項目]'', ''(任意項目)''

<code><catlist (namespace:) -option1 -option2...></code>

namespace が指定されない場合、今いるページの名前空間を使用します。

オプション：
^  表示オプション                 ^^
|  **[Default]**  ''-displayList''   |  ''<ul>'' と ''<li>'' で表示する。上記のスクリーンショットの最初のような表示です。  |
|  ''-displayLine''                  |  ページと名前空間を一行で表示する。名前空間内の内容は ''['' と '']'' で囲む。**警告** 表示バグがあります。  |
|  ''-noNSInBold''                   |  名前空間と太字見出し（''<strong>''）を表示しない。  |
^  Force links options                   ^^
|  ''-forceLinks''                   |  スタートページがなくても、名前空間リンクを強制的に表示する。  |
^  除外オプション                       ^^
|  ''-exclupage(:"//regex//")''      |  //正規表現// があった場合、一致したページを除外。それ以外は全てのページを除外。  |
|  ''-excluns(:"//regex//")''        |  //正規表現// があった場合、一致した名前空間を除外。それ以外は全ての名前空間を除外。  |
|  ''-exclunsall(:"//regex//")''     |  //正規表現// があった場合、一致したサブ名前空間の内容を除外。それ以外は全てのサブ名前空間の内容を非表示。  |
|  ''-exclunspages(:"//regex//")''   |  //正規表現// があった場合、一致したサブ名前空間のページを除外。それ以外は全てのサブ名前空間のページを除外。  |
|  ''-exclunsns(:"//regex//")''      |  //正規表現// があった場合、一致したサブ名前空間のサブ名前空間を除外。それ以外は全てのサブ名前空間のサブ名前空間を除外。  |
|  **注：** //正規表現//に区切り文字を追加しないでください。区切り文字は ''/'' です。  ||
|  ''-excludeOnID''                  |  ID に基づいて除外 (''namespace:subnamespace:page'')  |
|  ''-excludeOnName''                |  名前空間を除いた名前に基づいて除外 (''page'')  |
|  ''-excludeOnTitle''               |  ページの最初の見出しに基づいて除外 (''The Page'')  |
|  ''-maxDepth://depth//''           |  //depth// 以上再帰しない。 |
^  見出しオプション                          ^^
|  ''-noHead''                       |  見出しを表示しない。  |
|  ''-smallHead''                    |  Display headline into a simple ''<span>'', not into a title  |
|  ''-noLinkStartHead''              |  名前空間一覧にスタートページへのリンクを表示しない。  |
|  **[Default -h1]** ''-h[1-5]''     |  指定されたレベルのタイトルを見出しとして表示する。  |
|  ''-titleHead:"//Title//"''        |  名前空間一覧のスタートページタイトルを指定された //Title// に置き換える。  |
^  ページ追加ボタンオプション           ^^
|  ''-noAddPageButton''              |  表示された名前空間に「ページ追加」ボタンを表示しない。  |
|  ''-addPageButtonEach''            |  サブ名前空間毎に「ページ追加」ボタンを表示する（ページの作成権限がある場合）  |
^  ソートオプション //（デフォルトはファイルシステムのソート順）//                         ^^
|  ''-sortAscending''                |  昇順でソート（アルファベット順）   |
|  ''-sortDescending''               |  降順でソート（アルファベット順）  |

==== ヒント ====

名前空間（''mynamespace''）の ''mypage1'' と ''mypage2'' 以外の全ページを除外したい。
サブ名前空間のページは除外したくない。
これは正規表現では少し難しいが、あれこれ単純化した結果、これがその解決策です：
<code><catlist blocs: -excluPage:"mynamespace:[^:]*(?<!mypage1|mypage2)$"></code>

小さな CSS コードの ''-columns:'' オプションで列のスタイル設定が可能です：
<code><html>
	<style>
		.catlist_columns {
			-webkit-column-rule: 1px solid #BBB;
			   -moz-column-rule: 1px solid #BBB;
			        column-rule: 1px solid #BBB;
		}
	</style>
</html></code>

===== インストール =====

[[ja:plugin:plugin|プラグイン管理]]と最新バージョンを示す上記ダウンロード URL を使用して、プラグインをインストールします。
手動でインストールする方法は、[[ja:plugins|プラグイン]]を参照してください。

これらのリンクからもインストールできます。
  * [[http://dev.xif.fr/catlist/]]
  * [[https://github.com/haobug/dokuwiki_plugin_catlist/archive/master.zip]] 「期限切れ」

===== 開発 =====

[[plugin:catlist#development|Development]] を参照して下さい。


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

[[plugin:catlist#discussion|Discussion]] を参照して下さい。
DokuWiki

ユーザ用ツール

サイト用ツール

ページ用ツール

Global DokuWiki Links
