remove old readme
[atutor.git] / docs / documentation / admin / languages.php
1 <?php require('../common/body_header.inc.php'); $lm = '$LastChangedDate$'; ?>
2
3 <h2>Languages</h2>
4         <p>ATutor can be displayed in many different languages! Through the Langauge Manager completed languages packs can be selected and imported directly from the atutor.ca website. </p>
5
6 <h3>Managing Existing Languages</h3>
7         <p>Installed languages can be edited, deleted or exported as an ATutor language pack for redistribution. When exporting a language, a download prompt will appear asking to download a zip file of the language pack.</p>
8         
9         <p>Editing the language properties allows you to change the following:
10         <ul>
11                 <li>Language Code</li>
12                 <li>Locale</li>
13                 <li>Character Set</li>
14                 <li>Direction</li>
15                 <li>Left to Right, Right to Left</li>
16                 <li>Regular Expression</li>
17                 <li>Language name translated</li>
18                 <li>Language name in English</li>
19         </ul>
20         </p>
21
22         <p>Note that the default language (as specified in the <a href="system_preferences.php">System Preferences</a> <em>Default Language</em>) cannot be disabled or deleted unless another language has been installed.</p>
23
24
25 <h3>Importing Languages</h3>
26         <p>Language packs can be imported either manually by retreiving the package and then importing it into ATutor, or automatically by having ATutor connect to the atutor.ca language repository directly.</p>
27
28         <p>To <em>manually</em> import a new language pack:</p>
29         <ol>
30                 <li>Visit <a href="http://atutor.ca/atutor/translate/index.php" target="_new">atutor.ca/atutor/translate/</a> to download one of the available language packs for your version.</li>
31                 <li>Use the <code>Browse...</code> button to find the downloaded language pack.</li>
32                 <li>Use the <code>Import</code> button to import the language.</li>
33         </ol>
34
35         <p>If your ATutor installation is connected to the Internet and can contact the atutor.ca website, then it will try to retrieve the list remotely. To <em>automatically</em> import a new language pack from within ATutor:</p>
36
37         <ol>
38                 <li>Select the language you want to import from the drop down.</li>
39                 <li>Use the <code>Import</code> button to import the selected language.</li>
40         </ol>
41
42         <p>If your installation cannot retrieve the language list from atutor.ca, a message indicating so will be presented rather than a drop down list. In this case you will have to use the manual method described above.</p>
43
44
45 <h3>Translating ATutor</h3>
46
47         <p>Administrators have the ability to customize an installation's language. In order to translate a language, 
48         <ol>
49                 <li>Set the AT_DEVEL_TRANSLATE constant in /include/vitals.inc.php to '1'</li> 
50                 <li>Set the session language to the language you wish to translate by using the language selector at the bottom of the screen.</li>
51                 <li>Use the <code>Translate</code> button to pop up a translation window.</li>
52         </ol>
53         </p>
54
55         <p>You can contribute to the ATutor community by  exporting a language pack from your ATutor installation, and attaching it to a message in the atutor.ca <a href="http://atutor.ca/forum/4/1.html">Translation Forum</a>. Also see the <a href="http://atutor.ca/atutor/docs/translate.php">Translator Documentation</a> for further details about translating ATutor.</p>
56
57
58 <?php require('../common/body_footer.inc.php'); ?>