Язык разметки помощи Microsoft
 | Эта статья в значительной степени или полностью опирается на один источник . ( ноябрь 2019 г. ) |
Язык разметки Microsoft Assistance Markup Language ( Microsoft AML , MAML ) — это XML на основе язык разметки , разработанный командой Microsoft User Assistance Platform для предоставления помощи пользователям (« онлайн-справка ») для операционной системы Microsoft Windows Vista . Он составляет платформу помощи в Windows Vista.
MAML также используется для предоставления справочной информации для PowerShell V2. командлетов, модулей и расширенных функций [1]
Концепция
[ редактировать ]MAML — это отход от всех предыдущих типов помощи пользователям для операционных систем Windows. Некоторые из его функций были доступны в .NET Framework 2, но с выпуском .NET Framework 3 появилось больше возможностей. Раньше для поддержки пользователей в операционных системах Windows использовались скомпилированные Microsoft файлы справки HTML, которые содержат мало машиночитаемой семантической информации.
Наиболее важным аспектом MAML является то, что он переносит оказание помощи пользователям на концепцию структурированного авторинга (что-то похожее на DITA или DocBook ). Документы и их составные элементы определяются их контекстом. В MAML акцент делается на контенте и задачах, которые пользователь выполняет на компьютере, а не на функциях программного обеспечения. Презентация управляется как часть механизма рендеринга, когда пользователь запрашивает тему.
Структурированная особенность MAML означает, что он также может выражать широкий спектр активных концепций. [2] Одной из примечательных функций является управляемая справка (мастер активного содержимого), которая позволяет файлу справки либо автоматически запускать задачу, либо пошагово выделять части экрана, с которыми пользователь должен взаимодействовать. Эта функция была примечательным аспектом Project Longhorn, однако Microsoft решила не включать ее в окончательную версию Vista. [3]
Структура создания MAML разделена на сегменты, связанные с типом контента: концептуальные, часто задаваемые вопросы , глоссарий, процедуры, справочные материалы, повторно используемый контент, задачи, устранение неполадок и учебные пособия.
Презентация
[ редактировать ]При отображении темы происходят три уровня трансформации: структура, представление и рендеринг:
- Структурное преобразование содержит повторно используемый контент и применяет условную логику для определения структуры, которую контент должен принимать при отображении, а также содержимого самого текста.
- Преобразование представления позволяет использовать контент, созданный в MAML, во многих различных форматах, включая DHTML , XAML , RTF и печатные материалы.
- Преобразование рендеринга применяет таблицы стилей и отображает окончательный контент для пользователей.
Авторская работа
[ редактировать ]Не существует инструментов для помощи в создании MAML; поэтому файлы XML необходимо создавать вручную.
Такое приложение, как Notepad , Notepad++ или Infopath , можно использовать для создания содержимого MAML вручную. [1]
Формат
[ редактировать ]Содержимое MAML использует формат файла справки h1s, который вместе со средством просмотра HelpPane имеется в Windows Vista и Windows 7. Формат аналогичен файлам Microsoft Help 2 .hxs. [4] Существует сторонний инструмент xHelpMarkup для компиляции и декомпиляции, но он представляет собой лишь оболочку инструментов BDD 2007 apcompnt и apss.dll.
См. также
[ редактировать ]Ссылки
[ редактировать ]- ^ Jump up to: а б О'Нилс, Джеймс (4 марта 2016 г.). «Интерактивная справка PowerShell: изменение, которое следует внести в версию 2 (#3) (и как создавать файлы справки MAML для PowerShell) — блог Джеймса О'Нила — домашняя страница сайта — блоги TechNet» . Архивировано из оригинала 4 марта 2016 г.
- ^ «Основные сведения о справке Microsoft «Longhorn»» . ПисателиUA .
- ^ «Помощь с гидом» . БетаАрхив .
- ^ «Справка AP — техническая информация» . www.help-info.de .
Внешние ссылки
[ редактировать ]- Рекомендации по использованию Microsoft Vista в библиотеке MSDN
- Блог группы поддержки платформы в Microsoft Developer Network (прекращено)
- Руководство по MAML Sandcastle
- Help-Info.de Документация MAML