Перейти до вмісту
Intum — Довідковий центр

Хелплінки

Оновлення: 1 хв читання

Хелплінки - контекстна допомога в застосунку

Хелплінки поєднують елементи інтерфейсу застосунку зі статтями в базі знань. Завдяки їм користувач може побачити підказку або посилання на статтю в місці, де він саме працює.

Як це працює

  1. У коді застосунку Ви розміщуєте хелплінк із ключем (напр. tasks.create)
  2. У панелі хелплінків Ви призначаєте ключ до статті з бази знань
  3. Віджет хелплінків автоматично відображає текст або посилання на статтю

Властивості хелплінка

  • Ключ - унікальний ідентифікатор у межах бази (напр. settings.email, tasks.create)
  • Стаття - пов’язана стаття з бази знань
  • Розділ - опціональний якір до конкретного розділу статті
  • Текст - опціональний короткий HTML-текст, що відображається у віджеті
  • Активний - чи хелплінк видимий (неактивні створюються автоматично)

Автоматичне створення

Коли віджет запитує хелплінк, якого немає в базі - система автоматично створює його як неактивний. Завдяки цьому видно, які ключі використовуються в застосунку, і можна їх пізніше призначити до статей.

Статистика

Кожен хелплінк відстежує:

  • Кількість відкриттів - скільки разів віджет його завантажив
  • Кількість натискань - скільки разів користувач натиснув на посилання

Багатомовність

Віджет автоматично шукає хелплінк у відповідній мовній версії бази знань. Якщо не знайде - повертається до стандартної версії.

Тестування

З деску бази знань можна відобразити список хелплінків для тестування - перевірити, які ключі мають призначені статті.

Чи була ця інформація корисною?

Поділитися

Коментарі