Code

Updated core descriptions
authorcajus <cajus@594d385d-05f5-0310-b6e9-bd551577e9d8>
Tue, 30 Nov 2010 08:08:51 +0000 (08:08 +0000)
committercajus <cajus@594d385d-05f5-0310-b6e9-bd551577e9d8>
Tue, 30 Nov 2010 08:08:51 +0000 (08:08 +0000)
git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@20411 594d385d-05f5-0310-b6e9-bd551577e9d8

gosa-core/include/class_core.inc

index 282c0047aa78ecf557c5996043c8e98ba5b23bf4..156606d4d885fbcb45620ed07036fde25d6f3d4e 100644 (file)
@@ -500,7 +500,7 @@ class core extends plugin {
                                 "type"          => "switch",
                                 "default"       => "entryCSN",
                                 "defaults"      => "core::getPropertyValues",
-                                "description"   => _("Specifies the LDAP attribute which is used to detect changes."),
+                                "description"   => _("LDAP attribute which is used to detect changes."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "core",
@@ -522,7 +522,7 @@ class core extends plugin {
                                 "type"          => "switch",
                                 "default"       => "default",
                                 "defaults"      => "core::getPropertyValues",
-                                "description"   => _("Specifies the web theme to be used."),
+                                "description"   => _("CSS and template theme to be used."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "visual",
@@ -542,7 +542,7 @@ class core extends plugin {
                                 "name"          => "templateCompileDirectory",
                                 "type"          => "path",
                                 "default"       => "/var/spool/gosa",
-                                "description"   => _("Specifies the template engine compile directory."),
+                                "description"   => _("Template engine compile directory."),
                                 "check"         => "gosaProperty::isWriteablePath",
                                 "migrate"       => "",
                                 "group"         => "core",
@@ -552,8 +552,9 @@ class core extends plugin {
                                 "name"          => "debugLevel",
                                 "type"          => "integer",
                                 "default"       => 0,
-                                "description"   => sprintf(_("The 'debugLevel' value tells GOsa to display certain information on each page load. Value is an AND combination of the following byte values: %s"),
+                                "description"   => sprintf(_("Logical AND of the integer values below that controls the debug output on every page load: %s"),
 "
+
 DEBUG_TRACE   = 1
 DEBUG_LDAP    = 2
 DEBUG_MYSQL   = 4
@@ -572,7 +573,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "sambaHashHook",
                                 "type"          => "command",
                                 "default"       => "perl -MCrypt::SmbHash -e \"print join(q[:], ntlmgen \\\$ARGV[0]), $/;\"",
-                                "description"   => sprintf(_("The 'sambaHashHook' statement contains an executable to generate samba hash values. This is required for password synchronization, but not required if you apply gosa-si services. If you don't have mkntpasswd from the samba distribution installed, you can use perl to generate the hash: %s"),"perl -MCrypt::SmbHash -e \"print join(q[:], ntlmgen \\\$ARGV[0]), $/;\""),
+                                "description"   => _("Command to create Samba NT/LM hashes. Required for password synchronization if you don't use supplementary services."),
                                 "check"         => "gosaProperty::isCommand",
                                 "migrate"       => "",
                                 "group"         => "samba",
@@ -583,7 +584,7 @@ DEBUG_SI      = 256"),
                                 "type"          => "switch",
                                 "default"       => "crypt/md5",
                                 "defaults"      => "core::getPropertyValues",
-                                "description"   => _("The 'passwordDefaultHash' statement defines the default password hash to choose for new accounts."),
+                                "description"   => _("Default hash to be used for newly created user passwords."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "password",
@@ -592,7 +593,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "strictPasswordRules",
                                 "type"          => "bool",
                                 "default"       => "true",
-                                "description"   => _("The 'strictPasswordRules' tells GOsa to check for UTF-8 characters in the supplied password. These Characters can lead to non working authentications if UTF-8 and none UTF-8 systems locales get mixed. The default is 'true'."),
+                                "description"   => _("Enable checking for the presence of problematic unicode characters in passwords."),
                                 "check"         => "gosaProperty::isBool",
                                 "migrate"       => "",
                                 "group"         => "password",
@@ -603,7 +604,7 @@ DEBUG_SI      = 256"),
                                 "type"          => "switch",
                                 "default"       => "cn",
                                 "defaults"      => "core::getPropertyValues",
-                                "description"   => _("The 'accountPrimaryAttribute' option tells GOsa how to create new accounts. Possible values are 'uid' and 'cn'. In the first case GOsa creates uid style DN entries: 'uid=superuser,ou=staff,dc=example,dc=net'. In the second case, GOsa creates cn style DN entries: 'cn=Foo Bar,ou=staff,dc=example,dc=net'. If you choose \"cn\" to be your 'accountPrimaryAttribute' you can decide whether to include the personal title in your dn by selecting 'personalTitleInDN'."),
+                                "description"   => _("Specify whether 'cn' or 'uid' style user DNs are generated. For more sophisticated control use the 'accountRDN' setting."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "security",
@@ -613,7 +614,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "userRDN",
                                 "type"          => "rdn",
                                 "default"       => "ou=people,",
-                                "description"   => _("The 'userRDN' statement defines the location where new accounts will be created inside of defined departments. The default is 'ou=people'."),
+                                "description"   => _("Location component for user storage inside of departments."),
                                 "check"         => "gosaProperty::isRdn",
                                 "migrate"       => "migrate_userRDN", 
                                 "group"         => "user",
@@ -623,7 +624,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "groupRDN",
                                 "type"          => "rdn",
                                 "default"       => "ou=groups,",
-                                "description"   => _("The 'groupsRDN' statement defines the location where new groups will be created inside of defined departments. The default is 'ou=groups'."),
+                                "description"   => _("Location component for group storage inside of departments."),
                                 "check"         => "gosaProperty::isRdn",
                                 "migrate"       => "migrate_groupRDN",
                                 "group"         => "group",
@@ -633,7 +634,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gidNumberBase",
                                 "type"          => "integer",
                                 "default"       => "1000",
-                                "description"   => _("The 'gidNumberBase' statement defines where to start looking for a new free group id. This should be synced with your 'adduser.conf' to avoid overlapping gidNumber values between local and LDAP based lookups. The gidNumberBase can even be dynamic. Take a look at the 'nextIdHook' definition."),
+                                "description"   => _("Count base for group IDs. For dynamic ID assignment use the 'nextIdHook' setting."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -643,7 +644,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "baseIdHook",
                                 "type"          => "command",
                                 "default"       => "",
-                                "description"   => _("The 'baseIdHook' statement allows to hook into the id generation method (traditional mode), to define the starting range for new generated ids"), 
+                                "description"   => _("Count base for user IDs. For dynamic ID assignment use the 'nextIdHook' setting."),
                                 "check"         => "gosaProperty::isCommand",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -653,7 +654,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gidNumberPoolMin",
                                 "type"          => "integer",
                                 "default"       => 10000,
-                                "description"   => _("The 'uidNumberPoolMin/gidNumberPoolMin' statement defines the lowest assignable user/group id for use with the 'idAllocationMethod = pool'."),
+                                "description"   => _("Lowest assignable group ID for use with the idAllocationMethod set to 'pool'."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -663,7 +664,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gidNumberPoolMax",
                                 "type"          => "integer",
                                 "default"       => 40000,
-                                "description"   => _("The 'uidNumberPoolMax/gidNumberPoolMax' statement defines the highest assignable user/group id for use with the 'idAllocationMethod = pool'."),
+                                "description"   => _("Highest assignable group ID for use with the idAllocationMethod set to 'pool'."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -673,7 +674,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "uidNumberPoolMin",
                                 "type"          => "integer",
                                 "default"       => 10000,
-                                "description"   => _("The 'uidNumberPoolMin/gidNumberPoolMin' statement defines the lowest assignable user/group id for use with the 'idAllocationMethod = pool'."),
+                                "description"   => _("Lowest assignable user ID for use with the idAllocationMethod set to 'pool'."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -683,7 +684,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "uidNumberPoolMax",
                                 "type"          => "integer",
                                 "default"       => 40000,
-                                "description"   => _("The 'uidNumberPoolMax/gidNumberPoolMax' statement defines the highest assignable user/group id for use with the 'idAllocationMethod = pool'."),
+                                "description"   => _("Highest assignable user ID for use with the idAllocationMethod set to 'pool'."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -693,7 +694,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "uidNumberBase",
                                 "type"          => "integer",
                                 "default"       => "1000",
-                                "description"   => _("The 'uidNumberBase' statement defines where to start looking for a new free user id. This should be synced with your 'adduser.conf' to avoid overlapping uidNumber values between local and LDAP based lookups. The uidNumberBase can even be dynamic. Take a look at the 'baseIdHook' definition."),
+                                "description"   => _("Count base for user IDs. For dynamic ID assignment use the 'baseIdHook' setting."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "id",
@@ -703,7 +704,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gosaRpcServer",
                                 "type"          => "string",
                                 "default"       => "",
-                                "description"   => "The server to use for RPC connections! (http://localhost:8080/rpc), Future GOsa-ng service! If this value is set and not empty GOsa will try to establish a connection!",
+                                "description"   => _("Connection URL for use with the gosa-ng service."),
                                 "check"         => "jsonRPC::testConnectionProperties",
                                 "migrate"       => "",
                                 "group"         => "rpc",
@@ -713,7 +714,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gosaRpcUser",
                                 "type"          => "string",
                                 "default"       => "admin",
-                                "description"   => "Ther username to use for RPC connections! Future GOsa-ng service!",
+                                "description"   => _("User name used to connect to the 'gosaRpcServer'."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "rpc",
@@ -723,7 +724,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gosaRpcPassword",
                                 "type"          => "string",
                                 "default"       => "tester",
-                                "description"   => "Ther password to use for RPC connections! Future GOsa-ng service!",
+                                "description"   => _("Password used to connect to the 'gosaRpcServer'."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "rpc",
@@ -733,7 +734,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gosaSupportURI",
                                 "type"          => "string",
                                 "default"       => "",
-                                "description"   => _("The 'gosaSupportURI' defines the major gosa-si server host and the password for GOsa to connect to it. It can be used if you want to use i.e. kerberos to authenticate the users. The format is: credentials@host:port"),
+                                "description"   => _("Connection URI for use with the gosa-si service (obsolete)."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "gosa-si",
@@ -743,7 +744,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "gosaSupportTimeout",
                                 "type"          => "integer",
                                 "default"       => 15,
-                                "description"   => _("The 'gosaSupportTimeout' sets a connection timeout for all gosa-si actions. See 'gosaSupportURI' for details."),
+                                "description"   => _("Number of seconds after a gosa-si connection is considered 'dead'."),
                                 "check"         => "gosaProperty::isInteger",
                                 "migrate"       => "",
                                 "group"         => "gosa-si",
@@ -754,7 +755,7 @@ DEBUG_SI      = 256"),
                                 "type"          => "switch",
                                 "default"       => "uid",
                                 "defaults"      => "core::getPropertyValues",
-                                "description"   => _("The 'loginAttribute' statement tells GOsa which LDAP attribute is used as the login name during login. It can be set to 'uid', 'mail' or 'both'"),
+                                "description"   => _("User attribute which is used for log in."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "security",
@@ -765,7 +766,7 @@ DEBUG_SI      = 256"),
                                 "type"          => "switch",
                                 "default"       => "",
                                 "defaults"      => "core::getPropertyValues",
-                                "description"   => _("The 'timezone' statements defines the timezone used inside of GOsa to handle date related tasks, such as password expiery, vacation messages, etc. The 'timezone' value should be a unix conform timezone value like in /etc/timezone."),
+                                "description"   => _("Local time zone."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "core",
@@ -775,7 +776,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "honourUnitTags",
                                 "type"          => "bool",
                                 "default"       => "false",
-                                "description"   => _("The 'honourUnitTags' statement enables checking of 'unitTag' attributes when using administrative units. If this is set to 'true' GOsa can only see objects inside the administrative unit a user is logged into."),
+                                "description"   => _("Enable tagging of administrative units. This can be used in conjunction with ACLs (obsolete)."),
                                 "check"         => "",
                                 "migrate"       => "",
                                 "group"         => "core",
@@ -785,7 +786,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "useSaslForKerberos",
                                 "type"          => "bool",
                                 "default"       => "false",
-                                "description"   => _("The 'useSaslForKerberos' statement defines the way the kerberos realm is stored in the #userPassword' attribute. Set it to 'true' in order to get {sasl}user@REALM.NET, or to 'false' to get {kerberos}user@REALM.NET. The latter is outdated, but may be needed from time to time."),
+                                "description"   => _("Enable the use of {sasl} instead of {kerberos} for user realms."),
                                 "check"         => "gosaProperty::isBool",
                                 "migrate"       => "",
                                 "group"         => "password",
@@ -795,7 +796,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "rfc2307bis",
                                 "type"          => "bool",
                                 "default"       => "false",
-                                "description"   => _("The 'rfc2307bis' statement enables rfc2307bis style groups in GOsa. You can use 'member' attributes instead of memberUid in this case. To make it work on unix systems, you've to adjust your NSS configuration to use rfc2307bis style groups, too"),
+                                "description"   => _("Enable RFC 2307bis style groups. This combines the use of 'member' and 'memberUid' attributes."),
                                 "check"         => "gosaProperty::isBool",
                                 "migrate"       => "",
                                 "group"         => "core",
@@ -805,7 +806,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "personalTitleInDN",
                                 "type"          => "bool",
                                 "default"       => "false",
-                                "description"   => _("The 'personalTitleInDN' option tells GOsa to include the personal title in user DNs when #accountPrimaryAttribute' is set to \"cn\"."),
+                                "description"   => _("Adjusts the user DN generation to include the users personal title (only in conjunction with accountPrimaryAttribute)."),
                                 "check"         => "gosaProperty::isBool",
                                 "migrate"       => "",
                                 "group"         => "storage location",
@@ -815,6 +816,7 @@ DEBUG_SI      = 256"),
                                 "name"          => "nextIdHook",
                                 "type"          => "command",
                                 "default"       => "",
+                                #TODO: Work starts here...
                                 "description"   => _("The 'nextIdHook' statement defines a script to be called for finding the next free id for users or groups externaly. It gets called with the current entry \"dn\" and the attribute to be ID'd. It should return an integer value."),
                                 "check"         => "gosaProperty::isCommand",
                                 "migrate"       => "",