Extension:CategoryTree/ru

Расширение CategoryTree обеспечивает динамическое представление о структуре категорий в вики в виде дерева. Он использует AJAX для загрузки части дерева по требованию. CategoryTree был первоначально написан Даниэлем Кинзлером как внешний инструмент (см. meta:User:Duesentrieb/CategoryTree). Позже это расширение было интегрировано в программное обеспечение MediaWiki с помощью Тима Старлинга.

Использование
CategoryTree может быть использован тремя путями:
 * непосредственно на страницах категорий,
 * как "пользовательский тег" (или "функция парсера") для отображения структуры категории построчно на вики,
 * а также на специальной странице.

Расширение CategoryTree добавляет виджет [+], который "разворачивает" подкатегории, перечисленные на страницах категории. Если Javascript отключён, этот виджет переведёт на страницу категории (в более ранних версиях, он ничего не сделал в этом случае).

Тег &lt;categorytree&gt;
Пример:

Пользовательский тег называется &lt;categorytree&gt;. Например, если вы поместите &lt;categorytree&gt;Foo&lt;/categorytree&gt; на вики-странице, он отобразит содержимое категории Foo как динамическое дерево на странице (см. пример справа). Тег принимает следующие атрибуты, используя HTML-подобный синтаксис :


 * mode: определяет, какие страницы будут отображены в дереве. Может быть изменено с помощью пространства имён. Возможные значения:
 * categories: показывать только подкатегории (константа CT_MODE_CATEGORIES)
 * pages: показывать подкатегории и страниц, без изображений (константа CT_MODE_PAGES)
 * all: показывать все подкатегории, страницы, картинки и т.д. (константа CT_MODE_ALL)
 * parents: список корневых категорий, а не подкатегории (константа CT_MODE_PARENTS). Это помещает CategoryTree в "инверсивную" операцию (поддерживается начиная с 36892, июль 2008).


 * depth: определяет, сколько показывать уровней дерева на начальном этапе. По умолчанию 1. 0 означает, только корневой узел. Максимальное значение зависит от указанного режима, и в опции $wgCategoryTreeMaxDepth. (введено между r20410 и 20840, 30 марта 2007; полностью функциональна даже с $wgCategoryTreeDynamicTag начиная с 36864, июль 2008)
 * onlyroot : "on" показывает только "корневой" узел дерева на начальном этапе. Эквивалент depth="0". (введено в 20385, 13 марта 2007) . Запрещено в 36864, июль 2008: заместо него использовать depth="0".
 * hideroot: "on" спрячет "корневой" узел дерева, т. е. hideroot=on. Например, он не будет отображать название категории Foo
 * hideprefix: определяет, когда префикс пространства имён должны быть скрыт от записи в дереве (начиная с 36864, июль 2008). Возможные значения:
 * always: всегда скрывать префикс. Следует использовать только тогда, когда все страницы имеют одно и то же пространство имён (константа CT_MODE_CT_HIDEPREFIX_ALWAYS</tt>).
 * never: никогда не скрывать префикс (константа CT_MODE_CT_HIDEPREFIX_NEVER</tt>).
 * auto: скрывать пространство имён категорий, если категории показаны через mode="categories"</tt> (константа CT_MODE_CT_HIDEPREFIX_AUTO</tt>); Это эквивалентно старому поведению по умолчанию (до июня 2008).
 * categories: всегда скрывать пространство имен категорий, но показать все другие префиксы (константа CT_MODE_CT_HIDEPREFIX_CATEGORIES</tt>). Это новое поведение по умолчанию (начиная с 36864, июль 2008).


 * showcount: "on", чтобы показать число записей в подкатегории, т. е. showcount="on"</tt> (начиная с 36864, июль 2008). По-умолчанию отключено для дерева категории встроенного в страницы, но по-умолчанию включено в списках категорий на страница Служебная:CategoryTree.
 * namespaces: список пространств имён страниц, которые должно быть показано в дереве (начиная с 36864, июль 2008). Записи в списке должны быть разделены пробелами. Основное пространство имён может быть представлено как "-" или "0". Это отменяет опцию mode</tt>.
 * class, style, id, etc: тег &lt;categorytree&gt; поддерживает все стандартные HTML-атрибуты блока элементов (начиная с 36864, июль 2008. До этого был поддержан только style</tt>).

Синтаксический анализатор
Начиная с 25825 (2007-9-13), вы можете также использовать синтаксис синтаксического анализатора чтобы поместить дерево категорий на странице. Работает подобно тегу &lt;categorytree&gt;, используя другой синтаксис, например,  </tt>; опции могут быть определены с использованием синтаксиса именованных параметров шаблона, например,   </tt>.

