Přehled aktualizovatelné nápovědy

Tento dokument obsahuje základní úvod k návrhu a provozu funkce aktualizovatelné nápovědy PowerShellu. Je určená pro autory modulů a další uživatele, kteří uživatelům poskytují témata nápovědy windows PowerShellu.

Úvod

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

Funkce Aktualizovatelná nápověda, která byla představena ve Windows PowerShellu 3.0, zajišťuje, aby uživatelé měli na příkazovém řádku nejnovější verze témat nápovědy, a to i pro integrované příkazy PowerShellu, aniž by museli stahovat nové moduly nebo spouštět windows Update. Aktualizovatelná nápověda usnadňuje aktualizaci tím, že poskytuje rutiny, které stáhnou nejnovější verze témat nápovědy z internetu a nainstalují je do správných podadresářů na místním počítači uživatele. I uživatelé, kteří jsou za branami firewall, můžou pomocí nových rutin získat aktualizovanou nápovědu z interní sdílené složky.

Aktualizovatelná nápověda je plně podporovaná všemi moduly Windows PowerShellu ve Windows 8 a Windows Serveru 2012 a její funkce jsou k dispozici všem autorům modulů Windows PowerShellu. Aktualizovatelná nápověda podporuje pouze soubory nápovědy založené na JAZYCE XML. Nepodporuje nápovědu založenou na komentářích.

Aktualizovatelná nápověda obsahuje následující funkce.

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

• Rutina Save-Help, která stáhne nejnovější soubory nápovědy z internetu a uloží je do adresáře systému souborů. Uživatelé můžou pomocí rutiny Update-Help získat soubory nápovědy z adresáře systému souborů a rozbalit je a nainstalovat do podadresářů modulu na počítač uživatele. Rutina Save-Help je určená pro uživatele, kteří mají omezený nebo žádný přístup k internetu, a pro podniky, které dávají přednost omezení přístupu k internetu.

• nápovědy k modulu. Soubory nápovědy pro modul se spravují a doručují jako jednotka, takže uživatelé můžou získat všechny soubory nápovědy pro moduly, které používají. Aktualizovatelná nápověda je podporovaná jenom pro moduly, ne pro moduly prostředí Windows PowerShell.

• podpora verze. Aktualizovatelná nápověda používá standardní čtyři pozice (N1. N2. N3. N4) čísla verzí. Aktualizovatelná nápověda stáhne soubory nápovědy, pokud je číslo verze souborů nápovědy v počítači uživatele (nebo v adresáři Save-Help) nižší než číslo verze souborů nápovědy na internetu.

• podpora více jazyků. Aktualizovatelná nápověda podporuje soubory nápovědy k modulům v několika jazykových verzích uživatelského rozhraní. Aktualizovatelné názvy souborů nápovědy zahrnují standardní kódy jazyka, napříkladen-USaja-JPa rutiny Update-Help a Save-Help umístí soubory nápovědy do podadresářů modulu specifických pro jazyk.

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

• Rozšířená online nápověda. Snadný přístup k online nápovědě už nevyžaduje soubory nápovědy. Parametr Online rutiny Get-Help teď získá adresu URL online tématu nápovědy z hodnoty vlastnosti HelpUri libovolného příkazu, pokud v souboru nápovědy nenajde adresu URL online nápovědy. Vlastnost helpuri můžete naplnit přidáním atributu HelpUri kódu rutin, funkcí a příkazů CIM nebo použitím klíčového slova nápovědy založené na .LINK komentářů v pracovních postupech a skriptech.

  Aby byly naše soubory nápovědy aktualizovatelné, moduly Windows PowerShellu ve Windows nepřicházejí se soubory nápovědy. Uživatelé můžou použít aktualizovatelnou nápovědu k instalaci souborů nápovědy a jejich aktualizaci. Autoři jiných modulů můžou do modulů zahrnout soubory nápovědy nebo je vynechat. Podpora aktualizovatelné nápovědy je volitelná, ale doporučuje se.