From 4fc2ca15af48933dcc287d400390d24021194a5a Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sun, 10 Jul 2005 18:33:42 +0000 Subject: [PATCH] added some documentation on PDF and tree view/schema browser --- lam/docs/devel/index.htm | 11 ++-- lam/docs/devel/other_libs.htm | 19 ++++++- lam/docs/devel/pdf_profiles.htm | 99 +++++++++++++++++++++++++++++++++ lam/docs/devel/tree_schema.htm | 21 +++++++ 4 files changed, 144 insertions(+), 6 deletions(-) create mode 100644 lam/docs/devel/pdf_profiles.htm create mode 100644 lam/docs/devel/tree_schema.htm diff --git a/lam/docs/devel/index.htm b/lam/docs/devel/index.htm index 4e27e157..1e594701 100644 --- a/lam/docs/devel/index.htm +++ b/lam/docs/devel/index.htm @@ -26,7 +26,8 @@ the library files.
  • Configuration
  • Account -lists
    +lists
    • +
  • Tree view
  • Account pages
  • Tools
    • @@ -45,7 +46,7 @@ lists
    @@ -74,7 +77,7 @@ lists
  • Base module
  • Account modules
    • -
  • PDF templates
    • +
  • PDF templates
  • Account profiles
  • Configuration profiles
    • diff --git a/lam/docs/devel/other_libs.htm b/lam/docs/devel/other_libs.htm index 8956a9fb..6b810542 100644 --- a/lam/docs/devel/other_libs.htm +++ b/lam/docs/devel/other_libs.htm @@ -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.

    -

    Status messages (status.inc)
    -

    +

    Status messages (status.inc)

    +
    +
    +

    Tree view and schema browser

    +The files tree.inc and schema.inc contain functions which are needed by +the tree view and the schema browser.
    +These functions were copied from phpLDAPadmin +(PLA).
    +
    + diff --git a/lam/docs/devel/pdf_profiles.htm b/lam/docs/devel/pdf_profiles.htm new file mode 100644 index 00000000..0393d705 --- /dev/null +++ b/lam/docs/devel/pdf_profiles.htm @@ -0,0 +1,99 @@ + + + + + PDF templates + + + +

    PDF templates
    +

    +
    +Every PDF structure is saved as a single file in config/pdf. The +file extension is the account type (user, group, ...) plus ".xml" (e.g. +default.user.xml).
    +
    +

    Format

    +The root tag is <pdf> +with the attributes filename for the +logo and headline +for the title.
    +
    +There are two types of subentries in <pdf>:
    + +

    Sections:

    +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.
    +
    +The title is defined with the name 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.
    +
    +Each section has a list of subentries which are defined with the <entry> tag. The have only one +attribute which is name and +contains the identifier of this entry.
    +
    +

    Text:

    +LAM allows to display a fixed text in the PDF which is defined with the +<text> tag. The text is +just written inside the tags.
    +
    +
    +
    +Example:
    +
    +<pdf type="user" filename="printLogo.jpg" headline="LDAP Account +Manager">
    +    <text>This document includes your personal +account settings.</text>
    +    <section name="Personal User Infos">
    +        <entry +name="inetOrgPerson_givenName" />
    +        <entry name="inetOrgPerson_sn" +/>
    +        <entry +name="inetOrgPerson_street" />
    +        <entry +name="inetOrgPerson_postalCode" />
    +        <entry +name="inetOrgPerson_postalAddress" />
    +        <entry +name="inetOrgPerson_mail" />
    +        <entry +name="inetOrgPerson_telephoneNumber" />
    +        <entry +name="inetOrgPerson_mobileTelephoneNumber" />
    +        <entry +name="inetOrgPerson_facsimileTelephoneNumber" />
    +    </section>
    +    <section name="Unix User Settings">
    +        <entry name="posixAccount_uid" +/>
    +        <entry +name="posixAccount_userPassword" />
    +        <entry +name="posixAccount_primaryGroup" />
    +        <entry +name="posixAccount_additionalGroups" />
    +        <entry +name="posixAccount_homeDirectory" />
    +        <entry +name="posixAccount_loginShell" />
    +    </section>
    +</pdf>
    +
    +
    + + diff --git a/lam/docs/devel/tree_schema.htm b/lam/docs/devel/tree_schema.htm new file mode 100644 index 00000000..16e64b5c --- /dev/null +++ b/lam/docs/devel/tree_schema.htm @@ -0,0 +1,21 @@ + + + + + Tree view and schema browser + + + +

    Tree view and schema browser
    +

    +
    +
    +These parts are based on phpLDAPadmin.
    +The two tools are located in templates/schema +and templates/tree.
    +
    + +