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

Материал из Викиновостей, свободного источника новостей
[непроверенная версия][непроверенная версия]
Содержимое удалено Содержимое добавлено
обновление из песочницы
перенос из песочницы изменений для учёта пробелов в именах шаблонов
Строка 6: Строка 6:
{{doc/end}}{{doc-inline}}''Во избежание поломок страниц, использующих данный шаблон, можно сначала экспериментировать в его {{
{{doc/end}}{{doc-inline}}''Во избежание поломок страниц, использующих данный шаблон, можно сначала экспериментировать в его {{
#ifexist: {{SUBJECTPAGENAME}}/песочница
#ifexist: {{SUBJECTPAGENAME}}/песочница
| [[{{SUBJECTPAGENAME}}/песочница|песочнице]] <small style="font-style: normal">([{{fullurl: {{SUBJECTPAGENAME}}/песочница | action=edit }} редактировать])</small>
| [[{{SUBJECTPAGENAME}}/песочница|песочнице]] <small style="font-style: normal">([{{fullurl: {{urlencode:{{SUBJECTPAGENAME}}}}/песочница | action=edit }} редактировать])</small>
| песочнице <small style="font-style: normal">([{{fullurl: {{SUBJECTPAGENAME}}/песочница | action=edit&preload={{SUBJECTPAGENAME}} }} создать])</small>
| песочнице <small style="font-style: normal">([{{fullurl: {{urlencode:{{SUBJECTPAGENAME}}}}/песочница | action=edit&preload={{urlencode:{{SUBJECTPAGENAME}}}} }} создать])</small>
}} и связанной с ней {{
}} и связанной с ней {{
#ifexist: {{SUBJECTPAGENAME}}/тесты
#ifexist: {{SUBJECTPAGENAME}}/тесты
| [[{{SUBJECTPAGENAME}}/тесты|тестовой страницей]] <small style="font-style: normal">([{{fullurl: {{SUBJECTPAGENAME}}/тесты | action=edit }} редактировать])</small>
| [[{{SUBJECTPAGENAME}}/тесты|тестовой страницей]] <small style="font-style: normal">([{{fullurl: {{urlencode:{{SUBJECTPAGENAME}}}}/тесты | action=edit }} редактировать])</small>
| тестовой страницей <small style="font-style: normal">([{{fullurl: {{SUBJECTPAGENAME}}/тесты | action=edit&preload=Шаблон:Doc/preload-тесты}} создать])</small>
| тестовой страницей <small style="font-style: normal">([{{fullurl: {{urlencode:{{SUBJECTPAGENAME}}}}/тесты | action=edit&preload=Шаблон:Doc/preload-тесты}} создать])</small>
}}.''{{doc/end}}}}</includeonly><noinclude>
}}.''{{doc/end}}}}</includeonly><noinclude>
{{doc}}
{{doc}}
<!--
<!--

Версия от 20:27, 21 декабря 2010

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

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

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

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

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

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

Документация
Во избежание поломок страниц, использующих данный шаблон, можно сначала экспериментировать в его песочнице (создать) и связанной с ней тестовой страницей (создать).