developer documentation - initial checkin
This commit is contained in:
Roland Gruber
parent
0c77b21df2
commit
df8079c315
|
|
@ -0,0 +1,77 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta content="text/html; charset=ISO-8859-15"
|
||||||
|
http-equiv="content-type">
|
||||||
|
<title>LAM - Configuration pages</title>
|
||||||
|
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div style="text-align: center;">
|
||||||
|
<h1>Configuration pages</h1>
|
||||||
|
</div>
|
||||||
|
<br>
|
||||||
|
<div style="text-align: center;"><img
|
||||||
|
style="width: 620px; height: 319px;" alt="configuration"
|
||||||
|
src="images/lam_config.png"><br>
|
||||||
|
<div style="text-align: left;">
|
||||||
|
<h2>Configuration - Login (conflogin.php):</h2>
|
||||||
|
This is the start page of the configuration editor. The user can select
|
||||||
|
a profile for editing or go to the profile management page.<br>
|
||||||
|
Each account profile is protected with a password which is stored in
|
||||||
|
the profile.<br>
|
||||||
|
The list of possible profiles is returned by <span
|
||||||
|
style="font-style: italic; font-weight: bold;">getConfigProfiles()</span>
|
||||||
|
in config.inc, the default profile is returned by an object of class <span
|
||||||
|
style="font-weight: bold; font-style: italic;">CfgMain</span> from
|
||||||
|
config.inc.<br>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<h2>Configuration - Profile management (profmanage.php):</h2>
|
||||||
|
Here the user can add and modify configuration profiles or change the
|
||||||
|
configuration master password. <br>
|
||||||
|
The configuration master password prevents unauthorised users from
|
||||||
|
changing the profiles. The password is saved in config/config.cfg and
|
||||||
|
managed via the <span style="font-style: italic; font-weight: bold;">CfgMain</span>
|
||||||
|
class.<br>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<h2>Configuration - Main page (confmain.php):</h2>
|
||||||
|
This page presents all configuration settings for editing.<br>
|
||||||
|
Some of the settings are module independent (e.g. server settings,
|
||||||
|
language, ...) and displayed always.<br>
|
||||||
|
The others are set up by the account modules. Only settings of
|
||||||
|
currently selected modules are displayed.<br>
|
||||||
|
Users may also change the profile password on this page.<br>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<h2>Configuration - Module selection (confmodules.php):<br>
|
||||||
|
</h2>
|
||||||
|
On this page the user can select which account modules LAM should use.<br>
|
||||||
|
The list of possible modules is returned by <span
|
||||||
|
style="font-style: italic; font-weight: bold;">getAvailableModules()</span>
|
||||||
|
in modules.inc and checked for dependencies/conflicts with <span
|
||||||
|
style="font-weight: bold; font-style: italic;">check_module_depends()</span>
|
||||||
|
and <span style="font-weight: bold; font-style: italic;">check_module_conflicts()</span>.<br>
|
||||||
|
<br>
|
||||||
|
Each account type needs a <span style="font-style: italic;">base module</span>
|
||||||
|
which provides the base of a senseful account. It also provides the
|
||||||
|
LDAP search filter for the account lists.<br>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<h2>Configuration - Save settings (confsave.php):<br>
|
||||||
|
</h2>
|
||||||
|
This script checks the input and displays possible error messages or an
|
||||||
|
overview of the saved settings.<br>
|
||||||
|
The static settings are set and checked with an object of class <span
|
||||||
|
style="font-style: italic; font-weight: bold;">Config</span> from
|
||||||
|
config.inc.<br>
|
||||||
|
The account modules manage the input validation for their fields and
|
||||||
|
are also able to return error messages. This is done with <span
|
||||||
|
style="font-weight: bold; font-style: italic;">checkConfigOptions()</span>
|
||||||
|
from modules.inc.<br>
|
||||||
|
<br>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
|
|
@ -0,0 +1,37 @@
|
||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>LAM development documentation</title>
|
||||||
|
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div style="text-align: center;">
|
||||||
|
<h1>LDAP Account Manager - Code overview</h1>
|
||||||
|
<img src="images/lam_overview.png" width="877" height="620" border="0"
|
||||||
|
align="middle" alt="overview"><br>
|
||||||
|
<div style="text-align: left;">
|
||||||
|
<h2>Web pages:</h2>
|
||||||
|
<ul>
|
||||||
|
<li>Login<br>
|
||||||
|
</li>
|
||||||
|
<li><a href="config_pages.htm">Configuration</a></li>
|
||||||
|
<li><a href="lists.htm">Account lists</a><br>
|
||||||
|
</li>
|
||||||
|
<li>Account pages<br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<br>
|
||||||
|
<h2>Libraries:</h2>
|
||||||
|
<ul>
|
||||||
|
<li>Account modules</li>
|
||||||
|
<li>PDF</li>
|
||||||
|
<li>Account profiles</li>
|
||||||
|
<li>Configuration</li>
|
||||||
|
<li>LDAP</li>
|
||||||
|
<li>other libraries<br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta content="text/html; charset=ISO-8859-15"
|
||||||
|
http-equiv="content-type">
|
||||||
|
<title>LAM - Account lists</title>
|
||||||
|
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1 style="text-align: center;">Account lists</h1>
|
||||||
|
<br>
|
||||||
|
<div style="text-align: center;"><img
|
||||||
|
style="width: 496px; height: 177px;" alt="Account lists"
|
||||||
|
src="images/lam_lists.png"><br>
|
||||||
|
</div>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -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;
|
||||||
|
}
|
||||||
|
|
||||||
Loading…
Reference in New Issue