Información general acerca de la Ayuda actualizable

En este documento se proporciona una introducción básica al diseño y el funcionamiento de la característica ayuda actualizable de PowerShell. Está diseñado para autores de módulos y otros usuarios que entregan temas de ayuda de Windows PowerShell a los usuarios.

Introducción

Los temas de ayuda de PowerShell son una parte integral de la experiencia de PowerShell. Al igual que los módulos de PowerShell, los autores y las contribuciones de la comunidad de usuarios de PowerShell actualizan y mejoran continuamente los temas de ayuda.

La característica Ayuda actualizable, introducida en Windows PowerShell 3.0, garantiza que los usuarios tengan las versiones más recientes de temas de ayuda en el símbolo del sistema, incluso para comandos integrados de PowerShell, sin descargar nuevos módulos ni ejecutar Windows Update. La Ayuda actualizable facilita la actualización al proporcionar cmdlets que descarguen las versiones más recientes de temas de ayuda de Internet e instálelos en los subdirectorios correctos en el equipo local del usuario. Incluso los usuarios que están detrás de firewalls pueden usar los nuevos cmdlets para obtener ayuda actualizada de un recurso compartido de archivos interno.

La Ayuda actualizable es totalmente compatible con todos los módulos de Windows PowerShell en Windows 8 y Windows Server 2012, y sus características están disponibles para todos los autores de módulos de Windows PowerShell. La Ayuda actualizable solo admite archivos de ayuda basados en XML. No admite ayuda basada en comentarios.

La Ayuda actualizable incluye las siguientes características.

• El cmdlet Update-Help, que determina si los usuarios tienen los archivos de ayuda más recientes de un módulo y, si no es así, descarga los archivos de ayuda más recientes de Internet, los desempaqueta e instala en los subdirectorios de módulo correctos en el equipo del usuario. Los usuarios pueden usar el cmdlet Get-Help de para ver los temas de ayuda recién instalados inmediatamente. No es necesario reiniciar PowerShell.

• El cmdlet Save-Help, que descarga los archivos de ayuda más recientes de Internet y los guarda en un directorio del sistema de archivos. Los usuarios pueden usar el cmdlet Update-Help para obtener archivos de ayuda del directorio del sistema de archivos y desempaquetarlos e instalarlos en los subdirectorios del módulo en el equipo del usuario. El cmdlet Save-Help está diseñado para los usuarios que tienen acceso limitado o no a Internet y para empresas que prefieren limitar el acceso a Internet.

• Ayuda para un módulo. Los archivos de ayuda de un módulo se administran y entregan como unidad, por lo que los usuarios pueden obtener todos los archivos de ayuda de los módulos que usan. La ayuda actualizable solo se admite para módulos, no para complementos de Windows PowerShell.

• Versión admite. La Ayuda actualizable usa la posición estándar de cuatro posiciones (N1. N2. N3. N4) números de versión. La Ayuda actualizable descarga archivos de ayuda cuando el número de versión de los archivos de ayuda en el equipo del usuario (o en el directorio Save-Help) es inferior al número de versión de los archivos de ayuda en la ubicación de Internet.

• compatibilidad con varios idiomas. La Ayuda actualizable admite archivos de ayuda del módulo en varias referencias culturales de la interfaz de usuario. Los nombres de archivo de ayuda actualizables incluyen códigos de idioma estándar, como "en-US" y "ja-JP", y los cmdlets Update-Help y Save-Help colocan los archivos de ayuda en subdirectorios específicos del idioma del directorio del módulo.

• ayuda generada automáticamente. El cmdlet Get-Help muestra ayuda básica para los comandos que no tienen archivos de ayuda. La ayuda generada automáticamente incluye la sintaxis y los alias de comandos, así como instrucciones para usar ayuda en línea y Ayuda actualizable.

• ayuda mejorada en línea. El acceso fácil a la ayuda en línea ya no requiere archivos de ayuda. El parámetro Online del cmdlet Get-Help ahora obtiene la dirección URL de un tema de ayuda en línea del valor de la propiedad HelpUri de cualquier comando, si no encuentra la dirección URL de ayuda en línea en un archivo de ayuda. Puede rellenar la propiedad helpUri de agregando un atributo helpUri de al código de cmdlets, funciones y comandos CIM, o mediante la palabra clave de ayuda basada en comentarios .LINK en flujos de trabajo y scripts.

  Para que nuestros archivos de ayuda sean actualizables, los módulos de Windows PowerShell en Windows no vienen con archivos de ayuda. Los usuarios pueden usar la Ayuda actualizable para instalar archivos de ayuda y actualizarlos. Los autores de otros módulos pueden incluir archivos de ayuda en módulos o omitirlos. La compatibilidad con la Ayuda actualizable es opcional, pero se recomienda.