Шаблон:Дерево категорий/Документация: различия между версиями

← Предыдущая правка

Шаблон:Дерево категорий/Документация (посмотреть исходный код)

Версия от 13:19, 28 апреля 2024

3605 байт добавлено , 28 апреля 2024

м

в топку.

Красавица

moder

25 889

правок

@@ Строка 1: / Строка 1: @@
-Шаблон создаёт дерево категорий для быстрой навигации.
+Шаблон использует некоторые атрибуты тега <nowiki><categorytree></nowiki> и создаёт дерево категорий для визуализации структуры и быстрой навигации. В этой документации описаны основные варианты заполнения шаблона, но не все возможные.
-<code><nowiki>{{Дерево категорий|Наименование категории|Вид отображения|глубина|title=123}}</nowiki></code>
+== Применение ==
+Шаблон размещается в нужном месте страницы. Записывается одной строкой, параметры перечисляются через вертикальную черту <code>|</code> в определённом порядке:
+<br><code><nowiki>{{Дерево категорий|наименование категории|значение параметра вид (mode)|значение параметра глубина (depth)}}</nowiki></code>
-Первый после наименования — '''Вид (mode)''', варианты
+== Параметры ==
-* '''категории''' — показывает только ''под''категории (по умолчанию, другой вариант записи: mode=categories)
+. Первый параметр (обязательный) — '''наименование категории'''. Вводится имя категории без префикса. Пример заполнения: <code><nowiki>{{Дерево категорий|Игровое}}</nowiki></code>
-* '''все''' — отображает всё содержимое категории
-* '''страницы''' — показывает только страницы
-* '''inverse''' — показывает только ''над''категории
-Второй после наименования — '''Глубина (depth)''' — по умолчанию глубина развёртывания стоит depth=0. Значение глубины может быть 0, 1, 2.
+. Второй параметр (дополнительный) — '''вид''' (mode). Этот параметр определяет, какие страницы указанной категории будут отображены в дереве. Пример: <code><nowiki>{{Дерево категорий|Игровое|страницы}}</nowiki></code>
+<br>Возможные значения:
+* '''категории''' — показывает только подкатегории (по умолчанию при пустом значении);
+* '''страницы''' — показывает подкатегории и страницы;
+* '''всё''' — отображает всё содержимое категории (подкатегории и страницы, в том числе страницы файлов);
+* '''inverse''' — показывает только надкатегории (обратная развёртка для показа родительских категорий).
+''Существующее ограничение: шаблон показывает не более 200 первых страниц каждой категории.''
-'''Как записать:''' <br /><nowiki>{{Дерево категорий|наименование категории|параметр|глубина}}</nowiki>
+. Третий параметр (дополнительный) — '''глубина''' (depth). Этот параметр определяет, сколько уровней дерева показывать на начальном этапе. Пример: <code><nowiki>{{Дерево категорий|Игровое||1}}</nowiki></code>
+<br>Возможные значения:
+* '''0''' (по умолчанию)
+* '''1'''
+* '''2''' (не работает в паре со значением inverse).
+Также шаблон поддерживает необязательный параметр '''title'''. С его помощью можно установить свой вариант названия шапки шаблона (название по умолчанию — Дерево категорий). Параметр можно разместить в любом порядковом месте строки шаблона, но для сохранения заданной последовательности рекомендуется включать последним фрагментом. Пример: <code><nowiki>{{Дерево категорий|Монстры|inverse|1|title=Своё название}}</nowiki></code>
-Вместо шаблона можно использовать теги <nowiki><categorytree>Наименование категории</categorytree></nowiki>
+== Примеры ==
-* параметр inverse — <nowiki><categorytree mode="inverse">Питомцы</categorytree></nowiki> — отображает список ''над''категорий.
+{| class="wikitable" style="font-size:95%;"
-<categorytree mode="inverse">Питомцы</categorytree>
+|-
-или <nowiki><categorytree mode=pages>Наименование категории</categorytree></nowiki> для отображения страниц в категории.
+! Варианты !! Заполнение строки шаблона !! Результат
+|-
-== Примеры использования ==
+| Только подкатегории, глубина развёртки&nbsp;0 || <nowiki>{{Дерево категорий|Снаряжение}}</nowiki> || {{Дерево категорий|Снаряжение}}
+|-
-''Документация и код шаблона взяты из Википедии, документация будет доработана позже''
+| Подкатегории и все страницы, глубина развёртки&nbsp;0 || <nowiki>{{Дерево категорий|Снаряжение|всё}}</nowiki> || {{Дерево категорий|Снаряжение|всё}}
+|-
+| Подкатегории и все страницы, глубина развёртки&nbsp;1 || <nowiki>{{Дерево категорий|Снаряжение|всё|1}}</nowiki> || {{Дерево категорий|Снаряжение|всё|1}}
+|-
+| Только подкатегории, глубина развёртки&nbsp;1 || <nowiki>{{Дерево категорий|Снаряжение||1}}</nowiki> || {{Дерево категорий|Снаряжение||1}}
+|-
+| Только надкатегории (инверсия), глубина развёртки&nbsp;1 || <nowiki>{{Дерево категорий|Снаряжение|inverse|1}}</nowiki> || {{Дерево категорий|Снаряжение|inverse|1}}
+|-
+| Только надкатегории (инверсия), глубина развёртки&nbsp;1, своё название шаблона || <nowiki>{{Дерево категорий|Снаряжение|inverse|1|title=Наверх}}</nowiki> || {{Дерево категорий|Снаряжение|inverse|1|title=Наверх}}
+|}
+----
+Код шаблона скопирован из [[Wikipedia:ru:Шаблон:Дерево_категорий|Википедии]].
 <includeonly><!--Категория шаблона-->[[Категория:Шаблоны:Служебные]]</includeonly>
 <noinclude><!--Категория этой страницы-->[[Категория:Шаблоны/Документация]]</noinclude>