Update-MarkdownHelp

リファレンス

モジュール:: platyPS

PlatyPS マークダウンヘルプファイルを更新します。

構文

Update-MarkdownHelp
      [-Path] <String[]>
      [[-Encoding] <Encoding>]
      [[-LogPath] <String>]
      [-LogAppend]
      [-AlphabeticParamsOrder]
      [-UseFullTypeName]
      [-UpdateInputOutput]
      [-Force]
      [-Session <PSSession>]
      [-ExcludeDontShow]
      [<CommonParameters>]

説明

コマンドレットは Update-MarkdownHelp 、ファイルの内容を完全に置き換えることなく PlatyPS マークダウンヘルプファイルを更新します。

一部のパラメーター属性は、時間の経過と伴って変化します。たとえば、パラメーターセット、型、既定値、必須などです。このコマンドレットは、マークダウンヘルプを更新して、これらの変更を反映します。また、新しいパラメーターのマークダウンファイルにプレースホルダーテキストを追加します。

マークダウンヘルプファイルに変更を反映するには、次の操作を行います。

モジュールの新しいバージョンをWindows PowerShell セッションに読み込みます。
コマンドレットを Update-MarkdownHelp 実行してファイルを更新します。
マークダウンファイル内の新しいパラメーターメタデータを確認します。

例

例 1: フォルダー内のすべてのファイルを更新する

PS C:\> Update-MarkdownHelp -Path ".\docs"

    Directory: D:\working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

このコマンドは、指定したパス内のすべてのマークダウンヘルプファイルを現在のコマンドレットと一致するように更新します。

例 2: 1 つのファイルを更新し、ログをキャプチャする

PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"

    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   8:20 PM           9993 New-MarkdownHelp.md

このコマンドは、マークダウンヘルプファイルを更新します。ログ情報がファイルに markdown.log 書き込まれます。

パラメーター

-AlphabeticParamsOrder

PARAMETERS セクションで、名前でアルファベット順にパラメーターを並べ替えます。 5 つの例外があります。-Confirm、、-WhatIf-IncludeTotalCount-Skipおよび -First パラメーターは最後になります。これらのパラメーターは一般的であるため、動作が明確に定義されています。

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

-Encoding

外部ヘルプファイルの文字エンコードを指定します。 System.Text.Encoding オブジェクトを指定します。詳細については、「about_Character_Encoding」をご覧ください。

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

-ExcludeDontShow

パラメーター属性でで DontShow マークされたパラメーターをヘルプコンテンツから除外します。

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

-Force

セッション内に存在しなくなったヘルプファイルを削除する (関数が削除された場合など)

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

-LogAppend

このコマンドレットがログに情報を追加して上書きすることを示します。

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

-LogPath

ログ情報のファイルパスを指定します。コマンドレットは、VERBOSE ストリームをログに書き込みます。 Verbose パラメーターを指定した場合、このコマンドレットは、その情報もコンソールに書き込みます。

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

-Path

更新するマークダウンファイルとフォルダーのパスの配列を指定します。

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

-Session

リモートコマンドのサポートを提供します。を使用してコマンドを作成するために使用したセッションを Import-PSSession渡します。これは、リモートセッションから正確なパラメーターメタデータを取得するために必要です。

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

-UpdateInputOutput

コマンドレットの現在の状態を反映するように、[入力] セクションと [出力] セクションを更新します。警告: このパラメーターは、これらのセクションに手動で追加した内容を削除します。

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

-UseFullTypeName

ターゲットドキュメントで、パラメーターに短い名前ではなく完全な型名を使用することを示します。

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

入力

String[]

パスの配列をこのコマンドレットにパイプできます。

出力

FileInfo[]

このコマンドレットは、更新されたファイルの FileInfo[] オブジェクトを返します。

メモ

ヘルプを更新するモジュールは、最初に、以前のバージョンのヘルプを含む場所からインポートする必要があります。この条件が満たされない場合、パラメーター AlphabeticParamsOrder が使用されていない場合でも、更新されたヘルプのパラメーターの順序はアルファベット順になります。

次の方法で共有