Общие сведения об обновляемой справке

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

Введение

Разделы справки PowerShell являются неотъемлемой частью интерфейса PowerShell. Как и модули PowerShell, разделы справки постоянно обновляются и улучшаются авторами и вкладом сообщества пользователей PowerShell.

Функция обновляемой справки, появившейся в Windows PowerShell 3.0, гарантирует, что у пользователей есть новые версии разделов справки в командной строке, даже для встроенных команд PowerShell, без скачивания новых модулей или запуска Центра обновления Windows. Обновляемая справка упрощает обновление, предоставляя командлеты, которые загружают новейшие версии тем справки из Интернета и устанавливают их в правильных подкаталогах на локальном компьютере пользователя. Даже пользователи, которые находятся за брандмауэрами, могут использовать новые командлеты для получения обновленной справки из внутренней общей папки.

Обновляемая справка полностью поддерживается всеми модулями Windows PowerShell в Windows 8 и Windows Server 2012, а ее функции доступны всем авторам модулей Windows PowerShell. Обновляемая справка поддерживает только XML-файлы справки. Он не поддерживает справку на основе комментариев.

Обновляемая справка включает следующие функции.

• Командлет Update-Help, который определяет, имеют ли пользователи самые новые файлы справки для модуля и, если нет, скачивает новейшие файлы справки из Интернета, распаковывает их и устанавливает их в правильные подкаталоги модуля на компьютере пользователя. Пользователи могут использовать командлет get-Help для просмотра недавно установленных разделов справки. Не нужно перезапускать PowerShell.

• Командлет Save-Help, который скачивает новейшие файлы справки из Интернета и сохраняет их в каталоге файловой системы. Пользователи могут использовать командлет Update-Help для получения файлов справки из каталога файловой системы и распаковки и их установки в подкаталогах модуля на компьютере пользователя. Командлет Save-Help предназначен для пользователей с ограниченным доступом в Интернет или без доступа к Интернету и для предприятий, которые предпочитают ограничить доступ к Интернету.

• справку по модулю. Файлы справки для модуля управляются и предоставляются в виде единицы, поэтому пользователи могут получать все файлы справки для используемых модулей. Обновляемая справка поддерживается только для модулей, а не для оснастки Windows PowerShell.

• поддержка версий. Обновляемая справка использует стандартную четырех позицию (N1). N2. N3. N4) номера версий. Обновляемая справка скачивает файлы справки, если номер версии файлов справки на компьютере пользователя (или в каталоге Save-Help) ниже номера версии файлов справки в расположении в Интернете.

• поддержка нескольких языков. Обновляемая справка поддерживает файлы справки по модулям в нескольких языках и региональных параметрах пользовательского интерфейса. Обновляемые имена файлов справки включают стандартные коды языка, такие как "en-US" и "ja-JP", а командлеты Update-Help и Save-Help помещать файлы справки в вложенные каталоги модуля для конкретного языка.

• автоматическое создание справки. Командлет get-Help отображает базовую справку для команд, у которых нет файлов справки. Автоматическая справка включает синтаксис команды и псевдонимы, а также инструкции по использованию справки в Интернете и обновляемой справки.

• улучшенная справка по Интернету. Простой доступ к онлайн-справке больше не требует файлов справки. Параметр Online командлета Get-Help теперь получает URL-адрес раздела справки по сети из значения свойства HelpUri любой команды, если он не может найти URL-адрес справки в файле справки. Вы можете заполнить свойство HelpUri, добавив атрибут HelpUri в код командлетов, функций и команд CIM или с помощью ключевого слова справки на основе .LINK в рабочих процессах и сценариях.

  Чтобы сделать файлы справки обновляемыми, модули Windows PowerShell в Windows не приходят с файлами справки. Пользователи могут использовать обновляемую справку для установки файлов справки и их обновления. Авторы других модулей могут включать файлы справки в модулях или опустить их. Поддержка обновляемой справки является необязательной, но рекомендуется.