Update-MarkdownHelp
Обновление файлов справки PlatyPS Markdown.
Синтаксис
Default (по умолчанию)
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
Описание
Командлет Update-MarkdownHelp обновляет файлы справки PlatyPS markdown без полной замены содержимого файлов.
Некоторые атрибуты параметров изменяются с течением времени. Например, наборы параметров, типы, значение по умолчанию и обязательные. Этот командлет обновляет markdown, чтобы отразить эти изменения. Он также добавляет текст заполнителя в файл markdown для любого нового параметра.
Чтобы распространить изменения в файлы справки markdown, сделайте следующее:
- Загрузите новую версию модуля в сеанс Windows PowerShell.
- Выполните командлет
Update-MarkdownHelp, чтобы обновить файлы. - Проверьте новые метаданные параметров в файлах markdown.
Примеры
Пример 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
Эта команда обновляет все файлы справки Markdown в указанном пути, чтобы соответствовать текущим командлетам.
Пример 2. Обновление одного файла и журнала записи
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. Он записывает данные журнала в файл markdown.log.
Параметры
-AlphabeticParamsOrder
Упорядочивание параметров в алфавитном порядке по имени в разделе PARAMETERS. Существует 5 исключений: -Confirm, -WhatIf, -IncludeTotalCount, -Skipи параметры -First будут последними. Эти параметры являются общими и поэтому имеют четко определенное поведение.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Encoding
Задает кодировку символов для внешнего файла справки. Укажите объект System.Text.Encoding. Дополнительные сведения см. в about_Character_Encoding.
Свойства параметра
| Тип: | Encoding |
| Default value: | UTF8 without BOM |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ExcludeDontShow
Исключите параметры, помеченные DontShow в атрибуте параметра из содержимого справки.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Удаление файлов справки, которые больше не существуют в сеансах (например, если функция была удалена)
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LogAppend
Указывает, что этот командлет добавляет сведения в журнал, а не перезаписывает его.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LogPath
Указывает путь к файлу для сведений журнала. Командлет записывает поток VERBOSE в журнал. Если указать параметр verbose, этот командлет также записывает эти сведения в консоль.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 2 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Path
Задает массив путей к файлам и папкам markdown для обновления.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | True |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Session
Предоставляет поддержку удаленных команд. Передайте сеанс, который использовался для создания команд с Import-PSSession. Это необходимо для получения точных метаданных параметров из удаленного сеанса.
Свойства параметра
| Тип: | PSSession |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-UpdateInputOutput
Обновляет раздел входных и выходных данных, чтобы отразить текущее состояние командлета. ПРЕДУПРЕЖДЕНИЕ. Этот параметр удаляет любые дополнения вручную к этим разделам.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-UseFullTypeName
Указывает, что целевой документ будет использовать полное имя типа вместо короткого имени для параметров.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
Входные данные
String
Вы можете передать массив путей к этому командлету.
Выходные данные
FileInfo
Этот командлет возвращает объект FileInfo[] для обновленных файлов.
Примечания
Модуль, для которого необходимо обновить справку, сначала следует импортировать из расположения, содержащего предыдущую версию справки. Если это условие не выполнено, порядок параметров будет алфавитным в обновленной справке, даже если параметр AlphabeticParamsOrder не использовался.
