Шаблон:Doc: различия между версиями

Материал из Викиновостей, свободного источника новостей
[непроверенная версия][непроверенная версия]
Содержимое удалено Содержимое добавлено
-notoc +editsection
передача порядковых параметров в кастомный шаблон документации
Строка 1: Строка 1:
<includeonly>{{doc/begin|{{SUBJECTSPACE}}:{{PAGENAME:{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|editsection={{{editsection|}}}}}
<includeonly>{{doc/begin|{{SUBJECTSPACE}}:{{PAGENAME:{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|editsection={{{editsection|}}}}}
{{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|{{#ifexist:{{SUBJECTSPACE}}:{{{1}}}|{{{{{1}}}}}|{{Документировать|{{{1|{{SUBJECTPAGENAME}}/doc}}}}}}}}}
{{#if:{{{1|}}}|{{#ifexist:{{{1}}}|{{{{{1}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}|{{{5|}}}}}|{{#ifexist:{{SUBJECTSPACE}}:{{{1}}}|{{{{{1}}}}}|{{Документировать|{{{1}}}}}}}}}|{{#ifexist:{{SUBJECTPAGENAME}}/doc|{{{{SUBJECTPAGENAME}}/doc}}|{{Документировать|{{SUBJECTPAGENAME}}/doc}}}}}}
{{doc/end}}</includeonly><noinclude>
{{doc/end}}</includeonly><noinclude>
{{doc}}
{{doc}}

Версия от 18:25, 11 декабря 2013

Документация

Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон НАЗВАНИЕ СТРАНИЦЫ/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.

Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>.

Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.

Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.

Шаблон поддерживает необязательный параметр. При вводе {{doc|Название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.