Update-MarkdownHelp

Referencia

Módulo:: platyPS

Actualice los archivos de ayuda de PlatyPS Markdown.

Syntax

Update-MarkdownHelp
      [-Path] <String[]>
      [[-Encoding] <Encoding>]
      [[-LogPath] <String>]
      [-LogAppend]
      [-AlphabeticParamsOrder]
      [-UseFullTypeName]
      [-UpdateInputOutput]
      [-Force]
      [-Session <PSSession>]
      [-ExcludeDontShow]
      [<CommonParameters>]

Description

El Update-MarkdownHelp cmdlet actualiza los archivos de ayuda de PlatyPS Markdown sin reemplazar completamente el contenido de los archivos.

Algunos atributos de parámetro cambian con el tiempo. Por ejemplo, conjuntos de parámetros, tipos, valor predeterminado y obligatorios. Este cmdlet actualiza la ayuda de Markdown para reflejar esos cambios. También agrega texto de marcador de posición al archivo markdown para cualquier parámetro nuevo.

Para propagar los cambios a los archivos de ayuda de Markdown, haga lo siguiente:

Cargue la nueva versión del módulo en la sesión de Windows PowerShell.
Ejecute el Update-MarkdownHelp cmdlet para actualizar los archivos.
Compruebe los nuevos metadatos de parámetros en los archivos markdown.

Ejemplos

Ejemplo 1: Actualizar todos los archivos de una carpeta

PS C:\> Update-MarkdownHelp -Path ".\docs"

    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

Este comando actualiza todos los archivos de ayuda de Markdown de la ruta de acceso especificada para que coincidan con los cmdlets actuales.

Ejemplo 2: Actualización de un archivo y registro de captura

PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"

    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   8:20 PM           9993 New-MarkdownHelp.md

Este comando actualiza un archivo de ayuda de Markdown. Escribe información de registro en el markdown.log archivo.

Parámetros

-AlphabeticParamsOrder

Ordenar parámetros alfabéticamente por nombre en la sección PARAMETERS. Hay 5 excepciones: -Confirmlos parámetros , -IncludeTotalCount-WhatIf, -Skip, y -First 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

-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:	1
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

Quitar archivos de ayuda que ya no existen dentro de las sesiones (por ejemplo, si se eliminó la función)

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

-LogAppend

Indica que este cmdlet anexa información al registro en su lugar sobrescribiéndolo.

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

-LogPath

Especifica una ruta de acceso de archivo para la información de registro. El cmdlet escribe la secuencia VERBOSE en el registro. Si especifica el parámetro Verbose , este cmdlet también escribe esa información en la consola.

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

-Path

Especifica una matriz de rutas de acceso de archivos y carpetas markdown que se van a actualizar.

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

-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

-UpdateInputOutput

Actualiza la sección Entrada y salida para reflejar el estado actual del cmdlet. ADVERTENCIA: este parámetro quitará las adiciones manuales a estas secciones.

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

Entradas

String[]

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

Salidas

FileInfo[]

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

Notas

El módulo para el que desea actualizar la ayuda debe importarse primero desde la ubicación que contiene la versión anterior de la ayuda. Si no se cumple esta condición, el orden del parámetro será alfabético en la ayuda actualizada, incluso si no se ha usado el parámetro AlphabeticParamsOrder .

Compartir a través de