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

Материал из свободной русской энциклопедии «Традиция»
Перейти к: навигация, поиск

Шаблон Карточка протокола предназначен для вставки информационных карточек в статьи о сетевых протоколах. Такие карточки содержат в себе краткое изложение основных сведений о протоколе в виде таблицы.

Использование[править]

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

Шаблону можно передавать ряд параметров. Из соображений гибкости все параметры, кроме Аббр, являются необязательными: если какой-то параметр не указан, соответствующее поле карточки просто не будет отображаться. Однако на практике, если вы не можете указать хотя бы самые главные сведения, лучше повременить со вставкой карточки.

Итак, параметры:

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

Пример[править]

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

{{Карточка протокола
  |Аббр = HTTP
  |Изображение =
  |Название = Hypertext Transfer Protocol
  |Уровень = Прикладной
  |Семейство = [[стек протоколов TCP/IP|TCP/IP]]
  |Создан = [[1990]]
  |Порт = 80/[[TCP]]
  |Назначение = Доступ к гипертексту, ныне стал универсальным
  |Спецификация = RFC 1945, RFC 2616
  |Реализации =
  |Клиенты = [[браузер|Веб-браузеры]], например [[Internet Explorer]], [[Mozilla Firefox]] и др.
  |Серверы = [[Apache]], [[IIS]]
  |Расширяемость =
  |Основные расширения =
}}
Hypertext Transfer Protocol
HTTP
Уровень:
Прикладной
Семейство:
TCP/IP
Создан:
1990
Порт:
80/TCP
Назначение:
Доступ к гипертексту, ныне стал универсальным
Спецификация:
RFC 1945, RFC 2616
Реализация:
Клиенты:
Веб-браузеры, например Internet Explorer, Mozilla Firefox и др.
Серверы:
Apache, IIS