From 7e5c281adf2575d1e001f954577b932583503820 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sun, 3 Feb 2008 18:37:05 +0000 Subject: [PATCH] no more external help links documented get_help() --- lam/help/help.inc | 99 ++++++++++++++--------------- lam/lib/baseModule.inc | 21 ++++-- lam/lib/modules/sambaAccount.inc | 46 +++++++------- lam/lib/modules/sambaSamAccount.inc | 56 ++++++++-------- lam/templates/help.php | 51 +++++---------- 5 files changed, 131 insertions(+), 142 deletions(-) diff --git a/lam/help/help.inc b/lam/help/help.inc index 006cfb59..8335a847 100644 --- a/lam/help/help.inc +++ b/lam/help/help.inc @@ -54,9 +54,9 @@ $helpArray = array ( // configuration wizard // configuration login // config profile management - "200" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Login"), + "200" => array ("Headline" => _("Configuration wizard") . " - " . _("Login"), "Text" => _("Please enter the configuration password. This is NOT your LDAP password. It is stored in your .conf-file. If this is the first time you log in, enter \"lam\".")), - "201" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Server address"), + "201" => array ("Headline" => _("Configuration wizard") . " - " . _("Server address"), "Text" => _("This is the server address of your LDAP server. Use ldap:// for standard LDAP connections and ldaps:// for encrypted (require server certificates) connections. The port value is optional.") . "

" . _("Examples") . @@ -68,109 +68,109 @@ $helpArray = array ( _("Note") . ":

" . _("When using ldaps:// be sure to use exactly the same IP/domain name as in your certificate!")), - "202" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("LDAP suffix"), + "202" => array ("Headline" => _("Configuration wizard") . " - " . _("LDAP suffix"), "Text" => _("This is the suffix of the LDAP tree from where to search for LDAP entries. Only entries in this subtree will be displayed in the account list. When creating a new accont this will be the DN where it is saved.") . "

". _("Example"). ":

". _("ou=People,dc=yourcompany,dc=com will read and store all accounts in this subtree.")), - "203" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Tree suffix"), + "203" => array ("Headline" => _("Configuration wizard") . " - " . _("Tree suffix"), "Text" => _("This is the suffix for the LDAP tree viewer.") . "

". _("Example"). ":

". _("dc=yourcompany,dc=com")), - "206" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("List attributes"), + "206" => array ("Headline" => _("Configuration wizard") . " - " . _("List attributes"), "Text" => _("This is the list of attributes to show in the account list. The entries can either be predefined values, \"#attribute\", or individual ones, \"attribute:description\". Several entries are separated by semicolons.") . "


" . _("Example") . ": #homeDirectory;#uid;#uidNumber;#gidNumber;mail:Mail address

" . "
" . _("Predefined values") . ":


" . $entry206Example), - "207" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Valid users"), + "207" => array ("Headline" => _("Configuration wizard") . " - " . _("Valid users"), "Text" => _("This is a list of valid DN entries of all users that are allowed to login to LDAP Account Manager. Please enter one DN per line.") . "

" . _("Example") . ": cn=admin,dc=yourdomain,dc=org;cn=manager,dc=yourdomain,dc=org"), - "208" => array ("ext" => "FALSE", "Headline" => _("Maximum list entries"), + "208" => array ("Headline" => _("Maximum list entries"), "Text" => _("This is the number of rows to show in the account list. If more entries are found the list will be split into several pages.")), - "209" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Default language"), + "209" => array ("Headline" => _("Configuration wizard") . " - " . _("Default language"), "Text" => _("This defines the language of the login window and sets this language as the default language. Users can change the language at login.")), - "210" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Script path"), + "210" => array ("Headline" => _("Configuration wizard") . " - " . _("Script path"), "Text" => _("This is the absolute path to an external script for setting quotas and creating home directories.")), - "212" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Change password"), + "212" => array ("Headline" => _("Configuration wizard") . " - " . _("Change password"), "Text" => _("If you want to change the current preferences password, please enter it here.")), - "214" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Cache timeout"), + "214" => array ("Headline" => _("Configuration wizard") . " - " . _("Cache timeout"), "Text" => _("This is the time in minutes which LAM caches its LDAP searches. Shorter times will stress LDAP more but decrease the possibility that changes are not identified.")), - "216" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Text for user PDF"), + "216" => array ("Headline" => _("Configuration wizard") . " - " . _("Text for user PDF"), "Text" => _("This text will appear on top of every user PDF file.")), - "217" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Account types and modules"), + "217" => array ("Headline" => _("Configuration wizard") . " - " . _("Account types and modules"), "Text" => _("Here you can select which plugins you want to use for account management.") . "

