Creación de la Ayuda actualizable: paso a paso

En este documento se enumeran los pasos del proceso de creación de la Ayuda actualizable.

Creación de ayuda actualizable: Paso a paso

La Ayuda actualizable está diseñada para los usuarios finales, pero también proporciona importantes ventajas a los autores de módulos y escritores de ayuda, incluida la capacidad de agregar contenido, corregir errores, entregar varias culturas de interfaz de usuario y responder a las solicitudes y comentarios de los usuarios, mucho después de que se haya enviado el módulo. En este tema se explica cómo empaquetar y cargar archivos de ayuda para que los usuarios puedan descargarlos e instalarlos mediante los cmdlets Update-Help y Save-Help.

Los pasos siguientes proporcionan información general sobre el proceso de compatibilidad con la Ayuda actualizable.

Paso 1: Buscar un sitio de Internet para los archivos de ayuda

El primer paso para crear ayuda actualizable es buscar una ubicación de Internet para los archivos de ayuda del módulo. En realidad, puede usar dos ubicaciones diferentes. Puede mantener el archivo de información de ayuda del módulo (HelpInfo XML , que se describe a continuación) en una ubicación de Internet y los archivos CAB de contenido de ayuda en otra ubicación de Internet. Todos los archivos CAB de contenido de ayuda de un módulo deben estar en la misma ubicación. Puede colocar archivos CAB de contenido de ayuda para distintos módulos en la misma ubicación.

Paso 2: Agregar una clave HelpInfoURI al manifiesto del módulo

Agregue una clave HelpInfoURI al manifiesto del módulo. El valor de la clave es el identificador uniforme de recursos (URI) de la ubicación del archivo de información XML HelpInfo del módulo. Por motivos de seguridad, la dirección debe comenzar por "http" o "https". El URI debe especificar una ubicación de Internet, pero no debe incluir el nombre de archivo XML HelpInfo.

Por ejemplo:

@{
RootModule = TestModule.psm1
ModuleVersion = '2.0'
HelpInfoURI = 'https://go.microsoft.com/fwlink/?LinkID=0123'
}

Paso 3: Crear un archivo XML HelpInfo

El archivo de información XML HelpInfo contiene el URI de la ubicación de Internet de los archivos de ayuda y los números de versión de los archivos de ayuda más nuevos para el módulo en cada referencia cultural de la interfaz de usuario admitida. Cada Windows PowerShell módulo tiene un archivo XML HelpInfo. Al actualizar los archivos de ayuda, edita o reemplaza el archivo XML HelpInfo; no agrega otro. Para obtener más información, vea How to Create a HelpInfo XML File.

Paso 4: Crear archivos CAB

Use una herramienta que cree archivos de archivador (), como , para crear un archivo CAB que contenga los .cab archivos de ayuda del MakeCab.exe módulo. Cree un archivo CAB independiente para los archivos de ayuda en cada referencia cultural de interfaz de usuario compatible. Para obtener más información, vea How to Prepare Updatable Help CAB Files.

Paso 5: Upload los archivos

Para publicar archivos de ayuda nuevos o actualizados, cargue los archivos CAB en la ubicación de Internet especificada por el elemento HelpContentUri en el archivo XML HelpInfo. A continuación, cargue el archivo XML HelpInfo en la ubicación de Internet especificada por el valor de la clave HelpInfoUri en el manifiesto del módulo.