Compartir a través de

New-ExternalHelp

  • Referencia
Módulo:
platyPS

Crea un archivo de ayuda externo basado en Markdown compatible con PlatyPS.

Syntax

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

Description

El New-ExternalHelp cmdlet crea un archivo de ayuda externo basado en los archivos de ayuda de Markdown admitidos por PlatyPS. Puede enviarlo con un módulo para proporcionar ayuda con el Get-Help cmdlet .

Si los archivos markdown especificados no siguen el esquema PlatyPS, este cmdlet devuelve mensajes de error.

Ejemplos

Ejemplo 1: Crear ayuda externa basada en el contenido de una carpeta

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 crea un archivo de ayuda externo en la ubicación especificada. Este comando usa el procedimiento recomendado que el nombre de la carpeta incluye la configuración regional.

Ejemplo 2: Crear ayuda que use la codificación 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 crea un archivo de ayuda externo en la ubicación especificada. Este comando especifica el parámetro Force , por lo tanto, sobrescribe un archivo existente. El comando especifica la codificación Unicode para el archivo creado.

Ejemplo 3: Escritura de advertencias y errores en el archivo

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 crea un archivo de ayuda externo en la ubicación especificada. Este comando usa el procedimiento recomendado que el nombre de la carpeta incluye la configuración regional. Este comando escribe las advertencias y errores en el archivo WarningsAndErrors.json.

Parámetros

-ApplicableTag

Especifique la matriz de etiquetas que se usará como filtro. Si el cmdlet tiene applicable en los metadatos yaml y no se menciona ninguna de las etiquetas pasadas, el cmdlet se omitiría en la ayuda generada. Lo mismo se aplica a los metadatos yaml de nivel de parámetro applicable . Si applicable se omite, el cmdlet o el parámetro siempre estarán presentes. Consulte el problema de diseño para obtener más detalles.

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

-Encoding

Especifica la codificación de caracteres para el archivo de ayuda externo. Especifique un objeto System.Text.Encoding . Para obtener más información, vea Acerca de la codificación de caracteres.

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

-ErrorLogFile

Ruta de acceso donde este cmdlet guardará el archivo de registro de resultados con formato.

La ruta de acceso debe incluir la ubicación y el nombre de la carpeta y el nombre de archivo con la extensión json. El objeto JSON contiene tres propiedades: Message, FilePath y Severity (Advertencia o Error).

Si no se proporciona esta ruta de acceso, no se genera ningún registro.

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

-Force

Indica que este cmdlet sobrescribe un archivo existente que tiene el mismo nombre.

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

-MaxAboutWidth

Especifica la longitud máxima de línea al generar archivos de texto de ayuda "about". Otros tipos de archivo de ayuda no se ven afectados por este parámetro. Para obtener más información, vea New-MarkdownAboutHelp.

Las líneas dentro de los bloques de código no se encapsulan y no se ven afectadas por el parámetro MaxAboutWidth .

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

-OutputPath

Especifica la ruta de acceso de una carpeta donde este cmdlet guarda el archivo de ayuda externo. El nombre de la carpeta debe terminar con una carpeta de configuración regional, como en el ejemplo siguiente: .\out\PlatyPS\en-US\.

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

-Path

Especifica una matriz de rutas de acceso de archivos o carpetas markdown. Este cmdlet crea ayuda externa basada en estos archivos y carpetas.

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

-ShowProgress

Muestra las barras de progreso en el análisis de los archivos markdown existentes.

Si esto se usa para generar ayuda es mucho más lento.

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

Entradas

String[]

Puede canalizar una matriz de rutas de acceso a este cmdlet.

Salidas

FileInfo[]

Este cmdlet devuelve un FileInfo[] objeto para los archivos creados.