Merge-MarkdownHelp

Riferimento

Modulo:: platyPS

Unire più versioni markdown dello stesso cmdlet in un singolo file markdown.

Sintassi

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

Descrizione

Moduli simili o versioni diverse dello stesso modulo, spesso contengono contenuto duplicato.

Merge-MarkdownHelp unire più file markdown in un singolo file markdown. Usa il applicable: campo dei metadati yaml per identificare le versioni o i tag applicabili. Agisce su due livelli: per l'intero cmdlet e per i singoli parametri.

Il markdown risultante contiene i applicable: tag e tutto il contenuto dei file markdown originali. Il contenuto duplicato viene semplicemente ignorato. Il contenuto univoco per ogni file viene unito usando marcatori di unione, seguito da un elenco delimitato da virgole di tag applicabili. Un marcatore di unione è una stringa di testo che funge da marcatore per descrivere il contenuto unito. Il testo predefinito dell'indicatore di unione è costituito da tre punti esclamativi !! può tuttavia essere modificato in qualsiasi testo pertinente usando il flag -MergeMarker .

Esempio

Esempio 1

Il cmdlet Test-CsPhoneBootstrap.md è incluso sia in Lync Server 2010 che in Lync Server 2013. Gran parte del contenuto viene duplicato e quindi si vuole avere un singolo file per il cmdlet con contenuto univoco unito da ogni singolo file.

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

Il file risultante si trova in lync\Test-CsPhoneBootstrap.md.

Parametri

-Encoding

Specifica la codifica dei caratteri per il file della Guida esterna. Specificare un oggetto System.Text.Encoding . Per altre informazioni, vedere about_Character_Encoding.

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

-ExplicitApplicableIfAll

Scrivere sempre l'elenco completo dei tag applicabili. Per impostazione predefinita, i cmdlet e i parametri presenti in tutte le varianti non ottengono un tag dell'applicazione.

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

-Force

Indica che questo cmdlet sovrascrive un file esistente con lo stesso nome.

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

-MergeMarker

Stringa da usare come indicatore di testo di tipo merge. L'elenco di tag applicabile verrà incluso dopo il marcatore

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

-OutputPath

Specifica il percorso della cartella in cui questo cmdlet crea i file della Guida markdown combinati.

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

-Path

Specifica una matrice di percorsi di file o cartelle markdown. Questo cmdlet crea una guida markdown combinata in base a questi file e cartelle.

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

Input

String[]

Output

FileInfo[]

Condividi tramite