Модул:category tree/док

Пређи на навигацију Пређи на претрагу

Ово је документациона подстраница за Модул:category tree

This module is used for generating category boilerplate templates. It is not meant to be used directly. Rather, each template will have its own submodule, which handles the specifics of that template.

This documentation only covers the generics of the category tree system. If you are looking for documentation on a specific template, or on how to add or modify category information, see the documentation of that template.

Параметри[уреди]

Модул стабло категорије се позива као:

{{#invoke:category tree|show|template=name of the template|...other parameters...}}

Сваки шаблон који користи овај модул треба да има подмодул овог модула са именом датим у |template= parameter. (For example, {{poscatboiler}} uses Модул:category tree/poscatboiler.) Овај подмодул треба да извози функцију названу new који узима један параметар: табела именована info који садржи различите параметре који су првобитно прослеђени шаблону. Ова функција треба вратити нову Category објекат који представља те параметре, или nil ако комбинација параметара није важећа (тј. таква категорија не постоји).

Већина предложака прихвата и усваја овај скуп скупова параметара. Параметри прослеђени модулу помоћу шаблона су дефинирани темом појединачно, тако да сваки образац нужно неће користити све ове. {{famcatboiler}} на пример само пролази |code= параметар за модул.

|code=
The code that specifies what 'owns' the category's contents. This is usually a language code such as en, but it can also be a script code like Latn or the code of a language family, depending on how the specific template treats it.
|label=
A name for the thing that is being categorised. The submodule determines how the label is interpreted, so it depends on the template being used. Many templates use it to look up data in a table, while others may interpret it as a language code of some kind.
|sc=
The script code of the items to be categorised. This is usually empty, but many categories such as those used by Mandarin Chinese can split into subcategories based on script.

Опште радње[уреди]

The module is based on the principle of two main kinds of category:

Basic categories are those for which the |code= parameter is not empty. These therefore belong to a specific language (or similar) and are the "regular" categories. Examples are: Категорија:Енглески именице, Категорија:Француски шаблони, Категорија:nl:Лингвистика, Категорија:Енглески појмови изведени из Јапански, Категорија:Латински текст карактери.

Umbrella categories do not have a code, but contain all basic categories of their label, one for each code. These are the "по језику" type categories. Examples are: Категорија:Именице по језику, Категорија:Шаблони по језику, Категорија:Лингвистика, Категорија:Појмови изведени из Јапански језици, Категорија:Карактери по писму.

Some templates also distinguish a third type of category, the fundamental category. This category is used as the parent category for umbrella categories.

Category objects[уреди]

Text-x-generic with pencil.svg This documentation is out of date.
The documentation on this page or section no longer reflects its current state, and some information may be missing or incorrect. Please help by editing the documentation page, and adding information about undocumented features, while removing information that is no longer applicable.

Category objects are returned by each submodule's new function. They represent a single category in the tree. A category object has a variety of methods which may be called on it to ask for information about the category.

getBreadcrumbName[уреди]

getBreadcrumbName()

Returns the name that is used for the category in the "breadcrumbs" at the top of the category page.

getDataModule[уреди]

getDataModule()

Returns the name of the module which contains the data for this category. This is used to create an "edit" link on the category, which allows users to find and edit the information more easily.

canBeEmpty[уреди]

canBeEmpty()

Returns true either if the category contains pages but might be empty or if the category only contains categories, otherwise returns false.

getCategoryName[уреди]

getCategoryName()

Returns the name of the category that this category object represents.

getDescription[уреди]

getDescription()

Returns the description text that is shown at the top of the category page. If the category has no description, this returns nil.

getParents[уреди]

getParents()

Returns a table of the parent categories of this category. Each element in the table is a table itself, with two elements:

.name
One of two possibilities: An category object representing the parent category, or a string that directly specifies the name of the parent category.
.sort
The sorting key that should be used when categorizing the current category in the parent.

If the category has no parents, this returns nil.

If there are two or more parent categories, the first will be used to generate the breadcrumbs that are displayed at the top of the category page. For example, Категорија:Енглески језик is in numerous categories (Сви језици, Западно германски језици, Латински текст језици, Braille script languages, and so on), but the first category, Сви језици, is the one displayed in the breadcrumbs: Почетак » Сви језици » Енглески језик.

getChildren[уреди]

getChildren()

Returns a table of the child categories of this category. Each element in the table is a category object representing the child category. If the category has no children, this returns nil.

getUmbrella[уреди]

getUmbrella()

Returns a category object for the current category's corresponding umbrella category. If the current category is already an umbrella category, this returns nil. It also returns nil if the category has no umbrella category.

getAppendix[уреди]

getAppendix()

Returns an appendix link (such as Додатак:Француски глаголи) if the page exists, else returns nil.