Шаблон:Doc/doc: различия между версиями
[[:ru:]]>SandBot м (→См. также: удаление устаревшего ключа сортировки) |
|||
Строка 11: | Строка 11: | ||
{{другие названия шаблона|документация}} | {{другие названия шаблона|документация}} | ||
+ | <templatedata> | ||
+ | { | ||
+ | "params": { | ||
+ | "1": {}, | ||
+ | "2": {}, | ||
+ | "3": {}, | ||
+ | "4": {}, | ||
+ | "5": {}, | ||
+ | "editsection": {}, | ||
+ | "SUBJECTPAGENAME": {} | ||
+ | }, | ||
+ | "format": "block" | ||
+ | } | ||
+ | </templatedata> | ||
== См. также == | == См. также == |
Версия 22:32, 20 сентября 2016
24px |
Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон Название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>
.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе Шаблон:Tc вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
Шаблон:Другие названия шаблона <templatedata> { "params": { "1": {}, "2": {}, "3": {}, "4": {}, "5": {}, "editsection": {}, "SUBJECTPAGENAME": {} }, "format": "block" } </templatedata>
См. также
- Проект по документированию шаблонов
- Пара шаблонов {{doc-inline}} и {{doc-end}}