Merge-MarkdownHelp
Fusionnez plusieurs versions markdown de la même applet de commande dans un seul fichier markdown.
Syntaxe
Default (Par défaut)
Merge-MarkdownHelp
[-Path] <String[]>
[-OutputPath] <String>
[-Encoding <Encoding>]
[-ExplicitApplicableIfAll]
[-Force]
[[-MergeMarker] <String>]
[<CommonParameters>]
Description
Les modules similaires, ou différentes versions 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 champ de métadonnées yaml applicable: pour identifier les versions ou 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 balises applicable: ainsi que tout le contenu des fichiers markdown d’origine.
Le contenu en double est simplement ignoré.
Le contenu unique à chaque fichier est fusionné à l’aide de marqueurs de fusion, suivi d’une liste séparée par des virgules de balises applicables.
Un marqueur de fusion est une chaîne de texte qui agit comme un marqueur pour décrire le contenu fusionné.
Le marqueur de fusion par défaut texte 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 à 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.
Propriétés du paramètre
| Type: | Encoding |
| Valeur par défaut: | UTF8 without BOM |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Force
Indique que cette applet de commande remplace un fichier existant portant le même nom.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-MergeMarker
Chaîne à utiliser comme indicateur de texte de fusion. La liste des balises applicable est incluse après le marqueur
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | !!! |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 3 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-OutputPath
Spécifie le chemin du dossier dans lequel cette applet de commande crée les fichiers d’aide markdown combinés.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 1 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Path
Spécifie un tableau de chemins d’accès de fichiers ou de dossiers Markdown. Cette applet de commande crée une aide markdown combinée basée sur ces fichiers et dossiers.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
