cdsa.build.xliffhelper.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: New-XliffDelta --> <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"> <command:details> <command:name>New-XliffDelta</command:name> <command:verb>New</command:verb> <command:noun>XliffDelta</command:noun> <maml:description> <maml:para>Serialize data into a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command receives 2 xliff objects and saves the differences between the 2 of them into a file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>New-XliffDelta</maml:name> <!-- Parameter: SourceXliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceXliffObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetXliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>TargetXliffObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: File --> <command:syntaxItem> <maml:name>New-XliffDelta</maml:name> <!-- Parameter: SourceFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceFileName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>TargetFileName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceXliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceXliffObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetXliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>TargetXliffObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SourceFileName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>TargetFileName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: XliffData --> <command:returnValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$res = New-XliffDelta -SourceFileName $file1 -TargetFileName $file2</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-XliffFile --> <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"> <command:details> <command:name>Import-XliffFile</command:name> <command:verb>Import</command:verb> <command:noun>XliffFile</command:noun> <maml:description> <maml:para>Imports an xliff file into an object</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command imports an xliff file into an object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-XliffFile</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FileName</maml:name> <maml:description> <maml:para>FileName - Path to the xliff file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FileName</maml:name> <maml:description> <maml:para>FileName - Path to the xliff file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: XliffData --> <command:returnValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$xliffObject = Import-XliffFile -FileName $file</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Out-XliffFile --> <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"> <command:details> <command:name>Out-XliffFile</command:name> <command:verb>Out</command:verb> <command:noun>XliffFile</command:noun> <maml:description> <maml:para>Serialize data into a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command receives an xlif object and saves it into a file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Out-XliffFile</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: XliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>XliffObject</maml:name> <maml:description> <maml:para>The object.</maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: XliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>XliffObject</maml:name> <maml:description> <maml:para>The object.</maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$MyObj | Out-XlifFile $file</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Out-XliffFile -XliffObject $MyObj $file</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Out-XliffFile -XliffObject $MyObj -FileName $file</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Out-XliffGridView --> <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"> <command:details> <command:name>Out-XliffGridView</command:name> <command:verb>Out</command:verb> <command:noun>XliffGridView</command:noun> <maml:description> <maml:para>GUI for Xliff file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will open an GUI where you can change the target column for a Xliff file and save it.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: File --> <command:syntaxItem> <maml:name>Out-XliffGridView</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Out-XliffGridView</maml:name> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: XliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>XliffObject</maml:name> <maml:description> <maml:para>The object.</maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: XliffObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>XliffObject</maml:name> <maml:description> <maml:para>The object.</maml:para> </maml:description> <command:parameterValue required="true">XliffData</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>The file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$MyObj | Out-XliffGridView $file</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Out-XliffGridView -XliffObject $MyObj -OutputFile $file</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Out-XliffGridView -FileName $file</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Merge-XliffObjects --> <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"> <command:details> <command:name>Merge-XliffObjects</command:name> <command:verb>Merge</command:verb> <command:noun>XliffObjects</command:noun> <maml:description> <maml:para>Merges multiple xliff objects into one single xliff object</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command merge multiple xliff objects into one single xliff object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Merge-XliffObjects</maml:name> <!-- Parameter: XliffObjects --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>XliffObjects</maml:name> <maml:description> <maml:para>XliffObjects - Array of in-memory xliff objects.</maml:para> </maml:description> <command:parameterValue required="true">XliffData[]</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceLanguage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceLanguage</maml:name> <maml:description> <maml:para>Source Language</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetLanguage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetLanguage</maml:name> <maml:description> <maml:para>Target Language</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: File --> <command:syntaxItem> <maml:name>Merge-XliffObjects</maml:name> <!-- Parameter: XliffFiles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>XliffFiles</maml:name> <maml:description> <maml:para>XliffFiles - Array of string paths to xliff files.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceLanguage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceLanguage</maml:name> <maml:description> <maml:para>Source Language</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetLanguage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetLanguage</maml:name> <maml:description> <maml:para>Target Language</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: XliffObjects --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>XliffObjects</maml:name> <maml:description> <maml:para>XliffObjects - Array of in-memory xliff objects.</maml:para> </maml:description> <command:parameterValue required="true">XliffData[]</command:parameterValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: XliffFiles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>XliffFiles</maml:name> <maml:description> <maml:para>XliffFiles - Array of string paths to xliff files.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceLanguage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceLanguage</maml:name> <maml:description> <maml:para>Source Language</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetLanguage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetLanguage</maml:name> <maml:description> <maml:para>Target Language</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: XliffData --> <command:returnValue> <dev:type> <maml:name>cdsa.build.xliffhelper.core.Models.XliffData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$xliffObject = Merge-XliffObjects -XliffFiles $stringArrayofPaths</dev:code> </command:example> </command:examples> </command:command> </helpItems> |