Jak vytvořit soubor HelpInfo XML

  • Článek

Tato témata v této části vysvětluje, jak vytvořit a naplnit soubor informací nápovědy, který se běžně označuje jako soubor HELPInfo XML, pro funkci aktualizovatelné nápovědy PowerShellu.

Přehled souboru HELPInfo XML

Soubor HelpInfo XML je primárním zdrojem informací o aktualizovatelné nápovědě pro modul. Zahrnuje umístění souborů nápovědy pro moduly, podporované jazykové verze uživatelského rozhraní a čísla verzí, které aktualizovatelná nápověda používá k určení, zda má uživatel nejnovější soubory nápovědy.

Každý modul má pouze jeden soubor HelpInfo XML, i když modul obsahuje více souborů nápovědy pro více jazykových verzí uživatelského rozhraní. Autor modulu vytvoří soubor HelpInfo XML a umístí ho do umístění v internetu, které je určeno klíčem HelpInfoUri v manifestu modulu. Při aktualizaci a nahrání souborů nápovědy modulu autor modulu aktualizuje soubor HelpInfo XML a nahradí původní soubor HelpInfo XML novou verzí.

Je velmi důležité, aby byl soubor HelpInfo XML pečlivě udržován. Pokud nahrajete nové soubory, ale zapomenete zvýšit čísla verzí, aktualizovatelná nápověda nebude nové soubory stahovat do počítačů uživatelů. Pokud přidáte soubory nápovědy pro novou jazykovou verzi uživatelského rozhraní, ale ne aktualizujte soubor HelpInfo XML nebo ho umístěte do správného umístění, aktualizovatelná nápověda nové soubory nestáhne.

V této části

Tato část obsahuje následující témata.

Viz také

Podpora aktualizovatelné nápovědy