Шаблон:Doc/doc
Материал из FragoriaWiki
Эйфария (Обсуждение | вклад) (Новая страница: «<noinclude>{{docpage}}</noinclude> Включает подстраницу с документаций для текущего шаблона. Точнее, вклю…») |
Ваан (Обсуждение | вклад) |
||
| (6 промежуточных версий не показаны.) | |||
| Строка 1: | Строка 1: | ||
| - | <noinclude>{{docpage}}</noinclude> | + | <noinclude>{{docpage|Doc}}</noinclude> |
Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон <code style="white-space:nowrap"><span style="opacity:0.5">название страницы</span>/doc</code>. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным. | Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон <code style="white-space:nowrap"><span style="opacity:0.5">название страницы</span>/doc</code>. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным. | ||
| - | + | Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. | |
| - | + | == Использование == | |
| - | + | Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код: | |
| - | + | <nowiki><noinclude>{{doc}}</noinclude></nowiki> | |
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. | Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. | ||
| - | + | Документация шаблона {{tl|doc}} сформирована по тому же принципу, так что можно посмотреть код. | |
| - | < | + | <noinclude> |
| - | [[Категория | + | [[Категория:Шаблоны]]</noinclude> |
| - | </ | + | |
Текущая версия на 05:04, 29 апреля 2011
Шаблон:Doc · Документация · Обсуждение · Где используется
Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Использование
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код:
<noinclude>{{doc}}</noinclude>
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}}
вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
Документация шаблона {{doc}}
сформирована по тому же принципу, так что можно посмотреть код.
