Шаблон:Doc

Материал из NikiWiki
(перенаправлено с «Шаблон:Documentation»)
Перейти к:навигация, поиск
(i) Документация

Включает подстраницу с документацией для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.

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

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

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

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

См. также проект по документированию шаблонов.

ar:قالب:توثيق ba:Ҡалып:Doc bg:Шаблон:Документация ca:Plantilla:Ús de la plantilla cs:Šablona:Dokumentace da:Skabelon:Dokumentation de:Vorlage:Dokumentation dsb:Pśedłoga:Dokumentacija en:Template:Documentation et:Mall:Dokumentatsioon es:Plantilla:Documentación de plantilla eo:Ŝablono:Dok fa:الگو:توضیحات fr:Modèle:Documentation modèle gl:Modelo:Uso de marcador hsb:Předłoha:Dokumentacija hu:Sablon:Sablondokumentáció hy:Կաղապար:Փաստաթղթեր ia:Patrono:Docpatrono id:Templat:Dokumentasi it:Template:Man ja:Template:Documentation ko:틀:틀 설명문서 no:mal:Dokumentasjon nl:Sjabloon:Sjabdoc pl:Szablon:Dokumentacja pt:Predefinição:Instruções da predefinição ro:Format:Documentaţie sk:Šablóna:Dokumentácia sl:Predloga:Dokumentacija sr:Шаблон:Документација sq:Stampa:Dokumentacion stq:Foarloage:Dokumentation sv:Mall:Dokumentation tl:Suleras:Documentation tpi:Template:Template doc uk:Шаблон:Документація war:Template:Documentation zh:Template:Documentation

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