Merge-MarkdownHelp

Référence

Module:: platyPS

Fusionnez plusieurs versions markdown de la même applet de commande dans un seul fichier markdown.

Syntax

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

Description

Des modules similaires, ou des versions différentes du même module, contiennent souvent du contenu en double.

Merge-MarkdownHelp fusionne les fichiers markdown multiples en un seul fichier markdown. Il utilise le applicable: champ de métadonnées yaml pour identifier les versions ou les balises applicables. Il agit sur deux niveaux : pour l’ensemble de l’applet de commande et pour les paramètres individuels.

Le markdown résultant contient les applicable: balises ainsi que tout le contenu des fichiers markdown d’origine. Le contenu en double est simplement ignoré. Le contenu qui est unique à chaque fichier est fusionné à l’aide de marqueurs de fusion, suivi d’une liste séparée par des virgules des balises applicables. Un marqueur de fusion est une chaîne de texte qui agit comme un marqueur pour décrire le contenu qui a été fusionné. Le texte du marqueur de fusion par défaut se compose de trois points d’exclamation !! toutefois, cela peut être modifié en n’importe quel texte pertinent à l’aide de l’indicateur -MergeMarker .

Exemples

Exemple 1

L’applet de commande Test-CsPhoneBootstrap.md est incluse dans Lync Server 2010 et Lync Server 2013. Une grande partie du contenu est dupliquée et nous voulons donc avoir un seul fichier pour l’applet de commande avec du contenu unique fusionné à partir de chaque fichier individuel.

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

Le fichier résultant se trouve dans lync\Test-CsPhoneBootstrap.md.

Paramètres

-Encoding

Spécifie l’encodage de caractères pour votre fichier d’aide externe. Spécifiez un objet System.Text.Encoding . Pour plus d’informations, consultez about_Character_Encoding.

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

-ExplicitApplicableIfAll

Écrivez toujours la liste complète des balises applicables. Par défaut, les applets de commande et les paramètres présents dans toutes les variantes n’obtiennent pas de balise d’application.

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

-Force

Indique que cette applet de commande remplace un fichier existant portant le même nom.

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

-MergeMarker

Chaîne à utiliser comme indicateur de texte de fusion. La liste de balises applicable est incluse après le marqueur

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

-OutputPath

Spécifie le chemin du dossier dans lequel cette applet de commande crée les fichiers d’aide markdown combinés.

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

-Path

Spécifie un tableau de chemins d’accès de fichiers ou dossiers markdown. Cette applet de commande crée une aide markdown combinée basée sur ces fichiers et dossiers.

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

Entrées

String[]

Sorties

FileInfo[]

Partager via