Extension:CategoryTree
 リリースの状態: 安定 |
|
|---|---|
 |
|
| 実装 | タグ, パーサー関数, 特別ページ |
| 説明 | ウィキのカテゴリ構造の動的なビューをツリーとして提供する。 |
| 作者 | Daniel Kinzler (Duesentriebtalk) |
| 最新バージョン | 継続的な更新 |
| 互換性ポリシー | リリースブランチ |
| MediaWiki | 1.25+ |
| ライセンス | GNU 一般公衆利用許諾書 2.0 以降 |
| ダウンロード | README |
|
|
| translatewiki.net で翻訳を利用できる場合は、CategoryTree 拡張機能の翻訳にご協力ください | |
| 使用状況とバージョン マトリクスを確認してください。 | |
| 問題点 | 未解決のタスク · バグを報告 |
CategoryTree拡張機能はウィキのカテゴリ構造の動的なビューをツリーとして提供します。これは必要に応じてツリーの一部をロードするためにAJAXを使います。CategoryTreeは外部ツールとしてもともとはDaniel Kinzlerによって開発されました(meta:User:Duesentrieb/CategoryTreeを参照)。のちにこれはTim Starlingの助けによってMediaWikiソフトウェアに統合されました。
インストール
- ダウンロードして、ファイルを
extensions/フォルダー内のCategoryTreeという名前のディレクトリ内に配置します。
- 以下のコードを LocalSettings.php の末尾に追加します:
wfLoadExtension( 'CategoryTree' );
完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。
完了 – ウィキの「MediaWiki 1.27 以前を稼働させている利用者へ:
上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.27 以前) にインストールする必要がある場合は、wfLoadExtension( 'CategoryTree' ); の代わりに以下を使用する必要があります:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";
使用法
CategoryTreeは3つの方法で使用できます:
- カテゴリページ内で直接使用する
- ウィキページでインラインのカテゴリ構造を表示する"カスタムタグ"(または"パーサー関数")
- 特別ページとして追加する
CategoryTree拡張機能はカテゴリページに一覧が表示される下位カテゴリに ► "expand" ウィジェットを追加します。
<categorytree> タグ
例。実行結果は下のボックスと右にあります:
<categorytree mode="pages">Manual</categorytree>
カスタムタグは <categorytree> と呼ばれます。たとえば、ウィキページに <categorytree>Foo</categorytree> を記載すると、そのページでFooカテゴリの内容が動的なツリーとして表示されます (右の例を参照)。HTMLライクな構文を使って、タグは次の属性を受け入れます:
- mode
- ツリーに表示されるページを決定します。これは
namespacesオプションを使用することでオーバーライドできます。許可される値は次の通りです:- categories
- 下位カテゴリだけ表示する(構成定数の
0) - pages
- 画像以外の下位カテゴリとページを表示する(構成定数の
10)、ページ数の上限は200件 - all
- すべてのページ、下位カテゴリ、画像などを表示する(構成定数の
20) - parents
- 下位カテゴリの代わりに親カテゴリの一覧を表示する (構成定数の
100)。これはCategoryTreeに"inverse"オペレーションをさせます(2008年7月の r36892 以降でサポートされます)。
- depth
- 最初に表示されるツリーのレベルを決めます。既定値は1で、0はルートノードのみを意味します。最大値は指定されるモード、と
$wgCategoryTreeMaxDepthオプションに依存します(2007年5月30日の r20410 と r20840 の間に導入されました; 2008年6月の r36864 以降の$wgCategoryTreeDynamicTagでも、十分な機能があります) onlyroot- 初期の状態でツリーの"root"ノードのみを表示するようにするには
これを "on" に設定します。2008年7月の r36864 で廃止予定になりました: 代わりにdepth="0"と同等です。(2007年3月13日の r20385 で導入されました)depth="0"を使用してください。 - hideroot
- ツリーの"root"ノードを隠すにはこれを "on"、すなわち
hideroot=onにセットします。この例ではカテゴリのFooは表示されません。 - hideprefix
- ツリーのエントリから隠される名前空間の接頭辞を決定します(2008年7月の r36864 以降)。可能な値は次の通りです:
- always
- 常に接頭辞を隠します。すべてのページが同じ名前空間に属する場合に使います (構成定数の
10)。 - never
- カテゴリに対してでも、名前空間の接頭辞を決して隠さない(構成定数の
0)。 - auto
- カテゴリの名前空間を隠します。カテゴリのみが表示される場合、
mode="categories"と同じです(構成定数の30)。これは古い既定の挙動と同等です(2008年6月以前)。 - categories
- カテゴリの名前空間を隠しますが、他のすべての接頭辞を表示します(構成定数の
20)。これは新しい既定の挙動です(2008年7月の r36864 以降)。
- showcount
- 下位カテゴリの数を表示するにはこれを "on"、すなわち
showcount="on"に設定します(2008年7月の r36864 以降)。これはページのインラインのカテゴリツリーに対しては既定で無効ですが、カテゴリ一覧および Special:CategoryTree では既定で有効になります。 - notranslations
- set this to "on" to hide all translations pages corresponding to the pages pertaining to the category, i.e.
notranslations="on"(since Gerrit change 526234, November 2019). This is disabled by default. When set to "on", instead of showing e.g. (Page, Page/en, Page/fr, Page/de, it will show only the default one "Page" and suppress all it's translations).This doesn't affect "showcount", so still a bug. - namespaces
- a list of namespaces from which pages should be shown in the tree (since r36864, July 2008). The entries in the list must be namespace names, separated by spaces. The main namespace can be represented by "-" or "0". Subcategories will be shown only if Category namespace is present on the list.
- class, style、id、etc
- <categorytree> タグはブロック要素用の標準のすべてのHTML属性をサポートします(2008年7月の r36864 以降で、それ以前は
styleのみがサポートされました)。
Notes on the 'namespaces' parameter
Category is a namespace. Categories are shown in all modes by default, but specifying the namespaces parameter hides them just like any other namespace not present on the list. If you want to list pages in a given namespace, including pages in subcategories, simply add Category to the namespace list.
例:
- Listing main namespace pages in Category:Manual:
<categorytree mode="pages" namespaces="Main">Manual</categorytree>
- Listing main namespace pages and subcategories in Category:Manual:
<categorytree mode="pages" namespaces="Main Category">Manual</categorytree>
The mode parameter is overridden by namespaces:
- if only Category namespace is asked, it's equivalent to
mode=categories; - if file namespace is present on the list, it will imply
mode=all; - otherwise
mode=pageswill be used. It means that if the site configuration hasn't been changed, the following are equivalent (the first two are always equivalent, the third only if$wgCategoryTreeDefaultModeis the defaultCategoryTreeMode::CATEGORIES):
<categorytree mode="categories">Manual</categorytree> <categorytree namespaces="Category">Manual</categorytree> <categorytree>Manual</categorytree>
{{#categorytree}} パーサー関数
r25825 (2007-9-13)以降、ページのカテゴリツリーを置くのにパーサー関数の構文を使用することもできます。これは、例えば {{#categorytree:Foo}} などの異なる構文を使った <categorytree> タグのように機能します。オプションは名前付きのテンプレート名、例えば {{#categorytree:Foo|hideroot|mode=pages}} の構文を使って指定できます。
パーサー関数の構文を使用することには カテゴリを指定する際にマジックワード、テンプレートとテンプレートパラメーターが使える利点があります。いくつかの例です:
- "this pages"カテゴリツリーを表示するにはマジック変数を使う(カテゴリ説明ページに役立ちます):
{{#categorytree:{{PAGENAME}}}}。 - カテゴリを指定するにはテンプレートを使う:
{{#categorytree:{{root category}}}}- ルートカテゴリの名前は Template:Root_category の内容によって定義されます。 - テンプレート内部でCategoryTreeを使うとき、カテゴリを指定するにはテンプレートパラメーターを使います: Template:Baz では
{{#categorytree:{{{1}}}}}を使って呼び出すことができます。
Special:CategoryTreeページ
特別ページはSpecial:CategoryTreeと呼ばれます。カテゴリの名前を入力しブラウザーでコンテンツにアクセスします。
設定
LocalSettings.php ファイルで指定できるオプションがいくつかあります:
0 for category mode, 10 for pages, 20 for all, 100 for parents.- $wgCategoryTreeMaxChildren
- ツリーノードに表示できる子の最大数です。既定値は200です。
- $wgCategoryTreeAllowTag
- <categorytree> タグを有効にします。既定値はtrueです。
- $wgCategoryTreeDynamicTag
- <categorytree> でツリーの最初のレベルのツリーを動的に読み込みます。この方法では、キャッシュを無効にする必要はありません。既定値はfalseです。
- $wgCategoryTreeDisableCache
- disables the parser cache for pages with a <categorytree> tag, or provides max cache time in seconds. Default is 21600 which is 6 hours.
- $wgCategoryTreeUseCache
- 匿名利用者のHTTPキャッシュを有効にします。既定値はfalseです。
$wgCategoryTreeOmitNamespaceページとカテゴリで名前空間を表示しない。既定値はfalseで、カテゴリのみを表示しない限り名前空間が表示されます。2008年7月の r36864 で廃止予定になったため代わりに$wgCategoryTreeDefaultOptions['hideprefix']を使用してください- $wgCategoryTreeMaxDepth
- <category> タグで深さのパラメーターを使用して初期に展開されるそれぞれのmodeの最大の深さを決める配列です。既定では、これは"categories"モードで2に、他のモードでは1に設定されます。例えばcategoriesには3、他のモードには2に設定するには、
$wgCategoryTreeMaxDepth = [10 => 2, 20 => 2, 0 => 3, 100 => 2];を使用できます。 - $wgCategoryTreeDefaultMode
<categorytree> タグでmode属性が設定されていないときの既定のモード。可能な値は0(既定値)、10、20のいずれかです。$wgCategoryTreeCategoryPageModeカテゴリページでツリーをレンダリングするときに使用するモード。2008年7月の r36864 に廃止予定になりました。代わりに$wgCategoryTreeCategoryPageOptions['mode']を使用します。- $wgCategoryTreeForceHeaders
- trueの場合、必要に応じてではなく、すべてのページでCategoryTreeが必要なスクリプトを強制します。CategoryTreeが通常の方法で例えばカスタム外装またはシステムメッセージに埋め込まれるときに必要な場合があります(2008年7月の r36888 以降)。
- $wgCategoryTreeSidebarRoot
- カテゴリツリーをサイドバーに統合するために使用するルートカテゴリ(2008年7月の r36920 以降)。設定されていない場合、ツリーは統合されません(これは既定値)。サイドバーへのCategoryTreeの統合はSkinTemplateにもとづく外装のみ機能します。すなわち、Modern、Monobook、Chick、Simple、MySkinは機能しますが、Standard、Nostalgia、CologneBlueは機能しません。
- $wgCategoryTreeDefaultOptions
- 既定のオプションは配列として適用します(2008年7月の r36864 以降)。利用可能なオプションは上記の通りです。例:
$wgCategoryTreeDefaultOptions['mode'] = 'pages'; - $wgCategoryTreeCategoryPageOptions
- カテゴリページで配列として使用するオプション(2008年7月の r36864 以降)。
- $wgCategoryTreeSpecialPageOptions
- Special:CategoryTreeで配列として使用するオプション(2008年7月の r36864 以降)
- $wgCategoryTreeSidebarOptions
- サイドバーでツリーを表示するときに配列として使用するオプション(2008年7月の r36920 以降)
システムメッセージ
categorytree-member-num
By default, when listing subcategories on a category page, each subcategory is followed by an integer, indicating how many subcategories lie beneath it, how many pages it contains, and how many files are in the category (if applicable):
- My category name (5 C, 2 P, 1 F)
システムメッセージの MediaWiki:Categorytree-member-num をオーバーライドすることでこのふるまいを変更できます。これは5つのパラメーターをとります:
| パラメーター | 意味 |
|---|---|
| $1 | 下位カテゴリの個数 |
| $2 | 記事の数 (カテゴリページやファイルページは含まない) |
| $3 | アップロードされたファイルの個数 |
| $4 | カテゴリページとファイルページを含む、メンバーページの合計数 |
| $5 | Something close to ($1 C, $2 P, $3 F) but with anything that is 0 omitted.
More precisely, a comma separated list of the number of pages (mediawiki:categorytree-num-pages), subcategories (mediawiki:categorytree-num-categories), and files (mediawiki:categorytree-num-files) in the category, or empty (mediawiki:categorytree-num-empty) in the case the category has no members. In versions prior to those around 1.19 this value was different. See older version of these docs. |
既定値は ($5) です。
ヒント: 異なる部分を条件ごとに表示するif/then/elseロジックを提供するには ParserFunctions 拡張機能を使用します。例:
{{#ifeq:$1|0||$1 categories}}
すべての情報を出力するときにカンマと空白を管理する設定:
省略版:
({{#ifeq:$4|0|empty|{{#ifeq:$1|0||$1 C{{#ifeq:{{#expr:$3+$2}}|0||,}}}} {{#ifeq:$2|0||$2 P{{#ifeq:$3|0||,}}}} {{#ifeq:$3|0||$3 F}}}})
完全名版:
({{#ifeq:$4|0|empty|{{#ifeq:$1|0||$1 categories{{#ifeq:{{#expr:$3+$2}}|0||,}}}} {{#ifeq:$2|0||$2 pages{{#ifeq:$3|0||,}}}} {{#ifeq:$3|0||$3 files}}}})
トラブルシューティング
CategoryTreeをインストールした後でウィキが壊れる
- エラー出力機能をオンにする
- すべてのファイルがインストールされていることを確認する
- CategoryTree拡張機能のすべてのファイルが644モードで、CategoryTreeディレクトリが755モードであることを確認してください
LocalSettings.phpのオプションの効果がない
- 拡張機能のファイルをインクルードした後でオプションを指定していることを確認してください。
► をクリックしても効果がない、JavaScriptエラーまたはloadingになる
- 期待通りに動かない場合システムメッセージで <categorytree> タグを使用していることを確認してください(MediaWiki-Namespace) - これは既知の警告です。次善策は、下記の#サイドバーでCategoryTreeを使うを参照してください。
- 拡張機能のファイルをインクルードする前にLocalSettings.phpで
$wgUseAjax = true;があることを確認してください。 - 拡張機能の最新バージョンを使用していることを確認してください - 開発の最先端のバージョンは [1] です。
- 書き換えルールまたはエイリアスを使っている場合(例えば"very short URLs"がある - ドキュメントルートでウィキページ)、/skinsディレクトリと同じように/extensionsディレクトリに例外ファイルがあることを確認してください。下記の項目も参照してください。
Clicking the ► shows no sub-categories error
- Try to fix this by adding this code to LocalSettings.php:
$wgCategoryTreeDefaultOptions['namespaces'] = [ 0, NS_CATEGORY, NS_FILE ];
ブラウザーがCategoryTree.js かつ/または CategoryTree.cssに対してbad MIMEタイプを報告する
- Webサーバーが.jsと.cssファイルに対して正しいmimeタイプを使っていることを確認してください
- ブラウザーでURLを直接入力し ページが完全に提供されエラーが表示されていないことを確認してください; とりわけ:
- 書き換えルールまたはエイリアスを使っている場合(たとえば"very short URLs"がある - ドキュメントルートでウィキページ)、/skinsディレクトリと同じように/extensionsディレクトリに例外ファイルがあることを確認してください。下記の項目も参照してください。
メンバーの件数が間違っている、► の代わりに ► が表示される
MediaWiki 1.13以降では、CategoryTreeはカテゴリのメンバーの数を表示し、その番号に基づく子を持たないツリーのノードに灰色の矢印 ► を表示します。この情報は新しい category テーブルに基づいています。しかしながら、そのテーブルに現在の値を投入しても1.13にアップグレードするときは常に機能しません。その場合、populateCategory.php メンテナンススクリプトを実行し、必要であれば --force オプションをつけます。
► ► ▼ toggles shown only on the first level of the category tree view
In case you get only one level depth while visualing the tree, try to set in modules/ext.categoryTree.styles.css file display: none; to display: inline !important;.
The JavaScript intended to switch the tag style is somehow buggy.
ボット利用者のための注記
カテゴリページのHTMLを構文解析するボットとスクリプトは従来の出力を強制するURLの notree パラメーターを使用できます。しかしながらHTML出力は一般的には安定していないので、カテゴリの一覧を取得するには ll|API:Main page を使用するようスクリプトを変更することをお勧めします。
"Category Not Found"メッセージ
Category Treeプラグインを実装しツリーを表示するコードを追加した後で、Category Not Foundというメッセージが見える場合、コンテントをカテゴリページに追加する必要があります。基本的にカテゴリページを赤くすることはできません。カテゴリ名をクリックし、テキストをカテゴリページに追加すれば、ツリーはきちんと機能します。
Next 200 links do not work with CategoryTree installed
Make sure the right version of this extension is installed, relative to the version of MediaWiki you have installed. In particular, versions of this extension made for versions of MediaWiki prior to 1.17 are not compatible with MediaWiki 1.17 and greater, and will cause issues where all the paging links on category pages are broken.
No pages are shown when using the "namespaces" parameter
See above.
ハック
システムメッセージとカスタム外装でCategoryTreeを使用
システムメッセージまたはサイドバーでCategoryTreeを使うには、すなわち、ページ本文の代わりに、ユーザーインターフェイスの一部として使用するには、サポートスクリプトがすべてのページにリンクされるように(通常、これらは"必要に応じて"リンクされますが、システムメッセージの検出は機能しません)、wgCategoryTreeForceHeaders を true にセットしなければなりません。これは r36888 (2008年7月)以降に機能します。スクリプトをインクルードすることを強制せずにこれを試す場合、#Clicking the ► has no effect, gives a JavaScript error or just sits on loading|Clicking the ► has no effect, gives a JavaScript error or just sits on loadingになります。
CategoryTreeの古いバージョンでは、この動かすためにコードを修正しなければなりません: CategoryTree.php ファイルで efCategoryTreeParserOutput 関数を見つけ、条件ブロックを削除すれば次のようになります:
function efCategoryTreeParserOutput( &$outputPage, &$parserOutput ) {
CategoryTree::setHeaders( $outputPage );
return true;
}
サイドバーでCategoryTreeを使用
JavaScriptの使用
MediaWiki 1.13 (r36917)の r36920 (2008年7月)以降では、$wgCategoryTreeSidebarRoot をルートとして使用したいカテゴリに設定するだけでCategoryTreeをサイドバーに統合できます。これはSkinTemplateを継承する外装、すなわちModern、Monobook、Chick、Simple、MySkinのみに機能しますが、Standard、Nostalgia、CologneBlueは機能しません。
独自のウィキテキストをサイドバーに落とし込むためにLocalSettings.phpで $wgHooks['MonoBookTemplateToolboxEnd'][] = 'wfSomeFunc'; を使用し、CategoryTreeの項目をそれに追加する場合、すべてのページで機能させるために $wgCategoryTreeForceHeaders = true; を設定する必要があります。
If you want the CategoryTree on a different position in the sidebar, you can reference it on MediaWiki:Sidebar as "categorytree-portlet".
CategoryTreeかつ/またはMediaWikiの以前のバージョンに関して、サイドバーの通常のウィキテキストを有功にするためにmodをMonoBook.phpにインストールする必要があります。サイドバー内でウィキテキスト --DJ 19:26, 24 January 2008 (UTC) を参照してください。
"CategoryTree"のリンクをツールボックス(サイドバー)に追加するには、次のコードを外装のJavaScriptのページ(例えば monobook.js)に追加しURL "w:en:Special:CategoryTree"をカスタマイズします。
function AppendCategoryTreeToSidebar() {
try {
var node = document.getElementById( "p-tb" )
.getElementsByTagName('div')[0]
.getElementsByTagName('ul')[0];
var aNode = document.createElement( 'a' );
var liNode = document.createElement( 'li' );
aNode.appendChild( document.createTextNode( 'CategoryTree' ) );
aNode.setAttribute( 'href' , '[[w:en:Special:CategoryTree]]' );
liNode.appendChild( aNode );
liNode.className = 'plainlinks';
node.appendChild( liNode );
} catch(e) {
// lets just ignore what's happened
return;
}
}
addOnloadHook( AppendCategoryTreeToSidebar );
このコードのより汎用的な版は Manual:インターフェイス/サイドバー#content of sidebar and toolbox (javascript) で見つかります。
Step by step if works easy:
- Add these lines to LocalSettings.php:
$wgCategoryTreeSidebarRoot = 'Category:article_name';
$wgCategoryTreeForceHeaders = true;
Using MediaWiki: namespace pages
If you want to create a link that goes to the generic categorytree (displayed as Category tree) when you're on a non-category page, and to a particular categorytree (displayed as View as category tree, with foo being the name of the category you're viewing) when you're on a category page:
- Add to your MediaWiki:Sidebar (right above the SEARCH is a good place) a line,
** sidebarcategorytree-url|sidebarcategorytree - Create a [[MediaWiki:Sidebarcategorytree]] with, say:
{{#ifeq: {{NAMESPACE}}|Category|View as category tree|Category tree}} - Create a [[MediaWiki:Sidebarcategorytree-url]] with, say:
{{#ifeq: {{NAMESPACE}}|Category|Special:CategoryTree/{{BASEPAGENAME}}|Special:CategoryTree/Categories}}
Parameters to request
It is possible to override the default site configuration of "mode" by providing it to as URL parameter. For example
//en.wikipedia.org/wiki/Category:MediaWiki- use default mode//en.wikipedia.org/wiki/Category:MediaWiki?mode=0- use categories mode//en.wikipedia.org/wiki/Category:MediaWiki?mode=10- use page mode//en.wikipedia.org/wiki/Category:MediaWiki?mode=20- use all mode//en.wikipedia.org/wiki/Category:MediaWiki?mode=100- use parent mode
 | この拡張機能は 1 つ以上のウィキメディアのプロジェクトで使用されています。 これはおそらく、この拡張機能が安定していて高いトラフィックのウェブサイトでも十分に動作することを意味します。 この拡張機能がインストールされている場所を確認するには、ウィキメディアの設定ファイル CommonSettings.php および InitialiseSettings.php 内で、この拡張機能の名前を探してください。 特定のウィキにインストールされている拡張機能の完全な一覧は、そのウィキの Special:Version ページにあります。 |
 | この拡張機能は BlueSpice に同梱されています。 |
- Extensions bundled with MediaWiki 1.31/ja
- Stable extensions/ja
- Tag extensions/ja
- Parser function extensions/ja
- Special page extensions/ja
- GPL licensed extensions/ja
- Extensions in Wikimedia version control/ja
- ArticleFromTitle extensions/ja
- BeforePageDisplay extensions/ja
- BeforePageDisplayMobile extensions/ja
- OutputPageMakeCategoryLinks extensions/ja
- OutputPageParserOutput extensions/ja
- ParserFirstCallInit extensions/ja
- SkinBuildSidebar extensions/ja
- SpecialTrackingCategories::generateCatLink extensions/ja
- SpecialTrackingCategories::preprocess extensions/ja
- All extensions/ja
- Extensions used on Wikimedia/ja
- Category extensions/ja
- Tree extensions/ja
- Ajax extensions/ja
