Översikt över uppdateringsbar hjälp

Det här dokumentet ger en grundläggande introduktion till designen och driften av PowerShell Updatable Help-funktionen. Den är utformad för modulförfattare och andra som levererar Windows PowerShell-hjälpavsnitt till användare.

Inledning

PowerShell-hjälpavsnitt är en integrerad del av PowerShell-upplevelsen. Precis som PowerShell-moduler uppdateras och förbättras hjälpämnen kontinuerligt av författarna och av bidragen från communityn med PowerShell-användare.

Funktionen Updatable Help, som introducerades i Windows PowerShell 3.0, ser till att användarna har de senaste versionerna av hjälpavsnitten i kommandotolken, även för inbyggda PowerShell-kommandon, utan att ladda ned nya moduler eller köra Windows Update. Uppdateringsbar hjälp gör det enkelt att uppdatera genom att tillhandahålla cmdletar som laddar ned de senaste versionerna av hjälpämnen från Internet och installerar dem i rätt underkataloger på användarens lokala dator. Även användare som ligger bakom brandväggar kan använda de nya cmdletarna för att få uppdaterad hjälp från en intern filresurs.

Uppdateringsbar hjälp stöds fullt ut av alla Windows PowerShell-moduler i Windows 8 och Windows Server 2012, och dess funktioner är tillgängliga för alla Windows PowerShell-modulförfattare. Uppdateringsbar hjälp stöder endast XML-baserade hjälpfiler. Den stöder inte kommentarsbaserad hjälp.

Uppdateringsbar hjälp innehåller följande funktioner.

• Cmdleten Update-Help, som avgör om användarna har de senaste hjälpfilerna för en modul och, om inte, hämtar de senaste hjälpfilerna från Internet, packar upp dem och installerar dem i rätt modulunderkataloger på användarens dator. Användare kan använda cmdleten Get-Help för att visa de nyligen installerade hjälpavsnitten omedelbart. De behöver inte starta om PowerShell.

• Cmdleten Save-Help, som laddar ned de senaste hjälpfilerna från Internet och sparar dem i en filsystemkatalog. Användare kan använda cmdleten Update-Help för att hämta hjälpfiler från filsystemkatalogen och packa upp och installera dem i modulunderkatalogerna på användarens dator. Cmdleten Save-Help är utformad för användare som har begränsad eller ingen internetåtkomst och för företag som föredrar att begränsa internetåtkomsten.

• Hjälp om en modul. Hjälpfiler för en modul hanteras och levereras som en enhet, så att användarna kan hämta alla hjälpfiler för de moduler som de använder. Uppdateringsbar hjälp stöds endast för moduler, inte för Windows PowerShell-snapin-moduler.

• Version stöder. Updatable Help använder standard fyra-position (N1. N2. N3. N4) versionsnummer. Uppdateringsbar hjälp laddar ned hjälpfiler när versionsnumret för hjälpfilerna på användarens dator (eller i katalogen Save-Help) är lägre än versionsnumret för hjälpfilerna på internetplatsen.

• stöd för flera språk. Uppdaterad hjälp stöder modulhjälpfiler i flera användargränssnittskulturer. Uppdateringsbara hjälpfilnamn innehåller standardspråkkoder, till exempel "en-US" och "ja-JP", och cmdletarna Update-Help och Save-Help placerar hjälpfilerna i språkspecifika underkataloger i modulkatalogen.

• automatiskt genererad hjälp. Cmdleten Get-Help visar grundläggande hjälp för kommandon som inte har hjälpfiler. Den automatiskt genererade hjälpen innehåller kommandosyntaxen och aliasen samt instruktioner för att använda onlinehjälp och uppdateringsbar hjälp.

• Förbättrad onlinehjälp. Enkel åtkomst till onlinehjälp kräver inte längre hjälpfiler. Parametern Online i cmdleten Get-Help hämtar nu URL:en för ett onlinehjälpavsnitt från värdet för egenskapen HelpUri för alla kommandon, om den inte hittar webbadressen till onlinehjälpen i en hjälpfil. Du kan fylla i egenskapen HelpUri genom att lägga till ett HelpUri- attribut i koden för cmdletar, funktioner och CIM-kommandon, eller med hjälp av det .LINK kommentarsbaserade hjälpnyckelordet i arbetsflöden och skript.

  För att göra våra hjälpfiler uppdaterade kommer Inte Windows PowerShell-modulerna i Windows med hjälpfiler. Användare kan använda Updatable Help för att installera hjälpfiler och uppdatera dem. Författare av andra moduler kan inkludera hjälpfiler i moduler eller utelämna dem. Stöd för uppdateringsbar hjälp är valfritt, men rekommenderas.