Шаблон:Doc/Документация: различия между версиями
м (оформление, категоризация) |
(документация существенно доработана [почти написана с нуля]) |
||
| Строка 1: | Строка 1: | ||
<noinclude>{{docpage|Doc}}</noinclude> | <noinclude>{{docpage|Doc}}</noinclude> | ||
Шаблоны {{tl|doc}} и {{tl|docpage}} нужны для создания и использования документации шаблонов, вынесенной на подстраницу. | |||
== Использование == | |||
Обычно документация шаблона находится на его подстранице ''Документация'' (например, для <code>Шаблон:Foo</code> это <code>Шаблон:Foo/Документация</code>). Вместо этого в качестве документации шаблона может быть подключена документация другого шаблона (например, если иначе у двух или нескольких шаблонов были бы одинаковые подстраницы документации). | |||
=== Создание документации === | |||
Создайте подстраницу документируемого шаблона, называющуюся ''Документация'' (например, для <code>Шаблон:Foo</code> это будет <code>Шаблон:Foo/Документация</code>). | |||
В первой строчке создаваемой страницы напишите <code style="white-space: nowrap;"><noinclude>{{docpage|''Название шаблона''}}</noinclude></code> (вместо слов ''Название шаблона'' укажите название шаблона, подстраницу которого создаёте). | |||
Далее (можно со следующей строки, но не оставляйте в этом месте пустую строку) опишите назначение и использование шаблона. Документация будет более наглядной, если привести примеры использования шаблона, оформленные в виде таблицы: в каждой строке таблицы в левом столбце приведён образец кода, обёрнутый в <code><code><nowiki></code> соответственно <code></nowiki></code></code>, в правом — результат работы этого кода. | |||
В конце документации, не переводя перед этим строку, напишите: | |||
<pre style="width: 24em;"><includeonly> | |||
[[Категория:Шаблоны]]</includeonly></pre> | |||
Обратите внимание: здесь вы указываете категорию для самого́ документируемого шаблона, а не для подстраницы документации (она будет проставлена автоматически — конечно, если всё остальное вы сделаете правильно). Вы можете указать вместо категории {{cl|Шаблоны}} одну из её подкатегорий, если считаете, что подкатегория подходит для документируемого шаблона больше. | |||
=== Подключение документации === | |||
Чтобы использовать подстраницу документации самого́ документируемого шаблона, в конце его кода добавьте: <code style="white-space: nowrap;"><noinclude>{{doc}}</noinclude></code>. | |||
Чтобы использовать подстраницу документации другого шаблона, в конце кода документируемого шаблона добавьте: <code style="white-space: nowrap;"><noinclude>{{doc|''Другой шаблон''}}</noinclude></code> (к примеру, если в конце кода шаблона <code>Foo</code> указать <code><noinclude>{{doc|Bar}}</noinclude></code>, то на странице <code>Шаблон:Foo</code> будет использоваться документация, находящаяся на подстранице <code>Шаблон:Bar/Документация</code>). | |||
== См. также == | |||
* {{tl|doc-inline}}<includeonly> | |||
[[Категория:Шаблоны для шаблонов]]</includeonly> | [[Категория:Шаблоны для шаблонов]]</includeonly> | ||
Текущая версия на 18:58, 24 ноября 2020
Шаблоны {{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}}
