Convert-XliffToBcDevComments

1.1.0.0

Convert-XliffToBcDevComments.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="https://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10">
    <command:details>
      <command:name>Get-XliffTranslation</command:name>
      <maml:description>
        <maml:para>Retrieves the translations from one or more XLIFF files.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>XliffTranslation</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Retrieves the translations from one or more XLIFF files.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-XliffTranslation</maml:name>
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" variableLength="true">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>One or more XLIFF files to process. May also contain one or more directories to search for XLIFF files.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
          <dev:type>
            <maml:name>System.String[]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>Recurse</maml:name>
          <maml:description>
            <maml:para>If -Path contains directories, specifies whether to also search subdirectories.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" variableLength="true">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>One or more XLIFF files to process. May also contain one or more directories to search for XLIFF files.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
        <dev:type>
          <maml:name>System.String[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>Recurse</maml:name>
        <maml:description>
          <maml:para>If -Path contains directories, specifies whether to also search subdirectories.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples />
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10">
    <command:details>
      <command:name>New-XliffTranslation</command:name>
      <maml:description>
        <maml:para>Creates a user-defined translation entry.</maml:para>
      </maml:description>
      <command:verb>New</command:verb>
      <command:noun>XliffTranslation</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Creates a user-defined translation entry.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-XliffTranslation</maml:name>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>XliffPath</maml:name>
          <maml:description>
            <maml:para>Path to the XLIFF file</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>SourceLanguage</maml:name>
          <maml:description>
            <maml:para>Source language for the translation; defaults to 'en-US'</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>TargetLanguage</maml:name>
          <maml:description>
            <maml:para>Target language for the translation</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>ID</maml:name>
          <maml:description>
            <maml:para>Unique ID for the translation</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>Source</maml:name>
          <maml:description>
            <maml:para>Source text for the translation</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>Target</maml:name>
          <maml:description>
            <maml:para>Target text for the translation</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>TargetState</maml:name>
          <maml:description>
            <maml:para>State of the translation target text</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">Final|NeedsAdaptation|NeedsLocalization|NeedsReviewAdaptation|NeedsReviewLocalization|NeedsReviewTranslation|NeedsTranslation|New|SignedOff|Translated</command:parameterValue>
          <dev:type>
            <maml:name>System.Nullable`1[[ConvertXliffToBcDevComments.TranslationState, Convert-XliffToBcDevComments, Version=1.1.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>Context</maml:name>
          <maml:description>
            <maml:para>Context for the translation</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>XliffPath</maml:name>
        <maml:description>
          <maml:para>Path to the XLIFF file</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>SourceLanguage</maml:name>
        <maml:description>
          <maml:para>Source language for the translation; defaults to 'en-US'</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>TargetLanguage</maml:name>
        <maml:description>
          <maml:para>Target language for the translation</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>ID</maml:name>
        <maml:description>
          <maml:para>Unique ID for the translation</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>Source</maml:name>
        <maml:description>
          <maml:para>Source text for the translation</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>Target</maml:name>
        <maml:description>
          <maml:para>Target text for the translation</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>TargetState</maml:name>
        <maml:description>
          <maml:para>State of the translation target text</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">Final|NeedsAdaptation|NeedsLocalization|NeedsReviewAdaptation|NeedsReviewLocalization|NeedsReviewTranslation|NeedsTranslation|New|SignedOff|Translated</command:parameterValue>
        <dev:type>
          <maml:name>System.Nullable`1[[ConvertXliffToBcDevComments.TranslationState, Convert-XliffToBcDevComments, Version=1.1.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>Context</maml:name>
        <maml:description>
          <maml:para>Context for the translation</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples />
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10">
    <command:details>
      <command:name>Remove-XliffTranslation</command:name>
      <maml:description>
        <maml:para>Removes translations from their respective translation files.</maml:para>
      </maml:description>
      <command:verb>Remove</command:verb>
      <command:noun>XliffTranslation</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Removes translations from their respective translation files.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Remove-XliffTranslation</maml:name>
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" variableLength="true">
          <maml:name>InputObject</maml:name>
          <maml:description>
            <maml:para>Translation to remove</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">XliffTranslation[]</command:parameterValue>
          <dev:type>
            <maml:name>ConvertXliffToBcDevComments.XliffTranslation[]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" variableLength="true">
        <maml:name>InputObject</maml:name>
        <maml:description>
          <maml:para>Translation to remove</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">XliffTranslation[]</command:parameterValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues />
    <command:examples />
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10">
    <command:details>
      <command:name>Set-XliffTranslationAsBcDevComment</command:name>
      <maml:description>
        <maml:para>Adds translations to AL objects (as developer comments in label properties).</maml:para>
      </maml:description>
      <command:verb>Set</command:verb>
      <command:noun>XliffTranslationAsBcDevComment</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Adds translations to AL objects (as developer comments in label properties).</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Set-XliffTranslationAsBcDevComment</maml:name>
        <command:parameter required="true" globbing="false" pipelineInput="false" position="1" variableLength="true">
          <maml:name>ObjectPath</maml:name>
          <maml:description>
            <maml:para>Path of the AL object file to update. May also contain one or more directories to search for AL objects.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
          <dev:type>
            <maml:name>System.String[]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>Recurse</maml:name>
          <maml:description>
            <maml:para>If -Path contains directories, specifies whether to also search subdirectories.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" variableLength="true">
          <maml:name>Translations</maml:name>
          <maml:description>
            <maml:para>One or more descriptions as retrieved using Get-XliffTranslation or created using New-XliffTranslation</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">XliffTranslation[]</command:parameterValue>
          <dev:type>
            <maml:name>ConvertXliffToBcDevComments.XliffTranslation[]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="true">
          <maml:name>StateToProcess</maml:name>
          <maml:description>
            <maml:para>Translation target states to convert to AL developer comments; other states will be ignored</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">TranslationState[]</command:parameterValue>
          <dev:type>
            <maml:name>ConvertXliffToBcDevComments.TranslationState[]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="true">
          <maml:name>StateToEmit</maml:name>
          <maml:description>
            <maml:para>Translation target states that will be emitted after processing.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">TranslationState[]</command:parameterValue>
          <dev:type>
            <maml:name>ConvertXliffToBcDevComments.TranslationState[]</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Overwrite developer comments if they already exist</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
          <maml:name>PassThru</maml:name>
          <maml:description>
            <maml:para>Output the translations that match the -StateToEmit filter to the PowerShell pipeline</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" globbing="false" pipelineInput="false" position="1" variableLength="true">
        <maml:name>ObjectPath</maml:name>
        <maml:description>
          <maml:para>Path of the AL object file to update. May also contain one or more directories to search for AL objects.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
        <dev:type>
          <maml:name>System.String[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>Recurse</maml:name>
        <maml:description>
          <maml:para>If -Path contains directories, specifies whether to also search subdirectories.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" variableLength="true">
        <maml:name>Translations</maml:name>
        <maml:description>
          <maml:para>One or more descriptions as retrieved using Get-XliffTranslation or created using New-XliffTranslation</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">XliffTranslation[]</command:parameterValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="true">
        <maml:name>StateToProcess</maml:name>
        <maml:description>
          <maml:para>Translation target states to convert to AL developer comments; other states will be ignored</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">TranslationState[]</command:parameterValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.TranslationState[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="true">
        <maml:name>StateToEmit</maml:name>
        <maml:description>
          <maml:para>Translation target states that will be emitted after processing.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">TranslationState[]</command:parameterValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.TranslationState[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>Force</maml:name>
        <maml:description>
          <maml:para>Overwrite developer comments if they already exist</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" variableLength="false">
        <maml:name>PassThru</maml:name>
        <maml:description>
          <maml:para>Output the translations that match the -StateToEmit filter to the PowerShell pipeline</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation[]</maml:name>
          <maml:uri />
        </dev:type>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>ConvertXliffToBcDevComments.XliffTranslation</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>--------------------------- Example ----------------------------</maml:title>
        <maml:introduction>
          <maml:para>Read translations from test.nl-NL.xlf, (where possible) add developer comments to AL objects in (subfolders of) ./test, and removes the applied translations from the translation (xliff) file.</maml:para>
        </maml:introduction>
        <dev:code>Get-XliffTranslation -Path './Translations/test.nl-NL.xlf'| Set-XliffTranslationAsBcDevComment -ObjectPath ./test -Recurse -PassThru| Remove-XliffTranslation</dev:code>
        <maml:remarks>
          <maml:para />
        </maml:remarks>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>