ru.m.wikipedia.org
Проект:Технические работы/Шаблоны/Документирование
< Проект:Технические работы‎ | Шаблоны
Википроект «Документирование шаблонов» создан для выработки общих правил пользования шаблонами (уместность применения, правила установки и снятия и т. д.). На данный момент многие шаблоны не имеют соответствующих отметок, что необходимо исправлять. Главная категория для работы — Шаблоны:Недокументированные​.
На страницу задокументированного шаблона ставится пометка <noinclude>{{doc}}</noinclude>​. При этом создаётся ссылка на страницу документации. После написания документации на соответствующей странице ссылка автоматически будет заменена документацией. Обратите внимание, что редактирование документации не вызовет перерисовки всех страниц, использующих шаблон.
Сверху страницы документации также следует добавлять
{{docpage}}
для создания простой навигации между шаблоном, его страницей документации и обсуждением. Помещать его на страницу шаблона не нужно, имеющиеся в нём ссылки уже есть в шаблоне {{doc}}.
См. список задокументированных шаблонов, категория документаций шаблонов.
Для шаблонов, которым не требуется подробная и/или часто обновляемая документация, может использоваться конструкция
<noinclude>{{​doc-inline​}}</noinclude>
для размещения документации прямо в тексте шаблона.
Обратите внимание на /Защищённые шаблоны без документации.
Некоторые тонкости работы и рекомендации
Далее некоторые оформительские советы от Jack who built the house (можете добавить свои и тогда удалить моё имя).
Структура документации
Оформительские тонкости
См. также
Проект:Технические работы/Оформление шаблонов
Последний раз редактировалась 29 ноября 2020 в 16:29
Содержание доступно по лицензии CC BY-SA 3.0 (если не указано иное).
Политика конфиденциальности
Условия использования
Настольная версия
ГлавнаяСлучайнаяПоблизостиВойтиНастройкиПожертвоватьОписание ВикипедииОтказ от ответственности
СледитьПравить