Модул:category tree/doc

Ин модул аст, ки барои тавлид намудани категорияи дегхонаи қолибҳои судӣ истифода бурда мешавад. Ин аст, маънои онро надорад, ки бевосита истифода бурда шавад. Баръакс, ҳар як шаблон хоҳад модули зерсохторњо худ, ки сарукордошта хусусияти, ки ба шаблон доранд.

Ин ҳуҷҷатҳо танҳо системаи категорияи дарахти фаро мегирад. Агар шумо дар ҷустуҷӯи хуҷҷатҳо бар Шаблон мушаххас, ё дар бораи чӣ гуна ба илова ё тағйир маълумоти гурӯҳ, ба ҳуҷҷати ки шаблон дид.

Параметрҳо

Модули категорияи дарахт аст, мехонданд:

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

Ҳар шаблон, ки истифода мебарад ин модул бояд модули мазкур бо номи дода, дар шаблон = параметри доранд. як миз бо номи маълумоти, ки дорои параметрҳои гуногун, ки дар аввал ба шаблон гузашт карда шуданд: як миз бо номи маълумоти, ки дорои параметрҳои гуногун, ки дар аввал ба шаблон гузашт карда шуданд: Ин модул зерсохторҳо бояд вазифаи номи нав, ки мегирад параметр ягона содирот.

Аксари шаблонҳои мепазирем ва аз ин маҳмўи умумии нишондиҳандаҳои. Дар параметри бо як Шаблон ба модули гузашт, ки аз тарафи шаблон муайян дар алоҳидагӣ, то на ҳар шаблон ҳатман хоҳад истифода ҳамаи ин. {{famcatboiler}} барои мисол, танҳо коди= параметри ба модул мегузарад.

code=

Рамзи, ки мувофиқи он чӣ 'соҳибӣ' мундариҷаи категорияи мекунад. Ин аст, ки одатан як рамзи забон ба монанди en, балки аз он низ метавонад рамзи скрипт мисли Latn ё кодекси оила забон, вобаста ба, ки чӣ тавр ба Шаблон махсус ба он муносибат аст.

label=

Номи барои чизе аст, ки ҳоло гурӯҳбандӣ кард. Дар зербанди модул муайян, ки чӣ тавр аз муҳимтарин тафсир аст, то онро ба шаблон истифода вобаста аст. Бисёр шаблонҳои аз он истифода диҳад, то маълумоти дар як миз, дар ҳоле ки дигарон онро ҳамчун рамзи забон ягон гиёҳи тафсир кунад.

sc=

Рамзи скрипт намудани адад ба категорияи шавад. Ин аст, ки одатан холӣ, вале бисёре аз гурӯҳҳои ба монанди онҳое, истифода Мандарин Чин метавонад ба зергурӯҳҳо тақсим асоси скрипт.

Кории умумӣ

Модули мазкур дар бораи принсипи ду намуди асосии гурӯҳ асос ёфтааст:

Basic категорияҳои касоне ҳастанд, ки барои он code= параметри аст, холӣ нест. Пас, ин ба забони махсус (ё монанд) тааллуқ ва категорияҳои «мунтазам» мебошанд. Мисолҳо ҳастанд: Category:English nouns, Category:French templates, Category:nl:Linguistics, Category:Шартҳои англисӣ даст аз ҷопонӣ, Category:Ҳарфҳои алифбои лотинӣ.

Umbrella категорияҳои як рамзи надоранд, вале дорои ҳамаи категорияҳои асосии нишонаи онҳо, барои ҳар як кодекси. Инҳо аз ҳониби забони" категорияҳои навъи мебошанд. Намунаҳои аз инҳо иборатанд:Category:Nouns by language, Category:Templates by language, Category:Linguistics, Category:Шартҳои даст аз ҷопонӣ, Category:Ҳарфҳое, бо скрипт.

Баъзе қолибҳои низ як навъи категорияи сеюм, ба категорияи асосии фарқ карда наметавонед. Ин гурӯҳ ҳамчун категорияи волидайн барои категорияҳои чатр истифода бурда мешавад.

Category objects

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.

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.

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.