en-US/rename-me-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>Export-MonikerContent</command:name> <command:verb>Export</command:verb> <command:noun>MonikerContent</command:noun> <maml:description> <maml:para>Exports content from markdown files based on specified moniker conditions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet processes markdown files and extracts content based on the specified moniker range. It uses comparison operators in the moniker range to determine which content to include in the output.</maml:para> <maml:para>The command skips any files that don't have a `.md` extension. The output file are written to the OutputPath location with the target moniker appended to original file name. For example, if the original file is `example.md` and the moniker is `mvc-150`, the output file is named `example_mvc_150.md`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-MonikerContent</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="PSPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path(s) to the markdown files or directories containing markdown files to process. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.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="2" aliases="none"> <maml:name>Moniker</maml:name> <maml:description> <maml:para>The moniker value to filter the content by.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="3" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The folder path where the filtered content will be saved. If not specified, the current directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Moniker</maml:name> <maml:description> <maml:para>The moniker value to filter the content by.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="3" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The folder path where the filtered content will be saved. If not specified, the current directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="PSPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path(s) to the markdown files or directories containing markdown files to process. Wildcards are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.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.String[]</maml:name> </dev:type> <maml:description> <maml:para>You can pipe a collection of strings representing file paths to the Path parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</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>Export-MonikerContent -Path C:\Docs\*.md -Moniker mvc-150 -OutputPath C:\FilteredDocs</dev:code> <dev:remarks> <maml:para>This command processes all markdown files in the `C:\Docs` directory, filters the content based on the moniker `mvc-150`, and saves the output to the `C:\FilteredDocs` directory.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |