New-MarkdownHelp

Referencia

Módulo:: platyPS

Crea ayuda en formato Markdown.

Syntax

New-MarkdownHelp
   -Module <String[]>
   [-Session <PSSession>]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-WithModulePage]
   [-ModulePagePath <String>]
   [-Locale <String>]
   [-HelpVersion <String>]
   [-FwLink <String>]
   [-ExcludeDontShow]
   [<CommonParameters>]

New-MarkdownHelp
   -Command <String[]>
   [-Session <PSSession>]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   [-OnlineVersionUrl <String>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-ExcludeDontShow]
   [<CommonParameters>]

New-MarkdownHelp
   -MamlFile <String[]>
   [-ConvertNotesToList]
   [-ConvertDoubleDashLists]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-WithModulePage]
   [-ModulePagePath <String>]
   [-Locale <String>]
   [-HelpVersion <String>]
   [-FwLink <String>]
   [-ModuleName <String>]
   [-ModuleGuid <String>]
   [-ExcludeDontShow]
   [<CommonParameters>]

Description

El New-MarkdownHelp cmdlet crea ayuda en formato markdown basado en un módulo, un comando o un archivo en formato de lenguaje de marcado de asistencia de Microsoft (MAML).

Ejemplos

Ejemplo 1: Creación de ayuda a partir de un comando

PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"


    Directory: D:\Working\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:53 PM            664 Command03.md

El primer comando crea una función denominada Command03 con la sintaxis estándar Windows PowerShell.

El segundo comando crea ayuda para esa función de código auxiliar en la carpeta .\docs.

Ejemplo 2: Creación de ayuda a partir de un módulo

PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force


    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

El primer comando carga el módulo PlatyPS en la sesión actual mediante el Import-Module cmdlet .

El segundo comando crea ayuda para todos los cmdlets del módulo PlatyPS. Los almacena en la .\docs carpeta . Este comando especifica el parámetro Force . Por lo tanto, sobrescribe los archivos markdown de ayuda existentes que tienen el mismo nombre.

Ejemplo 3: Crear ayuda a partir de un archivo MAML existente

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'

    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:56 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:56 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM          15320 Set-PSReadLineOption.md

Este comando crea ayuda en formato Markdown para el archivo MAML de ayuda especificado. No es necesario cargar el módulo, como en el ejemplo anterior. Si el módulo ya está cargado, este comando crea ayuda basada en el archivo MAML, no en el módulo instalado actualmente.

Ejemplo 4: Crear ayuda a partir de un archivo MAML existente para su uso en un archivo CAB

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage  -Force -ModuleName "PSReadLine"


    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:59 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:59 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM          15320 Set-PSReadLineOption.md
-a----        5/22/2016   6:59 PM            942 PSReadLine.md

Este comando crea ayuda en formato Markdown para el archivo MAML de ayuda especificado, como en el ejemplo anterior. Este comando también especifica el parámetro WithModulePage y el parámetro ModuleName . El comando crea un archivo denominado PSReadLine.md que contiene vínculos a los demás archivos markdown de este módulo y metadatos que se pueden usar para crear .cab archivos.

Parámetros

-AlphabeticParamsOrder

Ordene los parámetros alfabéticamente por nombre en la sección PARAMETERS. Hay 5 excepciones: -Confirm, -WhatIf, -IncludeTotalCount, -Skipy -First los parámetros serán los últimos. Estos parámetros son comunes y, por tanto, tienen un comportamiento bien definido.

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

-Command

Especifica el nombre de un comando en la sesión actual. Puede ser cualquier comando compatible con la ayuda de PowerShell, como un cmdlet o una función.

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

-ConvertDoubleDashLists

Indica que este cmdlet convierte viñetas de lista de guiones dobles en viñetas de guion único. Las listas de guiones dobles son comunes en Windows PowerShell documentación. Markdown acepta guiones únicos para las listas.

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

-ConvertNotesToList

Indica que este cmdlet da formato a varios elementos de párrafo en la sección NOTES como elementos de lista únicos.

Type:	SwitchParameter
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

-ExcludeDontShow

Excluya los parámetros marcados con DontShow en el atributo parameter del contenido de ayuda.

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

-Force

Indica que este cmdlet sobrescribe los archivos existentes que tienen los mismos nombres.

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

-FwLink

Especifica el vínculo de reenvío de la página del módulo. Este valor es necesario para la .cab creación de archivos. Este valor se usa como metadatos de encabezado markdown en la página del módulo.

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

-HelpVersion

Especifica la versión de la ayuda. Este valor es necesario para la .cab creación de archivos. Este valor se usa como metadatos de encabezado markdown en la página del módulo.

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

-Locale

Especifica la configuración regional de la ayuda. Este valor es necesario para .cab creación de archivos. Este valor se usa como metadatos de encabezado markdown en la página del módulo.

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

-MamlFile

Especifica una matriz de rutas de acceso de ruta de acceso de los archivos de ayuda MAML .xml .

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

-Metadata

Especifica los metadatos que este cmdlet incluye en los archivos markdown de ayuda como una tabla hash de pares clave-valor de cadena a sting. Este cmdlet escribe los metadatos en el encabezado de cada archivo de ayuda de Markdown.

El New-ExternalHelp cmdlet no usa estos metadatos. Las herramientas externas pueden usar estos metadatos.

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

-Module

Especifica una matriz de nombres de módulos para los que este cmdlet crea ayuda en formato Markdown.

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

-ModuleGuid

Especifica el GUID del módulo de ayuda. Este valor es necesario para la .cab creación de archivos. Este valor se usa como metadatos de encabezado markdown en la página del módulo.

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

-ModuleName

Especifica el nombre del módulo de ayuda. Este valor es necesario para la .cab creación de archivos. Este valor se usa como metadatos de encabezado markdown en la página del módulo.

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

-ModulePagePath

Cuando el parámetro WithModule se usa de forma predeterminada, coloca el archivo .md en la misma ubicación que el resto de documentos. Con este parámetro, puede especificar un nuevo nombre o ubicación que proporcione mejores opciones de selección de ubicación.

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

-NoMetadata

Indica que este cmdlet no escribe ningún metadato en el markdown generado.

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

-OnlineVersionUrl

Especifica la dirección en la que la función de ayuda actualizable descarga la ayuda actualizada. Si no especifica un valor, el cmdlet usa una cadena vacía.

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

-OutputFolder

Especifica la ruta de acceso de la carpeta donde este cmdlet crea los archivos de ayuda de Markdown.

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

-Session

Proporciona compatibilidad con comandos remotos. Pase la sesión que usó para crear los comandos con Import-PSSession. Esto es necesario para obtener metadatos precisos de parámetros de la sesión remota.

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

-UseFullTypeName

Indica que el documento de destino usará un nombre de tipo completo en lugar de un nombre corto para los parámetros.

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

-WithModulePage

Indica que este cmdlet crea una página de módulo en la carpeta de salida. Este archivo tiene el nombre que especifica el parámetro ModuleName . Si no especificó ese parámetro, el cmdlet proporciona el nombre MamlModulepredeterminado . Puede sobrescribir esta configuración mediante ModulePagePath , lo que le permite definir una ruta de acceso diferente para la página del módulo.

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

Entradas

String[]

Puede canalizar los nombres de módulo a este cmdlet. Estos son los módulos desde los que este cmdlet crea ayuda a Markdown.

Salidas

FileInfo[]

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

Compartir a través de