Update-MarkdownModuleFile

Модуль:

Microsoft.PowerShell.PlatyPS Module

Обновляет файл модуля Markdown.

Синтаксис

path

Update-MarkdownModuleFile
    [-Path] <string>
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

literalpath

Update-MarkdownModuleFile
    [-CommandHelp] <CommandHelp[]>
    -LiteralPath <string>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Этот командлет обновляет файл модуля Markdown с CommandHelp сведения об объекте, импортированные из файлов команд Markdown.

Примеры

Пример 1. Обновление файла модуля из новых файлов справки команд

$mdfiles = Measure-PlatyPSMarkdown -Path .\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Update-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md

Параметры

-CommandHelp

Объекты CommandHelp для экспорта. Объект CommandHelp можно передать в конвейере или с помощью этого параметра.

Свойства параметров

Тип:	Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	1
Обязательно:	True
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	cf

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Encoding

Кодировка, используемая при написании файла Markdown. Если значение не указано, кодировка по умолчанию соответствует значению переменной предпочтения $OutputEncoding.

Свойства параметров

Тип:	Encoding
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Force

Используйте параметр Force, чтобы перезаписать выходной файл, если он уже существует.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HelpInfoUri

Этот параметр позволяет указать универсальный код ресурса (URI), используемый для поддержки обновления. По умолчанию командлет использует HelpInfoUri, указанный в манифесте модуля.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HelpVersion

Этот параметр позволяет указать версию справки. Значение по умолчанию — 1.0.0.0. Эта версия записывается в файл HelpInfo.xml, который используется для обновления справки.

Свойства параметров

Тип:	Version
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-LiteralPath

Указывает путь к одному или нескольким файлам markdown модуля. Значение LiteralPath используется точно так, как оно введено. Никакие символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки указывают PowerShell на то, что не следует интерпретировать какие-либо символы как управляющие последовательности.

Дополнительную информацию см. в разделе about_Quoting_Rules.

Свойства параметров

Тип:	String
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	PSPath, LP

Наборы параметров

literalpath

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Locale

Этот параметр позволяет указать языковой стандарт для файлов справки. По умолчанию командлет использует текущий CultureInfo. Используйте командлет Get-Culture для просмотра текущих параметров языка и региональных параметров в системе.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Metadata

Метаданные, добавляемые в интерфейсный файл markdown. Метаданные — это хэш-список, в котором указываются пары "ключ и значение", добавляемые в frontmatter. Новые имена ключей добавляются в существующий интерфейсный элемент. Значения существующих ключей перезаписываются. Нельзя перезаписать значения ключей document type или PlatyPS schema version. Если эти ключи присутствуют в хэш-таблицы, командлет игнорирует значения и выводит предупреждение.

Свойства параметров

Тип:	Hashtable
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-NoBackup

По умолчанию командлет создает резервную копию исходного файла Markdown перед обновлением. Используйте этот параметр для подавления создания файла резервной копии.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Path

Указывает путь к одному или нескольким файлам markdown модуля.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

path

Position:	0
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WhatIf

Выполняет команду в режиме, который сообщает только о том, что произойдет, без выполнения действий.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	wi

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Выходные данные

FileInfo

Связанные ссылки

• New-MarkdownModuleFile