< Back
Update-MarkdownHelp
Post
NAME Update-MarkdownHelp
SYNOPSIS
Update PlatyPS markdown help files.
SYNTAX
Update-MarkdownHelp [-Path] <String[]> [[-Encoding] <Encoding>] [[-LogPath] <String>] [-LogAppend]
[-AlphabeticParamsOrder] [-UseFullTypeName] [-Session <PSSession>] [-UpdateInputOutput] [-Force]
[-ExcludeDontShow] [<CommonParameters>]
DESCRIPTION
The Update-MarkdownHelp cmdlet updates PlatyPS markdown help files without completely replacing the content of the
files.
Some parameter attributes change over time. For instance, parameter sets, types, default value, and required. This
cmdlet updates markdown help to reflect those changes. It also adds placeholder text to the markdown file for any
new parameter.
To propagate changes to your markdown help files, do the following:
- Load the new version of the module into your Windows PowerShell session.
- Run the Update-MarkdownHelp cmdlet to update the files. - Check new parameters metadata in the markdown files.
PARAMETERS
-Encoding <Encoding>
Specifies the character encoding for your markdown help files. Specify a System.Text.Encoding object. For more
information, see Character Encoding in the .NET Framework
(https://msdn.microsoft.com/en-us/library/ms404377.aspx)in the Microsoft Developer Network. For example, you
can control Byte Order Mark (BOM) preferences. For more information, see Using PowerShell to write a file in
UTF-8 without the BOM
(http://stackoverflow.com/questions/5596 ... ut-the-bom)at the
Stack Overflow community.
Required? false
Position? 1
Default value UTF8 without BOM
Accept pipeline input? False
Accept wildcard characters? false
-LogAppend [<SwitchParameter>]
Indicates that this cmdlet appends information to the log instead overwriting it.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-LogPath <String>
Specifies a file path for log information. The cmdlet writes the VERBOSE stream to the log. If you specify the
Verbose parameter, this cmdlet also writes that information to the console.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies an array of paths of markdown files and folders to update.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-AlphabeticParamsOrder [<SwitchParameter>]
Order parameters alphabetically by name in PARAMETERS section. There are 5 exceptions: -Confirm, -WhatIf,
-IncludeTotalCount, -Skip, and -First parameters will be the last. These parameters are common and hence have
well-defined behavior.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-UseFullTypeName [<SwitchParameter>]
Indicates that the target document will use a full type name instead of a short name for parameters.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Session <PSSession>
Provides support for remote commands. Pass the session that you used to create the commands with
`Import-PSSession`. This is required to get accurate parameters metadata from the remote session.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UpdateInputOutput [<SwitchParameter>]
Refreshes the Input and Output section to reflect the current state of the cmdlet. WARNING: this parameter
will remove any manual additions to these sections.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Remove help files that no longer exists within sessions (for example if function was deleted)
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDontShow [<SwitchParameter>]
Exclude the parameters marked with `DontShow` in the parameter attribute from the help content.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
String[]
You can pipe an array of paths to this cmdlet.
OUTPUTS
System.IO.FileInfo[]
This cmdlet returns a FileInfo[] object for updated files.
NOTES
The module for which you want to update the help should first be imported from the location containing the
previous version of the help. If this condition is not met, the parameter order will be alphabetical in the
updated help, even if the parameter AlphabeticParamsOrder has not been used.
----------- Example 1: Update all files in a folder -----------
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
This command updates all markdown help files in the specified path to match the current cmdlets.
---------- Example 2: Update one file and capture log ----------
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
This command updates a markdown help file. It writes log information to the markdown.log file.
RELATED LINKS
Online Version: https://github.com/PowerShell/platyPS/b ... ownHelp.md
Character Encoding in the .NET Framework https://msdn.microsoft.com/en-us/library/ms404377.aspx
Using PowerShell to write a file in UTF-8 without the BOM
http://stackoverflow.com/questions/5596 ... ut-the-bom
SYNOPSIS
Update PlatyPS markdown help files.
SYNTAX
Update-MarkdownHelp [-Path] <String[]> [[-Encoding] <Encoding>] [[-LogPath] <String>] [-LogAppend]
[-AlphabeticParamsOrder] [-UseFullTypeName] [-Session <PSSession>] [-UpdateInputOutput] [-Force]
[-ExcludeDontShow] [<CommonParameters>]
DESCRIPTION
The Update-MarkdownHelp cmdlet updates PlatyPS markdown help files without completely replacing the content of the
files.
Some parameter attributes change over time. For instance, parameter sets, types, default value, and required. This
cmdlet updates markdown help to reflect those changes. It also adds placeholder text to the markdown file for any
new parameter.
To propagate changes to your markdown help files, do the following:
- Load the new version of the module into your Windows PowerShell session.
- Run the Update-MarkdownHelp cmdlet to update the files. - Check new parameters metadata in the markdown files.
PARAMETERS
-Encoding <Encoding>
Specifies the character encoding for your markdown help files. Specify a System.Text.Encoding object. For more
information, see Character Encoding in the .NET Framework
(https://msdn.microsoft.com/en-us/library/ms404377.aspx)in the Microsoft Developer Network. For example, you
can control Byte Order Mark (BOM) preferences. For more information, see Using PowerShell to write a file in
UTF-8 without the BOM
(http://stackoverflow.com/questions/5596 ... ut-the-bom)at the
Stack Overflow community.
Required? false
Position? 1
Default value UTF8 without BOM
Accept pipeline input? False
Accept wildcard characters? false
-LogAppend [<SwitchParameter>]
Indicates that this cmdlet appends information to the log instead overwriting it.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-LogPath <String>
Specifies a file path for log information. The cmdlet writes the VERBOSE stream to the log. If you specify the
Verbose parameter, this cmdlet also writes that information to the console.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies an array of paths of markdown files and folders to update.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-AlphabeticParamsOrder [<SwitchParameter>]
Order parameters alphabetically by name in PARAMETERS section. There are 5 exceptions: -Confirm, -WhatIf,
-IncludeTotalCount, -Skip, and -First parameters will be the last. These parameters are common and hence have
well-defined behavior.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-UseFullTypeName [<SwitchParameter>]
Indicates that the target document will use a full type name instead of a short name for parameters.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Session <PSSession>
Provides support for remote commands. Pass the session that you used to create the commands with
`Import-PSSession`. This is required to get accurate parameters metadata from the remote session.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UpdateInputOutput [<SwitchParameter>]
Refreshes the Input and Output section to reflect the current state of the cmdlet. WARNING: this parameter
will remove any manual additions to these sections.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Remove help files that no longer exists within sessions (for example if function was deleted)
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDontShow [<SwitchParameter>]
Exclude the parameters marked with `DontShow` in the parameter attribute from the help content.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
String[]
You can pipe an array of paths to this cmdlet.
OUTPUTS
System.IO.FileInfo[]
This cmdlet returns a FileInfo[] object for updated files.
NOTES
The module for which you want to update the help should first be imported from the location containing the
previous version of the help. If this condition is not met, the parameter order will be alphabetical in the
updated help, even if the parameter AlphabeticParamsOrder has not been used.
----------- Example 1: Update all files in a folder -----------
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
This command updates all markdown help files in the specified path to match the current cmdlets.
---------- Example 2: Update one file and capture log ----------
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
This command updates a markdown help file. It writes log information to the markdown.log file.
RELATED LINKS
Online Version: https://github.com/PowerShell/platyPS/b ... ownHelp.md
Character Encoding in the .NET Framework https://msdn.microsoft.com/en-us/library/ms404377.aspx
Using PowerShell to write a file in UTF-8 without the BOM
http://stackoverflow.com/questions/5596 ... ut-the-bom