diff --git a/lam/docs/devel/config_pages.htm b/lam/docs/devel/config_pages.htm new file mode 100644 index 00000000..27efa4d3 --- /dev/null +++ b/lam/docs/devel/config_pages.htm @@ -0,0 +1,77 @@ + + + + + LAM - Configuration pages + + + +
+

Configuration pages

+
+
+
configuration
+
+

Configuration - Login (conflogin.php):

+This is the start page of the configuration editor. The user can select +a profile for editing or go to the profile management page.
+Each account profile is protected with a password which is stored in +the profile.
+The list of possible profiles is returned by getConfigProfiles() +in config.inc, the default profile is returned by an object of class CfgMain from +config.inc.
+
+
+

Configuration - Profile management (profmanage.php):

+Here the user can add and modify configuration profiles or change the +configuration master password.
+The configuration master password prevents unauthorised users from +changing the profiles. The password is saved in config/config.cfg and +managed via the CfgMain +class.
+
+
+

Configuration - Main page (confmain.php):

+This page presents all configuration settings for editing.
+Some of the settings are module independent (e.g. server settings, +language, ...) and displayed always.
+The others are set up by the account modules. Only settings of +currently selected modules are displayed.
+Users may also change the profile password on this page.
+
+
+

Configuration - Module selection (confmodules.php):
+

+On this page the user can select which account modules LAM should use.
+The list of possible modules is returned by getAvailableModules() +in modules.inc and checked for dependencies/conflicts with check_module_depends() +and check_module_conflicts().
+
+Each account type needs a base module +which provides the base of a senseful account. It also provides the +LDAP search filter for the account lists.
+
+
+

Configuration - Save settings (confsave.php):
+

+This script checks the input and displays possible error messages or an +overview of the saved settings.
+The static settings are set and checked with an object of class Config from +config.inc.
+The account modules manage the input validation for their fields and +are also able to return error messages. This is done with checkConfigOptions() +from modules.inc.
+
+
+
+ + diff --git a/lam/docs/devel/images/lam_config.png b/lam/docs/devel/images/lam_config.png new file mode 100644 index 00000000..3be05b25 Binary files /dev/null and b/lam/docs/devel/images/lam_config.png differ diff --git a/lam/docs/devel/images/lam_lists.png b/lam/docs/devel/images/lam_lists.png new file mode 100644 index 00000000..a942977e Binary files /dev/null and b/lam/docs/devel/images/lam_lists.png differ diff --git a/lam/docs/devel/images/lam_overview.png b/lam/docs/devel/images/lam_overview.png new file mode 100644 index 00000000..235a5050 Binary files /dev/null and b/lam/docs/devel/images/lam_overview.png differ diff --git a/lam/docs/devel/index.htm b/lam/docs/devel/index.htm new file mode 100644 index 00000000..d7783475 --- /dev/null +++ b/lam/docs/devel/index.htm @@ -0,0 +1,37 @@ + + + + LAM development documentation + + + +
+

LDAP Account Manager - Code overview

+overview
+
+

Web pages:

+ +
+

Libraries:

+ +
+
+ + diff --git a/lam/docs/devel/lists.htm b/lam/docs/devel/lists.htm new file mode 100644 index 00000000..42fa3edf --- /dev/null +++ b/lam/docs/devel/lists.htm @@ -0,0 +1,19 @@ + + + + + LAM - Account lists + + + +

Account lists

+
+
Account lists
+
+
+
+ + diff --git a/lam/docs/devel/style/layout.css b/lam/docs/devel/style/layout.css new file mode 100644 index 00000000..ad4f4d54 --- /dev/null +++ b/lam/docs/devel/style/layout.css @@ -0,0 +1,51 @@ + /* +$Id$ + + This code is part of LDAP Account Manager (http://www.sourceforge.net/projects/lam) + Copyright (C) 2004 Roland Gruber + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more detaexils. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +*/ + +/* CSS layout for LAM development documentation */ + + + +h1,h2,h3,h4 { + color:#0c12b7; +} + +/* links */ +a { +color:blue; +text-decoration:none; +} + +a:visited { +color:blue; +text-decoration:none; +} + +a:hover { +color:red; +text-decoration:none; +} + +a:active { +color:red; +text-decoration:none; +} +