Cómo crear y cargar archivos CAB
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.
Este tema explica cómo crear archivos CAB de Ayuda actualizable y cargarlos en la ubicación donde los cmdlets de Ayuda actualizable pueden encontrarlos.
Cómo crear y cargar archivos CAB de ayuda actualizables
Puede utilizar la función Ayuda actualizable para entregar archivos de ayuda nuevos o actualizados para un módulo en varios idiomas y culturas. Un paquete de ayuda actualizable para un módulo consta de un archivo XML HelpInfo y uno o más archivos contenedor (.CAB). Cada archivo CAB contiene archivos de ayuda para el módulo en una cultura de interfaz de usuario. Utilice el siguiente procedimiento para crear archivos CAB para la Ayuda actualizable.
Organice los archivos de ayuda del módulo por cultura de interfaz de usuario. Cada archivo CAB de ayuda actualizable contiene los archivos de ayuda para un módulo en una cultura de interfaz de usuario. Puede entregar varios archivos CAB de ayuda para el módulo, cada uno para una cultura de interfaz de usuario diferente.
-
Verifique que los archivos de ayuda incluyan solo los tipos de archivos permitidos para la Ayuda actualizable y valídelos con un esquema de archivo de ayuda. Si el cmdlet
Update-Helpencuentra un archivo que no es válido o que no es de un tipo permitido, no instala el archivo no válido y detiene la instalación de archivos desde CAB. Para obtener una lista de los tipos de archivos permitidos, consulte Tipos de archivos permitidos en un archivo CAB de ayuda actualizable. Incluya todos los archivos de ayuda para el módulo en la cultura de la interfaz de usuario, no solo los archivos nuevos o que hayan cambiado. Si el archivo CAB está incompleto, los usuarios que descarguen archivos de ayuda por primera vez o no descarguen todas las actualizaciones no tendrán todos los archivos de ayuda.
Utilice una utilidad que cree archivos contenedor, como
MakeCab.exe. PowerShell no incluye cmdlets que crean archivos CAB.Nombra los archivos CAB. Para obtener más información, consulte Cómo asignar un nombre a un archivo CAB de ayuda actualizable.
Cargue los archivos CAB del módulo en la ubicación especificada por el elemento HelpContentUri en el archivo XML HelpInfo del módulo. Luego cargue el archivo XML de HelpInfo en la ubicación especificada por la clave HelpInfoUri del manifiesto del módulo. HelpContentUri y HelpInfoUri pueden apuntar a la misma ubicación.
Precaución
El valor de la clave HelpInfoUri y el elemento HelpContentUri deben comenzar con http o https. El valor debe ser una ruta URL que apunte a la ubicación (carpeta) que contiene la ayuda actualizable. La URL debe terminar en /. La URL no debe incluir un nombre de archivo.