Шаблон:Описание полей шаблона/Документация

Шаблон, упрощающий табличное описание полей, параметров и функций шаблонов на страницах их документации.

Синтаксис

Параметры
Все	Основные	Минимум
{{описание полей шаблона | Поле = | Формат = | По умолчанию = | Описание = | область1 = | !1 = | поле1 = | альт1 = | формат1 = | по умолчанию1 = | переносы1 = | описание1 = ··· | область50 = | !50 = | поле50 = | альт50 = | формат50 = | по умолчанию50 = | переносы50 = | описание50 = | примечания = }}	{{описание полей шаблона | По умолчанию = | !1 = | поле1 = | формат1 = | по умолчанию1 = | описание1 = | !2 = | поле2 = | формат2 = | по умолчанию2 = | описание2 = | !3 = | поле3 = | формат3 = | по умолчанию3 = | описание3 = ··· }}	{{описание полей шаблона | !1 = | поле1 = | формат1 = | описание1 = | !2 = | поле2 = | формат2 = | описание2 = | !3 = | поле3 = | формат3 = | описание3 = ··· }}

• !1…50 — визуальная индикация обязательных параметров. Вызов:

  | !1…50 = !

• Поле (по умолчанию) — заголовок столбца таблицы с названиями полей шаблона.
• Формат (по умолчанию) — заголовок столбца таблицы с примерами заполненных полей шаблона.
• По умолчанию — дополнительный столбец таблицы с предустановленными значениями полей (параметров) шаблона. Вызов:

  | По умолчанию = есть

• Описание (по умолчанию) — заголовок столбца таблицы с описанием полей шаблона.
• область1…50 — название области специфических параметров шаблона.
• поле1…50 — название поля шаблона. Для заполненных полей (именованных параметров шаблона) в соответствующую ячейку второго столбца автоматически добавляется знак равенства.
• альт1…50 — альтернативное (дополнительное) название поля шаблона.
• формат1…50 — пример заполненного поля шаблона.
• по умолчанию1…50 — значение поля (параметра) по умолчанию.
• переносы1…50 — перенос длинных строк кода в примере заполненного поля шаблона и значении поля (параметра) по умолчанию. Вызов:

  | переносы1…50 = есть

• описание1…50 — описание поля шаблона. Обязательный параметр.
• примечания — строка дополнительных пояснений и комментариев. Добавляется к низу таблицы.

Пример

Шаблон	Описание полей шаблона	Результат
{{шаблон | <номер> | <годы жизни> | автор = | произведение = | персонаж = }}	{{описание полей шаблона | Описание = Назначение | По умолчанию = есть | поле1 = | формат1 = № 1 | описание1 = Порядковый номер автора. | !2 = ! | поле2 = | формат2 = 1828—1910 | описание2 = Годы жизни автора. | поле3 = автор | формат3 = Толстой, Л. Н. | по умолчанию3 = не установлен | описание3 = ФИО автора. | область4 = Основные параметры | поле4 = произведение | формат4 = «Война и мир» | по умолчанию4 = не указано | описание4 = Название произведения<ref>Кавычки обязательны.</ref>. | !5 = ! | поле5 = персонаж | альт5 = герой | формат5 = Андрей Болконский | переносы5 = есть | описание5 = Персонаж. | примечания = {{примечания}} }}	Поле = Формат По умолчанию Назначение № 1 — Порядковый номер автора. 1828—1910 — обязательный параметр Годы жизни автора. автор = Толстой, Л. Н. не установлен ФИО автора. Основные параметры произведение = «Война и мир» не указано Название произведения. персонаж герой = Андрей Болконский — обязательный параметр Персонаж.