Окно средства просмотра справки

Пользователи обычно запускают Средство просмотра Справки путем выбора элемента справки приложения из Меню справки, или путем ввода запроса в текстовом поле Spotlight For Help в Меню справки (см., Как Пользователи Получают доступ Справке). Когда Средство просмотра Справки запускается, оно переводит справку отображения окна в рабочее состояние для приложения, со стороны которого пользователь запросил помощь. На рисунке 1-1 окно Help Viewer выводит на экран системную книгу справки, Справку Mac.

Существует четыре элемента пользовательского интерфейса на панели инструментов наверху окна Help Viewer: кнопки Back и Forward, кнопка «Домой», кнопка Меню действий и поле поиска. Кнопки Back и Forward на левой стороне панели инструментов позволяют пользователям просмотреть свою историю навигации и перейти через ранее посещаемые страницы справки. Нажатие кнопки «Домой» открывает титульный лист в настоящее время открытой книги справки; если пользователь нажимает эту кнопку, меню всех доступных книг справки появляется. Меню действий обеспечивает элементы те, которые Делают текст Больше (или меньший), Находят (который находит текстовые строки на текущей странице), и Печать. Поле поиска позволяет пользователям искать всю справку в текущей книге или всю справку в системе — они щелкают по лупе слева от поля поиска для выбора который. Меню лупы также позволяет пользователю выбирать, включать ли поиски поддержки продукта — т.е. результаты поиска от Базы знаний Apple поддерживают веб-сайт или от Вашего собственного сайта поддержки.

Поиск в средстве просмотра справки

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

Поле ввода текста в правой стороне панели инструментов окна Help Viewer позволяет пользователям искать доступное содержание справки в системе. Пользователи вводят срок или понятие, для которого они хотят получить справку в текстовое поле. Рисунок 1-2 показывает запрос, вводимый в текстовое поле окна Help Viewer с Поиском Вся выбранная Справка.

Когда пользователь нажимает Return, Help Viewer ищет книги справки, установленные в системе (если пользователь выбрал Search All Help), или в выбранной книге справки (если они выбрали ту опцию) для соответствующего срока или условий. Это возвращает до 15 тем справки и до 7 статей поддержки (если пользователь выбрал ту опцию) от веб-сайта AppleCare или от Вашего сайта поддержки (если Вы установили поиск сайта поддержки — посмотрите Обеспечение Ваших Собственных Онлайновых Статей Поддержки). Рисунок 1-3 показывает результаты поиска, возвращенные Средством просмотра Справки в ответ на запрос, вводимый в рисунок 1-2. Средство просмотра справки сортирует темы справки в порядке уместности (как определено Поисковым Набором). Статьи поддержки перечислены в алфавитном порядке заголовком.

Средство просмотра справки выводит на экран заголовок каждой соответствующей темы справки в таблице результатов поиска, вместе с книгой справки, в которой та тема найдена (если пользователь выбрал Search All Help). Когда пользователь перемещает их курсор через тему от результатов поиска, краткий обзор темы справки появляется при наличии. Пользователь может просмотреть выбранную тему путем щелчка по теме в таблице результатов поиска. Рисунок 1-4 показывает, что краткий обзор для темы справки возвратился как результат поиска для запроса, вводимого в рисунок 1-2. Для получения информации о том, как обеспечить краткие обзоры для тем справки, см. Добавляющие Краткие обзоры.

Чтобы гарантировать, чтобы определенные запросы возвратили наиболее релевантные результаты независимо от возникновения критерия поиска в тексте, можно обеспечить список критериев поиска и соответствующих результатов поиска, которые будут выведены на экран. Это упоминается как поиск точного совпадения. Можно использовать список поиска точного совпадения, например, для обеспечения ответов на критерии поиска, слишком короткие, чтобы обычно использоваться в поиске (таком как «CD»), удостовериться, что определенная тема справки включена в ответы, когда, вероятно, будет больше чем 15 соответствий к запросу, или удостоверяться, что наиболее релевантные результаты получают самую высокую оценку уместности независимо от алгоритма, используемого для ранжирования результатов. Поиски точного совпадения описаны более подробно в Установке Поиска Точного совпадения.

Перекрестные ссылки и индексные списки

Существует Apple Специфичный для справки URLs, который можно использовать для создания ссылок к страницам справки в книге справки. Можно создать отдельные ссылки к определенным расположениям в книге, и можно генерировать списки ссылок для использования для индексных страниц, или для “см. также” списки в конце тем справки. Посмотрите Справку Apple URLs для списка этого URLs и перекрестных ссылок на их описания в этом документе.

