Merge-MarkdownHelp

Módulo:

platyPS

Combine varias versiones de Markdown del mismo cmdlet en un único archivo markdown.

Syntax

Merge-MarkdownHelp
     [-Path] <String[]>
     [-OutputPath] <String>
     [-Encoding <Encoding>]
     [-ExplicitApplicableIfAll]
     [-Force]
     [[-MergeMarker] <String>]
     [<CommonParameters>]

Description

Los módulos similares o versiones diferentes del mismo módulo suelen contener contenido duplicado.

Merge-MarkdownHelp combina los varios archivos markdown en un único archivo markdown. Usa el applicable: campo de metadatos yaml para identificar qué versiones o etiquetas son aplicables. Actúa en dos niveles: para todo el cmdlet y para parámetros individuales.

El markdown resultante contiene las applicable: etiquetas, así como todo el contenido de los archivos markdown originales. El contenido duplicado simplemente se omite. El contenido que es único para cada archivo se combina mediante marcadores de combinación, seguido de una lista separada por comas de etiquetas aplicables. Un marcador de combinación es una cadena de texto que actúa como marcador para describir el contenido que se combinó. El texto del marcador de combinación predeterminado consta de tres signos de exclamación !! sin embargo, esto se puede cambiar a cualquier texto relevante mediante la marca -MergeMarker .

Ejemplos

Ejemplo 1

El cmdlet Test-CsPhoneBootstrap.md se incluye en Lync Server 2010 y Lync Server 2013. Gran parte del contenido está duplicado y, por tanto, queremos tener un único archivo para el cmdlet con contenido único combinado de cada archivo individual.

Merge-MarkdownHelp -Path @('Lync Server 2010\Test-CsPhoneBootstrap.md', 'Lync Server 2013\Test-CsPhoneBootstrap.md') -OutputPath lync

El archivo resultante se ubicará en lync\Test-CsPhoneBootstrap.md.

Parámetros

-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

-ExplicitApplicableIfAll

Escriba siempre una lista completa de etiquetas aplicables. De forma predeterminada, los cmdlets y parámetros que están presentes en todas las variaciones no obtienen una etiqueta de aplicación.

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

-MergeMarker

Cadena que se va a usar como indicador de texto de combinación. La lista de etiquetas aplicable se incluiría después del marcador.

Type:	String
Position:	3
Default value:	'!!! '
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputPath

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

Type:	String
Position:	1
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 combinada de Markdown en función de estos archivos y carpetas.

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

Entradas

String[]

Salidas

FileInfo[]