Creación de ayuda actualizable: paso a paso

Este artículo documenta los pasos necesarios para publicar la Ayuda actualizable.

Ayuda actualizable para la creación: paso a paso

La ayuda actualizable está diseñada para usuarios finales, pero también proporciona importantes beneficios a los autores de módulos y redactores de ayuda, incluida la capacidad de agregar contenido, corregir errores, entregar en múltiples culturas de interfaz de usuario y responder a los comentarios y solicitudes de los usuarios, mucho después del módulo. ha enviado. Este tema 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 siguientes pasos proporcionan una descripción general del proceso de soporte de la Ayuda actualizable.

Paso 1: busque un sitio de Internet para sus archivos de ayuda

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

Paso 2: agregue una clave HelpInfoURI al manifiesto de su módulo

Agregue una clave HelpInfoURI al manifiesto de su 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 para su módulo. Por seguridad, la dirección debe comenzar con http: o https:. El URI debe especificar una ubicación de Internet para el archivo XML de HelpInfo. No incluya el nombre del archivo XML de HelpInfo.

Por ejemplo:

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

Paso 3: cree un archivo XML de HelpInfo

El archivo de información XML HelpInfo contiene el URI de la ubicación en Internet de sus archivos de ayuda y los números de versión de los archivos de ayuda más recientes para su módulo en cada cultura de UI admitida. Cada módulo de PowerShell tiene un archivo XML de HelpInfo. Cuando actualiza sus archivos de ayuda, debe actualizar el archivo XML de HelpInfo. Para obtener más información, consulte Cómo crear un archivo XML de HelpInfo.

Paso 4: cree archivos CAB y ZIP

PowerShell en Windows espera que los archivos de contenido de ayuda de un módulo se almacenen en un archivo CAB. PowerShell en Linux o macOS espera que los archivos de contenido de ayuda de un módulo se almacenen en un archivo ZIP. Si su módulo se ejecuta en varias plataformas, debe crear ambos formatos.

Utilice una herramienta, como MakeCab.exe, para crear un archivo CAB que contenga los archivos de ayuda para su módulo. Cree un archivo CAB independiente para los archivos de ayuda en cada cultura de interfaz de usuario compatible. Para obtener más información, consulte Cómo preparar archivos CAB de ayuda actualizables.

Puede utilizar el cmdlet Compress-Archive para crear un archivo ZIP.

Paso 5: sube tus archivos

Para publicar archivos de ayuda nuevos o actualizados, cargue los archivos de contenido de ayuda en la ubicación de Internet especificada por el elemento HelpContentUri en el archivo XML HelpInfo. Luego, 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.

Usar PlatyPS para crear contenido de ayuda

PlatyPS es un módulo de PowerShell diseñado para ayudarle a crear contenido de ayuda para sus módulos. Usted es el autor del contenido de ayuda en archivos Markdown. PlatyPS puede crear plantillas de Markdown para su cmdlet, convertir los archivos de Markdown al formato de ayuda XML (MAML), crear archivos XML de HelpInfo y empaquetar el contenido de ayuda de MAML en archivos CAB y ZIP.

Para obtener más información, consulte Crear ayuda basada en XML utilizando PlatyPS.