Update-MarkdownHelpModule

Ссылка

Модуль:: platyPS

Обновите все файлы в папке модуля справки Markdown.

Синтаксис

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

Описание

Командлет Update-MarkdownHelpModule обновляет существующие файлы Markdown справки и создает файлы Markdown для новых командлетов в модуле. Этот командлет объединяет функции командлетов Update-MarkdownHelp и New-MarkdownHelp для выполнения массового обновления.

Примеры

Пример 1. Обновление модуля справки Markdown

PS C:\> Update-MarkdownHelpModule -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

Эта команда обновляет все файлы в указанной папке на основе командлетов, загруженных в текущий сеанс. Команда создает разделы справки Markdown для всех командлетов, которые еще не включены в папку .\docs.

Параметры

-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 . Подробные сведения см. в статье О шифровании символов.

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

-ExcludeDontShow

Исключите параметры, помеченные в DontShow атрибуте parameter, из содержимого справки.

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

-ModulePagePath

Если по умолчанию используется параметр -RefreshModulePage, MD-файл помещается в то же расположение, что и все другие документы. С помощью этого параметра можно указать новое имя или расположение, чтобы улучшить варианты размещения.

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

-Path

Задает массив путей к обновляемым папкам Markdown. Папка должна содержать страницу модуля, с которой этот командлет может получить имя модуля.

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

-RefreshModulePage

Страница обновления модуля при обновлении модуля справки.

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

-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 не использовался.

Поделиться через