Difference between revisions of "Template:Doc"

From Wiki
Jump to navigationJump to search
(ю)
 
(изменение шаблона)
Line 1: Line 1:
<noinclude>{{docpage}}</noinclude>Полный алфавитный индекс для категорий. Должен использоваться только в пространстве категорий (для статей можно применять {{tl|АБВ}}).
+
<noinclude>{{docpage}}</noinclude>
  
Дополнительный параметр '''префикс'''. Используется в тех случаях, когда название всех статей, входящих в категорию, начинаются с одинакового текста, например «'''Файл:'''». Пример использования: [[:Категория:Изображения:Переданные в общественное достояние участниками Википедии]].
+
{| style="border-spacing:0;" width="100%"
 +
! style="border-bottom: 1px dotted rgb(153, 153, 153);border-right: 1px dotted rgb(153, 153, 153)" width="50%"| <center>RUS</center>
 +
! style="border-bottom: 1px dotted rgb(153, 153, 153);border-left: 1px dotted rgb(153, 153, 153)" width="50%"| <center>ENG</center>
  
Для использования шаблона поместите <code><nowiki>{{Индекс категории}}</nowiki></code> или <code><nowiki>{{Индекс категории|префикс = значение префикса}}</nowiki></code> (примеры значения префикса: <code>Файл:</code>, <code>Шаблон:</code>) на страницу категории.
+
|-
 +
| style="border-right: 1px dotted rgb(153, 153, 153);"| Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон <code style="white-space:nowrap"><span style="opacity:0.5">название страницы</span>/doc</code>. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
  
<includeonly>
+
| style="border-left: 1px dotted rgb(153, 153, 153);"|
[[Категория:Википедия:Шаблоны:Алфавитные индексы|{{PAGENAME}}]]
 
[[Категория:Шаблоны:Для категорий|{{PAGENAME}}]]
 
[[Категория:Википедия:TOC Шаблоны|{{PAGENAME}}]]
 
  
== См. также ==
+
|-
* [[Шаблон:Индекс категории АБВ (удобный)]]
+
| style="border-right: 1px dotted rgb(153, 153, 153);"|Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <code style="white-space:nowrap"><nowiki>&lt;noinclude&gt;{{doc}}&lt;/noinclude&gt;</nowiki></code>.
</includeonly>
+
 
 +
| style="border-left:  1px dotted rgb(153, 153, 153);"|
 +
|-
 +
| style="border-right: 1px dotted rgb(153, 153, 153);"|Документация шаблона {{tl|doc}} сформирована по тому же принципу, так что можно посмотреть код.
 +
| style="border-left:  1px dotted rgb(153, 153, 153);"|
 +
|-
 +
| style="border-right: 1px dotted rgb(153, 153, 153);"|Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
 +
 
 +
| style="border-left: 1px dotted rgb(153, 153, 153);"|
 +
|-
 +
| style="border-right: 1px dotted rgb(153, 153, 153);"|Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Полное название страницы}} вместо страницы <code>/doc</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
 +
 
 +
| style="border-left:  1px dotted rgb(153, 153, 153);"|
 +
 
 +
|}

Revision as of 14:28, 29 August 2010


RUS
ENG
Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.