Cómo crear un archivo XML de HelpInfo
Nota
La creación manual de ayuda basada en XML es muy difícil. El módulo PlatyPS le permite escribir ayuda en Markdown y luego convertirla en ayuda basada en XML. Esto hace que sea mucho más fácil escribir y mantener la ayuda. PlatyPS también puede crear paquetes de ayuda actualizables para usted. Para obtener más información, consulte Crear ayuda basada en XML utilizando PlatyPS.
Los temas de esta sección explican cómo crear y completar un archivo de información de ayuda, comúnmente conocido como "archivo XML HelpInfo", para la función Ayuda actualizable de PowerShell.
Descripción general del archivo XML de HelpInfo
El archivo XML HelpInfo es la fuente principal de información sobre la Ayuda actualizable para el módulo. Incluye la ubicación de los archivos de ayuda para los módulos, las culturas de UI admitidas y los números de versión que utiliza la Ayuda actualizable para determinar si el usuario tiene los archivos de ayuda más recientes.
Cada módulo tiene solo un archivo XML de HelpInfo, incluso si el módulo incluye varios archivos de ayuda para múltiples culturas de UI. El autor del módulo crea el archivo XML HelpInfo y lo coloca en la ubicación de Internet especificada por la clave HelpInfoUri en el manifiesto del módulo. Cuando los archivos de ayuda del módulo se actualizan y cargan, el autor del módulo actualiza el archivo XML de HelpInfo y reemplaza el archivo XML de HelpInfo original con la nueva versión.
Es fundamental que el archivo XML de HelpInfo se mantenga cuidadosamente. Si carga archivos nuevos, pero olvida incrementar los números de versión, la Ayuda actualizable no descargará los archivos nuevos en las computadoras de los usuarios. Si agrega archivos de ayuda para una nueva cultura de interfaz de usuario, pero no actualiza el archivo XML de HelpInfo ni lo coloca en la ubicación correcta, la Ayuda actualizable no descargará los nuevos archivos.
En esta sección
Esta sección incluye los siguientes temas.
- Esquema XML de información de ayuda
- Archivo de muestra XML de información de ayuda
- Cómo nombrar un archivo XML de HelpInfo
- Cómo configurar los números de versión XML de HelpInfo
Ver también
Soporte de ayuda actualizable