Template:Doc/doc

From FragoriaWiki

(Difference between revisions)
Jump to: navigation, search
 
(2 intermediate revisions not shown)
Line 6: Line 6:
== Использование ==
== Использование ==
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код:
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код:
-
  <nowiki><noinclude>{{doc}}</noinclude></nowiki>.
+
  <nowiki><noinclude>{{doc}}</noinclude></nowiki>
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
Line 12: Line 12:
Документация шаблона {{tl|doc}} сформирована по тому же принципу, так что можно посмотреть код.
Документация шаблона {{tl|doc}} сформирована по тому же принципу, так что можно посмотреть код.
-
<includeonly>
+
<noinclude>
-
[[Категория:Шаблоны:Для шаблонов|{{PAGENAME}}]]
+
[[Категория:Шаблоны]]</noinclude>
-
</includeonly>
+

Current revision as of 05:04, 29 April 2011

Doc/doc


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

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

Использование

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

<noinclude>{{doc}}</noinclude>

Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}}

вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.

Документация шаблона {{doc}}

сформирована по тому же принципу, так что можно посмотреть код.


Категория:Шаблоны

Personal tools