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

Документація шаблону[перегляд] [редагувати] [історія] [очистити кеш]

Опис

Цей шаблон відображає документацію шаблону чи модуля в зеленій коробці подібно до того, як ви бачите зараз, вміст якої взято з супутньої підсторінки «/документація». Крім того, він додає посилання на перегляд, редагування, історію підсторінки документації та очищення кешу сторінки.

Використання

Підсторінка документації

Документацію буде взято з підсторінки «/документація» цього ж шаблону чи модуля, якщо така існує.

[--код шаблону--]<noinclude>
{{Документація}}
<!-- Додавайте категорії на підсторінку /документація, а не сюди. Дякуємо! -->
</noinclude>

Будь-яка сторінка

Документацію буде взято з будь-якої сторінки, яку ви вкажете.

[--код шаблону--]<noinclude>
{{Документація|назва сторінки}}
<!-- Додавайте категорії на підсторінку /документація, а не сюди. Дякуємо! -->
</noinclude>

Інлайн-документація

За допомоги параметру |content або |текст можна використовувати цей шаблон для інлайн-документації — тобто не створюючи окремої підсторінки документації, а додаючи текст документації безпосередньо в шаблон. Цей варіант використовується, якщо документація дуже коротка (одне-два речення).

Інлайн-документація не має містити лише категорії та інтервікі!

Зауважте, що параметр |content не може містити таблиці {|…|}, тому за їхньої наявності варто створити повноцінну підсторінку документації або додатково скористатися шаблоном {{Wikitable}}.

[--код шаблону--]<noinclude>
{{Документація|content=текст документації}}
<!-- Додавайте категорії нижче цього рядка -->
...
</noinclude>

Приховання змісту

Зміст документації можна приховати, надавши параметру |notoc чи |без_змісту будь-яке значення, наприклад:

[--код шаблону--]<noinclude>
{{Документація|notoc=1}}
<!-- Додавайте категорії на підсторінку /документація, а не сюди. Дякуємо! -->
</noinclude>

Див. також

• {{Підсторінка документації}}