diff --git a/lam/docs/devel/account_modules.htm b/lam/docs/devel/account_modules.htm index a466208d..c2d4cea5 100644 --- a/lam/docs/devel/account_modules.htm +++ b/lam/docs/devel/account_modules.htm @@ -39,7 +39,7 @@ to be implemented.

Module detection

New modules can simply be copied to lib/modules. LAM will check what files are inside the directory and provide the user -new modules automtically.
+new modules automatically.
There is no extra configuration file.


diff --git a/lam/docs/devel/account_modules_lib.htm b/lam/docs/devel/account_modules_lib.htm index 6f4f2465..f3cbd4e4 100644 --- a/lam/docs/devel/account_modules_lib.htm +++ b/lam/docs/devel/account_modules_lib.htm @@ -21,7 +21,7 @@ in modules.inc.

General functions:

getModuleAlias: This returns -the alias name of a module. It is used label buttons or fieldsets.
+the alias name of a module. It is used to label buttons or fieldsets.

parseHtml: Converts the LAM meta HTML code to real HTML code.
diff --git a/lam/docs/devel/account_types.htm b/lam/docs/devel/account_types.htm new file mode 100644 index 00000000..543623d0 --- /dev/null +++ b/lam/docs/devel/account_types.htm @@ -0,0 +1,46 @@ + + + + + Account types + + + +

Account types
+

+
base module
+
+

+
The account types define what kind of +accounts can be managed with LAM. If you want to create a new account +module which does not fit in the existing classes of users, groups and +hosts then you need your own account type.
+
+All account types are saved in lib/types/.
+
+Please take a look at the type HowTo for +an example to write your own types.
+The complete specification for the type interface can be found here.
+
+

Superclass

+All account types should be +subclasses of the baseType.
+This reduces very much the code since not the complete type interface +has +to be implemented.
+
+
+

Type detection

+New types can simply be copied to lib/types. +LAM will check what files are inside the directory and provide the user +new types automatically.
+There is no extra configuration file.
+
+
+
+
+ + diff --git a/lam/docs/devel/account_types_lib.htm b/lam/docs/devel/account_types_lib.htm new file mode 100644 index 00000000..80d8c6cc --- /dev/null +++ b/lam/docs/devel/account_types_lib.htm @@ -0,0 +1,42 @@ + + + + + Account types (types.inc) + + + +

Account types (types.inc)
+

+
+Types.inc is the interface to +the account types. It provides information about the type alias names, +descriptions and other things.
+
+

Functions:

+
+

General functions:

+getAlias: This returns +the alias name of a type. It is used to label buttons or fieldsets.
+
+getDescription: Returns a +description for the account type.
+
+
+

Functions for list views:

+getListClassName: Here you can +specify your own class to handle the list view.  This is needed to +label the buttons in the list view.
+
+getDefaultListAttributes: +Returns the default setting for the displayed list attributes. It is +used as default for the LAM configuration.
+
+getListAttributeDescriptions: +Returns a hash array which contains predefined, translated descriptions +of LDAP attributes.
+
+
+ + diff --git a/lam/docs/devel/base_type.htm b/lam/docs/devel/base_type.htm new file mode 100644 index 00000000..b26755e0 --- /dev/null +++ b/lam/docs/devel/base_type.htm @@ -0,0 +1,26 @@ + + + + + Base type + + + +

Base type
+

+
base type
+
+

+
The baseType +is the parent class of all account types.
+It implements all functions of the type +interface.
+
+However, you surely want to override most of the functions in your +account type class.
+
+
+ + diff --git a/lam/docs/devel/images/lam_baseType.png b/lam/docs/devel/images/lam_baseType.png new file mode 100644 index 00000000..25178a1e Binary files /dev/null and b/lam/docs/devel/images/lam_baseType.png differ diff --git a/lam/docs/devel/images/lam_overview.png b/lam/docs/devel/images/lam_overview.png index 235a5050..24b96625 100644 Binary files a/lam/docs/devel/images/lam_overview.png and b/lam/docs/devel/images/lam_overview.png differ diff --git a/lam/docs/devel/index.htm b/lam/docs/devel/index.htm index fc89d400..d377c429 100644 --- a/lam/docs/devel/index.htm +++ b/lam/docs/devel/index.htm @@ -11,8 +11,12 @@ These documents are supposed to give developers who want to modify LAM an overview of the codebase. It focuses mainly on what is done to generate the HTML output and the most important functions provided by the library files.
+
+
overview
+ border="0">
+
+

Libraries:

Configuration files: