Всплывающие подсказки (тултипы)

Всплывающие подсказки позволяют давать подробное объяснение терминов и сокращений, при этом не перегружая текст излишним контентом. Кроме того, если подсказка берется из словаря определений, то это сокращает работу над составлением и согласованием текста.

Слово, у которого есть подсказка, выделено в тексте точечным подчеркиванием.

В каких случаях используется подсказка

• Аббревиатуры и сокращения. Например: ЦРПТ, НДС, РПН.
• Термины достаточно узкой специализации, которые не используются повсеместно. Даже если термин очевиден профессионалу, пользователь может быть новичком и не знать его значение. Например: обслуживающая бухгалтерия, идентификатор участника ЭДО.
• Термины, имеющие необщепринятое значение. Например: комната (в Толке), артефакты (в Толке).

Если подсказка может пригодиться в других статьях, добавьте ее в словарь определений, чтобы впоследствии использовать уже готовую словарную статью.

В каких случаях использовать подсказку запрещено

• В ссылках.
• В подписях к картинкам.
• В заголовках.

Как часто можно применять подсказку

Не нужно использовать всплывающую подсказку при каждом упоминании термина.

• Правильно

• Неправильно

Подсказка используется, если:

• Термин или сокращение используется впервые в статье.
• Термин или сокращение используется впервые в подразделе статьи. Даже если он уже расшифровывался в другом подразделе. Такое использование предусмотрено для тех, кто читает статью не сначала, а перешел сразу к интересующему подразделу.
• Если статья очень длинная и термин был подтянут только в самом ее начале, а затем используется где-то в конце, допустимо продублировать подсказку, чтобы напомнить пользователю значение термина.

Исключение: не используйте подсказку, если статья посвящена непосредственно объяснению термина. Пример такой статьи.

Правила оформления подсказки

Перед добавлением подсказки проверьте, нет ли такого термина в словаре определений («Админка» → модуль «Словарь определений»). Если есть, укажите id определения и подтяните уже готовый текст в подсказку.

Если термин состоит из двух и более слов, вешайте подсказку на все словосочетание целиком, а не на каждое слово по отдельности.

• Правильно

• Неправильно

Определение должно быть лаконичным. Если нужно сообщить много информации о термине, добавьте в подсказку ссылку на любой информационный ресурс об этом термине.

Не начинайте определение со слова «это» или с тире «—». Сразу пишите описание/расшифровку термина.

• Правильно

• Неправильно

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

Знаки препинания в конце предложений:

• Если определение состоит из одного предложения, то точка в конце не ставится.

• Если предложений несколько, то они разделяются точками, но в последнем предложении точка не ставится.

• Если в определении несколько абзацев, то точка ставится везде. Подробнее см. в статье.

Заполнение подсказки из словаря определений

Если в словаре определений («Админка» → модуль «Словарь определений») уже есть описание нужного термина, используйте его. Для этого в макросе «Слово с тултипом»:

1. Укажите id определения из словаря.
2. Если слово, на которое навешивается подсказка, отличается от словоформы, указанной в словаре, укажите нужное значение в поле «Слово».

   

Если вы нашли нужный термин в словаре определений, но его описание в вашем случае не полностью подходит или его нужно дополнить, не вносите изменения в словарную статью с определением — такое изменение повлияет на описание во всех подсказках, где оно используется. В таком случае скопируйте уже готовое определение и вставьте его в макрос подсказки по месту использования, внеся нужные изменения и дополнения.

Что проверить после добавления подсказки

После сохранения статьи с подсказкой, перейдите на страницу статьи и проверьте:

• При наведении на слово всплывает корректное определение (не от другого термина и не пустое).
• Если в определении есть ссылки на статьи, убедитесь, что это актуальные статьи. Если нет, обновите статьи или замените ссылки.
• Если слово с подсказкой расположено под картинкой, убедитесь, что появляющаяся подсказка не перекрывает важную информацию на скриншоте, о которой идет речь.

  

• Если подсказка берется из словаря определений и определение устарело, обновите его сами или обратитесь к тем, кто сможет это сделать. Перед этим обязательно убедитесь в корректности новой информации — задайте вопросы экспертам, сверьтесь с данными из знаний, нормативных документов и других достоверных источников.

Если добавляем новый термин в словарь определений

Перед добавлением нового термина убедитесь, что в словаре еще нет такого же термина с идентичным определением.

Дублировать термин допускается, только если он используется в наших статьях в разных значениях. Т. е. слово одно, а определения разные. Например: ТК — это транспортная компания, а также это может быть трудовым кодексом. В словаре определений могут присутствовать оба эти термина, и при выборе нужно будет ориентироваться на описание.

Если добавляемый термин используется и в виде полного названия, и в виде буквенной аббревиатуры, то в словарь добавляется аббревиатура. А полное название указывается в определении. Такое оформление буквенных аббревиатур позволит использовать подсказку, не изменяя каждый раз словоформу.