Меню библиотеки

Списки меню Библиотеки вся справка в настоящее время бронируют регистрируемый в системе пользователя. Когда приложение вызывает, книга справки регистрируется AHRegisterHelpBook если книга справки перечислена в приложении, функция во время приложения запускается или ( Info.plist файл), когда пользователь выбирает справку приложения из Меню справки или из кнопки справки. Методы NSHelpManager (см. Ссылку класса NSHelpManager) также вызывают AHRegisterHelpBook функция для Вас автоматически. Для приложений Какао NSHelpManager является предпочтительным способом загрузить книги справки и отдельные страницы справки.

С меню Library пользователи могут легко получить доступ и просмотреть всю справку, доступную им. К меню Library получают доступ путем нажатия кнопки «Домой», как показано на рисунке 1-5.

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

Меню справки

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

Рисунок 1-6 показывает Меню справки в Почте.

Меню справки предоставляется системой. При регистрации книги справки система не только создает Меню справки, это также добавляет элемент меню справки приложения и открывает Help Viewer для домашней страницы зарегистрированной книги справки приложения, когда пользователь выбирает справку приложения. В OS X v10.5 и позже, пользователь может также использовать Центр внимания Для поля поиска Справки для поиска содержания книги справки. Когда они делают так и выбирают один из возвращенных поисковых элементов, система открывает надлежащую страницу в Вашем файле справки.

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

Кнопки справки

Кнопка справки является маленькой круглой кнопкой, выводящей на экран стандартный значок справки — вопросительный знак. Эта кнопка доступна в Интерфейсном Разработчике.

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

Рисунок 1-7 показывает типичную кнопку справки в нижнем правом углу Почтового предпочтительного окна.

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

Когда пользователь нажимает кнопку справки, Ваше приложение должно загрузить соответствующую тему справки в Средстве просмотра Справки, с помощью метода NSHelpManager openHelpAnchor:inBook: или, для приложений C, функции Справки Apple AHLookupAnchor. Посмотрите Прикладной программный интерфейс Справки Apple для получения дополнительной информации об использовании этих вызовов API.

Специфичные для справки метатеги

Средство просмотра справки распознает ряд свойств для стандартного HTML meta элемент, который можно использовать, чтобы управлять, как книга справки появляется в меню Library и в результатах поиска. Можно также использовать эти метатеги, чтобы управлять, как индексируется справка. Авторская Справка Apple описывает многие из этих метатегов и как можно использовать их. Для полного списка специфичных для справки метаданных, распознанных Средством просмотра Справки, посмотрите Таблицу a-1.

Справка URLs

Существует несколько URLs, с помощью Средства просмотра Справки help: протокол, который можно использовать в книге справки для создания ссылок к дополнительному содержанию справки. Вы используете стандарт a href синтаксис для исходной ссылки с ними помогает URLs. Несмотря на то, что можно использовать, помогают URLs соединиться со страницами справки HTML, можно использовать стандартные гиперссылки с этой целью также. Основное преимущество справки, которая URLs - то, что они позволяют Вам создавать гиперссылки, когда щелкнувшийся, инициирующие поиски в Средстве просмотра Справки, выполняет сценарии AppleScript и выполняет поиск привязки.

Справка URLs перечислена в Таблице b-1. Та таблица включает перекрестные ссылки на обсуждения этого URLs в этом документе.

Сегменты справки Apple

Средство просмотра справки также распознает определенные комментарии HTML, которые можно использовать для разделения книги справки на подразделы, названные сегментами. Сегменты могут быть возвращены, поскольку частное лицо совершает нападки в поиске, каждом с его собственным описанием, заголовком и поисковыми ключевыми словами. Если Вы имеете особенно большую книгу справки и хотите сократить количество файла, не загружая слишком много содержания справки в единственную страницу справки, можно счесть полезным использовать сегменты. Создание Сегментов в Файлах справки описывает сегменты более подробно. Посмотрите Таблицу c-1 для полного списка комментариев, обозначающих сегменты.

Сводки VoiceOver

Для поддержки читателей с ограниченными возможностями зрения документ W3C Методы HTML для Инструкций по Доступности веб-контента 1.0 (http://www .w3.org/TR/2000/NOTE-WCAG10-HTML-TECHS-20001106/) определяет a summary атрибут для table элемент. Можно использовать это, например, для обеспечения VoiceOver описанием отношений среди ячеек в таблице. Поддержка приложений Средства просмотра Справки summary атрибут.