Sympa::ListDef(3Sympa)

NAME
Sympa::ListDef - Definition of list configuration parameters

DESCRIPTION
This module keeps definition of configuration parameters for each list.

  Global variable

%pinfo
    This hash COMPLETELY defines ALL list parameters. It is then used to load, save, view, edit list config files.

    List parameters format accepts the following keywords :

    format
        Regexp aplied to the configuration file entry; some common regexps are defined in Sympa::Regexps.

        If the parameter is paragraph, value of this item is a hashref containing definitions of sub-parameters.

    file_format
        Config file format of the parameter might not be the same in memory.

    split_char
        Character used to separate multiple parameters.

    length
        Length of a scalar variable ; used in web forms.

    scenario
        Tells that the parameter is a scenario, providing its name.

    default
        Default value for the param ; may be a robot configuration parameter (conf).

    synonym
        Defines synonyms for parameter values (for compatibility reasons).

    gettext_unit
        Unit of the parameter ; this is used in web forms and refers to translated strings in NLS catalogs.

    occurrence
        Occurrence of the parameter in the config file possible values: "0-1", 1, "0-n" and "1-n". Example: A list may have multiple owner.

    gettext_id
        Title reference in NLS catalogs.

    gettext_comment
        Deescription text of a parameter.

    group
        Group of parameters.

    obsolete
        Obsolete parameter ; should not be displayed nor saved.

    obsolete_values
        Defined obsolete values for a parameter. These values should not get proposed on the web interface edition form.

    order
        Order of parameters within paragraph.

    internal
        Indicates that the parameter is an internal parameter that should always be saved in the config file.

    field_type
        Used to select passwords web input type.

@param_order
    XXX

SEE ALSO
config(5).