ReadMe: Changed the ``big picture'' ASCII art and wrote about the HTML entity replace...

[licom.git] / ReadMe

diff --git a/ReadMe b/ReadMe
index 54c6c5d..5700952 100644 (file)
--- a/ReadMe
+++ b/ReadMe
@@ -26,7 +26,7 @@ Please read these instructions, they include non-obvious hints.
   Field is set. LDAP-entries without an uid-field are considered to be
   contact-entries. For a sample layout see ``The big picture'' below.
 
-- Install and configure Apache. These is a sample config in the samples
+- Install and configure Apache. There is a sample config in the samples
   directory which will guide you. It's very important that the REMOTE_USER
   environment variable is set to the full DN by mod_auth_ldap. Look for
   ``AuthLDAPRemoteUserIsDN'' in Apache's manual.
@@ -43,7 +43,7 @@ Please read these instructions, they include non-obvious hints.
   will look in a subdirectory ``lib'' for it's modules.
 
 - Create a config at ``/etc/licom/licom.conf''. Again, the samples directory is
-  you friend. Also: there's probably a password in this file. Make sure it's
+  your friend. Also: there's probably a password in this file. Make sure it's
   not world-readable. The webserver will need read-permissions though.
 
 - To install the licom-mutt.pl script you will need to do something fancy, I
@@ -72,23 +72,44 @@ These requirements are tried to be met with the following approach:
 - On top of these modules a CGI-script has been written.
 
 
+Internationalization
+
+FIXME
+Since version 1.0 LiCoM is using UTF-8 for everything, so non-ASCII characters
+may be used everywhere. Entering these characters may be a problem, though,
+especially if you have an US american keyboard layout as I do. But entering a
+german umlaut is still hard if you have a french keyboard layout, so the
+problem is just shifted there.
+If your browser supports JavaScript LiCoM lets you enter such `foreign names'
+in a very elegant way: You simply type the HTML escape sequence and the
+JavaScript will convert it to the right character for youà So if you want to
+enter `MÃller' (a very common german surname)
+
+
 The big picture:
 
     [dc=org]
      |
      `->[dc=verplant]
          |
-         `->[ou=addresses]
+         `->[ou=LiCoM]
              |
-             +->[cn=Forster Florian]
-             |   |
-             |   +->[cn=Test Person]
-             |   +->[cn=Someone Else]
-             |   :  ...
+             +->[ou=Person]
+            |   |
+            |   +->[cn=Test Person]
+            |   +->[cn=Someone Else]
+            |   :  ...
              |   `->[cn=Last Person]
-             |
-             +->[cn=Another User]
-             |   |
-             |   +->[cn=Still More Entries]
-             :   :
+            |
+            `->[ou=Group]
+                |
+                +->[cn=Some Group]
+                |   member=cn=Test Person,ou=Person,ou=LiCoM,dc=verplant,dc=org
+                |   member=cn=Last Person,ou=Person,ou=LiCoM,dc=verplant,dc=org
+                |   member=...
+                +->[cn=Another Group]
+                :   member=cn=Someone Else,ou=Person,ou=LiCoM,dc=verplant,dc=org
+                    member=cn=Last Person,ou=Person,ou=LiCoM,dc=verplant,dc=org
+                    member=...
+