Редактирование: Шаблон:Описание шаблона/doc

{{Docpage}}
{{Устаревший шаблон|стандартная документация — через [[ВП:TemplateData|TemplateData]]}}
Упрощает табличное описание полей, параметров и функций шаблонов на подстраницах их документации.

== Синтаксис ==
{| class=wikitable
 !colspan=3| Параметры
 |- 
 ! Все
 ! Основные
 ! Минимум
 |-
 |valign=top| <pre style="border:0; padding:0 1em">{{Описание шаблона
 | Поле            = 
 | Формат          = 
 | По умолчанию    = 
 | Описание        = 

 | область1        = 
 | !1              = 
 | поле1           = 
 | альт1           = 
 | формат1         = 
 | по умолчанию1   = 
 | переносы1       = 
 | описание1       = 
···
 | область150      = 
 | !150            = 
 | поле150         = 
 | альт150         = 
 | формат150       = 
 | по умолчанию150 = 
 | переносы150     = 
 | описание150     = 

 | примечания      = 
}}</pre>

|valign=top| <pre style="border:0; padding:0 1em">{{Описание шаблона
 | По умолчанию  = 

 | !1            = 
 | поле1         = 
 | формат1       = 
 | по умолчанию1 = 
 | описание1     = 

 | !2            = 
 | поле2         = 
 | формат2       = 
 | по умолчанию2 = 
 | описание2     = 

 | !3            = 
 | поле3         = 
 | формат3       = 
 | по умолчанию3 = 
 | описание3     = 
···
}}</pre>

|valign=top| <pre style="border:0; padding:0 1em">{{Описание шаблона
 | !1        = 
 | поле1     = 
 | формат1   = 
 | описание1 = 

 | !2        = 
 | поле2     = 
 | формат2   = 
 | описание2 = 

 | !3        = 
 | поле3     = 
 | формат3   = 
 | описание3 = 
···
}}</pre>
|}

* {{Para|Поле}} — заголовок столбца таблицы с названиями полей шаблона. Значение по умолчанию: <code>Поле</code>.
* {{Para|Формат}} — заголовок столбца таблицы с примерами заполненных полей шаблона. Значение по умолчанию: <code>Формат</code>.
* {{Para|По умолчанию}} — дополнительный столбец таблицы с предустановленными значениями полей (параметров) шаблона. Вызов: {{Para|По умолчанию|есть}}.
* {{Para|Описание}} — заголовок столбца таблицы с описанием полей шаблона. Значение по умолчанию: <code>Описание</code>.
* {{Para|область1…150}} — название области специфических параметров шаблона.
* {{Para|!1…150}} — визуальная индикация обязательного параметра. Вызов: {{Para|!1…150|!}}.
* {{Para|поле1…150}} — название поля шаблона. Для заполненных полей (именованных параметров шаблона) в соответствующую ячейку второго столбца автоматически добавляется знак равенства.
* {{Para|альт1…150}} — альтернативное (дополнительное) название поля шаблона.
* {{Para|формат1…150}} — пример заполненного поля шаблона.
* {{Para|по умолчанию1…150}} — значение поля (параметра) по умолчанию.
* {{Para|переносы1…150}} — перенос длинных строк кода в примере заполненного поля шаблона и значении поля (параметра) по умолчанию. Вызов: {{Para|переносы1…150|есть}}.
* {{Para|описание1…150}} — описание поля шаблона. Обязательный параметр.
* {{Para|примечания}} — строка дополнительных пояснений и комментариев. Добавляется к низу таблицы.

== Пример ==
{| class="wikitable wide"
 !style=width:0| Шаблон 
 !style=width:400px| Описание шаблона
 ! Результат
 |-
 | <pre style=border:0>{{Шаблон
 | <номер>
 | <годы жизни>
 | автор        =
 | произведение =
 | персонаж     =
}}</pre>
 | <pre style="border:0; padding:0 1em 0 1em; word-wrap:break-word; white-space:-moz-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap">{{Описание шаблона
 | Описание      = Назначение
 | По умолчанию  = есть

 | поле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     = Персонаж.

 | примечания = {{Примечания}}
}}</pre>
 |style=padding:1em|
{{Описание шаблона
 | Описание      = Назначение
 | По умолчанию  = есть

 | поле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     = Персонаж.

 | примечания = {{Примечания}}
}}
|}

<includeonly>
[[Категория:Шаблоны:Для документирования шаблонов]]
</includeonly>