Difference between revisions of "Template:Doc"

From Wiki
Jump to navigationJump to search
(изменение шаблона)
(Основной текст)
Line 1: Line 1:
<noinclude>{{docpage}}</noinclude>
+
<includeonly>{{doc/begin|{{SUBJECTSPACE}}:{{PAGENAME:{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|notoc={{{notoc|}}}}}
 
+
{{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}}|{{#ifexist:{{SUBJECTSPACE}}:{{{1}}}|{{{{{1}}}}}|{{Документируйте|{{{1|{{SUBJECTPAGENAME}}/doc}}}}}}}}}
{| style="border-spacing:0;" width="100%"
+
{{doc/end}}</includeonly><noinclude>
! style="border-bottom: 1px dotted rgb(153, 153, 153);border-right: 1px dotted rgb(153, 153, 153)" width="50%"| <center>RUS</center>
+
{{doc}}
! style="border-bottom: 1px dotted rgb(153, 153, 153);border-left:  1px dotted rgb(153, 153, 153)" width="50%"| <center>ENG</center>
 
 
 
|-
 
| style="border-right: 1px dotted rgb(153, 153, 153);"| Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон <code style="white-space:nowrap"><span style="opacity:0.5">название страницы</span>/doc</code>. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
 
 
 
| style="border-left:  1px dotted rgb(153, 153, 153);"|
 
 
 
|-
 
| style="border-right: 1px dotted rgb(153, 153, 153);"|Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <code style="white-space:nowrap"><nowiki>&lt;noinclude&gt;{{doc}}&lt;/noinclude&gt;</nowiki></code>.
 
 
 
| 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:44, 29 August 2010

Документация Документация    —    Documentation
РУС ENG
'

Предназначение    —    Mission

Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным. Includes sub with the documentation for the current template. Specifically, the template includes the page title/doc. Works well in the discussion template that is comprised of one and the same page as a template, and from its discussion. Yet the inclusion of documentation in the discussion is undesirable.


'

Параметры    —    Parameters

Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. Template supports an optional parameter. If you enter {{doc|Full page name}} instead of the page /doc will be included either a necessary one. This is useful for creating a common document for similar patterns.


'

Инструкция по использованию    —    Operation manual

Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>. The easiest way to insert a call to this template, and then click on a link and create or copy the documents. Simply add the code <noinclude>{{doc}}</noinclude>.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код. Documentation template {{doc}} is formed on the same principle, so that you can see the code.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. The main purpose of removal of documentation on a separate page - to avoid regeneration HTML for all pages using the template, when editing its documentation. Also, it reduces the page template itself, which makes editing easier.


'

Шаблон основан на следующих шаблонах    —    Parent templates

<Перечень родительских шаблонов / List of parenting templates> <List of parenting templates>


'

Дочерние шаблоны    —    Subsidiaries templates

<Перечень дочерних шаблонов / List of subsidiaries templates> <List of subsidiaries templates>


'

Пример    —    Example

Шаблон    —    template Результат    —    result
{{doc}}