Шаблон:Навігацыйная табліца

З Вікіпедыі, свабоднай энцыклапедыі
(i) Дакументацыя

Дадзены шаблон дазваляе хутка ствараць навігацыйныя шаблоны, паказваючы ў якасці параметраў спісы спасылак.

У правым верхнім вуглу знаходзіцца кнопка [паказаць] / [схаваць]. Гэта рэалізавана з дапамогай MediaWiki:Common.js. Падрабязней гл. Вікіпедыя:Згортвальныя блокі.

Пусты шаблон

{{Навігацыйная табліца
| імя                       = Навігацыйная табліца/Дакументацыя
| navbar                    = 
| state                     = 
| стыль_асноўнага_загалоўка = 
| загаловак                 = 
| выява                     = 
| стыль_цела                = 
| стыль_загалоўкаў          = 
| стыль_спісаў              =
| стыль_уверсе              = 
| уверсе                    = 
| загаловак1                = 
| спіс1                     = 
| загаловак2                = 
| спіс2                     = ...
| загаловак20               = 
| спіс20                    = 
| стыль_унізе               = 
| унізе                     =  
}}<noinclude>
{{doc-inline}}
{{Навігацыйная табліца/TemplateData}}
{{doc-end}}
[[Катэгорыя:Навігацыйныя шаблоны]]
</noinclude>

Параметры

Для зручнасці шаблон {{Навігацыйная табліца}} мае аднолькавыя назвы параметраў з даччынымі шаблонамі {{Навігацыйная табліца з калонкамі}} і {{Навігацыйная табліца з блокамі}}. Параметры, пазначаныя зорачкай (*), з’яўляюцца агульнымі для ўсіх трох шаблонаў.

Асноўныя

