en-AU/PSDocs-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSDocumentHeader</command:name> <command:verb>Get</command:verb> <command:noun>PSDocumentHeader</command:noun> <maml:description> <maml:para>Get the Yaml header from a PSDocs generated markdown file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Yaml header from a PSDocs generated markdown file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSDocumentHeader</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="FullName"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to a specific markdown file or a parent directory containing one or more markdown files. A trailing slash is not required.</maml:para> <maml:para>If a path is not specified the current working path will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="FullName"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to a specific markdown file or a parent directory containing one or more markdown files. A trailing slash is not required.</maml:para> <maml:para>If a path is not specified the current working path will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-PSDocumentHeader -Path '.\build\Default';</dev:code> <dev:remarks> <maml:para>Get the Yaml header for all markdown files in the Default directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PSDocumentHeader -Path '.\build\Default\Server1.md';</dev:code> <dev:remarks> <maml:para>Get the Yaml header for a specific file Server1.md.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-PSDocumentHeader;</dev:code> <dev:remarks> <maml:para>Get the Yaml header for all markdown files in the current working directory.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/BernieWhite/PSDocs/blob/master/docs/commands/PSDocs/en-US/Get-PSDocumentHeader.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-PSDocument</command:name> <command:verb>Invoke</command:verb> <command:noun>PSDocument</command:noun> <maml:description> <maml:para>Create markdown from an input object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create markdown from an input object using a document definition. A document is defined using the `document` keyword.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PSDocument</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>An input object that will be passed to each document and can be referenced within document blocks as `$InputObject`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceName</maml:name> <maml:Description> <maml:para>The name of the resulting markdown file. During execution of this command, the variable `$InstanceName` will be available within the document definition for use by expressions.</maml:para> <maml:para>If InstanceName is not specified the name of the document definition will be used instead.</maml:para> <maml:para>If more then one InstanceName is specified, multiple markdown files will be generated in the order they were specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of a specific document definition to use to generate markdown.</maml:para> <maml:para>When this option is used with `-Path`, script files will be executed in order, and document blocks that do not match name are skipped.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>The directory path to store markdown files created based on the specified document template. This path will be automatically created if it doesn't exist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When specified generated markdown will be returned to the pipeline instead of being written to file.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:Description> <maml:para>Additional options that configure document generation. A `PSDocumentOption` can be created by using the `New-PSDocumentOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSDocumentOption</command:parameterValue> <dev:type> <maml:name>PSDocumentOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Encoding</maml:name> <maml:Description> <maml:para>Specifies the file encoding for generated markdown files. By default, UTF-8 without byte order mark (BOM) will be used. To use UTF-8 with BOM specify `UTF8`.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MarkdownEncoding</command:parameterValue> <dev:type> <maml:name>MarkdownEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:Description> <maml:para>One or more culture names when building documents that are localized. i.e. en-AU, en-US</maml:para> <maml:para>When culture names are specified, the generated document will be written to a culture specific subdirectory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-PSDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>A directory path to read document definitions recursively from. Document definitions are discovered within files ending in `.doc.ps1`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>An input object that will be passed to each document and can be referenced within document blocks as `$InputObject`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceName</maml:name> <maml:Description> <maml:para>The name of the resulting markdown file. During execution of this command, the variable `$InstanceName` will be available within the document definition for use by expressions.</maml:para> <maml:para>If InstanceName is not specified the name of the document definition will be used instead.</maml:para> <maml:para>If more then one InstanceName is specified, multiple markdown files will be generated in the order they were specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of a specific document definition to use to generate markdown.</maml:para> <maml:para>When this option is used with `-Path`, script files will be executed in order, and document blocks that do not match name are skipped.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>The directory path to store markdown files created based on the specified document template. This path will be automatically created if it doesn't exist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When specified generated markdown will be returned to the pipeline instead of being written to file.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:Description> <maml:para>Additional options that configure document generation. A `PSDocumentOption` can be created by using the `New-PSDocumentOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSDocumentOption</command:parameterValue> <dev:type> <maml:name>PSDocumentOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Encoding</maml:name> <maml:Description> <maml:para>Specifies the file encoding for generated markdown files. By default, UTF-8 without byte order mark (BOM) will be used. To use UTF-8 with BOM specify `UTF8`.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MarkdownEncoding</command:parameterValue> <dev:type> <maml:name>MarkdownEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>One or more tags that the document definition must contain. If more then one tag is specified, all tags be present on the document definition to be evaluated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:Description> <maml:para>One or more culture names when building documents that are localized. i.e. en-AU, en-US</maml:para> <maml:para>When culture names are specified, the generated document will be written to a culture specific subdirectory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>An input object that will be passed to each document and can be referenced within document blocks as `$InputObject`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceName</maml:name> <maml:Description> <maml:para>The name of the resulting markdown file. During execution of this command, the variable `$InstanceName` will be available within the document definition for use by expressions.</maml:para> <maml:para>If InstanceName is not specified the name of the document definition will be used instead.</maml:para> <maml:para>If more then one InstanceName is specified, multiple markdown files will be generated in the order they were specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of a specific document definition to use to generate markdown.</maml:para> <maml:para>When this option is used with `-Path`, script files will be executed in order, and document blocks that do not match name are skipped.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>The directory path to store markdown files created based on the specified document template. This path will be automatically created if it doesn't exist.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When specified generated markdown will be returned to the pipeline instead of being written to file.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:Description> <maml:para>Additional options that configure document generation. A `PSDocumentOption` can be created by using the `New-PSDocumentOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSDocumentOption</command:parameterValue> <dev:type> <maml:name>PSDocumentOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Encoding</maml:name> <maml:Description> <maml:para>Specifies the file encoding for generated markdown files. By default, UTF-8 without byte order mark (BOM) will be used. To use UTF-8 with BOM specify `UTF8`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MarkdownEncoding</command:parameterValue> <dev:type> <maml:name>MarkdownEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>A directory path to read document definitions recursively from. Document definitions are discovered within files ending in `.doc.ps1`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>One or more tags that the document definition must contain. If more then one tag is specified, all tags be present on the document definition to be evaluated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:Description> <maml:para>One or more culture names when building documents that are localized. i.e. en-AU, en-US</maml:para> <maml:para>When culture names are specified, the generated document will be written to a culture specific subdirectory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Create a new document definition called Sample in sample.doc.ps1 Set-Content -Path .\sample.doc.ps1 -Value @' document Sample { # Add an introduction section Section Introduction { # Add a comment "This is a sample file list from $InputObject" # Generate a table Get-ChildItem -Path $InputObject | Table -Property Name,PSIsContainer } } '@ # Discover document definitions in the current working path (and subdirectories) within .doc.ps1 files Invoke-PSDocument -Path .;</dev:code> <dev:remarks> <maml:para>Create markdown using *.doc.ps1 files loaded from the current working directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Define an inline document called Sample document Sample { # Add an introduction section Section Introduction { # Add a comment "This is a sample file list from $InputObject" # Generate a table Get-ChildItem -Path $InputObject | Table -Property Name,PSIsContainer } } # Calling an inline document definition by name using Invoke-PSDocument is depricated Invoke-PSDocument -Name 'Sample' -InputObject 'C:\'; # This is recommended way to call Sample Sample -InputObject 'C:\';</dev:code> <dev:remarks> <maml:para>Create markdown using the inline documentation definition called Sample using as input 'C:\'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/BernieWhite/PSDocs/blob/master/docs/commands/PSDocs/en-US/Invoke-PSDocument.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSDocumentOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-PSDocumentOption</command:name> <command:verb>New</command:verb> <command:noun>PSDocumentOption</command:noun> <maml:description> <maml:para>Create options to configure document generation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-PSDocumentOption cmdlet creates an options object that can be passed to PSDocs cmdlets to configure document generation behaviour.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PSDocumentOption</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:Description> <maml:para>Additional options that configure document generation. Option also accepts a hashtable to configure options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSDocumentOption</command:parameterValue> <dev:type> <maml:name>PSDocumentOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to a YAML file containing options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\.psdocs.yml</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Encoding</maml:name> <maml:Description> <maml:para>Specifies the file encoding for generated markdown files. By default, UTF-8 without byte order mark (BOM) will be used. To use UTF-8 with BOM specify `UTF8`.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MarkdownEncoding</command:parameterValue> <dev:type> <maml:name>MarkdownEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:Description> <maml:para>Additional options that configure document generation. Option also accepts a hashtable to configure options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSDocumentOption</command:parameterValue> <dev:type> <maml:name>PSDocumentOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to a YAML file containing options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\.psdocs.yml</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Encoding</maml:name> <maml:Description> <maml:para>Specifies the file encoding for generated markdown files. By default, UTF-8 without byte order mark (BOM) will be used. To use UTF-8 with BOM specify `UTF8`.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MarkdownEncoding</command:parameterValue> <dev:type> <maml:name>MarkdownEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSDocs.Configuration.PSDocumentOption</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $option = New-PSDocumentOption -Option @{ 'Markdown.WrapSeparator' = '<br />' }; PS C:\> Invoke-PSDocument -Name 'Sample' -Option $option;</dev:code> <dev:remarks> <maml:para>Create markdown using the Sample documentation definition using a wrap separator of `<br />`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/BernieWhite/PSDocs/blob/master/docs/commands/PSDocs/en-US/New-PSDocumentOption.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-PSDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |