Partilhar via

New-MarkdownAboutHelp

  • Referência
Módulo:
platyPS

Gera um novo arquivo About Topic MD a partir do modelo.

Sintaxe

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

Description

O cmdlet New-MarkdownAboutHelp gera um arquivo Markdown que é pré-preenchido com os elementos padrão de um Tópico Sobre. O cmdlet copia o modelo MD, renomeia cabeçalhos e nome de arquivo de acordo com o parâmetro AboutName e deposita o arquivo no diretório designado pelo parâmetro OutputFolder.

O tópico Sobre pode ser convertido para o formato Txt. Os tópicos sobre devem estar no formato txt ou o mecanismo de Ajuda do PowerShell não poderá analisar o documento. Use o cmdlet New-ExternalHelp para converter arquivos de marcação About Topic em arquivos txt About Topic.

Exemplos

Exemplo 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

Crie e exiba informações de arquivo para o PowerShell Sobre o arquivo de marcação de tópico.

Exemplo 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

Crie o arquivo PowerShell About Topic Txt a partir do arquivo Markdown About existente.

Parâmetros

-AboutName

O nome do tópico sobre.

Tipo:String
Position:1
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-OutputFolder

O diretório para criar o tópico sobre.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

None

Saídas

Object

Este cmdlet retorna um objeto para arquivos criados.

Notas

Os tópicos sobre precisarão ser adicionados a um arquivo cab para aproveitar a ajuda atualizável.