Шаблон:Doc

[просмотр] [править] [история] [обновить]

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

---

Шаблоны {{doc}} и {{docpage}} нужны для создания и использования документации шаблонов, вынесенной на подстраницу.

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

Обычно документация шаблона находится на его подстранице Документация (например, для Шаблон:Foo это Шаблон:Foo/Документация). Вместо этого в качестве документации шаблона может быть подключена документация другого шаблона (например, если иначе у двух или нескольких шаблонов были бы одинаковые подстраницы документации).

Создание документации

Создайте подстраницу документируемого шаблона, называющуюся Документация (например, для Шаблон:Foo это будет Шаблон:Foo/Документация).

В первой строчке создаваемой страницы напишите <noinclude>{{docpage|Название шаблона}}</noinclude> (вместо слов Название шаблона укажите название шаблона, подстраницу которого создаёте).

Далее (можно со следующей строки, но не оставляйте в этом месте пустую строку) опишите назначение и использование шаблона. Документация будет более наглядной, если привести примеры использования шаблона, оформленные в виде таблицы: в каждой строке таблицы в левом столбце приведён образец кода, обёрнутый в <code><nowiki> соответственно </nowiki></code>, в правом — результат работы этого кода.

В конце документации, не переводя перед этим строку, напишите:

<includeonly>
[[Категория:Шаблоны]]</includeonly>

Обратите внимание: здесь вы указываете категорию для самого́ документируемого шаблона, а не для подстраницы документации (она будет проставлена автоматически — конечно, если всё остальное вы сделаете правильно). Вы можете указать вместо категории Шаблоны одну из её подкатегорий, если считаете, что подкатегория подходит для документируемого шаблона больше.

Подключение документации

Чтобы использовать подстраницу документации самого́ документируемого шаблона, в конце его кода добавьте: <noinclude>{{doc}}</noinclude>.

Чтобы использовать подстраницу документации другого шаблона, в конце кода документируемого шаблона добавьте: <noinclude>{{doc|Другой шаблон}}</noinclude> (к примеру, если в конце кода шаблона Foo указать <noinclude>{{doc|Bar}}</noinclude>, то на странице Шаблон:Foo будет использоваться документация, находящаяся на подстранице Шаблон:Bar/Документация).

См. также

• {{doc-inline}}