Scroll to navigation

Sympa::ListDef(3Sympa) sympa 6.2.16 Sympa::ListDef(3Sympa)

NAME

Sympa::ListDef - Definition of list configuration parameters

DESCRIPTION

This module keeps definition of configuration parameters for each list.

Global variable

%alias
Deprecated by Sympa 6.2.16.
%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 :

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.

Config file format of the parameter might not be the same in memory.
Character used to separate multiple parameters.
Length of a scalar variable ; used in web forms.
Tells that the parameter is a scenario, providing its name.
Default value for the param ; may be a robot configuration parameter (conf).
Defines synonyms for parameter values (for compatibility reasons).
Unit of the parameter ; this is used in web forms and refers to translated strings in NLS catalogs.
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.
Title reference in NLS catalogs.
Deescription text of a parameter.
Group of parameters.
Obsolete parameter ; should not be displayed nor saved.

As of 6.2.16, if the value is true value and is not 1, defines parameter alias name mainly for backward compatibility.

Defined obsolete values for a parameter. These values should not get proposed on the web interface edition form.
Order of parameters within paragraph.
Indicates that the parameter is an internal parameter that should always be saved in the config file.
Used to select passwords web input type.

SEE ALSO

config(5).

HISTORY

Sympa::ListDef was separated from List module on Sympa 6.2.

2016-11-25 6.2.16