" . _("Account types define which sorts of LDAP entries (e.g. users and groups) should be managed. The account modules define which properties (e.g. Unix and Samba) can be edited.")), - "218" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Script servers"), + "218" => array ("Headline" => _("Configuration wizard") . " - " . _("Script servers"), "Text" => _("This is a list of the servers where the lamdaemon scripts are stored. LDAP Account Manager will make a SSH connection to the servers with the user name and password provided at login. Multiple servers are separated by semicolons. You can append a descriptive name after a colon.") . "

" . _("Example") . ": 127.0.0.1:LOCAL;192.168.0.2:Servername;"), - "219" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Rights for the home directory"), + "219" => array ("Headline" => _("Configuration wizard") . " - " . _("Rights for the home directory"), "Text" => _("This defines the rights for the home directories which are created by lamdaemon.")), - "230" => array ("ext" => "FALSE", "Headline" => _("Profile management") . " - " . _("Add profile"), + "230" => array ("Headline" => _("Profile management") . " - " . _("Add profile"), "Text" => _("Please enter the name of the new profile and the password to change its settings. Profile names may contain letters, numbers and -/_.")), - "231" => array ("ext" => "FALSE", "Headline" => _("Profile management") . " - " . _("Rename profile"), + "231" => array ("Headline" => _("Profile management") . " - " . _("Rename profile"), "Text" => _("Please enter the new name of the profile. The name may contain letters, numbers and -/_.")), - "232" => array ("ext" => "FALSE", "Headline" => _("Profile management") . " - " . _("Delete profile"), + "232" => array ("Headline" => _("Profile management") . " - " . _("Delete profile"), "Text" => _("This will delete the selected profile.")), - "233" => array ("ext" => "FALSE", "Headline" => _("Profile management") . " - " . _("Set profile password"), + "233" => array ("Headline" => _("Profile management") . " - " . _("Set profile password"), "Text" => _("This changes the password of the selected profile.")), - "234" => array ("ext" => "FALSE", "Headline" => _("Profile management") . " - " . _("Change default profile"), + "234" => array ("Headline" => _("Profile management") . " - " . _("Change default profile"), "Text" => _("This changes the profile which is selected by default at login.")), - "235" => array ("ext" => "FALSE", "Headline" => _("Change master password"), + "235" => array ("Headline" => _("Change master password"), "Text" => _("If you want to change your master configuration password, please enter it here.")), - "236" => array ("ext" => "FALSE", "Headline" => _("Master password"), + "236" => array ("Headline" => _("Master password"), "Text" => _("Please enter the master configuration password. This is NOT your LDAP password. It is stored in your config.cfg file. If this is the first time you log in, enter \"lam\".")), - "237" => array ("ext" => "FALSE", "Headline" => _("Configuration wizard") . " - " . _("Base module"), + "237" => array ("Headline" => _("Configuration wizard") . " - " . _("Base module"), "Text" => _("Every account type needs exactly one base module. This module provides a structural object class.")), - "238" => array ("ext" => "FALSE", "Headline" => _("Session timeout"), + "238" => array ("Headline" => _("Session timeout"), "Text" => _("This is the time (in minutes) of inactivity after which a user is automatically logged off.")), - "239" => array ("ext" => "FALSE", "Headline" => _("Log level"), + "239" => array ("Headline" => _("Log level"), "Text" => _("Please select your prefered log level. Messages with a lower level will not be logged.")), - "240" => array ("ext" => "FALSE", "Headline" => _("Log destination"), + "240" => array ("Headline" => _("Log destination"), "Text" => _("Here you can select where LAM should save its log messages. System logging will go to Syslog on Unix systems and event log on Windows. You can also select an extra file.")), - "241" => array ("ext" => "FALSE", "Headline" => _("Allowed hosts"), + "241" => array ("Headline" => _("Allowed hosts"), "Text" => _("This is a list of IP addresses from hosts who may access LAM. You can use \"*\" as wildcard (e.g. 192.168.0.*).")), - "250" => array ("ext" => "FALSE", "Headline" => _("Account lists - Filters"), + "250" => array ("Headline" => _("Account lists - Filters"), "Text" => _("Here you can input small filter expressions (e.g. 'value' or 'v*'). LAM will filter case-insensitive.")), // 300 - 399 // Roland Gruber // profile editor, file upload - "301" => array ("ext" => "FALSE", "Headline" => _("RDN identifier"), + "301" => array ("Headline" => _("RDN identifier"), "Text" => _("This is the identifier for the relative DN value. It must be one of the given allowed LDAP attributes (e.g. user accounts usually use \"uid\" while groups use \"cn\").")), - "360" => array ("ext" => "FALSE", "Headline" => _("Profile name"), + "360" => array ("Headline" => _("Profile name"), "Text" => _("Name under which the profile will be saved. If a profile with the same name exists, it will be overwritten.")), - "361" => array ("ext" => "FALSE", "Headline" => _("DN suffix"), + "361" => array ("Headline" => _("DN suffix"), "Text" => _("The account will be saved under this LDAP suffix.")), // 400 - 499 // account pages - "401" => array ("ext" => "FALSE", "Headline" => _("Load profile"), + "401" => array ("Headline" => _("Load profile"), "Text" => _("Here you can load an account profile to set default settings for your account. The \"default\" profile is automatically loaded for new accounts.")), - "403" => array ("ext" => "FALSE", "Headline" => _("Create PDF file"), + "403" => array ("Headline" => _("Create PDF file"), "Text" => _("Here you can select a PDF structure and export the account to a PDF file.")), // 500 - 599 // Roland Gruber // LAM Pro - "501" => array ("ext" => "FALSE", "Headline" => _("LDAP suffix"), + "501" => array ("Headline" => _("LDAP suffix"), "Text" => _("LAM will search for accounts in this part of the LDAP tree.")), - "502" => array ("ext" => "FALSE", "Headline" => _("LDAP user and password"), + "502" => array ("Headline" => _("LDAP user and password"), "Text" => _("LAM will use this LDAP DN and password to search for accounts. It is sufficient to specify an account with read rights. If nothing is inserted then LAM will try to connect anonymously.")), - "503" => array ("ext" => "FALSE", "Headline" => _("LDAP search attribute"), + "503" => array ("Headline" => _("LDAP search attribute"), "Text" => _("This is needed to find the LDAP DNs of your user accounts. E.g. if you use \"uid\" and your user inputs \"miller\" then LAM will search for an account with uid=miller.")), - "504" => array ("ext" => "FALSE", "Headline" => _("Login attribute label"), + "504" => array ("Headline" => _("Login attribute label"), "Text" => _("This text should shortly describe your selected LDAP search attribute (e.g. email or user name).")), - "505" => array ("ext" => "FALSE", "Headline" => _("Login caption"), + "505" => array ("Headline" => _("Login caption"), "Text" => _("This text is displayed on top of the self service login page. You can also input HTML code here.")), - "506" => array ("ext" => "FALSE", "Headline" => _("Main page caption"), + "506" => array ("Headline" => _("Main page caption"), "Text" => _("This text is displayed on top of the self service main page. You can also input HTML code here.")), - "507" => array ("ext" => "FALSE", "Headline" => _("Add new group"), + "507" => array ("Headline" => _("Add new group"), "Text" => _("Adds a new group element to the list of self service options. Use this to structure the input fields.")), - "508" => array ("ext" => "FALSE", "Headline" => _("Add input field"), + "508" => array ("Headline" => _("Add input field"), "Text" => _("Adds a new self service option to the selected group element.")), - "520" => array ("ext" => "FALSE", "Headline" => _("Generate random password"), + "520" => array ("Headline" => _("Generate random password"), "Text" => _("This will set a random password and display it on the screen or send it the user via mail.") . '

' . _('If you decide to send the password via mail then the mail template "config/passwordMailTemplate.txt" will be used.') . '

' . _('Format') . ':