PSUnidecode

1.0.0

en-US/PSUnidecode-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>ConvertFrom-Unicode</command:name>

      <command:verb>ConvertFrom</command:verb>

      <command:noun>Unicode</command:noun>

      <maml:description>

        <maml:para>Convert any Unicode data (string) to its ASCII equivalent.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>ConvertFrom-Unicode checks the input char by char and tries the conversion to an ASCII equivalent char if possible. The length of the input and output can differ, as chars can be discarded if they fall e.g. under the unicode private range.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>ConvertFrom-Unicode</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:Description>

            <maml:para>Data to be converted to ASCII</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Char[]</command:parameterValue>

          <dev:type>

            <maml:name>Char[]</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>DACH</maml:name>

          <maml:Description>

            <maml:para>Specifies if a conversion by the standard of Germany/Switzerland/Austria is desired. This changes the behavior from e.g. ä-&gt;a to ä-&gt;ae.</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>RemoveNonAlphabeticChars</maml:name>

          <maml:Description>

            <maml:para>Removes any character from the converted output not being an alphabetic char.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none">

        <maml:name>InputObject</maml:name>

        <maml:Description>

          <maml:para>Data to be converted to ASCII</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Char[]</command:parameterValue>

        <dev:type>

          <maml:name>Char[]</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>DACH</maml:name>

        <maml:Description>

          <maml:para>Specifies if a conversion by the standard of Germany/Switzerland/Austria is desired. This changes the behavior from e.g. ä-&gt;a to ä-&gt;ae.</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>RemoveNonAlphabeticChars</maml:name>

        <maml:Description>

          <maml:para>Removes any character from the converted output not being an alphabetic char.</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:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>Use with care. No guarantees of functionality are made. If you want to specify custom behavior, just alter the files underneath /lib.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>ConvertFrom-Unicode -InputObject "Testä__"</dev:code>

        <dev:remarks>

          <maml:para>Testa__</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>

        <dev:code>ConvertFrom-Unicode -InputObject "Testä__" -RemoveNonAlphabeticChars</dev:code>

        <dev:remarks>

          <maml:para>Testa</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>

        <dev:code>ConvertFrom-Unicode -InputObject "Testä__" -DACH -RemoveNonAlphabeticChars</dev:code>

        <dev:remarks>

          <maml:para>Testae</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>