Модуль:Portal/Дакументацыя

Гэта старонка дакументацыі для Модуль:Portal

Модуль залежыць ад наступных іншых модуляў:

Гэты модуль ужывае стылі:

Модуль:Portal/styles.css

Модуль мае дзве функцыі, portal і image. Функцыя portal стварае бокс са спасылкамі на партал або некалькі парталаў, і ўжываецца шаблонам {{Партал}}. Часцей за ўсё ўжываецца ў артыкулах у раздзеле «Гл. таксама». Функцыя image вяртае назву выявы, якая ўжываецца вызначаным парталам.

Функцыя portal

Функцыя portal стварае бокс са спасылкамі на парталы.

Ужыванне

Базавае ўжыванне

{{#invoke:Portal|portal |Партал 1 |Партал 2 |Партал 3 |... }}

Месца

У артыкулах вынік функцыі portal варта размяшчаць уверсе раздзела «Гл. таксама». Калі такога раздзела няма, яго можна змясціць у раздзеле «Спасылкі»; няма неабходнасці ствараць новы раздзел толькі для гэтага шаблона. Калі і раздзела «Спасылкі» няма, можна змясціць яго проста ўнізе тэксту артыкула ў месце, якое падаецца найбольш удалым.

На іншых старонках спасылкі на парталы можна змяшчаць там, дзе падаецца найбольш удалым.

Выява

Назвы выяў парталаў захоўваюцца на старонцы Модуль:Portal/images (там можна дадаваць, абнаўляць, выдаляць выявы). Калі партал знойдзены на гэтай старонцы, адпаведная выява будзе паказана каля спасылкі на партал. Калі выява не знойдзена, будзе паказаны Файл:Portal.svg

Для выяў партала можна вызначаць сінонімы, якія задаюцца на старонцы Модуль:Portal/images/aliases.

Вызначэнне выявы не залежыць ад рэгістру. Напрыклад, код {{Партал|Беларусь}} вярне тую ж выяву, што і {{Партал|беларусь}}. Назвы парталаў захоўваюцца ў ніжнім рэгістры на старонцы Модуль:Portal/images, і прыводзяцца ў ніжні рэгістр перад праверкай.

Прыклад

Код	Вынік
{{#invoke:Portal\|portal\|Навука}}	Партал «Навука»

Параметры

Назва	Значэнне	Апісанне
`1`, `2`, `3` ...	Назва партала, напрыклад, `Літаратура`	Безыменныя параметры задаюць парталы для паказу.
`left`	`yes`	Калі значэнне `yes`, партал будзе на старонцу злева, а не справа.
`margin`	Значэнне водступу для CSS, напрыклад, `1.2em 3em 0.5em 1em`	Дазваляе задаць свой водступ. Працуюць усе валідныя значэнні CSS для margin.
`border`	Адно са значэнняў: `no`, `n`, or `false`	Адключае вывад граніцы і заліўкі
`tracking`	Адно са значэнняў: `no`, `n`, `false`	Адключае катэгорыі для адсочвання. Па змоўчанні катэгорыі для адсочвання дадаюцца, акрамя пэўных прастораў нзаваў і старонак, назвы якіх змяшчаюць "/archive", "/doc" або "/test".

Апрацоўка памылак

Калі module ужываецца некарэктна, старонка дадаецца ў катэгорыі для адсочвання.

Катэгорыі для адсочвання не дадаюцца, калі выканана хоць адна з наступных умоў:

Адсочванне спецыяльна адключана. Гэта можна зрабіць з дапамогай спецыяльнага параметра |tracking=, задаўшы яму адно з наступных значэнняў: no, n, false
Шаблон ужываецца на старонці адной з наступных прастораў назваў: Размовы, Удзельнік, Размовы з ўдзельнікам, Размовы пра вікіпедыю, Размовы пра файл, Размовы пра шаблон, Размовы пра катэгорыю, Размовы пра модуль
Назва старонкі, дзе ўжыты шаблон, уключае які-небудзь з наступных радкоў (незалежна аж рэгістру): "/archive", "/doc", "/test", "/sandbox"

Функцыя image

Функцыя image вяртае назву выявы, якая ўжываецца вызначаным парталам.

Ужыванне

{{#invoke:Portal|image|партал}}

Прыклад

{{#invoke:Portal|image|Мастацтва}} → Nuvola apps package graphics.svg

Функцыя image dupes

Функцыя image dupes вяртае спіс усіх выяў, што ўжываюцца больш чым адным парталам (сінонімы не лічацца). Можа быць карыснай для вызначэння выяў, якія варта замяніць.

Ужыванне

{{#invoke:Portal|imageDupes}}

Функцыя display all

Функцыя display all вяртае бокс з усімі парталамі, што маюць выявы. Яна ўжываецца для распрацоўкі, і не мусіць ужывацца ў артыкулах.

Ужыванне

{{#invoke:Portal|displayAll}}