|
|
| Строка 1: |
Строка 1: |
| − | <noinclude>{{docpage}}</noinclude>Шаблон выделяет текст подчёркиванием и добавляет к нему [[Подсказка#Подсказка в компьютерных интерфейсах|всплывающую подсказку]]. | + | <includeonly>{{#if:{{{2|}}}|<span title="{{{2}}}" style="border-bottom: 1px dotted; cursor: help; white-space: nowrap">{{#if:{{{3|}}}|[[{{{3}}}|{{{1}}}]]|{{{1}}}}}</span>|{{{1}}}}}</includeonly><noinclude> |
| − | | + | {{doc}} |
| − | Использование: <tt style="border:1px dotted gray; padding:2px 5px 2px 5px"><nowiki>{{comment|текст|подсказка}}</nowiki></tt>,
| + | </noinclude> |
| − | например: <code><nowiki>{{comment|РФ|Российская Федерация}}</nowiki></code> → {{comment|РФ|Российская Федерация}}
| + | |
| − | | + | |
| − | Возможно использование с указанием вики-ссылки: <tt style="border:1px dotted gray; padding:2px 5px 2px 5px"><nowiki>{{comment|текст|подсказка|ссылка на статью}}</nowiki></tt>,
| + | |
| − | например: <code><nowiki>{{comment|РФ|Российская Федерация|Россия}}</nowiki></code> → {{comment|РФ|Российская Федерация|Россия}}
| + | |
| − | | + | |
| − | '''Технические ограничения:'''
| + | |
| − | * В тексте подсказки не должно быть знака машинописных кавычек <code style="border:1px dotted gray; padding:1px">"</code> (типографские кавычки <code style="border:1px dotted gray; padding:1px">«»</code> допустимы). При необходимости вместо них пишите {{comment|<code>&quot;</code>|ссылка на символ "}}.
| + | |
| − | * Если в параметрах шаблона есть знак <code style="border:1px dotted gray; padding:1px">=</code>, то, как и в любом другом шаблоне, приходится использовать явные номера параметров: <tt style="white-space:nowrap"><nowiki>{{comment|1=текст|2=подсказка}}</nowiki></tt>.
| + | |
| − | * В некоторых браузерах длина всплывающей подсказки ограничена. Например, в браузере 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> | + | |
| − | | + | |
| − | == См. также ==
| + | |
| − | * {{tl|abbr}} — расширенная версия этого шаблона
| + | |
| − | * {{tl|Comments}} — упрощённая версия этого шаблона (без изменения вида курсора)
| + | |
| − | <includeonly> | + | |
| − | {{сортировка}} | + | |
| − | | + | |
| − | [[Категория:Шаблоны:Форматирование]]
| + | |
| − | [[Категория:Википедия:Шаблоны частичного сокрытия реплик или текста]]
| + | |
| − | | + | |
| − | [[be-x-old:Шаблён:Падказка]]
| + | |
| − | [[uk:Шаблон:Comment]]
| + | |
| − | [[uz:Andoza:Comment]]
| + | |
| − | </includeonly> | + | |
Текущая версия на 10:14, 24 июля 2014
Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон название страницы/doc. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код <noinclude>{{doc}}</noinclude>.
Документация шаблона {{doc}} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе {{doc|Полное название страницы}} вместо страницы /doc будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
См. также Википедия:Проект:Документирование шаблонов|проект по документированию шаблонов.
Категория:Википедия:Шаблоны для документирования шаблонов|Comment
