Этот шаблон отображает сообщение о том, что текущая страница является подстраницей документации.
{{Documentation subpage}}
{{Documentation subpage|[[Page where the documentation is transcluded]]}}
Чтобы настроить этот шаблон на использование «userbox» и «userbox page» вместо «template» и «template page» или «user template» и «user template page», используйте:
{{Userbox documentation subpage}}
{{Userbox documentation subpage|[[userbox page]]}}
Параметры |text1=
и |text2=
могут использоваться для установки текста первой и второй строк шаблона соответственно. Если задан text1 , но не text2 , текст обеих строк будет получен из text1 :
{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}
{{Documentation subpage |text2='''''text2 appears here'''''}}
{{Documentation subpage |text1='''''text1 appears here'''''}}
|inhibit=yes
не позволит этому шаблону генерировать какие-либо категории. (По умолчанию добавляются « Страницы документации пространства имен » (обычно Категория:Страницы документации шаблона ) или подстраницы Категория:Документация без соответствующих страниц, если главная страница не существует.)
Этот шаблон обычно следует размещать в верхней части страниц /doc. Он изменяет вывод в зависимости от того, где он просматривается:
{{Documentation}}
Этот шаблон автоматически отображается на подстраницах /doc в пространстве имен модуля . Это делается автоматически через MediaWiki:Scribunto-doc-page-header . Это не добавляет страницу документа в страницы документации Category:Module , поэтому некоторые страницы документации модуля включают шаблон вручную или добавляют категорию напрямую, чтобы исправить это.
В дополнение к своему сообщению, шаблон добавляет страницы в Category:Template documentation pages , Category:User documentation pages или аналогичные (названные в честь предметного пространства), но только для страниц документации в пространствах имен с функцией подстраницы. По умолчанию он устанавливает ключ сортировки на имя страницы без пространства имен: Template:Foo, например, будет отсортирован как "Foo", т. е. под "F".