Спіс параметраў
Англійская назва Беларуская назва
|name= |імя=
|title= |загаловак=
|navbar= |спасылка_на_прагляд=
|border=
|state=
|navigation= |навігацыя=
|above= |уверсе=
|image= |выява=
|imageleft= |выява_злева=
|groupn= |загаловакn=
|listn= |спісn=
|below= |унізе=
|bodystyle= |стыль_цела=
|basestyle= |базавы_стыль=
|titlestyle= |стыль_асноўнага_загалоўка=
|groupstyle= |стыль_загалоўкаў=
|groupnstyle= |стыль_загалоўкаn=
|groupwidth= |шырыня_загалоўкаў=
|liststyle= |стыль_спісаў=
|listnstyle= |стыль_спісуn=
|listpadding= |водступ_спісаў=
|abovestyle= |стыль_уверсе=
|belowstyle= |стыль_унізе=
|imagestyle= |стыль_выявы=
|imageleftstyle= |стыль_выявы_злева=
|bodyclass= |клас_цела=
|titleclass= |клас_асноўнага_загалоўка=
|imageclass= |клас_выявы=
|groupclass= |клас_загалоўкаў=
|listclass= |клас_спісаў=
|aboveclass= |клас_уверсе=
|belowclass= |клас_унізе=
|titlegroup= |група-загаловак=
|titlegroupstyle= |стыль_групы-загалоўка=
|innerstyle=
імя*
name*
Імя шаблона, неабходнае для спасылкі Прагляд гэтага шаблона (пераход на шаблон) на ўсіх старонках, дзе выкарыстоўваецца шаблон. Для спрашчэння можна выкарыстаць {{subst:PAGENAME}}. Калі пазначаны параметр |спасылка_на_прагляд=plain, то гэты параметр не выкарыстоўваецца.
state* [autocollapse, collapsed, uncollapsed, plain, off]
autocollapse — значэнне па змоўчанні, калі |state= пусты або адсутнічае;
collapsed — пры гэтым значэнні табліца заўсёды будзе згартнута;
uncollapsed — пры гэтым значэнні табліца заўсёды будзе разгартнута;
plain — пры гэтым значэнні табліца заўсёды будзе разгартнута і будуць прыбраны спасылкі [паказаць] / [схаваць] справа. Загаловак будзе адцэнтраваны адносна ўсёй ячэйкі, ігнаруючы памеры «шасцяронкі»;
off — пры гэтым значэнні табліца заўсёды будзе разгартнута і будуць прыбраны спасылкі [паказаць] / [схаваць] справа. Загаловак не будзе адцэнтраваны адносна ўсёй ячэйкі, ігнаруючы памеры «шасцяронкі». Рэкамендуецца ўжываць plain замест off. Ужывайце дадзены параметр, толькі калі ведаеце што робіце.
Навігацыйная табліца з параметрам autocollapse будзе з’яўляцца ў згарнутым стане, калі на старонцы ёсць дзве ці больш навігацыйныя табліцы з CSS-класам collapsible (тэхнічныя дэталі гл. у MediaWiki:Common.js).
Часам патрабуецца навігацыйны шаблон са станам па змоўчанні, які можна перавызначыць у артыкуле. Для гэтага ў навігацыйным шаблоне ўжывайце параметр |state=, які проста перадае значэнне базаваму шаблону (замест стан па змоўчанні трэба падставіць неабходнае значэнне — напрыклад, autocollapse):
| state = <includeonly>{{{state|стан па змоўчанні}}}</includeonly>
(тэгі <includeonly> патрэбны для таго, каб пры праглядзе шаблона на яго старонцы ён заўсёда заставаўся ў разгорнутым стане). Адпаведна, пры ўжыванні такога навігацыйнага шаблона можна пазначаць яго стан, напрыклад:
{{Наш навігацыйны шаблон|state=collapsed}}
навігацыя [так, не]
navigation
Уключае дынамічную навігацыю для спасылак на іншыя шаблоны.
так — значэнне па змоўчанні для асноўнай прасторы назваў;
не — пры дадзеным значэнні поўнасцю адключаецца навігацыя паміж спасылкамі;
спасылка_на_прагляд*
navbar*
Значэнне па змоўчанні — паказваць спасылку Прагляд гэтага шаблона (або Прагляд гэтага шаблона — колер падбіраецца аўтаматычна ў залежнасці ад колеру фону) для пераходу на шаблон, пазначаны ў параметры |імя=. Калі зададзена значэнне plain, або параметр |імя= пусты ці не зададзены, спасылка ў левай частцы загалоўка паказана не будзе і загаловак будзе адцэнтраваны адносна ўсёй ячэйкі. Калі зададзена значэнне off, то цэнтраванне не будзе ўключаць у сябе памер спасылак [паказаць] / [схаваць].
border*
Калі значэнне ўсталявана як child або subgroup, то навігацыйная табліца можа быць ужыта ў якасці даччынага элемента, які плотна прылягае да іншай навігацыйнай табліцы. Мяжа будзе схавана і знікне вонкавая адлегласць паміж табліцамі, каб яна ўпісвалася ў (|list=) бацькоўскай навігацыйнай табліцы. Калі ўсталявана значэнне none, то мяжа таксама будзе схавана і знікне вонкавая адлегласць (padding), а навігацыйная табліца зможа быць ужыта ў якасці даччынага элемента іншага кантэйнера (не ўжывайце гэта значэнне, калі збіраецеся ўжываць навігацыйную табліцу ўнутры навігацыйнай табліцы, ужывайце толькі child або subgroup). Калі ўсталявана любое іншае значэнне, то звычайная навігацыйная табліца адлюструецца з мяжой у 1px. Альтэрнатыўны спосаб пазначыць мяжу каб задаць стыль падгрупы, гэта ўжыць першы безыменны параметр замест |border=:
{{Навігацыйны шаблон|child
...
}}

Ячэйкі

загаловак*
title*
Тэкст, які адлюстроўваецца ў верхнім радку табліцы. Звычайна гэта тэма шаблона, кароткае апісанне яго ўтрымання.
уверсе
above
Ячэйка ва ўсю шырыню табліцы, якая размяшчаецца непасрэдна пад асноўным загалоўкам (то бок над загалоўкамі/спісамі цела шаблона). У шаблоне без параметра |выява= заданне параметра |уверсе= аналагічнае ўказанню параметра |спіс1= без |загаловак1=, але пры гэтым спіс з параметра |уверсе= па змоўчанні будзе адцэнтраваны.
загаловакn
groupn
(то бок загаловак1, загаловак2 і г.д.) Калі гэты параметр пазначаны, злева ад адпаведнага |спісn= будзе адлюстраваны зададзены тэкст. Калі параметр не пазначаны, спісn зойме ўсю шырыню табліцы.
спісn
listn
(то бок спіс1, спіс2 і т.д.) Цела шаблона; як правіла, набор спасылак. Кожны спіс адлюстроўваецца ў асобным радку табліцы. Кожны |спісn= можа суправаджацца параметрам |загаловакn= (гл. вышэй). Калі параметр |клас_спісаў= (ці |клас_цела=) утрымлівае значэнне hlist, кожны элемент спісу мусіць пачынацца з новага радка і выкарыстоўваць астэрыск (*). Калі радок будзе пачынацца з двух ці болей астэрыскаў (**), то элементы пачнуць абгортвацца ў дужкі, як даччыныя для асноўнага. Прыклад:
| спіс1 =
* 1
* 2
** 3
* 4
дасць вынік: 1 · 2 (3) · 4.
Таксама можна ўжываць міні-групы, каб іх загалоўкі выдзяляліся тлустым. Для гэтай мэты варта ўжываць ; перад загалоўкам міні-групы і : перад кожным з элементаў. Прыклад:
| спіс1 =
; Загаловак
: 1
: 2
:* 3
: 4
дасць вынік:
Загаловак
1
2
  • 3
