Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Инструкции по интерфейсу пользователя OS X

iBook

Пользовательская помощь

OS X поддерживает две пользовательских функции справки: теги Справки и Справка Apple. Теги справки позволяют Вам обеспечивать временную контекстно-зависимую справку, тогда как Справка Apple позволяет Вам обеспечивать более полное обсуждение темы или задачи.

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

Используя Справку Apple, можно вывести на экран файлы HTML в Средстве просмотра Справки, подобное браузеру приложение, разработанное для отображения и поиска документов справки. Средство просмотра справки может также вывести на экран документы, содержащие содержание QuickTime, открыть AppleScript-based automations, получить обновленное содержание справки из Интернета и оказать контекстно-зависимую помощь.

Несмотря на то, что пользователи могут получить доступ к Справке Apple путем запуска приложения Средства просмотра Справки, они будут более обычно получать доступ к нему из приложения одним из следующих трех способов:

  • Меню справки. Меню справки является последним элементом меню приложения в строке меню (в слева направо системах, Меню справки справа). При регистрации книги справки в Средстве просмотра Справки первый элемент в Меню справки является предоставленным системой Центром внимания Для поля поиска Справки. Второй элемент в меню должен быть Справкой AppName, открывающей Help Viewer для первой страницы Вашего содержания справки. Для получения дополнительной информации о Меню справки посмотрите Меню справки.

  • Кнопки справки. Кнопка Help обеспечивает легкий доступ к определенным разделам Вашей книги справки. Когда пользователь нажимает кнопку Help в Вашем UI, Вы отправляете в Средство просмотра Справки или критерий поиска или поиск привязки.

  • От элемента контекстного меню. Если контекстуально надлежащее содержание справки доступно для объекта, пользователь Щелкнул по управлению, первый элемент в контекстном меню является Справкой. Как с кнопками Help, этот пункт меню может отправить или критерий поиска или поиск привязки для Помощи Средству просмотра.

Только выведите на экран кнопку Help в окне, когда будет контекстуально соответствующая доступная справка. Не необходимо для каждого диалогового окна и окна в Вашем приложении включать кнопку Help. Поскольку Меню справки доступно, у пользователей всегда есть другой способ получить доступ к Вашему содержанию справки. Чтобы изучить, как записать содержание Справки Apple и предоставить ему Ваше приложение, см. Руководство по программированию Справки Apple.

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

Когда пользователь позволяет указателю опираться на элемент UI в течение нескольких секунд, теги справки появляются. Когда указатель оставляет объект, тег исчезает. Если указатель не перемещен, система скрывает тег справки приблизительно после 10 секунд. Например, Средство поиска выводит на экран тег справки, описывающий поведение управления панелью инструментов Share.

image: ../Art/help_tag_2x.png

Обратите внимание на то, что теги справки выглядят подобными подсказкам расширения, но они не то же. Когда пользователи располагают указатель по усеченному тексту в таблице, схеме или ячейке представления браузера, подсказка расширения может появиться. Например, когда имя файла является слишком длинным для отображения без усечения в окне Finder, подсказка расширения выводит на экран полный текст. (Для узнавания больше о включении подсказок расширения в приложении посмотрите allowsExpansionToolTips.)

image: ../Art/expansion_tag_2x.png

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

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

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

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

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

Внимание на пользователей действия может выполнить использование управления. Хороший способ остаться фокусируемым на действии состоит в том, чтобы начать тег с глагола, например, “Восстанавливает настройки по умолчанию” или “Добавьте или удалите язык из списка”.

Используйте наименьшее количество возможных слов. Теги справки всегда включены, таким образом, важно сохранить Ваш текст тега незаметным — т.е. короткий — и полезный. Как можно больше, сохраните текст тега максимум к 60 - 75 символов. Тег должен представить только одно понятие, и то понятие должно быть непосредственно связано с интерфейсным элементом. Можно также опустить статьи для ограничения длины тега. Обратите внимание на то, что локализация может удлинить текст на 20 - 30 процентов, который является другим серьезным основанием сохранить тег коротким.

Используйте капитализацию стиля предложения. Капитализация стиля предложения имеет тенденцию казаться более дружественной и менее формальной пользователям (для узнавания больше об этом стиле капитализации, посмотрите Использование Правильный Стиль Капитализации в Метках и тексте).

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

Рассмотрите создание контекстуально чувствительных тегов справки. Можно обеспечить различный текст для различных состояний, которые может иметь управление, или можно обеспечить тот же текст для всех состояний. Когда Вы описываете то, что выполняет интерфейсный элемент, Вы помогаете пользователю понять текущее состояние управления, даже если тег не применим ко всем ситуациям.