Misc. documentation fixes by Simon Dick.
authorkink <kink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Mon, 28 Jan 2002 21:23:31 +0000 (21:23 +0000)
committerkink <kink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Mon, 28 Jan 2002 21:23:31 +0000 (21:23 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@2269 7612ce4b-ef26-0410-bec9-ea0150e637f0

doc/addressbook.txt
doc/db-backend.txt
doc/mime.txt
doc/plugin.txt
doc/translating.txt
doc/translating_help.txt
doc/tree.txt

index f0521e8..4d1f7d8 100644 (file)
@@ -1,7 +1,7 @@
 SquirrelMail Addressbook Internals
 ==================================
 
-This document describe how the SquirrelMail address book works. It is
+This document describes how the SquirrelMail address book works. It is
 primarily intended for developers.
 
 
@@ -21,7 +21,7 @@ To initialize the address book, the function addressbook_init() from
 functions/addressbook.php is called. This function will create an
 AddressBook object, add one backend for a personal address book (file
 based storage), and add the LDAP backends defined in the $ldap_server
-configuration directive (is any).
+configuration directive (if any).
 
 An addressbook can also be initialized like this if you want to:
 
@@ -144,7 +144,7 @@ AddressBook->error variable. Feel free to ignore it.
 For the result of a search, lookup or list_addr, one or more result
 arrays are used. These arrays contain the following keys: 
 
-  nickname:  Unique identifier for this name in this backend. Onlu
+  nickname:  Unique identifier for this name in this backend. Only
              usable for the local_file backend, and possibly LDAP.
   name:      Person's full name.
   email:     Person's e-mail address.
index 4b3a6d9..41feffc 100644 (file)
@@ -6,11 +6,11 @@ Storing private addressbooks and preferences in a database
 
 
 On sites with many users you might want to store your user data in a
-database instead of in files. This document describe how to configure
+database instead of in files. This document describes how to configure
 SquirrelMail to do this.
 
 Methods for storing both personal addressbooks and user preferences in
-a database is as a part of the distribution.
+a database is included as a part of the distribution.
 
 
 
@@ -41,7 +41,7 @@ For MySQL you would normally do something like:
 The table structure should be similar to this (for MySQL):
 
    CREATE TABLE address (
-     owner varchar(16) DEFAULT '' NOT NULL,
+     owner varchar(128) DEFAULT '' NOT NULL,
      nickname varchar(16) DEFAULT '' NOT NULL,
      firstname varchar(128) DEFAULT '' NOT NULL,
      lastname varchar(128) DEFAULT '' NOT NULL,
@@ -72,9 +72,9 @@ point to a database you create (can be the same you use for
 addressbooks).  Create a table similar to this (for MySQL):
 
   CREATE TABLE userprefs (
-    user varchar(32) DEFAULT '' NOT NULL,
+    user varchar(128) DEFAULT '' NOT NULL,
     prefkey varchar(64) DEFAULT '' NOT NULL,
-    prefval blob DEFAULT '' NOT NULL,
+    prefval BLOB DEFAULT '' NOT NULL,
     PRIMARY KEY (user,prefkey)
   );
 
index f5b7395..39eb3cb 100644 (file)
@@ -8,7 +8,7 @@ works and how it parses a MIME encoded message.
 
 Object Structure
 ----------------
-There are two objects that are used: "message" and "msg_header".  here is a
+There are two objects that are used: "message" and "msg_header".  Here is a
 brief overview of what each object contains.
 
 msg_header
@@ -43,7 +43,7 @@ Getting the Structure
 ---------------------
 Previously (version 0.4 and below), SquirrelMail handled all the parsing of
 the email message.  It would read the entire message in, search for 
-boundaries, and created an array similar to the $message object discribed
+boundaries, and create an array similar to the $message object described
 above.  This was very inefficient.
 
 Currently, all the parsing of the body of the message takes place on the
@@ -78,7 +78,7 @@ NOTE:  SquirrelMail passes the MIME Torture Test written by Mark
 
 Getting the Body
 ----------------
-Once all of the structure of the message has been read into the $message
+Once all the structure of the message has been read into the $message
 object, we then need to display the body of one entity.  There are a number
 of ways we decide which entity to display at a certain time, and I won't go
 into that here.  
index dbd6ab5..501e9b3 100644 (file)
@@ -185,9 +185,9 @@ It is possible to create your own options sections with plugins.  There are
 three hooks you will need to use.
 
 1.  options_link_and_description
-    This creates the link and has a description that are shown on the options
+    This creates the link and has a description that is shown on the options
     page.  This should output HTML that looks like this.  Make sure to read
-    the section on outputting your own pages.
+    the section on outputing your own pages.
 
     -----cut here-----  
       function my_plugin_name_my_function() {
@@ -299,7 +299,7 @@ of your PHP script should look very similar to this:
     
 The validate.php script will include internationalization support,
 config.php variables, strings.php functions, and also authenticate that the
-user is truly logged in.  Validate.php also calls stripslashes() on incoming
+user is truly logged in.  validate.php also calls stripslashes() on incoming
 data (if gpc_magic_quotes() is on).  You should never need to worry about
 that stuff again.  As a warning, this has only really been ironed out in
 1.1.1.  If you create/modify a plugin to follow these rules, you must
index dee35a3..5f26e1a 100644 (file)
@@ -20,9 +20,9 @@ b) Find the language code for the language you are going to translate
    Copy squirrelmail/po/squirrelmail.po into this directory. This is the
    file that is going to be translated.
 
-c) To translate the actual strings fill inn the msgstr after each
+c) To translate the actual strings fill in the msgstr after each
    msgid with the appropiate translation. There are a few tools which
