-
-
Notifications
You must be signed in to change notification settings - Fork 4
Save MAML
Saves a Module's MAML
Generates a Module's MAML file, and then saves it to the appropriate location.
Save-Maml -Module HelpOut
Save-Maml -Module HelpOut -WhatIf
Save-Maml -Module HelpOut -PassThru
The name of one or more modules.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[String[]] |
false | named | true (ByPropertyName) |
If set, the generated MAML will be compact (no extra whitespace or indentation). If not set, the MAML will be indented.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If provided, will save the MAML to a different directory than the current UI culture.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[CultureInfo] |
false | named | true (ByPropertyName) |
If set, the generate MAML will not contain a version number.
This slightly reduces the size of the MAML file, and reduces the rate of changes in the MAML file.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[Switch] |
false | named | false |
If set, will return the files that were generated.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[Switch] |
false | named | false |
-WhatIf is an automatic variable that is created when a command has [CmdletBinding(SupportsShouldProcess)]
.
-WhatIf is used to see what would happen, or return operations without executing them
-Confirm is an automatic variable that is created when a command has [CmdletBinding(SupportsShouldProcess)]
.
-Confirm is used to -Confirm each operation.
If you pass ```-Confirm:$false``` you will not be prompted.
If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.
System.Nullable
Save-MAML [-Compact] [-Culture <CultureInfo>] [-NoVersion] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Save-MAML [-Module <String[]>] [-Compact] [-Culture <CultureInfo>] [-NoVersion] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Adding a footer
Testing if custom sidebar overrides automatic