Шаблон:Doc/doc: различия между версиями
Andras (обсуждение | вклад) Нет описания правки |
Andras (обсуждение | вклад) Нет описания правки |
||
| (не показаны 4 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
{{ | {{Docpage}} | ||
{{ | {{Стили шаблона|Шаблон:Doc/styles.css}} | ||
Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «''Название текущей страницы''/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным). | Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «''Название текущей страницы''/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным). | ||
Проще всего вставить включение этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <code class="nowrap"><nowiki><noinclude>{{Doc}}</noinclude></nowiki></code>, '''не перенося строку''' после последней строчки кода шаблона. | Проще всего вставить включение этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <code class="nowrap"><nowiki><noinclude>{{Doc}}</noinclude></nowiki></code>, '''не перенося строку''' после последней строчки кода шаблона. | ||
Документация шаблона {{ | Документация шаблона {{T|Doc}} сформирована по тому же принципу, так что можно посмотреть код. | ||
Основная цель выноса документации на отдельную страницу — избежать [[ВП:Серверный кэш|перегенерации HTML]] для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. | Основная цель выноса документации на отдельную страницу — избежать [[ВП:Серверный кэш|перегенерации HTML]] для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще. | ||
Шаблон поддерживает необязательный параметр. При вводе {{ | Шаблон поддерживает необязательный параметр. При вводе {{Tc|Doc|''Полное название страницы''}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов. | ||
== См. также == | == См. также == | ||
* [[Проект:Технические работы/Шаблоны/Документирование|Проект по документированию шаблонов]] | * [[Проект:Технические работы/Шаблоны/Документирование|Проект по документированию шаблонов]] | ||
* Пара шаблонов {{ | * Пара шаблонов {{Tl|Doc-inline}} и {{Tl|Doc-end}} | ||
== TemplateData == | == TemplateData == | ||
Текущая версия от 22:00, 3 июня 2023
 |
 | Этот шаблон использует TemplateStyles и загружает следующие таблицы CSS-стилей:
|
Включает подстраницу с документацией для текущего шаблона. Точнее, включает страницу «Название текущей страницы/doc». Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения (хотя включение документации в обсуждение является нежелательным).
Проще всего вставить включение этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{Doc}}</noinclude>, не перенося строку после последней строчки кода шаблона.
Документация шаблона {{Doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{Doc|Полное название страницы}} вместо страницы «/doc» будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
См. также
- Проект по документированию шаблонов
- Пара шаблонов {{Doc-inline}} и {{Doc-end}}
TemplateData
Нет описания.
| Параметр | Описание | Тип | Статус | |
|---|---|---|---|---|
| 1 | 1 | без описания | Неизвестно | необязательный |
| 2 | 2 | без описания | Неизвестно | необязательный |
| 3 | 3 | без описания | Неизвестно | необязательный |
| 4 | 4 | без описания | Неизвестно | необязательный |
| 5 | 5 | без описания | Неизвестно | необязательный |
| editsection | editsection | без описания | Неизвестно | необязательный |
| SUBJECTPAGENAME | SUBJECTPAGENAME | без описания | Неизвестно | необязательный |