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 contengono spesso contenuto duplicato.

Merge-MarkdownHelp unisce più file markdown in un unico file markdown. Usa il campo dei metadati yaml applicable: 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 tag applicable: 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 marcatore di unione è costituito da tre punti esclamativi !! tuttavia questo può 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 troverà 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.

Tipo:	Encoding
Posizione:	Named
Valore predefinito:	UTF8 without BOM
Necessario:	False
Accettare l'input della pipeline:	False
Accettare caratteri jolly:	False

-ExplicitApplicableIfAll

Scrivi 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.

Tipo:	SwitchParameter
Posizione:	Named
Valore predefinito:	None
Necessario:	False
Accettare l'input della pipeline:	False
Accettare caratteri jolly:	False

-Force

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

Tipo:	SwitchParameter
Posizione:	Named
Valore predefinito:	None
Necessario:	False
Accettare l'input della pipeline:	False
Accettare caratteri jolly:	False

-MergeMarker

Stringa da utilizzare come indicatore di testo unione. L'elenco di tag applicabile verrà incluso dopo il marcatore

Tipo:	String
Posizione:	3
Valore predefinito:	'!!! '
Necessario:	False
Accettare l'input della pipeline:	False
Accettare caratteri jolly:	False

-OutputPath

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

Tipo:	String
Posizione:	1
Valore predefinito:	None
Necessario:	True
Accettare l'input della pipeline:	False
Accettare caratteri jolly:	False

-Path

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

Tipo:	String[]
Posizione:	0
Valore predefinito:	None
Necessario:	True
Accettare l'input della pipeline:	True
Accettare caratteri jolly:	True

Input

String[]

Output

FileInfo[]

Condividi tramite