Введение в Apple помогает руководству по программированию

Этот документ описывает Справку Apple, Основанную на HTML систему для оказания пользовательской помощи в OS X. Справка Apple является основной системой справочной информации для OS X и разработана для поставки онлайновой основанной на теме пользовательской справки, той, которая часто предоставлена в руководствах пользователя и списках часто задаваемых вопросов (FAQ). Углерод, Какао и JAVA-приложения могут использовать Справку Apple в OS X.

Справка Apple предлагает значительные преимущества перед статическими документами справки, такими как Чтение Меня файлы или руководства в PDF. Преимущества принятия Справки Apple для пользовательской помощи включают их:

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

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

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

• Простота обновления. Справка Apple делает простым пересмотреть и развернуть Ваше содержание справки, постранично или одновременно. Используя Справку Apple, можно даже поддержать актуальные страницы справки и искать индексы на собственном сервере и загружать их через Интернет для обновления содержания справки.

• Простота принятия. Много разработчиков распознали преимущества основанной на браузере справки и реализовали решения HTML оказать пользовательскую помощь. Справка Apple упрощает для Вас адаптировать ранее создаваемые страницы HTML в форму, используемую Справкой Apple.

• Пользовательский опыт. Приложение Средства просмотра Справки оптимизировано для поставки экранной справки. При помощи Справки Apple Вы гарантируете, что пользовательский опыт для Вашего приложения является соответствующим ожиданиям пользователей приложения OS X.

• Центр внимания Для Справки. Начиная с OS X v10.5, Справка Apple интегрирует Центр внимания Для Справки, позволяющей пользователям искать содержание Ваших меню и справки приложения непосредственно из Меню справки Вашего приложения. Если Вы не используете Справку Apple, то Центр внимания Для результатов возвратов Справки только от Справки Mac, а не от справки Вашего приложения.

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

Система справочной информации Apple включает эти компоненты:

• Приложение Средства просмотра Справки. Это - приложение по умолчанию для просмотра пользовательской помощи в OS X. Средство просмотра справки выводит на экран Вашу Основанную на HTML книгу справки.

• Прикладной программный интерфейс (API) Справки Apple. Это - ряд функций, предоставленных Справкой Apple, которые позволяют Вам получать доступ и загружать справку в Средстве просмотра Справки. Вы не должны использовать эти функции при обеспечении только основного интерфейса справки; однако, если Вы хотите реализовать усовершенствованные опции справки (такие как контекстная справка), необходимо вызвать функции Справки Apple. Справка Apple API доступна всему Углероду, Какао и разработчикам Java.

• Утилита Help Indexer. Это - инструмент разработчика, предоставленный Apple для индексации Вашей книги справки. При выполнении утилиты Help Indexer на книге справки инструмент генерирует индексный файл что использование Средства просмотра Справки для создания справки доступной для поиска.

Кто должен считать этот документ?

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

Организация этого документа

Этот документ включает следующие главы и приложения:

• Понятия Справки Apple описывают приложение Средства просмотра Справки и Центр внимания Для Справки, и представляют Справку Apple API.

• Авторская Справка Apple показывает, как Вы можете создать основную книгу справки и описываете, как использовать утилиту Help Indexer для индексации книги справки.

• Регистрация Книги справки описывает, как зарегистрировать Вашу книгу справки в Средстве просмотра Справки.

• Открытие Your Help Book in Help Viewer показывает, как использовать функции Справки Apple, чтобы получить доступ и вывести на экран содержание книги справки из Вашего приложения..

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

• URLs Справки Apple перечисляет Справку Apple URLs, который можно использовать для соединения со страницами справки и другими ресурсами.

• Сегменты Справки Apple перечисляют команды, которые можно использовать для деления страниц справки HTML на многократные сегменты.