Шаблон:Comment/doc

Версия 15:55, 17 февраля 2015

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

Этот служебный шаблон предоставляет навигацию для документации шаблона при использовании {{doc}}. Его вставляют на подстраницу ./doc в виде

<noinclude>{{docpage}}</noinclude>

Увидеть, как он выглядит, можно при просмотре документации этого шаблона.

Также этот шаблон автоматически помещает документацию в соответствующую категорию. Шаблон выделяет текст подчёркиванием и добавляет к нему всплывающую подсказку.

Использование: {{comment|текст|подсказка}}, например: {{comment|КБ|Класс Брони}}  →  КБ

Возможно использование с указанием вики-ссылки: {{comment|текст|подсказка|ссылка на статью}}, например: {{comment|КБ|Класс Брони|Класс Брони}}  →  КБ

Технические ограничения:

• В тексте подсказки не должно быть знака машинописных кавычек " (типографские кавычки «» допустимы). При необходимости вместо них пишите ".
• Если в параметрах шаблона есть знак =, то, как и в любом другом шаблоне, приходится использовать явные номера параметров: {{comment|1=текст|2=подсказка}}.
• В некоторых браузерах длина всплывающей подсказки ограничена. Например, в браузере Mozilla Firefox до третьей версии подсказки были однострочными.
• Пользователи смартфонов и планшетных компьютеров, как правило, не имеют возможности увидеть всплывающую подсказку, поэтому используйте данный шаблон только там, где это действительно необходимо.

Параметры шаблона

<TemplateData> {

       "description": "Шаблон выделяет текст подчёркиванием и добавляет к нему всплывающую подсказку. См. https://ru.wikipedia.org/wiki/Шаблон:Comment",
       "params": {
               "1": {
                       "label": "текст",
                       "description": "видимый текст",
                       "type": "string",
                       "required": false
               },
               "2": {
                       "label": "подсказка",
                       "description": "В тексте подсказки не должно быть знака машинописных кавычек (типографские кавычки «» допустимы). При необходимости вместо них пишите ".",
                       "type": "string",
                       "required": false
               },
               "3": {
                       "label": "ссылка",
                       "description": "ссылка на статью",
                       "type": "string",
                       "required": false
               }
       }

} </TemplateData>

См. также

• {{abbr}} — расширенная версия этого шаблона
• {{Comments}} — упрощённая версия этого шаблона (без изменения вида курсора)