-   kan make this job a bit easier at
+   can make this job a bit easier at
    <URL:http://i18n.kde.org/translation-howto/gui-specialized-apps.html>.
 
    Convert the translated squirrelmail.po into a binary file by
@@ -39,9 +39,9 @@ the Unicode consortium.
 2. Maintaining translations
 ---------------------------
 
-the text strings in the program will change over time. This means that
-strings that are already translated is no longer used and new strings
-are added. Therefore it is neccessary to maintain the translations.
+The text strings in the program will change over time. This means that
+strings that are already translated are no longer used and new strings
+are added. Therefore it is necessary to maintain the translations.
 
 a) There should always be an updated template containing all strings
    in SquirrelMail in squirrelmail/squirrelmail.po. To merge all new
index 44cda3e..a7e10e7 100644 (file)
@@ -5,11 +5,11 @@ I have tried to write the help files in plain english with good grammer.
 Since English is not my strong point you probably can't tell, but I hope it 
 helps.
 
-The help files, at this point, are devided into functional areas.  Each .hlp 
+The help files, at this point, are divided into functional areas.  Each .hlp 
 file represents a different functional block of how the program looks to the 
 user.
 
-Hopefully as SquirrelMail is more widely used, non-english translations will
+Hopefully as SquirrelMail gets more widely used, non-english translations will
 be used to make other non-english translations.  You might want to keep this
 in mind when writing yours.  Remember that these will be used all over the
 world and in many different environments so local language dialects might 
@@ -19,7 +19,7 @@ File Structure
 ==============
 
 All translated files should be placed under the help directory.  Under the
-help directory create another directory. This directory MUST be named to the
+help directory create another directory. This directory MUST be named in the
 two letter standard abbreviation for the language. English is "en" and Polish 
 would be "pl" for example.
 
@@ -32,7 +32,7 @@ For these help files, the tags must be on their own line like this:
 
 There are two types of main tags: <chapter> and <section>.  There can be only 
 one <chapter> tag in a .hlp file.  However, there can be many <section> tags.
-Inside both of these tags, their can be any combination of any of the following
+Inside each of these tags, there can be any combination of any of the following
 tags:  <title>, <description>, <summary>.  Here is an example:
 
                      | <chapter>
@@ -53,9 +53,9 @@ tags:  <title>, <description>, <summary>.  Here is an example:
 Translating
 ===========
 
-To translate, just copy all the .hlp files from help/en into your new directory
+To translate, just copy all the .hlp files from help/en into the new directory
 that you created for this language (i.e.  help/pl).  You only need to translate
-what is inbetween the tags.  Do not translate the actual tags such as <chapter> 
+what is between the tags.  Do not translate the actual tags such as <chapter> 
 or <summary>.  The tag names need to remain in English.  You should only translate
 the text between tags.
 
index 15b174c..5ccb012 100644 (file)
@@ -20,7 +20,7 @@ The trickiest part was finding the correct parent node when creating
 a new node in the tree.  Check the documentation in the code for
 more info on this.
 
-Basically all we had to do as loop through each of the items that
+Basically all we had to do was loop through each of the items that
 need to be in the tree (folders, subfolders), find their parent,
 let their parent know it has a new child, and insert the values
 into the child.