Использование синтаксиса синтаксического анализатора имеет преимущество, позволяющее использовать волшебные слова, шаблоны и параметры шаблонов при определении категории для отображения. Вот некоторые примеры:
 * Использование волшебной переменной для отображения "этих страниц" дерева категорий (могут быть полезны на страницах описания категории):  </tt>.
 * Использование шаблонов для указания категории:  </tt> - имя корневой категории будут определены по содержанию Template:Root_category.
 * Использование шаблонов для указания категории, при использовании CategoryTree внутри шаблона:  </tt> в Template:Baz может вызываться при помощи

Страница Special:CategoryTree
Специальные страницы, называется Special:CategoryTree, здесь вы можете ввести название категории, а затем просмотреть его содержание.

Установка CategoryTree
Примечание: Последняя версия расширения CategoryTree требует MediaWiki 1,13. Первая версия требует MediaWiki 1.8 (исправление 16385 или более поздняя версия).

Загрузите последнюю версию и распакуйте её в папку extension. Затем добавьте следующую строку в файл LocalSettings.php (ближе к концу):

Note that $wgUseAjax = true</tt> will enable the ajax framework in MediaWiki, which is required by the CategoryTree extension. AJAX is a term for using JavaScript to load parts of a page on demand. It is supported by all recent graphic web browsers.

Конфигурация
Существуют некоторые опции, который вы можете указать в своем файле LocalSettings.php:


 * $wgCategoryTreeMaxChildren: максимальное количество дочерних категорий в дереве. По умолчанию 200.
 * $wgCategoryTreeAllowTag: включить тег &lt;categorytree&gt;. По умолчанию true.
 * $wgCategoryTreeDynamicTag: загрузка первого уровня в дерево &lt;categorytree&gt; динамически. Таким образом, кэширование не должно быть отключено. По умолчанию false.
 * $wgCategoryTreeDisableCache: отключить кэширование для страниц с тегом &lt;categorytree&gt;. По умолчанию true.
 * $wgCategoryTreeHTTPCache: enable HTTP cache for anon users. Default is false.
 * $wgCategoryTreeOmitNamespace : do not show the namespace name for pages and categories. Default is false, namespaces are shown unless showing categories only. Deprecated as of 36864, July 2008: use $wgCategoryTreeDefaultOptions['hideprefix']</tt> instead.
 * $wgCategoryTreeMaxDepth: an array defining the maximum depth for each mode, to which the tree may be expanded initially using the depth parameter in a &lt;category&gt; tag. Per default, this is set to 2 for the "categories" mode, and 1 for other modes. To set it to 3 for categories and 2 for other modes, for example, you can use $wgCategoryTreeMaxDepth = array(CT_MODE_PAGES => 2, CT_MODE_ALL => 2, CT_MODE_CATEGORIES => 3);</tt>.
 * $wgCategoryTreeDefaultMode : the default mode to use when no mode attribute is specified in a &lt;categorytree&gt; tag. May be <tt>CT_MODE_CATEGORIES</tt> (the default), <tt>CT_MODE_PAGES</tt>, or <tt>CT_MODE_ALL</tt>.
 * $wgCategoryTreeCategoryPageMode : the mode to use when rendering trees on category pages. Deprecated as of 36864, July 2008: use <tt>$wgCategoryTreeCategoryPageOptions['mode']</tt> instead.
 * $wgCategoryTreeForceHeaders: if true, forces the scripts needed by CategoryTree on every page, instead of on-demand. This may be needed if a CategoryTree is embedded in an unusual way, for example in a custom skin or in a system message (since 36888, July 2008).
 * $wgCategoryTreeSidebarRoot: root category to use for integrating the category tree in the sidebar (since 36920, July 2008). If not set, no tree is integrated (this is the default). Integrating a CategoryTree into the sidebar only works with skins based upon SkinTemplate, that is, Modern, Monobook, Chick, Simple, and MySkin, but not Standard, Nostalgia or CologneBlue.
 * $wgCategoryTreeDefaultOptions: default options to apply, as an array (since 36864, July 2008). The available options are described above. Example:
 * $wgCategoryTreeCategoryPageOptions: options to use on category pages, as an array (since 36864, July 2008).
 * $wgCategoryTreeSpecialPageOptions: options to use on Special:CategoryTree, as an array (since 36864, July 2008).
 * $wgCategoryTreeSidebarOptions: options to use when showing the tree in the sidebar, as an array (since 36920, July 2008).

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:


 * My category name (5)

