[Name] ENCODING

[Description] ENCODING provides a drop down widget that contains the list of character encodings.
              The configuration is a list of one or more <value> options, each of which can take
              the following form:

              1. A wildcard pattern (e.g. "*", "utf-*") : Selects a list of the
                 predefined encodings whose short name matches the given pattern
                 The "predefined encodings" are listed in the file "encodings.db"
                 in the FME install directory. For each line, the first column is
                 the short name and the second column is a long description of the encoding
            

              2. A literal encoding name understood by the system (preferably
                 one of the standard IANA names (see http://www.iana.org/assignments/character-sets/character-sets.xml)) 
                 or one of the two fme specific encoding values: fme-binary & fme-system.

              3. A comma-separated list of the form <encodingName>,<description>,
                 where <description> is a human-readable description.
 

              4. a sentinel value indicating the encoding comes from an external location. For
                 example, httpCaller has an option <Auto Detect From HTTP Headers> to detect the
                 encoding based on the http header.

              Generally, OPTIONAL should not be used with this parameter type.  The user should always specify
              an encoding or unexpected behavior can occur between operating systems.
 
              A default value of fme-authoring-system will be replaced with the operating
              system encoding when the fmf/fmx/etc is read in.

In a Transformer (*.fmx) File

   Syntax
      PARAMETER_NAME: <macroName>
      PARAMETER_TYPE: ENCODING <value>[%<value>]*
      PARAMETER_PROMPT: <label>
      PARAMETER_DEFAULT: [<defaultValue>]

   Example
      1. Just allow selection from the predefined set of encodings:
      PARAMETER_NAME: ENCODING_NAME
      PARAMETER_TYPE: ENCODING *
      PARAMETER_PROMPT: Select encoding:
      PARAMETER_DEFAULT:
      

      2. Only allow Unicode encodings:
      PARAMETER_NAME: ENCODING_NAME
      PARAMETER_TYPE: ENCODING utf-*
      PARAMETER_PROMPT: Select encoding:
      PARAMETER_DEFAULT:
      

      3. Allow the standard examples, in addition to ISO646-CN:
      PARAMETER_NAME: ENCODING_NAME
      PARAMETER_TYPE: ENCODING *%ISO646-CN
      PARAMETER_PROMPT: Select encoding:
      PARAMETER_DEFAULT:
      

      4. Allow the standard examples, in addition to ISO646-CN, which will show up in the menu with
      the name "cn": 
      PARAMETER_NAME: ENCODING_NAME 
      PARAMETER_TYPE: ENCODING *%ISO646-CN,cn 
      PARAMETER_PROMPT: Select encoding: 
      PARAMETER_DEFAULT:
     

      5. Use sentinel value for 'auto detect' from a http header
      PARAMETER_NAME: TARGET_ATTR_ENCODING
      PARAMETER_TYPE: ENCODING \"<Auto Detect from HTTP Headers>\",auto-detect%Binary,fme-binary%\"System Default\",fme-system%-----%* 
      PARAMETER_PROMPT:Response Body Encoding: 
      PARAMETER_DEFAULT: auto-detect

In a Reader/Writer (*.fmf, *.fmi) File

   Syntax
   
      [DEFAULT_VALUE <macroName> <defaultValue>]
      GUI ENCODING <macroName> <value>[%<value>]* <label>
   

   Example

      1. Just allow selection from the predefined set of encodings:
      GUI ENCODING MACRO_NAME * Select encoding:

      2. Only allow Unicode encodings:
      GUI ENCODING MACRO_NAME utf-* Select encoding:
      

      3. Allow the standard examples, in addition to ISO646-CN:
      GUI ENCODING MACRO_NAME *%ISO646-CN Select encoding:
      

      4. Allow the standard examples, in addition to ISO646-CN, which will show up in the menu with the name "cn": GUI ENCODING MACRO_NAME *%ISO646-CN,cn Select encoding: