Extension:CategoryTree/ja

マニュアル - 一覧 - スナップショット

CategoryTree Release status: stable
実装	タグ, パーサー関数, 特別ページ
説明	ウィキのカテゴリ構造の動的なビューをツリーとして提供する
作者	Daniel Kinzler (Duesentriebtalk)
最新バージョン	continuous updates
MediaWiki	1.8 (r16385 以降), 1.11 (r30515 以降), 1.13+ (r36772 以降)
データベースの変更	no
ライセンス	GPL and GFDL
ダウンロード	スナップショットをダウンロード (Git master) Git [ヘルプ]: リポジトリの要約 ツリー ソースコードの変更履歴 README
パラメーター $wgCategoryTreeMaxChildren, $wgCategoryTreeAllowTag, $wgCategoryTreeDynamicTag, $wgCategoryTreeDisableCache, $wgCategoryTreeHTTPCache, $wgCategoryTreeOmitNamespace, $wgCategoryTreeMaxDepth, $wgCategoryTreeDefaultMode, $wgCategoryTreeCategoryPageMode
使用されているフック ArticleFromTitle Debug MakeGlobalVariablesScript OutputPageParserOutput OutputPageMakeCategoryLinks ParserFirstCallInit SkinTemplateOutputPageBeforeExec
使用法とバージョン一覧を確認してください
バグ: 未解決一覧 すべての一覧 報告

CategoryTree拡張機能はウィキのカテゴリ構造の動的なビューをツリーとして提供します。これは必要に応じてツリーの一部をロードするためにAJAXを使います。CategoryTreeは外部ツールとしてもともとはDaniel Kinzlerによって開発されました(meta:User:Duesentrieb/CategoryTreeを参照)。のちにこれはTim Starlingの助けによってMediaWikiソフトウェアに統合されました。

使い方

CategoryTreeは3つの方法で使うことができます:

• カテゴリページ内で直接使用する
• ウィキページでインラインのカテゴリ構造を表示する"カスタムタグ"(もしくは"パーサー関数")
• 特別ページとして追加する

CategoryTree拡張機能はカテゴリページに一覧が表示されるサブカテゴリに[+] "expand"ウィジェットを追加します。Javascriptが無効な場合、これらのウィジェットはカテゴリページに誘導してくれます(初期のバージョンでは、これは何もしません)。

If you want arrows ► ► ▼ instead of [+] [x] [-], see this discussion of how it was done for Wikipedia

• change MediaWiki:Categorytree-expand-bullet to <span style="color:#0645AD;">►</span>
• change MediaWiki:Categorytree-collapse-bullet to <span style="color:#0645AD;">▼</span>
• change MediaWiki:Categorytree-empty-bullet to <span style="color:#c0c0c0;">►</span>

<categorytree> タグ

例:

<categorytree mode=pages>Manual</categorytree>

[−] Manual

[+] Authentication and login

[+] Customization techniques

[+] Data exchange with other systems

[+] Extensions

[+] Installation

[+] Localisation

[+] MediaWiki administration

[+] MediaWiki administration/da

[+] MediaWiki components

[+] MediaWiki configuration

[+] MediaWiki for site admins

[+] MediaWiki technical documentation

[+] Personalization

[+] Sitemap

[+] Tools

[+] Tutorials

[+] User interface

[+] Wiki markup

[+] Wiki page URLs

  Manual:Contents

  Manual:Contents/To do

  Project:Manual

  Manual:Account creation

  Manual:External editors: control files

  Manual:FAQ

  Manual:Hashing

  Manual:IP ranges

  Manual:Linked images

  API:Main page

  Manual:Main Page

  Manual:Moving a page

  Manual:Page title

  Manual:Redirects

  Manual talk:Setting user groups in MediaWiki

  Manual:Tools

  Wikimedia technical search

カスタムタグは<categorytree>と呼ばれます。たとえば、ウィキページに<categorytree>Foo</categorytree>を記載すると、そのページでFooカテゴリの内容が動的なツリーとして表示されます (右の例を参照)。HTMLライクな構文を使って、タグは次の属性を受け入れます:

mode

ツリーに表示されるページを決定します。これはnamespacesオプションを使うことでオーバーライドできます。許可される値は次のとおりです:

categories

サブカテゴリだけ表示する(コンフィギュレーション定数のCT_MODE_CATEGORIES)

pages

画像以外のサブカテゴリとページを表示する(コンフィギュレーション定数のCT_MODE_PAGES)

all

すべてのページ、サブカテゴリ、画像などを表示する(コンフィギュレーション定数のCT_MODE_ALL)

parents

サブカテゴリの代わりに親カテゴリの一覧を表示する (コンフィギュレーション定数のCT_MODE_PARENTS). これはCategoryTreeに"inverse"オペレーションをさせます(2008年7月のrev:36892以降でサポートされます)。

depth

最初に表示されるツリーのレベルを決めます。デフォルトは1で、0はルートノードのみを意味します。最大値は指定されるモード、と$wgCategoryTreeMaxDepthオプションに依存します(2007年5月30日のrev:r20410とrev:20840の間に導入されました; 2008年6月のrev:36864以降の$wgCategoryTreeDynamicTagでも、十分な機能があります)

onlyroot

初期の状態でツリーの"root"ノードのみを表示するようにするにはこれを"on"にセットします。depth="0"と同等です。(2007年3月13日のrev:20385で導入されました) 2008年7月のrev:36864は廃止されました: 代わりにdepth="0"を使ってください。

hideroot

ツリーの"root"ノードを隠すにはこれを"on"、すなわちhideroot="on"にセットします。この例ではカテゴリのFooは表示されません。

hideprefix

ツリーのエントリから隠される名前空間のプレフィックスを決定します(2008年7月のrev:36864以降)。可能な値は次のとおりです:

always

つねにプレフィックスを隠します。すべてのページが同じ名前から由来する場合に使います (コンフィギュレーション定数のCT_MODE_CT_HIDEPREFIX_ALWAYS)。

never

カテゴリに対してでも、名前空間のプレフィックスをけっして隠さない(コンフィギュレーション定数のCT_MODE_CT_HIDEPREFIX_NEVER).

auto

カテゴリの名前空間を隠します。カテゴリのみが表示される場合、mode="categories"と同じです(コンフィギュレーション定数のCT_MODE_CT_HIDEPREFIX_AUTO); これは古いデフォルトのふるまいと同等です(2008年6月以前)。

categories

カテゴリの名前空間を隠しますが、ほかのすべてのプレフィックスを表示します(コンフィギュレーション定数のCT_MODE_CT_HIDEPREFIX_CATEGORIES)。これは新しいデフォルトのふるまいです(2008年7月以降のrev:36864)。

showcount

サブカテゴリの数を表示するにはこれを"on"、すなわちshowcount="on"にセットします(2008年7月のrev:36864以降)。これはページのインラインのカテゴリツリーに対してデフォルトごとに無効ですが、Special:CategoryTreeでカテゴリリストのデフォルトごとに有効になります。

namespaces

ツリーに表示されるページからの名前空間の一覧を決定します(2008年7月のrev:36864以降)。リストのエントリはスペースで区切られた名前空間の名前でなければなりません。メインの名前空間は"-"もしくは"0"によって表現できます。これはmodeオプションをオーバーライドします。

class, style、id、etc

<categorytree> タグはブロック要素用の標準のすべてのHTML属性をサポートします(2008年7月のrev:36864以降で、それ以前はstyleのみがサポートされました)。

{{#categorytree}} パーサー関数

rev:25825 (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}}}}}は{{Baz|Foo}}を使って呼び出すことができます

Special:CategoryTreeページ

特別ページはSpecial:CategoryTreeと呼ばれます; カテゴリの名前を入力しブラウザでコンテンツにアクセスします。

ダウンロード

拡張機能を、MediaWiki ソースコード リポジトリから直接ダウンロードできます (コードを参照)。以下のうちお好きなものを取得できます:

(1) 拡張機能のタグのいずれか 1 つ

すべての拡張機能にタグがあるわけではありません。リリースごとにタグを持つ拡張機能があり、それらのタグはリリース版と同じくらい安定しています。タグをダウンロードするには

• タグ一覧を開きます
• ダウンロードするタグの名前をクリック
• "snapshot" をクリック

(2) 拡張機能のブランチの 1 つの最新バージョン

拡張機能にはそれぞれ、最新のコード (不安定な場合あり) を含む master ブランチがあります。拡張機能には他のブランチもある場合があります。

• ブランチ一覧を開きます
• ブランチ名をクリック
• "snapshot" をクリック

(3) MediaWiki の各バージョンのリリースの際に作成されるスナップショット

これは、不安定な場合があり、MediaWiki の対応するバージョンで動作することは保証されません。

• スナップショットのダウンロードページ

コードを取得したら、自分のウィキの extensions/CategoryTree ディレクトリに保存してください。

サーバーへの git やシェルでのアクセスに慣れている場合は、以下のようにしてあらゆるタグやブランチの拡張機能を取得できます:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/CategoryTree.git

インストール

1. Download the files from Git or download a snapshot (select your version of MediaWiki) and place the files under $IP/extensions/CategoryTree
2. Add to the end of LocalSettings.php:
   $wgUseAjax = true;
   require_once( "$IP/extensions/CategoryTree/CategoryTree.php" );
3. Installation can now be verified through Special:Version on your wiki
   

$wgUseAjax = trueはMediaWikiのAjaxフレームワークを有効にすることに注意してください。これはCategoryTree拡張機能に必要です。AJAXは必要に応じてページの一部をロードするJavaScriptの用語です。これは最近のグラフィカルなWebブラウザすべてでサポートされます。

設定

LocalSettings.phpファイルで指定できるオプションがいくつかあります:

$wgCategoryTreeMaxChildren

ツリーノードに表示できる子の最大数です。デフォルトは200です。

$wgCategoryTreeAllowTag

<categorytree> タグを有効にします。デフォルトはtrueです。

$wgCategoryTreeDynamicTag

<categorytree> でツリーの最初のレベルのツリーを動的にロードします。この方法では、キャッシュを無効にする必要はありません。デフォルトはfalseです。

$wgCategoryTreeDisableCache

<categorytree> タグでページのパーサーキャッシュを無効にします。デフォルトはtrueです。

$wgCategoryTreeHTTPCache

匿名利用者のHTTPキャッシュを有効にします。デフォルトはfalseです。

$wgCategoryTreeOmitNamespace

ページとカテゴリで名前空間を表示しない。デフォルトはfalseで、カテゴリのみを表示しないかぎり名前空間が表示されます。 2008年7月のrev:36864で廃止されたので代わりに$wgCategoryTreeDefaultOptions['hideprefix']を使ってください

$wgCategoryTreeMaxDepth

<category> タグで深さのパラメータを使って初期に展開されるそれぞれのmodeの最大の深さを決める配列です。デフォルトでは、これは"categories"モードで2に、ほかのモードでは1にセットされます。たとえばcategoriesには3、ほかのモードには2にセットするには、$wgCategoryTreeMaxDepth = array(CT_MODE_PAGES => 2, CT_MODE_ALL => 2, CT_MODE_CATEGORIES => 3);を使うことができます。

$wgCategoryTreeDefaultMode

<categorytree> タグでmode属性が設定されていないときのデフォルトモード。可能な値はCT_MODE_CATEGORIES (デフォルト)、CT_MODE_PAGES、もしくは CT_MODE_ALLになります。

$wgCategoryTreeCategoryPageMode

カテゴリページでツリーをレンダリングするときに使うモード。2008年7月のrev:36864に廃止されました: 代わりに$wgCategoryTreeCategoryPageOptions['mode']を使います。

$wgCategoryTreeForceHeaders

trueの場合、必要に応じてではなく、すべてのページでCategoryTreeが必要なスクリプトを強制します。CategoryTreeが通常の方法でたとえばカスタムスキンもしくはシステムメッセージに埋め込まれるときに必要な場合があります(2008年7月のrev:36888以降)。

$wgCategoryTreeSidebarRoot

カテゴリツリーをサイドバーに統合するために使うルートカテゴリ(2008年7月のrev:36920以降)。セットされていない場合、ツリーは統合されません(これはデフォルト)。サイドバーへのCategoryTreeの統合はSkinTemplateにもとづくスキンのみ機能します。すなわち、Modern、Monobook、Chick、SimpleとMySkinは機能しますがStandard、NostalgiaもしくはCologneBlueは機能しません。

$wgCategoryTreeDefaultOptions

デフォルトのオプションは配列として適用します(2008年7月のrev:36864以降)。利用可能なオプションは上記のとおりです。例: $wgCategoryTreeDefaultOptions['mode'] = 'pages';

