Partilhar via

New-ExternalHelp

  • Referência
Módulo:
platyPS

Cria um ficheiro de ajuda externa com base no markdown suportado pelo PlatyPS.

Syntax

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

Description

O New-ExternalHelp cmdlet cria um ficheiro de ajuda externo com base em ficheiros de ajuda markdown suportados pelo PlatyPS. Pode enviar isto com um módulo para fornecer ajuda com o Get-Help cmdlet .

Se os ficheiros markdown que especificar não seguirem o Esquema PlatyPS, este cmdlet devolve 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 ficheiro de ajuda externo na localização especificada. Este comando utiliza a melhor prática de que o nome da pasta inclui a região.

Exemplo 2: criar ajuda que utiliza 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 ficheiro de ajuda externo na localização especificada. Este comando especifica o parâmetro Force , pelo que substitui um ficheiro existente. O comando especifica a codificação Unicode para o ficheiro 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 ficheiro de ajuda externo na localização especificada. Este comando utiliza a melhor prática de que o nome da pasta inclui a região. Este comando escreve os avisos e erros no ficheiro WarningsAndErrors.json.

Parâmetros

-ApplicableTag

Especifique a matriz de etiquetas a utilizar como filtro. Se o cmdlet tiver applicable os metadados do yaml e nenhuma das etiquetas transmitidas for mencionada, o cmdlet será ignorado na ajuda gerada. O mesmo se aplica aos metadados yaml ao nível applicable do parâmetro. Se applicable for omitido, o cmdlet ou parâmetro estará sempre presente. Veja o problema de design para obter mais detalhes.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

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

Type:Encoding
Position:Named
Default value:UTF8 without BOM
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorLogFile

O caminho onde este cmdlet irá guardar o ficheiro de registo de resultados formatados.

O caminho tem de incluir a localização e o nome da pasta e o nome do ficheiro com a extensão json. O objeto JSON contém três propriedades: Mensagem, FilePath e Gravidade (Aviso ou Erro).

Se este caminho não for fornecido, não será gerado nenhum registo.

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

-Force

Indica que este cmdlet substitui um ficheiro existente que tem o mesmo nome.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxAboutWidth

Especifica o comprimento máximo da linha ao gerar ficheiros de texto de ajuda "sobre". Outros tipos de ficheiro de ajuda não são afetados por este parâmetro. Para obter mais informações, veja 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 .

Type:Int32
Position:Named
Default value:80
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputPath

Especifica o caminho de uma pasta onde este cmdlet guarda o ficheiro de ajuda externa. O nome da pasta deve terminar com uma pasta de região, como no exemplo seguinte: .\out\PlatyPS\en-US\.

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

-Path

Especifica uma matriz de caminhos de ficheiros ou pastas markdown. Este cmdlet cria ajuda externa com base nestes ficheiros e pastas.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-ShowProgress

Apresentar barras de progresso em analisar ficheiros markdown existentes.

Se esta opção for utilizada, a geração de ajuda é muito mais lenta.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String[]

Pode encaminhar uma matriz de caminhos para este cmdlet.

Saídas

FileInfo[]

Este cmdlet devolve um FileInfo[] objeto para ficheiros criados.