Cómo funciona la Ayuda actualizable

En este tema se explica cómo la Ayuda actualizable procesa el archivo XML HelpInfo y los archivos CAB de cada módulo e instala la ayuda actualizada para los usuarios.

Proceso de Update-Help

En la lista siguiente se describen las acciones del cmdlet Update-Help cuando un usuario ejecuta un comando para actualizar los archivos de ayuda de un módulo en una referencia cultural de interfaz de usuario determinada.

1. Update-Help obtiene el archivo XML HelpInfo remoto de la ubicación especificada por el valor de la clave HelpInfoURI en el manifiesto del módulo y valida el archivo en el esquema. (Para ver el esquema, vea HelpInfo XML Schema).) A continuación, Update-Help busca un archivo XML helpInfo local para el módulo en el directorio del módulo en el equipo del usuario.

2. Update-Help compara el número de versión de los archivos de ayuda de la referencia cultural de interfaz de usuario especificada en los archivos XML de HelpInfo remotos y locales del módulo. Si el número de versión del archivo remoto es mayor que el número de versión en el archivo local o si no hay ningún archivo XML helpInfo local para el módulo, Update-Help se prepara para descargar nuevos archivos de ayuda.

3. Update-Help selecciona el archivo CAB del módulo en la ubicación especificada por el elemento HelpContentUri en el archivo XML helpInfo remoto. Usa el nombre del módulo, el GUID del módulo y la referencia cultural de la interfaz de usuario para identificar el archivo CAB.

4. Update-Help descarga el archivo CAB, lo desempaqueta, valida los archivos de contenido de ayuda y guarda los archivos de contenido de ayuda en el subdirectorio específico del idioma del directorio del módulo en el equipo del usuario.

5. Update-Help crea un archivo XML helpInfo local copiando el archivo XML helpInfo remoto. Edita el archivo XML local HelpInfo para que incluya elementos solo para el archivo CAB que instaló. A continuación, guarda el archivo XML helpInfo local en el directorio del módulo y concluye la actualización.

Proceso de Save-Help

En la lista siguiente se describen las acciones de los cmdlets Save-Help y Update-Help cuando un usuario ejecuta comandos para actualizar los archivos de ayuda de un recurso compartido de archivos y, a continuación, usar esos archivos para actualizar los archivos de ayuda en el equipo del usuario.

El Save-Help cmdlet realiza las siguientes acciones en respuesta a un comando para guardar los archivos de ayuda de un módulo en un recurso compartido de archivos especificado por el parámetro DestinationPath .

1. Save-Help obtiene el archivo XML HelpInfo remoto de la ubicación especificada por el valor de la clave HelpInfoURI en el manifiesto del módulo y valida el archivo en el esquema. (Para ver el esquema, vea HelpInfo XML Schema).) A continuación, Save-Help busca un archivo XML HelpInfo local en el directorio especificado por el parámetro DestinationPath en el Save-Help comando .

2. Save-Help compara el número de versión de los archivos de ayuda de la referencia cultural de interfaz de usuario especificada en los archivos XML de HelpInfo remotos y locales del módulo. Si el número de versión del archivo remoto es mayor que el número de versión en el archivo local o si no hay ningún archivo XML helpInfo local para el módulo en el directorio DestinationPath , Save-Help se prepara para descargar nuevos archivos de ayuda.

3. Save-Help selecciona el archivo CAB del módulo en la ubicación especificada por el elemento HelpContentUri en el archivo XML helpInfo remoto. Usa el nombre del módulo, el GUID del módulo y la referencia cultural de la interfaz de usuario para identificar el archivo CAB.

4. Save-Help descarga el archivo CAB y lo guarda en el directorio DestinationPath . (No crea ningún subdirectorio específico del lenguaje).

5. Save-Help crea un archivo XML helpInfo local copiando el archivo XML helpInfo remoto. Edita el archivo XML local HelpInfo para que incluya elementos solo para el archivo CAB que guardó. A continuación, guarda el archivo XML HelpInfo local en el directorio DestinationPath y concluye la actualización.

   El Update-Help cmdlet realiza las siguientes acciones en respuesta a un comando para actualizar los archivos de ayuda en el equipo de un usuario desde los archivos de un recurso compartido de archivos especificado por el parámetro SourcePath .

6. Update-Help obtiene el archivo XML HelpInfo remoto del directorio SourcePath . A continuación, busca un archivo XML helpInfo local en el directorio del módulo en el equipo del usuario.

7. Update-Help compara el número de versión de los archivos de ayuda de la referencia cultural de interfaz de usuario especificada en los archivos XML de HelpInfo remotos y locales del módulo. Si el número de versión del archivo remoto es mayor que el número de versión en el archivo local o si no hay ningún archivo XML helpInfo local, Update-Help se prepara para instalar nuevos archivos de ayuda.

8. Update-Help selecciona el archivo CAB del módulo en el directorio SourcePath . Usa el nombre del módulo, el GUID del módulo y la referencia cultural de la interfaz de usuario para identificar el archivo CAB.

9. Update-Help desempaqueta el archivo CAB, valida los archivos de contenido de ayuda y guarda los archivos de contenido de ayuda en el subdirectorio específico del idioma del directorio del módulo en el equipo del usuario.

10. Update-Help crea un archivo XML helpInfo local copiando el archivo XML helpInfo remoto. Edita el archivo XML local HelpInfo para que incluya elementos solo para el archivo CAB que instaló. A continuación, guarda el archivo XML helpInfo local en el directorio del módulo y concluye la actualización.