Шаблон:Doc/Документация

Материал из Wiki.crossplatform.ru

(Различия между версиями)
Перейти к: навигация, поиск
(заметка по тэгу <nowiki>)
(в работе)
 
(3 промежуточные версии не показаны)
Строка 1: Строка 1:
-
<noinclude>{{template navigation}}</noinclude>
+
{{template navigation}}<noinclude>
 +
[[Категория:Документация к шаблонам|{{PAGENAME}}]]
 +
</noinclude>
'''Этот шаблон предназначен для документирования других шаблонов.'''<br />
'''Этот шаблон предназначен для документирования других шаблонов.'''<br />
Его '''необходимо''' использовать во всех шаблонах нашей вики!<br />
Его '''необходимо''' использовать во всех шаблонах нашей вики!<br />
Строка 14: Строка 16:
==== Заготовка документации ====
==== Заготовка документации ====
  <nowiki>
  <nowiki>
-
<noinclude>
+
<noinclude>{{template navigation}}
-
{{template navigation}}
+
[[Категория:Документация к шаблонам|{{PAGENAME}}]]
[[Категория:Документация к шаблонам|{{PAGENAME}}]]
-
</noinclude>
+
</noinclude>__NOTOC__
== Описание ==
== Описание ==
Тест документации, необходимые ссылки;
Тест документации, необходимые ссылки;
Строка 33: Строка 34:
=== Примечание ===
=== Примечание ===
Если оно необходимо<includeonly>
Если оно необходимо<includeonly>
-
<!-- категории и интервики -->
+
<!-- категории и интервики для самого шаблона-->
[[Категория:КАТЕГОРИЯ_В_КОТОРУЮ_ПОМЕЩАЕТСЯ_ШАБЛОН|{{PAGENAME}}]]
[[Категория:КАТЕГОРИЯ_В_КОТОРУЮ_ПОМЕЩАЕТСЯ_ШАБЛОН|{{PAGENAME}}]]
</includeonly></nowiki>
</includeonly></nowiki>
Строка 49: Строка 50:
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Название страницы}} вместо страницы <code>/Документация</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.<includeonly>
Шаблон поддерживает необязательный параметр. При вводе {{tlp|doc|Название страницы}} вместо страницы <code>/Документация</code> будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.<includeonly>
 +
<!-- категории и интервики -->
[[Категория:Шаблоны для шаблонов|{{PAGENAME}}]]
[[Категория:Шаблоны для шаблонов|{{PAGENAME}}]]
-
</includeonly><noinclude>[[Категория:Документация к шаблонам]]
+
</includeonly>
-
</noinclude>
+

Текущая версия на 17:03, 7 октября 2008

Шаблон:Doc · Документация · Обсуждение

Этот шаблон предназначен для документирования других шаблонов.
Его необходимо использовать во всех шаблонах нашей вики!
Он создает ссылку на подстраницу с документаций для текущего шаблона.

[править] Применение

При создании шаблона не добавляйте сам шаблон в какую либо категорию, а добавте в конец шаблона следующий текст:

<noinclude>
{{doc}}
<!-- Пожалуйста, добавляйте категории и интервики на страницу документации! --></noinclude>

Затем сохраните шаблон, вы увидите ссылку НАЗВАНИЕ СТРАНИЦЫ/Документация. Перейдите по этой ссылке и напишите документацию. Категорию в которую надо поместить сам шаблон указывают на странице документации (см. заготовку).

[править] Заготовка документации

<noinclude>{{template navigation}}
[[Категория:Документация к шаблонам|{{PAGENAME}}]]
</noinclude>__NOTOC__
== Описание ==
Тест документации, необходимые ссылки;

== Пример использования ==

=== Заготовка для копирования ===
 <nowiki>ЗДЕСЬ ПОМЕЩАЕТСЯ ПРИМЕР ЗАПОЛНЕНИЯ ШАБЛОНА</nowiki>

=== Как выглядит ===
ЗДЕСЬ ПОМЕЩАЕТСЯ ПРИМЕР ЗАПОЛНЕНИЯ ШАБЛОНА,
но уже без тэга <nowiki></nowiki>,
т.е. будет отображен результат

=== Примечание ===
Если оно необходимо<includeonly>
<!-- категории и интервики для самого шаблона-->
[[Категория:КАТЕГОРИЯ_В_КОТОРУЮ_ПОМЕЩАЕТСЯ_ШАБЛОН|{{PAGENAME}}]]
</includeonly>

Обратите внимание: открывающиеся тэги <noinclude> и <includeonly> пишутся всегда слитно с предыдущим текстом, а открывающийся тэг <nowiki> пишется с отступом от начала строки, чтобы получилась рамка без вики-форматирования.

[править] Примечание

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

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

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