Шаблон {{documentation}}используется для хранения документированной информации и инструкций определенного шаблона, обычно из подстраницы /doc. Он также может быть настроен для загрузки контента с других страниц или напрямую подаваться текстом.
Подробные инструкции о том, как и когда использовать этот шаблон, см. в Wikipedia:Template documentation (сокращение: WP:TDOC ).
Этот шаблон состоит из двух частей: большого «блока документации» с документацией внутри и панелью инструментов (ссылки [view][edit][history][purge]) и меньшего «блока ссылок», в котором отображаются метаданные о документации вместе со ссылками на песочницу и тестовые случаи .
Использование этого шаблона позволяет защищать шаблоны там , где это необходимо, и в то же время разрешать любому пользователю редактировать документацию и категории.
Обычно шаблон используется без параметров и размещается внутри <noinclude>...</noinclude>внизу страницы шаблона (для получения дополнительной информации см. § Размещение и теги):
<!--Последняя строка кода вашего шаблона--> < noinclude > {{ Documentation }} <!-- Добавьте категории на подстраницу /doc --> </ noinclude >Чтобы включить другую страницу, отличную от подстраницы /doc, просто укажите |1=следующее:
<!--Последняя строка кода вашего шаблона--> < noinclude > {{ Documentation | Template:Other page/doc }} </ noinclude >Обратите внимание, что при загрузке документации со страницы, отличной от локальной подстраницы /doc, становится сложно обрабатывать категории.
Документацию также можно передать напрямую в виде текста, используя |content=параметр:
<!--Последняя строка кода вашего шаблона--> < noinclude > {{ Documentation | content = <!-- template documentation --> }}</ noinclude >При использовании этого параметра панель инструментов не будет отображаться. Обратите внимание, что подстраница /doc в поле ссылки все равно будет отображаться, если она существует.
Также обратите внимание, что если указано |1=and , оно имеет приоритет и всегда отображается в поле документации.|content=|content=
Заголовок в поле документации меняется в зависимости от пространства имен. Ниже приведен список текста по умолчанию в каждом пространстве имен:
.svg/1280px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
Шаблон документации Документация модуляЧтобы настроить заголовок, просто задайте параметру |heading=любое желаемое значение, например |heading=Infobox documentation.
Обратите внимание: если параметр заголовка пуст, но определен (например, |heading=), заголовок рядом с панелью инструментов отображаться не будет.
Параметру |heading-style=можно передать необязательные значения CSS|heading-style=font-size:150%;color:red; , например . Не то чтобы вам следовало опускать кавычки " "и добавлять точку с запятой в конце ;.
Чтобы настроить поле ссылки, установите |link box=что-то другое, например .|link box=The above documentation is automatically generated from Template:Foo
Чтобы скрыть поле ссылки, просто установите |link box=значение off.
Вы можете имитировать вывод для данной страницы, используя |page=параметр. Например, если вы используете код |page=Template:Edit protected, шаблон будет вести себя точно так же, как если бы он был на странице Template:Edit protected , включая отображение документации из Template:Edit protected/doc , ссылку на Template:Edit protected/sandbox и т. д. Этот параметр полезен для тестирования и широко используется на странице тестовых случаев модуля .
Этот код следует добавить в конец страницы кода шаблона, без пробела перед ним <noinclude>(что приводит к появлению дополнительных пробелов на страницах, где включен шаблон):
<!--Последняя строка кода вашего шаблона--> < noinclude > {{ documentation }} <!-- Добавьте категории на подстраницу /doc --> </ noinclude >Чтобы автоматически вставить указанный выше текст, вы также можете использовать быструю клавишу подстановочного кода .{{subst:doc-code}}
В зависимости от того, где находится документация, может быть сложно обрабатывать категории и интервики. См. Wikipedia:Template documentation § Categories and interwiki links для получения информации об их добавлении.
Если страница документации не существует, панель инструментов заменяется ссылкой [create][purge]. [create]Ссылка автоматически создает страницу с предварительно загруженным текстом с базовым синтаксисом документации. Предварительно загруженный текст также используется для ссылок /sandbox и /testcases [create].
Страница предварительной загрузки для [create]ссылки /doc — Template:Documentation/preload . Страницы предварительной загрузки для ссылок /sandbox и /testcases — Template:Documentation/preload-sandbox и Template:Documentation/preload-testcases . Страница предварительной загрузки для [mirror]ссылки /sandbox — Template:Documentation/mirror .
Этот шаблон также автоматически добавляет {{ pp-template }} на защищенную страницу шаблона. Когда этот шаблон находится на подстранице /sandbox, он также добавляет шаблон {{ Template sandbox notification }} .
В зависимости от пространства имен, поле ссылки может иметь меньше функций или вообще не отображаться. Следующая таблица показывает это:
При этом, если указано |1=или |content=, текст «Добавить категории на подстраницу /doc» отображаться не будет.
Этот шаблон обычно размещается в пространстве имен темы . Но в некоторых случаях этот шаблон должен быть в пространстве имен Talk :
<noinclude>часто не работает в системных сообщениях, а пространство имен MediaWiki необходимо поддерживать в чистоте по соображениям производительности.При размещении на страницах обсуждений этот шаблон обычно размещается в верхней части страницы и без <noinclude>...</noinclude>тегов.
Страницы /doc, /sandbox и /testcases обычно должны находиться в пространстве имен субъекта, за исключением пространств имен, в которых не включена функция подстраниц MediaWiki: Main, File и MediaWiki. (Категории могут иметь подстраницы, но документация создается в пространстве имен обсуждения категории, чтобы предотвратить создание пустых категорий. Существует также целый ряд других технических причин, по которым страница /doc должна храниться под страницей обсуждения для этих (но только этих) пространств имен.
Этот шаблон автоматически направляет свои ссылки [create] для /doc, /sandbox и /testcases на правильное пространство имен.
{{ Документация }}или{{ Документация | [путь к странице документации] }}{{ Документация | содержание = }}или{{ Документация | [путь к странице документации] | стиль заголовка = | заголовок = | поле ссылки = }}или{{ Документация | [путь к странице документации] | содержимое = | стиль заголовка = | заголовок = | поле ссылки = | страница = }}