Module:Сандбох/Ниҳилтрес/Cатегорй манагер/доc
This is the documentation page for Modul:Sandbox/Nihiltres/Category manager
| Тҳис модуле ис ратед ас бета, анд ис реадй фор wидеспреад усе. Ит ис стилл неw анд шоулд бе усед wитҳ соме cаутион то энсуре тҳе ресулц аре ас эхпеcтед. |
Тҳис модуле имплеменц а симпле тоол фор манагинг cатегорй оутпут ин модулес.
Усаге
Тҳе модуле cаннот бе усед фром wикитехт. Ит cан бе импортед то анотҳер модуле усинг cоде симилар то тҳе фоллоwинг:
local catMan = require("Module:Category manager")
Cатегорй-лист табле формат
Эач фунcтион ин тҳе модуле такес а табле ас иц фирст параметер, анд тҳат табле ис усед ас тҳе лист оф cатегориэс. Тҳесе таблес аре ассумед то онлй бе манипулатед бй тҳис модуле'с фунcтионс, бут тҳере ис но протеcтион агаинст эхтернал манипулатион; тҳере'с жуст басиc тйпе/валуэ валидатион. Эач итем ин а cатегорй-лист табле ҳас иц cатегорй наме (wитҳоут префих) ас иц кей; дуплиcате cатегориэс аре тҳерефоре импоссибле. Валуэс фор эач кей cан эитҳер бе true (но сорт кей) ор а стринг cонтаининг тҳат сорт кей. А false валуэ ор анй отҳер тйпе оф валуэ wилл cаусе эррорс. Тҳере аре тҳреэ фунcтионс фор манипулатинг а cатегорй лист табле, анд тҳеир индивидуал доcументатион фоллоwс.
Фунcтионс
аддCатегорй
Усаге:
catMan.addCategory(catList, name)catMan.addCategory(catList, name, sortKey)
Тҳе addCategory фунcтион аддс а cатегорй бй сеттинг тҳе кей фром name ин тҳе catList табле то эитҳер true ор тҳе провидед sortKey валуэ иф пресент.
Иф ан эхистинг cатегорй ис аддед а сеcонд тиме, иц валуэ wилл бе оверwриттен wитҳ тҳе неw валуэ; фор тҳис реасон тҳе модуле доэс нот инcлуде а сепарате фунcтион фор сеттинг сорт кейс.
Тҳе catList параметер муст бе а табле, тҳе name параметер муст бе а нон-эмптй, нон-wҳитеспаcе стринг, анд sortKey муст бе эитҳер а стринг ор нил.
ремовеCатегорй
Усаге:
catMan.removeCategory(catList, name)
Тҳе removeCategory фунcтион ремовес а cатегорй бй сеттинг тҳе кей фром name то нил ин тҳе catList табле.
Тҳе catList параметер муст бе а табле, анд тҳе name параметер муст бе а нон-эмптй, нон-wҳитеспаcе стринг.
wритеCатегорйЛист
Усаге:
catMan.writeCategoryList(catList)catMan.writeCategoryList(catList, nullify)
Тҳе writeCategoryList фунcтион продуcес а стринг cонтаининг алл тҳе cатегориэс ин тҳе табле форматтед ас wикитехт. Оптионаллй, а боолеан nullify параметер май бе провидед, анд иф труэ, ит wилл cаусе тҳе фунcтион то оутпут ан эмптй стринг. Тҳис ис усефул ас ит макес ит эасй то дисабле cатегорй оутпут тҳроугҳ а параметер, пробаблй ин cонжунcтион wитҳ Модуле:Есно.
Тҳе catList параметер муст бе а табле форматтед аccординг то тҳе cатегорй-лист табле формат, анд тҳе nullify параметер муст бе эитҳер а боолеан ор нил.