Partilhar via

New-ExternalHelp

  • Referência
Módulo:
platyPS

Cria um arquivo de ajuda externo com base na marcação suportada pelo PlatyPS.

Sintaxe

New-ExternalHelp
   -Path <String[]>
   -OutputPath <String>
   [-ApplicableTag <String[]>]
   [-Encoding <Encoding>]
   [-MaxAboutWidth <Int32>]
   [-ErrorLogFile <String>]
   [-Force]
   [-ShowProgress]
   [<CommonParameters>]

Description

O cmdlet New-ExternalHelp cria um arquivo de ajuda externo com base em arquivos de ajuda de marcação suportados pelo PlatyPS. Você pode enviar isso com um módulo para fornecer ajuda usando o cmdlet Get-Help.

Se os arquivos de marcação especificados não seguirem oPlatyPS Schema , esse cmdlet retornará mensagens de erro.

Exemplos

Exemplo 1: Criar ajuda externa com base no conteúdo de uma pasta

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US"

    Directory: D:\Working\PlatyPS\out\platyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/19/2016  12:32 PM          46776 platyPS-help.xml

Este comando cria um arquivo de ajuda externo no local especificado. Este comando usa a prática recomendada de que o nome da pasta inclui a localidade.

Exemplo 2: Criar ajuda que usa codificação personalizada

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\PlatyPS\en-US" -Force -Encoding ([System.Text.Encoding]::Unicode)


    Directory: D:\Working\PlatyPS\out\PlatyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:34 PM         132942 platyPS-help.xml

Este comando cria um arquivo de ajuda externo no local especificado. Este comando especifica o parâmetro Force, portanto, ele substitui um arquivo existente. O comando especifica a codificação Unicode para o arquivo criado.

Exemplo 3: Escrever avisos e erros no ficheiro

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US" -ErrorLogFile ".\WarningsAndErrors.json"

    Directory: D:\Working\PlatyPS\out\platyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/19/2016  12:32 PM          46776 platyPS-help.xml

Este comando cria um arquivo de ajuda externo no local especificado. Este comando usa a prática recomendada de que o nome da pasta inclui a localidade. Este comando grava os avisos e erros no arquivo WarningsAndErrors.json.

Parâmetros

-ApplicableTag

Especifique a matriz de tags a ser usada como filtro. Se o cmdlet tiver applicable nos metadados yaml e nenhuma das tags passadas for mencionada lá, o cmdlet será ignorado na ajuda gerada. O mesmo se aplica ao nível de parâmetro applicable metadados yaml. Se applicable for omitido, cmdlet ou parâmetro estará sempre presente. Consulte problema de design para obter mais detalhes.

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

-Encoding

Especifica a codificação de caracteres para o arquivo de ajuda externo. Especifique um objeto System.Text.Encoding. Para obter mais informações, consulte about_Character_Encoding.

Tipo:Encoding
Position:Named
Default value:UTF8 without BOM
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ErrorLogFile

O caminho onde esse cmdlet salva o arquivo de log de resultados formatado.

O caminho deve incluir o local e o nome da pasta e do nome do arquivo com a extensão json. O objeto JSON contém três propriedades: Message, FilePathe Severity (Warning or Error).

Se esse caminho não for fornecido, nenhum log será gerado.

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

-Force

Indica que esse cmdlet substitui um arquivo existente com o mesmo nome.

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

-MaxAboutWidth

Especifica o comprimento máximo da linha ao gerar arquivos de texto de ajuda "sobre". Outros tipos de arquivos de ajuda não são afetados por esse parâmetro. Para obter mais informações, consulte New-MarkdownAboutHelp.

As linhas dentro de blocos de código não são encapsuladas e não são afetadas pelo parâmetro MaxAboutWidth .

Tipo:Int32
Position:Named
Default value:80
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-OutputPath

Especifica o caminho de uma pasta onde esse cmdlet salva seu arquivo de ajuda externo. O nome da pasta deve terminar com uma pasta de localidade, como no exemplo a seguir: .\out\PlatyPS\en-US\.

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

-Path

Especifica uma matriz de caminhos de arquivos ou pastas de marcação. Este cmdlet cria ajuda externa com base nesses arquivos e pastas.

Tipo:String[]
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:True

-ShowProgress

Exiba barras de progresso em analisar arquivos de marcação existentes.

Se isso for usado, a geração de ajuda é muito mais lenta.

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

Entradas

String[]

Você pode canalizar uma matriz de caminhos para esse cmdlet.

Saídas

FileInfo[]

Este cmdlet retorna um objeto FileInfo[] para arquivos criados.