$wgCategoryTreeCategoryPageOptions

カテゴリページで配列として使うオプション(2008年7月のrev:36864以降)。

$wgCategoryTreeSpecialPageOptions

Special:CategoryTreeで配列として使うオプション(2008年7月のrev:36864以降)

$wgCategoryTreeSidebarOptions

サイドバーでツリーを表示するときに配列として使うオプション(2008年7月のrev:36920以降)

システムメッセージ

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/jaをオーバーライドすることでこのふるまいを変更できます。これは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/ja), subcategories (mediawiki:categorytree-num-categories/ja), and images (mediawiki:categorytree-num-files) in the category, or empty (mediawiki:categorytree-num-empty/ja) 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}}

すべての情報を出力するときにカンマとスペースを管理するコンフィギュレーション:

Abbreviation version:

({{#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}}}})

Full name version:

({{#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モードで、and the 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'] = array( 0, NS_CATEGORY, NS_FILE );

ブラウザがCategoryTree.js かつ/または CategoryTree.cssに対してbad MIMEタイプを報告する

• Webサーバーが.jsと.cssファイルに対して正しいmimeタイプを使っていることを確認してください
• ブラウザでURLを直接入力し ページが完全に提供されエラーが表示されていないことを確認してください; とりわけ:
• 書き換えルールもしくはエイリアスを使っている場合(たとえば"very short URLs"がある - ドキュメントルートでウィキページ)、/skinsディレクトリと同じように/extensionsディレクトリに例外ファイルがあることを確認してください。下記の項目も参照してください。

メンバーのカウントが間違っている、[+]の代わりに[x]が表示される

MediaWiki 1.13以降では、CategoryTreeはカテゴリのメンバーの数を表示し、その番号にもとづく子を持たないツリーのノードを[x]を表示します。この情報は新しいcategory tableに基づいています。しかしながら、そのテーブルに現在の値を投入しても1.13にアップグレードするときは常に機能しません。その場合、populateCategory.phpメンテナンススクリプトを実行し、必要であれば--forceオプションをつけます。

[x] [+] [-] 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 CategoryTreeFunctions.php file the following line

$linkattr['style'] = 'display: none;'; // Unhidden by JS

to

$linkattr['style'] = 'display: inline !important;'; // Unhidden by JS

The javascript intended to switch the tag style is somehow buggy.

ボット利用者のための注

カテゴリページのHTMLをパースするボットとスクリプトは従来の出力を強制するURLのnotreeパラメータを使うことができます。しかしながらHTML出力は一般的には安定していないので、カテゴリの一覧を取得するにはapi.phpを使うようスクリプトを変更することをおすすめします。

"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.

ハック

システムメッセージとカスタムスキンでCategoryTreeを使う

システムメッセージもしくはサイドバーでCategoryTreeを使うには、すなわち、ページコンテントの代わりに、ユーザーインターフェイスの一部として使うには、サポートスクリプトがすべてのページにリンクされるように(通常、これらは"必要に応じて"リンクされますが、システムメッセージの検出は機能しません)、wgCategoryTreeForceHeadersをtrueにセットしなければなりません。これはrev:36888 (2008年7月)以降に機能します。スクリプトをインクルードすることを強制せずにこれを試す場合、Clicking the [+] has no effect / gives JavaScript errorになります。

CategoryTreeの古いバージョンでは、この動かすためにコードを修正しなければなりません: CategoryTree.phpファイルでefCategoryTreeParserOutput関数を見つけ、条件ブロックを削除すれば次のようになります:

function efCategoryTreeParserOutput( &$outputPage, &$parserOutput )  {
    CategoryTree::setHeaders( $outputPage );
    return true;
}

サイドバーでCategoryTreeを使用

JavaScriptの使用

MediaWiki 1.13 (rev:36917)のrev:36920 (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/ja]] as "categorytree-portlet".

CategoryTreeかつ/もしくはMediaWikiの以前のバージョンに関して、サイドバーの通常のウィキテキストを有功にするためにmodをMonoBook.phpにインストールする必要があります。 Wikitext in side bar --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:Interface/Sidebar/ja#content of sidebar and toolbox (javascript)で見つかります。

Step by step if works easy:

• Add these lines to LocalSettings.php:
  1. $wgCategoryTreeSidebarRoot = 'Category:article_name';
  2. $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 the 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}}