New-MarkdownAboutHelp

  • Reference
Modul:
platyPS

Vygeneruje nový soubor O tématu MD ze šablony.

Syntax

New-MarkdownAboutHelp
   [-OutputFolder] <String>
   [[-AboutName] <String>]
   [<CommonParameters>]

Description

Rutina New-MarkdownAboutHelp vygeneruje soubor Markdown, který je předem vyplněn standardními prvky tématu O produktu. Rutina zkopíruje šablonu MD, přejmenuje hlavičky a název souboru podle parametru AboutName a uloží soubor do adresáře určeného parametrem OutputFoler .

Téma O produktu lze převést do formátu Txt. Témata O musí být ve formátu txt, jinak modul nápovědy PowerShellu nebude moct dokument analyzovat. Pomocí rutiny New-ExternalHelp převeďte soubory Markdown o tématu na soubory txt about topic.

Příklady

Příklad 1

PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test

    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:12 PM           1491 about_TestAboutTopic.md

Vytvoření a zobrazení informací o souboru v PowerShellu o souboru Markdown tématu

Příklad 2

PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test


    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:15 PM           1550 about_TestAboutTopic.help.txt

Vytvořte soubor Txt s informacemi o tématu v PowerShellu z existujícího souboru O markdownu.

Parametry

-AboutName

Název tématu about.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputFolder

Adresář pro vytvoření tématu about v.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

None

Výstupy

Object

Tato rutina vrátí objekt pro vytvořené soubory.

Poznámky

Pokud chcete využít aktualizovatelnou nápovědu, budete muset do souboru CAB přidat témata o tématech.