Still working to recover. Please don't edit quite yet.
Difference between revisions of "Template:doc"
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <includeonly>{{doc/begin|{{SUBJECTSPACE}}:{{PAGENAME:{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|notoc={{{notoc|}}}}} | |
+ | {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|{{#ifexist:{{SUBJECTSPACE}}:{{{1}}}|{{{{{1}}}}}|{{Документируйте|{{{1|{{SUBJECTPAGENAME}}/doc}}}}}}}}} | ||
+ | {{doc/end}}</includeonly><noinclude> | ||
+ | {{doc}} | ||
+ | <!-- | ||
+ | [Rus]: Добавляйте категории и интервики на подстраницу /doc, не сюда! | ||
+ | [Eng]: Please add categories and interwiki links to the /doc subpage, not here! | ||
+ | --> | ||
+ | </noinclude> |
Latest revision as of 17:15, 29 August 2011
Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон название страницы/doc
. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>
.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc
будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
См. также Анархопедия:Документирование шаблонов.
Во избежание поломок страниц, использующих данный шаблон, желательно экспериментировать в своём личном пространстве.