Vytváření aktualizovatelné nápovědy: krok za krokem

V těchto dokumentech jsou uvedené kroky v procesu vytváření aktualizovatelné nápovědy.

Pomoc s vytvářením aktualizovatelného souboru: Podrobný postup

Aktualizovatelná nápověda je určená pro koncové uživatele, ale také přináší významné výhody autorům modulů a autorům nápovědy, včetně možnosti přidávat obsah, opravovat chyby, dodávat více jazykových verzí uživatelského rozhraní a reagovat na komentáře a požadavky uživatelů, a to dlouho po odeslání modulu. Toto téma vysvětluje, jak zabalit a nahrát soubory nápovědy, aby je uživatelé mohli stáhnout a nainstalovat pomocí rutin Update-Help a Save-Help.

Následující kroky poskytují přehled procesu podpory aktualizovatelné nápovědy.

Krok 1: Vyhledání internetového webu pro soubory nápovědy

Prvním krokem při vytváření aktualizovatelné nápovědy je vyhledání umístění na internetu pro soubory nápovědy vašeho modulu. Ve skutečnosti můžete použít dvě různá umístění. Soubor s informacemi nápovědy k modulu (HelpInfo XML – popsaný níže) můžete ponechat v jednom umístění na internetu a soubory CAB s obsahem nápovědy v jiném umístění v internetu. Všechny soubory CAB obsahu nápovědy pro modul musí být ve stejném umístění. Soubory CAB nápovědy pro různé moduly můžete umístit do stejného umístění.

Krok 2: Přidání klíče HelpInfoURI do manifestu modulu

Přidejte do manifestu modulu klíč HelpInfoURI. Hodnota klíče je identifikátor URI (Uniform Resource Identifier) umístění informačního souboru HelpInfo XML pro váš modul. Kvůli zabezpečení musí adresa začínat na "http" nebo "https". Identifikátor URI by měl obsahovat umístění v internetu, ale nesmí obsahovat název souboru HELPInfo XML.

Například:

@{
RootModule = TestModule.psm1
ModuleVersion = '2.0'
HelpInfoURI = 'https://go.microsoft.com/fwlink/?LinkID=0123'
}

Krok 3: Vytvoření souboru HelpInfo XML

Informační soubor HelpInfo XML obsahuje identifikátor URI internetového umístění vašich souborů nápovědy a čísla verzí nejnovějších souborů nápovědy pro váš modul v každé podporované jazykové verzi uživatelského rozhraní. Každý Windows PowerShell obsahuje jeden soubor HelpInfo XML. Při aktualizaci souborů nápovědy upravíte nebo nahradíte soubor HelpInfo XML. nepřidáte další. Další informace najdete v tématu Vytvoření souboru HelpInfo XML.

Krok 4: Vytvoření souborů CAB

Pomocí nástroje, který vytváří soubory CAB ( ), například , vytvořte soubor CAB, který obsahuje soubory .cab MakeCab.exe nápovědy pro váš modul. Vytvořte samostatný soubor CAB pro soubory nápovědy v každé podporované jazykové verzi uživatelského rozhraní. Další informace najdete v tématu Příprava souborů CAB aktualizovatelné nápovědy.

Krok 5: Upload souborů

Pokud chcete publikovat nové nebo aktualizované soubory nápovědy, nahrajte soubory CAB do umístění v internetu, které je určeno elementem HelpContentUri v souboru HelpInfo XML. Potom nahrajte soubor HelpInfo XML do umístění v internetu, které je určeno hodnotou klíče HelpInfoUri v manifestu modulu.