Jak vytvořit soubor nápovědy rutiny

Tato část popisuje, jak vytvořit platný soubor XML, který obsahuje obsah pro témata nápovědy k rutinám Windows PowerShell. Tato část popisuje, jak pojmenovat soubor nápovědy, jak přidat odpovídající hlavičky XML a jak přidat uzly, které budou obsahovat různé části obsahu nápovědy rutiny.

Poznámka

Pokud chcete zobrazit úplný soubor nápovědy, otevřete jeden ze dll-Help.xml souborů umístěných v instalačním adresáři Windows PowerShell. Soubor například Microsoft.PowerShell.Commands.Management.dll-Help.xml obsahuje obsah pro několik rutin PowerShellu.

Vytvoření souboru nápovědy rutiny

1. Vytvořte textový soubor a uložte ho pomocí kódování UTF8. Název souboru musí mít následující formát, aby ho Windows PowerShell mohl rozpoznat jako soubor nápovědy rutiny.

   <PSSnapInAssemblyName>.dll-Help.xml

2. Do textového souboru přidejte následující záhlaví XML. Mějte na paměti, že soubor se ověří ve schématu MAML (Microsoft Assistance Markup Language). PowerShell v současné době neposkytuje žádné nástroje k ověření souboru.

   <?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml">

3. Přidání příkazového uzlu do souboru nápovědy rutiny pro každou rutinu v sestavení Každý uzel v rámci příkazového uzlu se vztahuje k různým oddílům tématu nápovědy rutiny.

   Následující tabulka uvádí element XML pro každý uzel a popis jednotlivých uzlů.

   Uzel	Description
   <details>	Přidá obsah pro oddíly NAME a SYNOPSIS tématu nápovědy rutiny. Další informace naleznete v tématu Přidání názvu rutiny a synopsis.
   <maml:description>	Přidá obsah pro část POPIS tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání podrobného popisu.
   <command:syntax>	Přidá obsah pro část SYNTAXe tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání syntaxe.
   <command:parameters>	Přidá obsah pro část PARAMETRY tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání parametrů.
   <command:inputTypes>	Přidá obsah pro část VSTUPy tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání vstupních typů.
   <command:returnValues>	Přidá obsah pro část VÝSTUPY tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání návratových hodnot.
   <maml:alertset>	Přidá obsah pro oddíl POZNÁMKy tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání poznámek.
   <command:examples>	Přidá obsah pro část PŘÍKLADY tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání příkladů.
   <maml:relatedLinks>	Přidá obsah pro část SOUVISEJÍCÍ ODKAZy tématu nápovědy rutiny. Další informace naleznete v tématu Nápovědy rutiny k přidání souvisejících odkazů.

Příklad

Tady je příklad příkazového uzlu, který obsahuje uzly pro různé části tématu nápovědy rutiny.

<command:command
  xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
  xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
  xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  <command:details>
    <!--Add name and synopsis here-->
  </command:details>
  <maml:description>
    <!--Add detailed description here-->
  </maml:description>
  <command:syntax>
    <!--Add syntax information here-->
  </command:syntax>
  <command:parameters>
    <!--Add parameter information here-->
  </command:parameters>
  <command:inputTypes>
    <!--Add input type information here-->
  </command:inputTypes>
  <command:returnValues>
    <!--Add return value information here-->
  </command:returnValues>
  <maml:alertSet>
    <!--Add Note information here-->
  </maml:alertSet>
  <command:examples>
    <!--Add cmdlet examples here-->
  </command:examples>
  <maml:relatedLinks>
    <!--Add links to related content here-->
  </maml:relatedLinks>
</command:command>

Viz také

Přidání názvu rutiny a synopsis

Přidání podrobného popisu do tématu nápovědy rutiny

Jak přidat syntaxi do tématu nápovědy rutiny

Přidání parametrů do tématu nápovědy rutiny

Jak přidat typy vstupů do tématu nápovědy rutiny

Jak přidat vrácené hodnoty do tématu nápovědy rutiny

Přidání poznámek do tématu nápovědy rutiny

Jak přidat příklady do tématu nápovědy rutiny

Jak přidat související odkazy do tématu nápovědy rutiny

Sada SDK Windows PowerShellu