Så här fungerar uppdateringsbar hjälp

Det här avsnittet beskriver hur uppdaterad hjälp bearbetar XML-filen HelpInfo och CAB-filer för varje modul och installerar uppdaterad hjälp för användare.

Den Update-Help processen

I följande lista beskrivs åtgärderna i cmdleten Update-Help när en användare kör ett kommando för att uppdatera hjälpfilerna för en modul i en viss användargränssnittskultur.

1. Update-Help hämtar xml-fjärrfilen HelpInfo från den plats som anges av värdet för HelpInfoURI-nyckeln i modulmanifestet och validerar filen mot schemat. (Information om hur du visar schemat finns i HelpInfo XML-schema.) Söker sedan Update-Help efter en lokal HelpInfo XML-fil för modulen i modulkatalogen på användarens dator.

2. Update-Help jämför versionsnumret för hjälpfilerna för den angivna användargränssnittskulturen i de fjärranslutna och lokala HelpInfo XML-filerna för modulen. Om versionsnumret på fjärrfilen är större än versionsnumret på den lokala filen, eller om det inte finns någon lokal HelpInfo XML-fil för modulen, Update-Help förbereder du nedladdningen av nya hjälpfiler.

3. Update-Help väljer CAB-filen för modulen från den plats som anges av elementet HelpContentUri i xml-fjärrfilen HelpInfo. Den använder modulnamnet, modulens GUID och användargränssnittskulturen för att identifiera CAB-filen.

4. Update-Help laddar ned CAB-filen, packar upp den, validerar hjälpinnehållsfilerna och sparar hjälpinnehållsfilerna i den språkspecifika underkatalogen för modulkatalogen på användarens dator.

5. Update-Help skapar en lokal HelpInfo XML-fil genom att kopiera XML-fjärrfilen HelpInfo. Den redigerar den lokala HelpInfo XML-filen så att den endast innehåller element för CAB-filen som den installerade. Sedan sparas den lokala HelpInfo XML-filen i modulkatalogen och uppdateringen avslutas.

Den Save-Help processen

I följande lista beskrivs åtgärderna i cmdletarna Spara hjälp och Uppdateringshjälp när en användare kör kommandon för att uppdatera hjälpfilerna i en filresurs och sedan använder dessa filer för att uppdatera hjälpfilerna på användarens dator.

Cmdleten Save-Help utför följande åtgärder som svar på ett kommando för att spara hjälpfilerna för en modul i en filresurs som anges av parametern DestinationPath .

1. Save-Help hämtar xml-fjärrfilen HelpInfo från den plats som anges av värdet för HelpInfoURI-nyckeln i modulmanifestet och validerar filen mot schemat. (Information om hur du visar schemat finns i HelpInfo XML-schema.) Söker sedan Save-Help efter en lokal HelpInfo XML-fil i katalogen som anges av parametern DestinationPath i Save-Help kommandot .

2. Save-Help jämför versionsnumret för hjälpfilerna för den angivna användargränssnittskulturen i de fjärranslutna och lokala HelpInfo XML-filerna för modulen. Om versionsnumret på fjärrfilen är större än versionsnumret på den lokala filen, eller om det inte finns någon lokal HelpInfo XML-fil för modulen i DestinationPath-katalogen , Save-Help förbereder du nedladdningen av nya hjälpfiler.

3. Save-Help väljer CAB-filen för modulen från den plats som anges av elementet HelpContentUri i xml-fjärrfilen HelpInfo. Den använder modulnamnet, modulens GUID och användargränssnittskulturen för att identifiera CAB-filen.

4. Save-Help laddar ned CAB-filen och sparar den i katalogen DestinationPath . (Den skapar inga språkspecifika underkataloger.)

5. Save-Help skapar en lokal HelpInfo XML-fil genom att kopiera XML-fjärrfilen HelpInfo. Den redigerar den lokala HELPInfo XML-filen så att den endast innehåller element för CAB-filen som den sparade. Sedan sparas den lokala HelpInfo XML-filen i Katalogen DestinationPath och uppdateringen avslutas.

   Cmdleten Update-Help utför följande åtgärder som svar på ett kommando för att uppdatera hjälpfilerna på en användares dator från filerna i en filresurs som anges av parametern SourcePath .

6. Update-Help hämtar XML-fjärrfilen HelpInfo från SourcePath-katalogen . Sedan letar den efter en lokal HelpInfo XML-fil i modulkatalogen på användarens dator.

7. Update-Help jämför versionsnumret för hjälpfilerna för den angivna användargränssnittskulturen i de fjärranslutna och lokala HelpInfo XML-filerna för modulen. Om versionsnumret på fjärrfilen är större än versionsnumret på den lokala filen, eller om det inte finns någon lokal HelpInfo XML-fil, Update-Help förbereder du för att installera nya hjälpfiler.

8. Update-Help väljer CAB-filen för modulen från SourcePath-katalogen . Den använder modulnamnet, modulens GUID och användargränssnittskulturen för att identifiera CAB-filen.

9. Update-Help packar upp CAB-filen, validerar hjälpinnehållsfilerna och sparar hjälpinnehållsfilerna i den språkspecifika underkatalogen i modulkatalogen på användarens dator.

10. Update-Help skapar en lokal HelpInfo XML-fil genom att kopiera XML-fjärrfilen HelpInfo. Den redigerar den lokala HelpInfo XML-filen så att den endast innehåller element för CAB-filen som den installerade. Sedan sparas den lokala HelpInfo XML-filen i modulkatalogen och uppdateringen avslutas.