You can change this behavior by overriding the system message MediaWiki:categorytree-member-num. It takes five parameters:

Значение по умолчанию.

Tip: Use the ParserFunctions extension to provide if/then/else logic to display different parts conditionally. For example:

A configuration to manage commas and spaces when outputting all info: 

Wiki не работает после установки CategoryTree

 * Включите error reporting
 * Убедитесь, что установлены все необходимые файлы
 * Убедитесь, что все файлы расширения имеют правильно настроенные права доступа mode 644, и права на папку CategoryTree - 755.

Параметры в LocalSettings.php have no effect

 * Make sure you specify the options after including the extension.

Clicking the [+] has no effect, gives a JavaScript error or just sits on loading

 * Note that using the &lt;categorytree&gt; tag in system messages (MediaWiki-Namespace) may not work as expected - this is a known caveat. For a workaround, see  below.
 * Make sure you have <tt>$wgUseAjax = true;</tt> in your LocalSettings.php before including the extension.
 * Make sure you are using the latest version of the extension - the bleeding edge is at
 * If you are using rewrite rules or aliasing (e.g. to have "very short URLs" - i.e. wiki pages in the document root), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory. Also see below.

Browser reports a bad MIME type for CategoryTree.js and/or CategoryTree.css

 * Make sure your Webserver uses the correct mime types for .js and .css files
 * Enter the URLs directly into the browser and see if it is serving the pages at all, and not some error page; especially:
 * If you are using rewrite rules or aliasing (e.g. to have "very short URLs" - i.e. wiki pages in the document root), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory.

Member counts are wrong, [x] is shown instead of [+]
Since MediaWiki 1.13, CategoryTree can show the number of members of a category, and can show an [x] for tree nodes that do not have any children based on that number. This information is based on the new category table. However, populating that table with the current values does not always work when upgrading to 1.13. In that case, run the <tt>populateCategory.php</tt> maintenance script, if neccessary with the <tt>--force</tt> option.

[x] [+] [-] toogles 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  file the following line   to

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

[frontpost--at--gmail-dot-com]

Note to bot users
Bots and scripts that parse the HTML of category pages can use the <tt>notree</tt> URL parameter to force the traditional output. However, HTML output is generally not stable, so it is recommended to change your script to use the <tt>api.php</tt> to fetch category listings and similar.''

"Category Not Found" message
After you implement the Category Tree plugin and add the code to show the tree, if you see a message that says Category Not Found, you need to add some content in your category pages. The category pages can't be red pages, basically. Click your category names, add some text in the category page, and then your tree should work fine.

Using CategoryTree in system messages and custom skins
To use the CategoryTree in system messages or the sidebar, that is, to use it as part of the user interface instead of page content, you have to set <tt>wgCategoryTreeForceHeaders</tt> to <tt>true</tt>, so that the support scripts are linked on every page (normally, they are only linked "on demand", but that detection does not work for system messages). This works since 36888 (July 2008). If you try this without forcing the scripts to be included, you will find that Clicking the [+] has no effect / gives JavaScript error.

In older versions of CategoryTree, you have to modify the code to make this work: find the <tt>efCategoryTreeParserOutput</tt> function in the file <tt>CategoryTree.php</tt>, and remove the condition; i.e. it should then look like this:

Using CategoryTree in the Sidebar
Since 36920 (July 2008) with MediaWiki 1.13 (36917), you can integrate a CategoryTree in the sidebar simply by setting <tt>$wgCategoryTreeSidebarRoot</tt> to the category you want to use as a root. This only works with skins based upon SkinTemplate however, that is, Modern, Monobook, Chick, Simple, and MySkin, but not Standard, Nostalgia or CologneBlue.

If you use  in LocalSettings.php to drop your own wikitext article into the Sidebar, and then add CategoryTree items to it, you'll need to set   to ensure that every page works.

If you want the CategoryTree on a different position in the sidebar, you can reference it on MediaWiki::Sidebar as "categorytree-portlet".

For earlier versions of CategoryTree and/or MediaWiki, you'll need to install a mod to MonoBook.php to enable normal wikitext in the sidebar, see Wikitext in side bar --DJ 19:26, 24 January 2008 (UTC)

To append a link "CategoryTree" to your toolbox (sidebar) add following code to the javascript-page (e.g. monobook.js) of your skin and customize the URL "w:en:Special:CategoryTree".

A more generic version of this code can be found at Manual:Interface/Sidebar.

Weblinks

 * README file
 * SVN extensions module
 * download area with bundled version (alternative bundle). (NOTE: the bundled versions may not be up to date!)
 * Bug Search