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

Документация по шаблону [ просмотреть ] [ изменить ] [ история ] [ очистить ]

Этот шаблон используется примерно на 75 000 страницах, и изменения могут быть широко заметны. Протестируйте изменения на подстраницах / sandbox или / testcases шаблона или на подстранице вашего собственного пользователя . Обсудите изменения на странице обсуждения, прежде чем внедрять их. Счетчик включений обновляется автоматически ( см. Документацию ).

Этот шаблон использует Lua : Модуль: Документация ( песочница )

Этот шаблон не следует подменять .

Этот шаблон используется почти на каждой странице шаблона, чтобы содержать задокументированные инструкции и информацию этого шаблона, включая <templatedata> , либо на самой странице шаблона, либо на созданной подстранице документации.{{documentation}}

Подробные инструкции о том, как и когда использовать этот шаблон, см. В Википедии: Документация по шаблону (ярлык: WP: TDOC ).

Этот шаблон отображает зеленую рамку документации, как вы сейчас видите, и автоматически загружает контент с подстраницы / doc. Он также может загружать контент из других мест, если это будет указано.

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

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

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

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

<! - Последняя строка кода вашего шаблона -> <noinclude> {{ Documentation }} <! - Добавьте категории на подстраницу / doc и интервики в Викиданные, а не здесь! -> </noinclude>

Затем этот шаблон автоматически загружает контент с подстраницы / doc шаблона, в котором он используется.

Этот шаблон также может загружать контент с любой другой страницы. Например:

<! - Последняя строка кода вашего шаблона -> <noinclude> {{ Документация  | Шаблон : Другая  страница / документ }} </noinclude>

Обратите внимание, что при загрузке документации со страницы, отличной от подстраницы local / doc, становится сложно обрабатывать категории.

Контент также можно подавать напрямую в виде текста. Например:

<! - Последняя строка кода вашего шаблона -> <noinclude>{{Документация | содержание =<! - документация по шаблону ->
}} </noinclude>

Когда используется |content=параметр, в окне документа обычно не отображаются ссылки [редактировать] [очистить] в правом верхнем углу. Обратите внимание, что если страница / doc существует, ссылка на нее по-прежнему отображается в поле ссылки под полем документа.

Параметр |1=и |content=параметр также можно комбинировать, например:

<! - Последняя строка кода вашего шаблона -> <noinclude>{{Документация | 1 = Шаблон: любая страница / документ| содержание =<! - {{Шаблон: любая страница / документ | параметры}} ->
}} </noinclude>

Затем имя страницы, указанное в качестве параметра 1, используется для ссылок [редактировать] [очистить] и для ссылки / doc в поле ссылки под полем документа. Но параметр содержимого используется для содержимого, отображаемого в окне документа. Приведенный выше код означает, что содержимое включено как {{Template:Any page/doc|parameters}}. В этом примере параметр также передается на загружаемую страницу / doc.

Размещение и теги

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

Чтобы автоматически вставлять теги noinclude , вызов шаблона и направляющий комментарий, вы также можете использовать этот ярлык кода замены :

{{subst:doc-code}}

<! - Последняя строка кода вашего шаблона -> <noinclude>{{документация}}<! - Добавляйте категории на подстраницу / doc и интервики в Викиданные, а не здесь! -> </noinclude>

Категоризация

Если с помощью этого шаблона создается подстраница документации, то, чтобы поместить сам шаблон в категорию, добавьте [[Category:Category name]]в <includeonly>{{Sandbox other||...}}</includeonly>раздел на подстранице / doc. Например, для размещения на подстранице документации:

{{Подстраница документации}} <! - Добавьте категории, указанные внизу этой страницы, и интервики в Викиданные ->== Использование ==<includeonly> {{другая песочница ||<! - Категории под этой строкой; интервики в Викиданных ->[[Категория: Название категории]][[Категория: Название категории2]]}} </includeonly>

Если подстраница документации не была создана, а шаблон документации используется с |content=параметром на фактической странице шаблона, то, чтобы поместить сам шаблон в категорию, добавьте [[Category:Category name]]внутри шаблона документации после содержимого. Например, для размещения на актуальной странице шаблона:

<! - Последняя строка кода вашего шаблона -> <noinclude>{{Документация | содержание =<! - документация по шаблону ->[[Категория: Название категории]][[Категория: Название категории2]]}} </noinclude>

Ссылки интервики, применимые к шаблону, должны быть перечислены в Викиданных (подробнее в Википедии: Викиданные ). Для более сложных случаев см. Википедия: документация по шаблонам § Категории и межвики-ссылки .

Лучшие практики

Если страница содержит документацию <includeonly>или <noinclude>тегов, как часть видимого текста документации, замените « <» с « <» или использовать шаблон: тег .

