Přehled aktualizovatelné nápovědy

  • Článek

Tento dokument poskytuje základní informace o návrhu a provozu funkce aktualizace pro PowerShell, které lze aktualizovat. je určená pro autory modulů a ostatní, kteří dodávají Windows PowerShell témata nápovědy uživatelům.

Úvod

Témata nápovědy PowerShellu jsou nedílnou součástí prostředí PowerShellu. Podobně jako moduly PowerShellu se témata nápovědy průběžně aktualizují a vylepšili autory a příspěvky komunity uživatelů PowerShellu.

funkce nápovědy aktualizovatelná v Windows PowerShell 3,0 zajišťuje, že uživatelé mají nejnovější verze témat nápovědy na příkazovém řádku, a to i v případě integrovaných příkazů powershellu, aniž byste museli stahovat nové moduly nebo spouštět web Windows Update. Aktualizovatelná Help usnadňuje aktualizaci tím, že poskytuje rutiny, které stahují nejnovější verze témat nápovědy z Internetu a instalují je do správných podadresářů v místním počítači uživatele. I uživatelé, kteří jsou za branou firewall, můžou pomocí nových rutin získat aktualizovanou nápovědu z interní sdílené složky.

aktualizovatelná Help je plně podporovaná všemi Windows PowerShell moduly v Windows 8 a Windows Server 2012 a její funkce jsou dostupné všem autorům modulů Windows PowerShell. Aktualizovatelná Help podporuje pouze soubory Help založené na XML. Nepodporuje pomoc na základě komentářů.

Aktualizovatelná help obsahuje následující funkce.

  • Rutina Update-Help , která určuje, jestli mají uživatelé nejnovější soubory pro nápovědu pro modul a pokud ne, stáhne nejnovější soubory s podporou z Internetu, rozbalí je a nainstaluje je do správných podadresářů modulů v počítači uživatele. Uživatelé mohou použít rutinu Get-Help k okamžitému zobrazení nově nainstalovaných témat nápovědy. Nepotřebují restartovat PowerShell.

  • Rutina Save-Help , která stáhne nejnovější soubory s podporou z Internetu a uloží je do adresáře systému souborů. Uživatelé mohou pomocí Update-Help rutiny získat soubory s nápovědu z adresáře systému souborů a rozbalit je a nainstalovat v podadresářích modulu v počítači uživatele. Save-HelpRutina je určená pro uživatele, kteří mají omezený přístup k Internetu, a pro podniky, které chtějí omezit přístup k Internetu.

  • Nápovědu pro modul Soubory s nápovědu pro modul se spravují a doručují jako jednotka, takže uživatelé můžou získat všechny soubory s nápovědami pro moduly, které používají. aktualizovatelná help je podporována pouze pro moduly, nikoli pro Windows PowerShell moduly snap-in.

  • Podpora verzí. Aktualizovatelná Help používá standardní čtyři pozice (N1). N2. N3. N4) čísla verzí. Aktualizovatelná aplikace Help stahuje soubory aplikace Help, pokud je číslo verze souborů Help v počítači uživatele (nebo v Save-Help adresáři) nižší než číslo verze souborů Help v umístění v Internetu.

  • Podpora více jazyků. Aktualizovatelná Help podporuje soubory Help modulu v několika jazykových verzích uživatelského rozhraní. K aktualizovatelným názvům souborů helpu patří kódy standardního jazyka, jako je "en-US" a "ja-JP", Update-Help a Save-Help rutiny a jsou určené pro konkrétní jazyk v adresářích modulu.

  • Automaticky generovaná Help. Rutina Get-Help zobrazí základní nápovědu pro příkazy, které nemají soubory s nápovědu. Automaticky generovaná nápovědu obsahuje syntaxi příkazů a aliasy a pokyny k používání online pomoci a aktualizovatelné pomoci.

  • Rozšířená online nápovědě. Snadný přístup k online nápovědě už nevyžaduje soubory s příponou. Parametr online Get-Help rutiny teď získá adresu URL tématu online nápovědy z hodnoty vlastnosti HelpUri libovolného příkazu, pokud nemůže najít adresu URL online nápovědy v souboru nápovědy. Vlastnost HelpUri lze naplnit přidáním atributu HelpUri do kódu rutin, funkcí a příkazů CIM nebo pomocí . Propojte direktivu Help na základě komentářů v pracovních postupech a skriptech.

    chcete-li zpřístupnit naše soubory s možností aktualizace, Windows PowerShell moduly v Windows 8 a Windows serveru vNext nepřicházejí do souborů help. Uživatelé mohou použít aktualizovatelnou aplikaci k instalaci souborů Help a jejich aktualizaci. Autoři jiných modulů mohou obsahovat soubory aplikace Help v modulech nebo je vynechat. Podpora pro aktualizovatelnou nápovědu je volitelná, ale doporučuje se.