moved module specification to docs/devel
This commit is contained in:
parent
4ab743eb9c
commit
ee105d99e3
|
@ -26,7 +26,7 @@ If your module needs any include files etc. please save it in <span
|
||||||
Please take a look at the <a href="mod_index.htm">module HowTo</a> for
|
Please take a look at the <a href="mod_index.htm">module HowTo</a> for
|
||||||
an example to write your own modules.<br>
|
an example to write your own modules.<br>
|
||||||
The complete specification for the module interface can be found <a
|
The complete specification for the module interface can be found <a
|
||||||
href="../modules-specification.htm">here</a>.<br>
|
href="modules-specification.htm">here</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
<h2>Superclass</h2>
|
<h2>Superclass</h2>
|
||||||
All <span style="font-weight: bold;">account modules</span> should be
|
All <span style="font-weight: bold;">account modules</span> should be
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
<div style="text-align: left;">The <span style="font-weight: bold;">baseModule</span>
|
<div style="text-align: left;">The <span style="font-weight: bold;">baseModule</span>
|
||||||
is the parent class of all account modules. <br>
|
is the parent class of all account modules. <br>
|
||||||
It implements most functions of the <a
|
It implements most functions of the <a
|
||||||
href="../modules-specification.htm">module interface</a> and provides
|
href="modules-specification.htm">module interface</a> and provides
|
||||||
the possibility to use <span style="font-style: italic;">meta data</span>
|
the possibility to use <span style="font-style: italic;">meta data</span>
|
||||||
for the module functions.<br>
|
for the module functions.<br>
|
||||||
There are also some class variables which are useful for the child
|
There are also some class variables which are useful for the child
|
||||||
|
@ -25,7 +25,7 @@ classes.<br>
|
||||||
<br>
|
<br>
|
||||||
<h2>Meta data</h2>
|
<h2>Meta data</h2>
|
||||||
The <span style="font-weight: bold;">baseModule</span> allows you to
|
The <span style="font-weight: bold;">baseModule</span> allows you to
|
||||||
not implement the <a href="../modules-specification.htm">module
|
not implement the <a href="modules-specification.htm">module
|
||||||
interface</a> directly but to provide <span style="font-style: italic;">meta
|
interface</a> directly but to provide <span style="font-style: italic;">meta
|
||||||
data</span> which is interpreted by the <span
|
data</span> which is interpreted by the <span
|
||||||
style="font-weight: bold;">baseModule</span>.<br>
|
style="font-weight: bold;">baseModule</span>.<br>
|
||||||
|
@ -41,7 +41,7 @@ to implement the function <span
|
||||||
style="font-weight: bold; font-style: italic;">get_metaData()</span>.
|
style="font-weight: bold; font-style: italic;">get_metaData()</span>.
|
||||||
This function must return a hash array with the meta options as array
|
This function must return a hash array with the meta options as array
|
||||||
keys.<br>
|
keys.<br>
|
||||||
Please refer to the <a href="../modules-specification.htm">module
|
Please refer to the <a href="modules-specification.htm">module
|
||||||
interface</a> for details about the format of <span
|
interface</a> for details about the format of <span
|
||||||
style="font-style: italic;">meta data</span>.<br>
|
style="font-style: italic;">meta data</span>.<br>
|
||||||
<br>
|
<br>
|
||||||
|
@ -52,7 +52,7 @@ interface</a> for details about the format of <span
|
||||||
returns the account type ("user", "group", ...) of the module.<br>
|
returns the account type ("user", "group", ...) of the module.<br>
|
||||||
<br>
|
<br>
|
||||||
For a list of <span style="font-style: italic;">meta data</span>
|
For a list of <span style="font-style: italic;">meta data</span>
|
||||||
functions please refer to the <a href="../modules-specification.htm">module
|
functions please refer to the <a href="modules-specification.htm">module
|
||||||
interface</a>.<br>
|
interface</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
|
@ -45,7 +45,7 @@ The function <span style="font-weight: bold;">print_option()</span>
|
||||||
manages the display of the different option types (checkbox, select,
|
manages the display of the different option types (checkbox, select,
|
||||||
...). The type of each option is saved in <span
|
...). The type of each option is saved in <span
|
||||||
style="font-weight: bold;">$_SESSION['profile_types']</span>.<br>
|
style="font-weight: bold;">$_SESSION['profile_types']</span>.<br>
|
||||||
See the <a href="../modules-specification.htm">modules specification</a>
|
See the <a href="modules-specification.htm">modules specification</a>
|
||||||
for a complete list of supported types.<br>
|
for a complete list of supported types.<br>
|
||||||
<br>
|
<br>
|
||||||
The profiles have unique names under which they are saved. If a profile
|
The profiles have unique names under which they are saved. If a profile
|
||||||
|
|
Loading…
Reference in New Issue