Модуль:Portal/Дакументацыя
Гэта старонка дакументацыі для Модуль:Portal
Модуль залежыць ад наступных іншых модуляў: |
Гэты модуль ужывае стылі:
|
Модуль мае дзве функцыі, 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}}