Шаблон:Картка пратакола/Дакументацыя

З Вікіпедыі, свабоднай энцыклапедыі
Дакументацыя Дакументацыя да шаблона Картка пратакола.

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

Ужыванне[правіць зыходнік]

Код для выкліку шаблона варта змяшчаць у самым версе старонкі, перад уступным абзацам. У гэтым выпадку картка будзе паказана ў правай верхняй частцы артыкула (гл. HTTP).

Шаблону можна перадаваць шэраг параметраў. З меркаванняў гнуткасці ўсе параметры, акрамя Абр, з'яўляюцца неабавязковымі: калі які-небудзь параметр не ўпісаны, адпаведнае поле карткі не будзе паказана. Аднак на практыцы, калі вы не здольны ўказаць хоць бы самыя галоўныя звесткі, лепш пачакаць з устаўкай катркі.

Параметры:

  • Абр — назва пратакола, якая будзе паказана над карткай як загаловак. Калі ў пратакола ёсць скарочаная назва (напрыклад, HTTP, FTP, SMTP, і г. д.), яе варта ўпісаць у гэты параметр.
  • Выява — калі ёсць нейкая выява, звязаная з пратаколам (напрыклад, лагатып), у гэтым параметры можна ўказаць вікі-спасылку на яго ў фармаце [[Выява:Файл.png|100px|Кароткае апісанне выявы]]. Памер у пікселях можа вар'іравацца ў залежнасці ад выявы; абярыце такі, каб выглядаў аптымальна ў невялікай па шырыні картцы.
  • Назва — поўная арыгінальная назва пратакола.
  • Узровень — узровень пратакола згодна мадэлі OSI.
  • Сямейства — група пратаколаў, да якой належыць гэты пратакол. Напрыклад, для пратаколаў Інтэрнэта тут можна ўказаць TCP/IP.
  • Створаны — год стварэння пратакола ў фармаце [[1999]]. Скарачэнне «г.» будзе дадавацца аўтаматычна.
  • Порт — калі пратакол звязаны з якім-небудзь стандартным (ці болей распаўсюджаным) партом ці аналагічнай канструкцыяй, змясціце тут яго нумар ці пазначэнне, а таксама транспартны пратакол (калі ёсць некалькі варыянтаў). Напрыклад, для пратакола HTTP гэта будзе 80/[[TCP]].
  • Прызначэнне — каротка аб тым, для чаго быў створаны і ўжываецца пратакол.
  • Спецыфікацыя — дакументы, якія задаюць спецыфікацыю гэтага пратакола (калі яны ёсць). Пры магчымасці пажадана ўказаць спасылкі. Памятайце, што для дакументаў RFC спасылкі ствараюцца аўтаматычна: дастаткова ўвесці RFC 1234 і вы атрымаеце спасылку RFC 1234.
  • Рэалізацыі — для пратаколаў, якія не з'яўляюцца кліент-сервернымі — кароткі пералік асноўных (найбольш распаўсюджаных рэалізацый пратакола (з вікі-спасылкамі).
  • Кліенты — для кліент-серверных пратаколаў — кароткі пералік асноўных (найбольш распаўсюджаных рэалізацый пратакола (з вікі-спасылкамі).
  • Серверы — для кліент-серверных пратаколаў — кароткі пералік асноўных (найбольш распаўсюджаных рэалізацый пратакола (з вікі-спасылкамі).
  • Пашыральнасць — магчымасці для пашырэння пратакола. Калі такіх няма, не запаўняйце гэты параметр.
  • Асноўныя пашырэнні — калі пратакол пашыральны, запішыце ў гэтым параметры кароткі пералік асноўных (найбольш распаўсюджаных) пашырэнняў. Не забудзьцеся таксама прапісаць параметр Пашыральнасць.

Узор[правіць зыходнік]

Ніжэй прыведзены прыклад ужывання карткі для пратакола HTTP (ужыты не ўсе параметры). Спачатку прыведзены поўны код для стварэння карткі, а ніжэй паказана, як яна будзе выглядаць у артыкуле.

Сямейства: TCP/IP
Створаны ў: 1990 г.
Порт/ID: 80/TCP
Прызначэнне пратаколу: Доступ да гіпертэкста, зараз стаў універсальным
Спецыфікацыя: RFC 1945, RFC 2616
Асноўныя рэалізацыі (кліенты): Вэб-браўзеры, напрыклад Mozilla Firefox, Safari Internet Explorer і інш.
Асноўныя рэалізацыі (серверы): Apache, IIS
{{Картка пратакола
  |Абр          = HTTP
  |назва        = Hypertext Transfer Protocol
  |узровень     = Прыкладны
  |Сямейства    = [[TCP/IP]]
  |Створаны     = [[1990]]
  |Порт         = 80/[[TCP]]
  |Прызначэнне  = Доступ да гіпертэкста, зараз стаў універсальным
  |Спецыфікацыя = RFC 1945, RFC 2616
  |Кліенты      = [[браўзер|Вэб-браўзеры]], напрыклад [[Mozilla Firefox]], [[Safari]] [[Internet Explorer]] і інш.
  |Серверы      = [[Apache]], [[Internet Information Services|IIS]]
}}