added some documentation on PDF and tree view/schema browser
This commit is contained in:
Roland Gruber
parent
2f206e021e
commit
4fc2ca15af
|
|
@ -26,7 +26,8 @@ the library files.<br>
|
|||
</li>
|
||||
<li><a href="file:///daten/cvs/lam/docs/devel/config_pages.htm">Configuration</a></li>
|
||||
<li><a href="file:///daten/cvs/lam/docs/devel/lists.htm">Account
|
||||
lists</a><br>
|
||||
lists</a></li>
|
||||
<li><a href="tree_schema.htm">Tree view</a><br>
|
||||
</li>
|
||||
<li>Account pages</li>
|
||||
<li>Tools</li>
|
||||
|
|
@ -45,7 +46,7 @@ lists</a><br>
|
|||
<ul>
|
||||
<li>Account modules (modules.inc)<br>
|
||||
</li>
|
||||
<li>PDF (pdf.inc)<br>
|
||||
<li>PDF (pdf.inc, pdfstruct.inc)<br>
|
||||
</li>
|
||||
<li><a href="profiles.htm">Account profiles (profiles.inc)</a><br>
|
||||
</li>
|
||||
|
|
@ -63,7 +64,9 @@ lists</a><br>
|
|||
<li><a href="other_libs.htm#blowfish">Blowfish</a></li>
|
||||
<li><a href="other_libs.htm#cache">LADP cache</a></li>
|
||||
<li><a href="other_libs.htm#lists">Account lists</a></li>
|
||||
<li><a href="other_libs.htm#status">Status messages</a><br>
|
||||
<li><a href="other_libs.htm#status">Status messages</a></li>
|
||||
<li><a href="other_libs.htm#treeSchema">Tree view and schema
|
||||
browser</a><br>
|
||||
</li>
|
||||
</ul>
|
||||
</ul>
|
||||
|
|
@ -74,7 +77,7 @@ lists</a><br>
|
|||
<li><a href="base_module.htm">Base module</a><br>
|
||||
</li>
|
||||
<li><a href="account_modules.htm">Account modules</a></li>
|
||||
<li>PDF templates</li>
|
||||
<li><a href="pdf_profiles.htm">PDF templates</a></li>
|
||||
<li><a href="profile_files.htm">Account profiles</a></li>
|
||||
<li><a href="config_files.htm">Configuration profiles</a><br>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -27,7 +27,22 @@ There is also one list of LDAP attribute descriptions per account type.
|
|||
They allow to have translated descriptions of the most common
|
||||
attributes.<br>
|
||||
<br>
|
||||
<h2><a name="status"></a>Status messages (status.inc)<br>
|
||||
</h2>
|
||||
<h2><a name="status"></a>Status messages (status.inc)</h2>
|
||||
<br>
|
||||
<br>
|
||||
<h2><a name="treeSchema"></a>Tree view and schema browser</h2>
|
||||
The files tree.inc and schema.inc contain functions which are needed by
|
||||
the tree view and the schema browser.<br>
|
||||
These functions were copied from <a
|
||||
href="http://sourceforge.net/projects/phpldapadmin/">phpLDAPadmin</a>
|
||||
(PLA).<br>
|
||||
<br>
|
||||
<ul>
|
||||
<li><span style="font-weight: bold;">tree.inc:</span> tree functions
|
||||
(from functions.php and some other files in PLA)</li>
|
||||
<li><span style="font-weight: bold;">schema.inc:</span> for schema
|
||||
browser (from schema_functions.php in PLA)<br>
|
||||
</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,99 @@
|
|||
<!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>PDF templates</title>
|
||||
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||
</head>
|
||||
<body>
|
||||
<h1 style="text-align: center;">PDF templates<br>
|
||||
</h1>
|
||||
<br>
|
||||
Every PDF structure is saved as a single file in <span
|
||||
style="font-weight: bold;">config/pdf</span>. The
|
||||
file extension is the account type (user, group, ...) plus ".xml" (e.g.
|
||||
default.user.xml).<br>
|
||||
<br>
|
||||
<h2>Format</h2>
|
||||
The root tag is <span style="font-weight: bold;"><pdf></span>
|
||||
with the attributes <span
|
||||
style="font-weight: bold; font-style: italic;">filename</span> for the
|
||||
logo and <span style="font-weight: bold; font-style: italic;">headline</span>
|
||||
for the title.<br>
|
||||
<br>
|
||||
There are two types of subentries in <pdf>:<br>
|
||||
<ul>
|
||||
<li>sections</li>
|
||||
<li>text<br>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Sections:</h3>
|
||||
Sections are parts of the PDF file where data from the account profiles
|
||||
(e.g. LDAP attributes) is shown. Each section has a title and a list of
|
||||
entries.<br>
|
||||
<br>
|
||||
The title is defined with the <span
|
||||
style="font-weight: bold; font-style: italic;">name</span> attribute
|
||||
inside the section tag. If the title begins with a "_" then LAM
|
||||
interprets it as entry. This means that LAM will insert the value part
|
||||
of this entry here.<br>
|
||||
<br>
|
||||
Each section has a list of subentries which are defined with the <span
|
||||
style="font-weight: bold;"><entry></span> tag. The have only one
|
||||
attribute which is <span style="font-weight: bold;">name</span> and
|
||||
contains the identifier of this entry.<br>
|
||||
<br>
|
||||
<h3>Text:</h3>
|
||||
LAM allows to display a fixed text in the PDF which is defined with the
|
||||
<span style="font-weight: bold;"><text></span> tag. The text is
|
||||
just written inside the tags.<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<span style="font-weight: bold;">Example:</span><br
|
||||
style="font-weight: bold;">
|
||||
<br>
|
||||
<pdf type="user" filename="printLogo.jpg" headline="LDAP Account
|
||||
Manager"><br>
|
||||
<text>This document includes your personal
|
||||
account settings.</text><br>
|
||||
<section name="Personal User Infos"><br>
|
||||
<entry
|
||||
name="inetOrgPerson_givenName" /><br>
|
||||
<entry name="inetOrgPerson_sn"
|
||||
/><br>
|
||||
<entry
|
||||
name="inetOrgPerson_street" /><br>
|
||||
<entry
|
||||
name="inetOrgPerson_postalCode" /><br>
|
||||
<entry
|
||||
name="inetOrgPerson_postalAddress" /><br>
|
||||
<entry
|
||||
name="inetOrgPerson_mail" /><br>
|
||||
<entry
|
||||
name="inetOrgPerson_telephoneNumber" /><br>
|
||||
<entry
|
||||
name="inetOrgPerson_mobileTelephoneNumber" /><br>
|
||||
<entry
|
||||
name="inetOrgPerson_facsimileTelephoneNumber" /><br>
|
||||
</section><br>
|
||||
<section name="Unix User Settings"><br>
|
||||
<entry name="posixAccount_uid"
|
||||
/><br>
|
||||
<entry
|
||||
name="posixAccount_userPassword" /><br>
|
||||
<entry
|
||||
name="posixAccount_primaryGroup" /><br>
|
||||
<entry
|
||||
name="posixAccount_additionalGroups" /><br>
|
||||
<entry
|
||||
name="posixAccount_homeDirectory" /><br>
|
||||
<entry
|
||||
name="posixAccount_loginShell" /><br>
|
||||
</section><br>
|
||||
</pdf><br>
|
||||
<br>
|
||||
<br>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<!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>Tree view and schema browser</title>
|
||||
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
||||
</head>
|
||||
<body>
|
||||
<h1 style="text-align: center;">Tree view and schema browser<br>
|
||||
</h1>
|
||||
<br>
|
||||
<br>
|
||||
These parts are based on <a
|
||||
href="http://sourceforge.net/projects/phpldapadmin/">phpLDAPadmin</a>.<br>
|
||||
The two tools are located in <span
|
||||
style="font-weight: bold; font-style: italic;">templates/schema</span>
|
||||
and <span style="font-weight: bold; font-style: italic;">templates/tree</span>.<br>
|
||||
<br>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue