Шаблон:Doc/doc: различия между версиями
AlexBond (обсуждение | вклад) (Новая страница: «Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «''…») |
AlexBond (обсуждение | вклад) Нет описания правки |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 6: | Строка 6: | ||
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. | Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. | ||
<includeonly> | |||
[[Категория:Шаблоны:Для документирования шаблонов]] | |||
</includeonly> | |||
<!-- | <!-- | ||
Шаблон поддерживает необязательный параметр. При вводе {{tl|doc|''Полное название страницы''}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.--> | Шаблон поддерживает необязательный параметр. При вводе {{tl|doc|''Полное название страницы''}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.--> | ||
<!-- | <!-- | ||
{{другие названия шаблона|документация}}--> | {{другие названия шаблона|документация}}--> | ||
<!-- | |||
== TemplateData == | == TemplateData == | ||
<templatedata> | <templatedata> | ||
| Строка 26: | Строка 29: | ||
} | } | ||
</templatedata> | </templatedata> | ||
--> | |||
Текущая версия от 22:52, 31 мая 2017
Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «Название текущей страницы/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным).
Проще всего вставить включение этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>, не перенося строку после последней строчки кода шаблона.
Документация шаблона сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.