Заголовок

Находясь в пространстве имен Template, этот шаблон показывает этот заголовок:

Документация по шаблону

В большинстве других пространств имен, таких как «Википедия:», отображается такой заголовок:

Документация

Но когда на страницах File (image) отображается такой заголовок:

Резюме

Параметр заголовка можно использовать для установки другого заголовка. Например:

{{Documentation |heading=Infobox documentation}}

Если параметр заголовка пуст, но определен, заголовок не отображается и не отображаются ссылки [редактировать] [очистить]. Например:

{{Documentation |heading=}}

Параметр стиля заголовка может содержать необязательные значения CSS . Без кавычек, " "но с точкой с запятой в конце ;. Например:

heading-style=font-size:150%;color:red;

Поле ссылки

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

Чтобы скрыть поле ссылки, добавьте параметр |link box=off.

Вы также можете вставить собственный текст в поле ссылки, установив |link box=параметр. Например:

| link box = Эта документация автоматически создается Template: Country showdata

Автоматические функции

Если страница документации не существует, ссылка [создать] включает страницу предварительной загрузки, поэтому при нажатии на нее форма редактирования будет предварительно заполнена базовым форматом страницы документации. Текст предварительной загрузки также используется для ссылок / sandbox и / testcases [create].

Когда этот шаблон находится на защищенной странице шаблона, он теперь автоматически добавляет {{ pp-template }}, который показывает серый или красный замок в правом верхнем углу. Поэтому нет необходимости вручную добавлять {{pp-template}} в шаблоны, использующие {{ Documentation }}.

Когда этот шаблон находится на подстранице / sandbox, он автоматически добавляет {{ Template sandbox notice }}.

Пространства имен субъектов против пространств имен talk

Терминология: пространства имен Subject противоположны пространствам имен talk . Например, «Шаблон:» - это тема «Обсуждение шаблона:».

Этот шаблон обычно помещается в пространство имен объекта внутри <noinclude>тегов. Но в некоторых случаях этот шаблон должен быть на странице обсуждения:

• В пространстве имен Mediawiki, поскольку <noinclude>часто не работает в системных сообщениях, и поскольку пространство имен Mediawiki необходимо содержать в чистоте по соображениям производительности.

При размещении на страницах обсуждения этот шаблон обычно размещается в верхней части страницы и без <noinclude>...</noinclude>тегов.

Страницы / doc, / sandbox и / testcases обычно должны находиться в пространстве имен субъекта, за исключением пространств имен, в которых не включена функция подстраницы MediaWiki : Main, File и Mediawiki. (Категории могут иметь подстраницы, но документация создается в пространстве имен Category talk для предотвращения создания пустых категорий.) (Но в настоящее время мы показываем только ссылки / sandbox и / testcases из пространств имен User, User talk, Template и Template talk.) Есть а также целый ряд других технических причин, по которым страница / doc должна храниться под страницей обсуждения для этих (но только этих) пространств имен.

Этот шаблон автоматически указывает свои ссылки [create] для / doc, / sandbox и / testcases на правильное пространство имен.

Тестирование

Вы можете смоделировать вывод для данной страницы с помощью |page=параметра. Например, если вы используете код |page=Template:Edit protected, шаблон будет вести себя точно так же, как если бы он был на странице Template: Edit protected , включая отображение документации из Template: Edit protected / doc , ссылки на Template: Edit protected / sandbox и т. Д. Параметр полезен для тестирования и широко используется на странице тестовых примеров модуля .

Технические детали

Страница предварительной загрузки для ссылки / doc [create] - это Template: Documentation / preload . Страницы предварительной загрузки для ссылок / sandbox и / testcases [create]: Template: Documentation / preload-sandbox и Template: Documentation / preload-testcases . Страница предварительной загрузки для ссылки / sandbox [mirror] - это Template: Documentation / mirror .

Для получения дополнительной информации см. Страницу обсуждения .

Полный синтаксис

{{Документация}}или же{{Документация | содержание =}}или же{{Документация| [путь к странице документации]| заголовок-стиль =| заголовок =| поле ссылки =}}

Смотрите также

• {{ Подстраница документации }}, примечание, размещенное в верхней части подстраницы / doc, объясняющее его роль и содержащее ссылку на страницу, которую он документирует.
• {{ Документация Barnstar }}, вариант {{ Документация }} для использования с шаблонами Barnstar .
• {{ Documentation / color scheme }} представляет цветовую схему, используемую в {{ Documentation }}.
• Википедия: Документация по шаблонам - это руководство по документации по шаблонам.
• Википедия: песочница и тестовые примеры шаблонов объясняют использование подстраниц / sandbox и / testcases и включают дополнительную информацию о тестировании шаблонов.