[GNUnet-SVN] r4141 - i18nHTML

[grothoff]

Author: grothoff
Date: 2006-12-30 20:03:10 -0800 (Sat, 30 Dec 2006)
New Revision: 4141

Modified:
   i18nHTML/README
Log:
reorg

Modified: i18nHTML/README
===================================================================
--- i18nHTML/README     2006-12-31 03:55:08 UTC (rev 4140)
+++ i18nHTML/README     2006-12-31 04:03:10 UTC (rev 4141)
@@ -10,17 +10,15 @@
 be updated without loosing existing translations for sentences that
 were not changed.
 
-src/ contains the PHP scripts that need to be copied into the source
-directory containing the webpage.  Every page is suposed to include
-"i18nhtml.inc.php" and use the PHP functions defined therein to
-construct the page.  Note: assuming you set $i18nHTMLbase correctly,
-you can place these files anywhere, then adjust the include path
-correctly and all should still work (ie no need to maintain a copy in
-each dir).
+src/i18nHTML/ contains PHP scripts that should be copied into a
+subdirectory "i18nHTML/" of a directory listed in the include_path
+from php.init (i.e. /usr/share/php/i18nHTML/).  The i18nhtml.php file
+should be included in internationalized webpages using PHP's
+"include()" function.  The i18nhtml_config.php file should be edited
+to configure the installation.  In particular, the file specifies the
+database access method.  You need to configure the MySQL database like
+this:
 
-src/i18nhtml_config.inc.php must be edited to configure the database
-access method.  You need to configure the MySQL database like this:
-
 $ mysql -u root -p 
 CREATE DATABASE translation;
 GRANT select,insert,update,delete,create,alter,drop
@@ -29,6 +27,20 @@
 FLUSH PRIVILEGES;
 
 
+You should copy the files from the "src/admin/" directory to some
+directory that exposed by apache to users that are allowed to provide
+translations.  This could be a normal public directory
+(http://yourwebserver.org/i18nHTML/) or a directory protected by
+access permissions in order to limit access to authorized users
+(i.e. https://yourwebserver.com/internal/i18nHTML/).  Regardless, you
+must specify the respective base-URL in the i18nhtml_config.php
+configuration file.
+
+examples/ contains some example pages that use i18nHTML.  You do
+not need to install those pages.  The update*.php scripts in the
+src/ directory can be used to migrate databases from previous
+i18nHTML versions.  They do not need to be installed either.
+
 doc/ should contain some additional documentation and examples
 how to use the system.  See also the i18nHTML-docs CVS repository
 for how the i18nHTML webpage itself is done.
@@ -94,11 +106,11 @@
 if somebody decides to be nasty.
 
 
-You may now want to open the "start.php" page.  This page
-contains the description for your end-users on how to translate
-the pages using i18nHTML.  After opening start.php the tables
-have been created and you can populate the database with an
-initial set of translations:
+You may now want to open the "examples/start.php" page.  This page
+contains the description for your end-users on how to translate the
+pages using i18nHTML.  After opening start.php the tables have been
+created and you can populate the database with an initial set of
+translations:
 
 $ mysql -ui18nHTML -ppass < contrib/populate.sql