Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml,v diff -u -r1.21 -r1.22 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml 26 May 2004 07:56:57 -0000 1.21 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml 11 Jun 2004 10:13:00 -0000 1.22 @@ -15,6 +15,7 @@ + Internationalization and Localization Internationalization and Localization @@ -107,11 +108,7 @@ dates must use internationalized functions. All displayed numbers must use internationalized functions. - - User Content - OpenACS does not have a general system for supporting multiple, localized versions of user-input content. This document currently refers only to internationalizing the text in the package user interface. - - + Localizable text must be handled in ADP files, in TCL files, and in APM Parameters. OpenACS provides two approaches, message @@ -124,6 +121,11 @@ distinguished by a file naming convention. + + User Content + OpenACS does not have a general system for supporting multiple, localized versions of user-input content. This document currently refers only to internationalizing the text in the package user interface. + + Separate Templates for each Locale @@ -232,14 +234,14 @@ Dynamic key lookup: [lang::util::localize $var_with_embedded_message_keys] - In this case the message keys in the variable var_with_embedded_message_keys must appear as string literals \#package_key.message_key\# somewhere in the code. Here is an example of a dynamic lookup: - set message_key_array { dynamic_key_1 \#package_key.message_key1\# dynamic_key_2 \#package_key.message_key2\# } set my_text [lang::util::localize $message_key_array([get_dynamic_key])] + @@ -274,36 +276,34 @@ - For each message call in the text, decide on a variable name and replace + + + For each message call in the text, decide on a variable name and replace the procedure call with a variable lookup on the syntax %var_name%. Remember - to initialize a tcl variable with the same name on some line above the text. - If the text is in a tcl file you must replace variable lookups - (occurences of $var_name or ${var_name}) with %var_name% - You are now ready to follow the normal procedure and mark up the text using a + to initialize a tcl variable with the same name on some line above the text. + If the text is in a tcl file you must replace variable lookups + (occurences of $var_name or ${var_name}) with %var_name% + You are now ready to follow the normal procedure and mark up the text using a tempoarary message tag (<#_ text_with_percentage_vars#>) and run the action - replace tags with keys in the APM. + replace tags with keys in the APM. The variable values in the message are usually fetched with upvar, here is an example from dotlrn: - - ad_return_complaint 1 "Error: A [parameter::get -parameter classes_pretty_name] must have <em>no</em>[parameter::get -parameter class_instances_pretty_plural] to be deleted" - - was replaced by: - - set subject [parameter::get -localize -parameter classes_pretty_name] set class_instances [parameter::get -localize -parameter class_instances_pretty_plural] ad_return_complaint 1 [_ dotlrn.class_may_not_be_deleted] + + This kind of interpolation also works in adp files where adp variable values will be inserted into the message. @@ -493,14 +493,14 @@ - + You will now be walked through all of the selected adp pages. The UI shows you the intended changes and lets you edit or cancel them key by key. - + @@ -668,12 +668,13 @@ are always is done with one of the valid lookups described above. The script further assumes that you have perl installed and in your path. Run the script like this: - + + acs-lang/bin/check-catalog.sh package_key + + - - acs-lang/bin/check-catalog.sh package_key - + where package_key is the key of the package that you want to test. If you don't provide the package_key argument then all @@ -698,7 +699,7 @@ has a bold tag which confuses the converter into thinking there are two message keys for the text beginning "Invitations ..." where there should be one: - + Instead, we cancel those keys, edit the file manually, and put in a single temporary message tag: @@ -936,13 +937,13 @@ - + While in Translator mode, a list of all message keys appears at the bottom of each page. - + @@ -953,7 +954,7 @@ - + Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml,v diff -u -r1.3 -r1.4 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml 23 Feb 2004 23:36:21 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml 11 Jun 2004 10:13:00 -0000 1.4 @@ -8,7 +8,7 @@ Contributions - by Joel Aufrecht + by Joel Aufrecht Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml,v diff -u -r1.25 -r1.26 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml 14 May 2004 14:10:27 -0000 1.25 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml 11 Jun 2004 10:13:00 -0000 1.26 @@ -146,7 +146,7 @@ Upgrading a local CVS repository - + Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-db.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-db.xml,v diff -u -r1.13 -r1.14 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-db.xml 14 May 2004 14:10:27 -0000 1.13 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-db.xml 11 Jun 2004 10:13:00 -0000 1.14 @@ -54,7 +54,7 @@ Tutorial Data Model - + @@ -84,7 +84,7 @@ Database Deletion Script example missing - (like the creation script the drop script calls a PL/pgSQL function: content_type__drop_type + (like the creation script the drop script calls a PL/pgSQL function: content_type__drop_type Run the create script manually to add your tables and functions. [$OPENACS_SERVICE_NAME postgresql]$ psql -f myfirstpackage-create.sql psql:myfirstpackage-create.sql:15: NOTICE: CREATE TABLE / PRIMARY KEY will create implicit index 'mfp_notes_pkey' for table 'mfp_notes' Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml,v diff -u -r1.10 -r1.11 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml 14 May 2004 14:10:27 -0000 1.10 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml 11 Jun 2004 10:13:00 -0000 1.11 @@ -129,7 +129,7 @@ like: set name "Simon", I tend to generate a random script in order avoid inserting a value that's already in the database: set name [ad_generate_random_string] -Here's how the test case looks so far: +Here's how the test case looks so far: aa_register_case mfp_basic_test { My test Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-pages.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-pages.xml,v diff -u -r1.13 -r1.14 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-pages.xml 14 May 2004 14:10:27 -0000 1.13 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-pages.xml 11 Jun 2004 10:13:00 -0000 1.14 @@ -25,7 +25,7 @@ Page Map - + Index: openacs-4/packages/acs-core-docs/www/xml/for-everyone/acs-faq.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/for-everyone/acs-faq.xml,v diff -u -r1.6 -r1.7 --- openacs-4/packages/acs-core-docs/www/xml/for-everyone/acs-faq.xml 11 Dec 2003 21:39:49 -0000 1.6 +++ openacs-4/packages/acs-core-docs/www/xml/for-everyone/acs-faq.xml 11 Jun 2004 10:13:01 -0000 1.7 @@ -87,19 +87,6 @@ Uptime Installation - - - ArsDigita Server Architecture Audit (mainly for OpenACS 3.x) Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml,v diff -u -r1.10 -r1.11 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml 14 May 2004 14:10:28 -0000 1.10 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml 11 Jun 2004 10:13:01 -0000 1.11 @@ -143,7 +143,7 @@ - + Add a database-specific wrapper script. This script Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/configuring.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/configuring.xml,v diff -u -r1.5 -r1.6 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/configuring.xml 14 May 2004 14:10:28 -0000 1.5 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/configuring.xml 11 Jun 2004 10:13:01 -0000 1.6 @@ -26,7 +26,7 @@ Click on Admin > Install Software > Install from OpenACS Repository / Install new application - Choose Edit This Page and install + Choose Edit This Page and install Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed). Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml,v diff -u -r1.15 -r1.16 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml 14 May 2004 14:10:28 -0000 1.15 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml 11 Jun 2004 10:13:01 -0000 1.16 @@ -140,7 +140,7 @@
How it Works - + Program @@ -369,7 +369,7 @@ Multiple-server configuration - + @@ -423,23 +423,23 @@ Simple A/B Deployment - Step 1 - +
Simple A/B Deployment - Step 2 - +
Simple A/B Deployment - Step 3 - +
@@ -450,23 +450,23 @@ Complex A/B Deployment - Step 1 - +
Complex A/B Deployment - Step 2 - +
Complex A/B Deployment - Step 3 - +
Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/oracle.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/oracle.xml,v diff -u -r1.17 -r1.18 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/oracle.xml 14 May 2004 13:53:14 -0000 1.17 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/oracle.xml 11 Jun 2004 10:13:01 -0000 1.18 @@ -58,7 +58,7 @@ note 223718.1to find certified platforms. If you don't have metalink access, take a look at the Oracle on Linux FAQ: Which - Linux Distributions Are Directly Supported By Oracle?. In summary, + Linux Distributions Are Directly Supported By Oracle?. In summary, free and inexpensive Linux distributions are not certified. Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/other-software.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/other-software.xml,v diff -u -r1.19 -r1.20 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/other-software.xml 19 May 2004 12:19:25 -0000 1.19 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/other-software.xml 11 Jun 2004 10:13:01 -0000 1.20 @@ -879,11 +879,11 @@ Once installed you can enable this by configuring your config file. Make sure your config file supports php (it should have a php section with it). Furthermore add index.php as the last element to your directoryfile directive. + Install Squirrelmail for use as a webmail system for OpenACS By Malte Sussdorff - Install Squirrelmail for use as a webmail system for OpenACS This section is work in progress. It will detail how you can install Squirrelmail as a webmail frontend for OpenACS, thereby neglecting the need to have a seperate webmail package within OpenACS [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]# cd www [$OPENACS_SERVICE_NAME www]# wget http://cesnet.dl.sourceforge.net/sourceforge/squirrelmail/squirrelmail-1.4.2.tar.gz Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/recovery.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/recovery.xml,v diff -u -r1.11 -r1.12 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/recovery.xml 14 May 2004 14:10:28 -0000 1.11 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/recovery.xml 11 Jun 2004 10:13:01 -0000 1.12 @@ -23,7 +23,7 @@ Backup and Recovery Strategy - + Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml,v diff -u -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml 14 May 2004 14:10:28 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml 11 Jun 2004 10:13:01 -0000 1.25 @@ -45,7 +45,7 @@ Upgrading with the APM - + @@ -65,11 +65,11 @@ Root of OpenACS file tree - /var/lib/aolserver/$OPENACS_SERVICE_NAME + /var/lib/aolserver/$OPENACS_SERVICE_NAME Database backup directory - /var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup + /var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup @@ -350,7 +350,7 @@ Upgrading a local CVS repository - + @@ -374,8 +374,7 @@ (b): via cvs working checkout - Create a CVS checkout from OpenACS. The first time you do this, you will need to create the checkout directory. We use one dedicated directory for each branch of OpenACS - if you are using OpenACS 5.0,x, you only need an OpenACS 5.0 branch. The openacs-5-1-compat tag identifies the latest released version of OpenACS 5.1 (ie, 5.1.3 or 5.1.4) and the latest compatible version of each package, including .LRN. Each minor release of OpenACS since 5.0 has this tagging structure. (Ie., OpenACS 5.1.x has openacs-5-1-compat.) - + Create a CVS checkout from OpenACS. The first time you do this, you will need to create the checkout directory. We use one dedicated directory for each branch of OpenACS - if you are using OpenACS 5.0,x, you only need an OpenACS 5.0 branch. The openacs-5-1-compat tag identifies the latest released version of OpenACS 5.1 (ie, 5.1.3 or 5.1.4) and the latest compatible version of each package, including .LRN. Each minor release of OpenACS since 5.0 has this tagging structure. For example, OpenACS 5.1.x has openacs-5-1-compat. You will want to separately check out all the packages you are using.