4
Калі не ўжываецца клас hlist, элементы спіса мусяць быць пазначаны на аднім радку, але, размясціўшы іх у <div></div>, можна выкарыстаць перанос радка (гл. #Без астэрыскаў).
выява
image
Выява, якая будзе адлюстравана пад асноўным загалоўкам у правай частцы табліцы (правей загалоўкаў/спісаў). Для таго, каб выява адлюстроўвалася, павінен быць хоць адзін |спіс= або |загаловак=. Параметр |выява= дапушчае стандартны вікікод для адлюстравання, то бок
[[Выява:Прыклад.jpg|100px]]
У шаблоне, не расцягнутым на ўсю шырыню старонкі, выява будзе адлюстравана са зрухам ад правага боку шаблона. Для таго, каб гэтага пазбегнуць, выкарыстайце параметр right у вікікодзе, то бок
[[Выява:Прыклад.jpg|80px|right]]
выява_злева
imageleft
Аналагічна стандартнай выяве, але будзе паказана пад асноўным загалоўкам у левай частцы табліцы (лявей загалоўкаў/спісаў). Для таго, каб выява адлюстроўвалася, павінен быць хоць адзін |спіс= або |загаловак=.
унізе
below
Ячэйка ва ўсю шырыню табліцы, якая размяшчаецца ўнізе цела шаблона (то бок пад загалоўкамі/спісамі і выявай). У шаблоне без параметра |выява= заданне параметра унізе аналагічнае ўказанню апошняга параметра |спісn= без адпаведнага |загаловакn=, але пры гэтым спіс з параметра |унізе= па змоўчанні будзе адцэнтраваны.

Стылі

У наступных параметрах пазначаюцца CSS-стылі.

Увага! Значэнні стыляў табліц па змоўчанні ў Вікіпедыі ў цяперашні час зададзены з дапамогай MediaWiki:Common.css.

Паколькі падзел радкоў адбываецца праз CSS-уласцівасць border-top, то магчымыя складанасці са стварэннем меж ячэек. Праблему могуць дапамагчы вырашыць CSS-цені або шаблон {{box-shadow}}.

стыль_цела або стыль
bodystyle або style
Стылі для цела (фону) шаблона. Параметр |стыль= або |style= з’яўляецца састарэлым, ужываецца для сумяшчальнасці, рэкамендуецца замяняць яго на |стыль_цела= або |bodystyle=. Прыклады аргументаў гэтых параметраў:
background: #nnnnnn;
text-align: [right/center/left/justified]
width: N[em/%/px or width: auto]
float: [left/right/none]
clear: [right/left/both/none]
базавы_стыль
basestyle
Задае агульны стыль для |уверсе=, |унізе=, |загаловак= і |загаловакn=, не закранаючы ячэйкі спісаў.
background: #nnnnnn;
стыль_асноўнага_загалоўка
titlestyle
Стылі для параметра |загаловак=. Як правіла, колер фону:
| стыль_асноўнага_загалоўка = background: #nnnnnn;
| стыль_асноўнага_загалоўка= background: name;
Колер фону па змоўчанні — #ccccff.
стыль_загалоўкаў
groupstyle
Стыі для ўсіх параметраў |загаловакn=. Гэты параметр мае больш высокі прыярытэт, чэм |базавы_стыль=. Прыклады аргументаў гэтага параметра:
background: #nnnnnn;
text-align: [left/center/right];
vertical-align: [top/middle/bottom];
white-space: nowrap;
Колер фону па змоўчанні — #ddddff. Як можна бачыць, гэты колер трохі святлей стандартнага колеру фону загалоўка шаблона. Калі вы падбіраеце колер фону па тым жа прынцыпе, зыходзячы ад іншага колеру фону загалоўка, вы можаце скарыстацца інструментам падбору колеру на базе HSL-шкалы, зрушыўшы значэнне трэцяга параметра (светлаты) на трэць бліжэй да 100 (напрыклад, 85 → 90; прыклад інструмента).
стыль_загалоўкаn
groupnstyle
Стыль для аднаго з загалоўкаў груп. Перапісвае параметр |groupstyle=. Прыклад:
| group2style = background: red; color: white;
шырыня_загалоўкаў
groupwidth
Параметр ужываецца для спрашчэнны працы з шырынёй загалоўкаў груп, калі меншыя загалоўкі маюць меншую шырыню. Асабліва карысна пры ўжыванні дачыных шаблонаў. Прыклад:
| groupwidth = 10em
стыль_спісаў
liststyle
Стылі для ўсіх параметраў |спісn=. Гэты параметр мае больш высокі прыярытэт, чым |стыль=. У папярэдняй версіі шаблона падтрымліваліся таксама параметры |стыль_няцотных= (|oddstyle=) і |стыль_цотных= (|evenstyle=), якія задавалі стылі адпаведна для няцотных (спіс1, спіс3 і г.д.) і цотных (спіс2, спіс4 і г.д.) радкоў, але ў цяперашняй версіі гэтыя параметры не працуюць, а вызначэнне чаргавання адбываецца аўтаматычна, ужываюцца колеры #f7f7f7 для цотных, transparent для няцотных.
Колеры фону спіса (і усёй табліцы) па змоўчанні — #fdfdfd.
стыль_спісуn
listnstyle
Стыль для аднаго са спісаў. Перапісвае параметр |liststyle=. Прыклад:
| list2style = background: red; color: white;
водступ_спісаў
listpadding
Вызначае значэнне ўнутраных водступаў для ўсіх спісаў, па змоўчанні гэты параметр роўны 0em — уверсе і ўнізе, 0.25em — справа і злева.
| listpadding = 0.5em 0 — задасць водступы 0.5em — уверсе і ўнізе, 0em — справа і злева.
| listpadding = 0 — прыбярэ ўсі водступы ў ячэйках спісаў.
цотнасць [swap, even, odd, off]
evenodd
Калі зададзены значэнне swap, то аўтаматычнае чаргаванне цотных і няцотных радкоў стане адваротным. Звычайна, калі цотным радкам зададзены светла-шэры фон, то пры ўжыванні гэтага параметра няцотныя радкі атрымаюць шэры фон замест цотных радкоў. Значэнні even і odd прымусяць усі радкі стаць цотнымі або няцотнымі. off адключае аўтаматычнае чаргаванне радкоў. Гэты дадатковы параметр варта ўжываць толькі для вырашэння праблем, калі навігацыйная табліца ўжываецца як даччыны элемент іншай навігацыйнай табліцы і радкі не супадаюць. Прыклады і далейшае апісанне можна знайсці ў раздзеле, прысвечаным даччыным шаблонам.
стыль_уверсе
abovestyle
стыль_унізе
belowstyle
Стылі для параметраў |уверсе= і |унізе=, адпаведна. Звычайна выкарыстоўваецца для задання колеру фону або выраўноўванню тэксту:
background: #nnnnnn;
text-align: [left/center/right];
стыль_выявы
imagestyle
стыль_выявы_злева
imageleftstyle
Задае стыль ячэек для выяў. Можна ўжываць, калі шырыня ячэйкі, у якой знаходзіцца выява, занадта вялікая.
стыль_выявы = width: 5em;

Класы

клас_цела
bodyclass
клас_загалоўкаў
groupclass
клас_спісаў
listclass
клас_уверсе
aboveclass
клас_унізе
belowclass
Задаюць CSS-клас для элементаў шаблона. Звычайна выкарыстоўваецца hlist у |клас_спісаў= для гарызантальных спісаў. Кожны з параметраў можа прымаць значэнне hlist, але калі ў шаблоне вы выкарыстоўваеце болей за адзін параметр з hlist, то лепш выкарыстоўваць |bodyclass= для ўсяго шаблона. Таксама можна выкарыстоўваць клас hlist-items-nowrap, каб забараніць перанос радка ўнутры элементаў (спасылкі не пераносяцца ў любым разе), але гэта стварае праблемы ў IE9 і ніжэй (на іх можна будзе не звяртаць увагі, калі доля іх выкарыстання стане вельмі малой).
Часам шаблоны яшчэ выкарыстоўваюць састарэлыя раздзяляльнікі {{}}, {{·}} замест спісаў з астэрыскам. Каб аўтаматычна пераўтварыць код шаблона са старога фармата ў новы, можна ўжыць наступны букмарклет  (руск.) (запускаецца з панэлі закладак):
javascript:if ('toHlist' in window) { window.toHlist(); } else { importScript('User:Artsiom91/toHlist.js'); }
Гэты букмарклет не пераўтварае элементы ў дужках пункты спісу другога ўзроўню (**) — гэта трэба рабіць уручную.

Прыклады

Без выявы

З выявай

З выявай і стылямі

Без астэрыскаў

Даччыныя шаблоны

Існуе магчымасць размясціць некалькі навігацыйных табліц у адной, пры гэтым вонкавыя рамкі будуць прыбраны. Для гэтага неабходна ўжыць параметр |border= або проста першы параметр са значэннем child. Як прыклад, у наступным кодзе дадатковая навігацыйная табліца дадаецца ў першы спіс:

{{Навігацыйная табліца
| імя        = {{subst:PAGENAME}}
| загаловак  = Загаловак

| загаловак1 = [апцыянальна]
| спіс1      = {{Навігацыйная табліца|child
   ...параметры даччынай навігацыйнай табліцы...
}}

...
}}

Прыклад з падгрупамі

Гэты прыклад паказвае, як могуць стварацца падгрупы. Рэкамендуецца ўжываць {{Падгрупы навігацыйнай табліцы}}, але такога ж выніку можна дабіцца з дапамогай {{Навігацыйная табліца}} з ужываннем параметра |border= або першага параметра са значэннем child. У гэтым прыкладзе ўжыты абодва спосабы стварэння падгруп. Для таго каб у падгрупах зусім прыбраць чаргаванне і ўжыць колер асноўнага спісу, трэба дадаць радок liststyle = background: transparent; у кожную падгрупу.

Прыклад складанага шаблона ў беларускай Вікіпедыі: {{Узброеныя сілы Германскай Імперыі ў ПСВ}}

Прыклад са згортвальнымі блокамі

Прыведзены ніжэй прыклад створаны з дапамогай звычайнай Навігацыйнай табліцы ў якасці асноўнага кантэйнера, а кожны яго спіс |list1=, |list2= і |list3= утрымлівае яшчэ адну Навігацыйную табліцу з першым параметрам child. Шасцяронка ў кожнай унтуранай табліцы прыбрана з дапамогай зададзенага параметра navbar — |navbar=plain. Але ў дадзеным прыкладзе, паколькі ва ўнутраных Навігацыйных табліц не зададзены параметр |імя=, шасцяронка не будзе паказвацца нават калі параметра |navbar= не будзе.

Вынік падобны на ўжыванне шаблона {{Навігацыйная табліца з блокамі}}, але, у адрозненне яд яго, у выпадку ўжывання толькі {{Навігацыйная табліца}} з child можна некаторыя спісы рабіць звычайнымі, а не ўкладзенымі блокамі. Прыклады: {{Інтэрнэт}}, {{Злучэнні вадароду}}

Узаемадзеянне з іншымі шаблонамі

Дадзены шаблон распрацаваны спецыяльна для працы з двума іншымі роднаснымі шаблонамі: {{Навігацыйная табліца з калонкамі}} і {{Навігацыйная табліца з блокамі}}. Усе тры гэтыя шаблоны маюць аднолькавыя параметры для спрашчэння выкарыстання (такія параметры пазначаны зорачкай (*) у спісе апісання параметраў). Найгалоўнае, што кожны шаблон можа быць выкарыстаны ў якасці даччынага адзін для аднаго (з дапамогай |border=child, або пазначыўшы значэнне першага безыменнага параметра роўным child, напрыклад: {{Навігацыйная табліца|child ...}}, {{Навігацыйная табліца з калонкамі|child ...}} або {{Навігацыйная табліца з блокамі|child ...}}).

Прыклады ўзаемадзеяння шаблонаў у беларускай вікіпедыі:

Гл. таксама

Каб пазбегнуць паломак старонак, дзе ўжыты гэты шаблон, пажадана эксперыментаваць у сваёй асабістай прасторы.