Tools

Contents

2. Tools manager overview

3. Translate tool
    3.1 Translate Tool overview
    3.2 Add a new language
    3.3 Translate a language
        3.4.1 Tips for translators
    3.4 Edit language properties
    3.5 Small language adaptations
       3.5.1 High visibility adaptions
       3.5.2 Export changes

4. Backup tool
    4.1 Database backup
    4.2 Data backup

5. Log viewer

6. Update manager
    6.1 Core update
    6.2 Other updates

7. Concluding remarks

1. Introduction

1.1 Features

1.1.1 Translate Tool

• General: A user-friendly way to translate the complete Website@School program in your language.
• Selectable language: When translating, two languages are available for easy reference: the installed language and the language to be translated. Example: you know Spanish very well (installed language) and a bit of English. So you translate English in the new language, say Norwegian.
• UTF-8: Fully UTF-8 (8-bit Unicode Transformation Format) compatible. That is, no problems with diacritical characters and non Western lanuages like Chinese, Hindi, et cetera.
• Shortcuts: Shortcut keys can be assigned language dependent.
• Notes: Notes can be added to translations.
• Submit language: If selected, a copy of your translation can be send per e-mail to the webmasters e-mail address, specified in the Site configuration.

1.1.2 Backup Tool

• General: Easily creat backups of the Website@School database.
• Database file format:

• > 2.(hidden feature) je kunt als je wilt nu ook een plain SQL
  >   backup maken. Normaal surf je naar
  >   ..../admin.php?job=tools&task=backuptool&download=zip
  >   maar je kunt nu ook dit doen:
  >   ..../admin.php?job=tools&task=backuptool&download=sql
  

• File name: Each backup has its own unique name. No risk of overwriting older backups.
• Compression: Backupfiles are zipped.
• Backup tool: memory_limit in php.ini 3 x database size.

1.1.3 Log Viewer

• Logs everything.

1.1.4 Update Manager

• :
• :

1.2 Assumptions

(top)

2. Tools manager overview

tools_open.png

The opening screen is split in two parts, the menu part and the management part.

• Menu: The Menu part has two modes:
  • Task selection: You can select a specific management task, Translate Tool, Backup Tool, Log View and Update Manager. By clicking on one of the items it's chosen, becomes underlined and is opened in the managing part.
  • Managing a task: When Translate Tool, Backup Tool, Log View or Update Manager is chosen, its configuration fields become available.

(top)

3. Translate Tool

This chapter is written in such a way that persons who have never seen Website@School can start translating. So, we assume you are unfamiliar with translating in a web browser. Please keep an eye on the 'NEW USERS' texts in this paragraph. Other parts are for Website@School webmasters and can be skipped.

NEW USERS:

What you need to successfully and eesily translate:

• You have access to a computer, either at home or at school/work.
• You know how to type on a keyboard and how to use, for example, an e-mail program and send and receive e-mails, or browse on the Internet, or use a word processor like Word or Open Office. That is, you must have basic computer skills.
• The computer needs to be connected to the Internet via an ADSL, cable or fibre Internet connection.
  We strongly advise you not to use a telephone connection with a telephone modem. Reason: translating takes time and all that time you must have a connection with the Internet. This means: in the end, we end up with a fine translation :-) and you end up with a huge telephone bill :-((. That's not our intention!
• The computer must have a browser program, like Firefox, Inernet EXplorer, Safari, Opera or some other program which you use to look around on the Internet.
  That's because you translate in the browser. By saving your work, you send what you have done from your computer to our server in the Netherlands. We do not put anything on your computer.
• To actually translate, you have to login to the translation website. This is the login page: http://translate.websiteatschool.eu/admin.php. Please, don't go there yet.
• You have received a username and password. If not, and you want to translate, please write to translators at websiteatschool dot eu or schoutdi at knoware dot nl.

When you do not have a a login name and a passwordd, please read the NOTICE below.
When you have a login name and a passwordd, please read on.

• Switch on your computer and start your web browser (Internet Explorer, Firefox, et cetera).
• Go to http://translate.websiteatschool.eu/admin.php.
• You enter the the website log in page:
  
  tools_translatee_tool_log_in.png

NOTICE:
When you do not (yet) have a login name and a password, also start your computer and a browser. You can excercise at our Website@School Test Site at:
http://wyxs.net/was_daily/admin.php with:
- Login name: jtester
- Password: Jtester4U
and practice without damaging anything. Do not do the real translation there. Your work will be destroyed every 24 hours!

When you are on the translators site you will see something like:

tools_translatee_tool_log_in.png

This is the login 'dialogue' (dialogue is terrible computer jargon, used to describe a sort of communication or 'dialog' between a computer and its user).
Anyhow, enter your login name and password in the fiields. Below is an example. The password is invisible, you only see ********.

tools_translatee_tool_log_in_name_passw.png

After entering your login name and password, click the [OK] button or press the [Enter] key on your keyboard.
If you have entered the correct login name and password, you etner the Website@School Welcome dialogue:

tools_translatee_tool_startcenter.png

Most icons in the upper left corner are greayed out, meaning you have no access to them.
Please click on the Tools Manager icon to open the Tools dialogue:

tools_translatee_tool_all_tools.png

You are in the Tools manager overview. In the Menu inaccessible tools are greyed out.

In the Menu click on the Translate Tool link to open the Translate Tool dialogue, which is described in the next paragraph.

NEW USERS:
Please read on in the 'Translate Tool Overview'.

3.1 Translate Tool Overview

tools_translatee_tool_open.png

The list of languages is visible. If you see strange blocks, the language pack of that languagae is not installed on y9ur PC.
We already have entered the language you are going to translte. Please look for the name of the language you are going to translate.

NOTICE:
Do NOT touch the other translations!!

Click on the name of the language you are going to translate, as axample for this manual: Français (French).

NEW USERS:
Please read on by going to paragraph 3.3 Translate a language. <--- Click on the link.

Explanation:

• Menu: The selected item is underlined. The other tools are greyed out, i.e. not accessible.
• Translate Tool: An overview of its options:
  • Add a language: Clicking on this link brings you to the Add a new language dialogue. Adding a language is discussed in section 3.2 Add a new language.
  • Pencil icon: Clicking on the pencil brings you to the Edit language properties dialogue. These options will be discussed below in sections 3.4 Edit language properties.
  • Language name: This link has the form:
    Lanaguagename (xx).
    The language name is shown in that language, So, not 'Polish', but 'Polski'. This options will be discussed below in section 3.4 Edit language properties.

3.2 Add a new language

tools_translatee_tool_add_language.png

Explanation:

• Language code (ISO 639): A two or three character code must be entered here that corresponds with the language to be created. For details on the country codes see: http://www.w3.org/WAI/ER/brIG/ert/iso639.htm to choose the correct code. Don't mind the 'obsolete' in the above web page; it works fine. For further details on this matter, see Wikipedia on http://en.wikipedia.org/wiki/ISO_639.
• Name (expressed in the language itself): Enter the name of the language, for example: Deutsch, Français, Polski.
• Parent language: Website@School uses a mother and a parent language. The mother language is always English. The parent language can be selected in the dropdown menu (ff available). By replacing these words and sentences in the parent language, you replace the chosen language with the translation you make.
  If the default (none) is selected, English will be the parent language.

  NOTICE:
  Carefully choose the Parent language. The choise of the parent language (for example Español) is a permanent one and cannot be changed or undone

• Mark the language as active: When the box is checked the language is selectable by the users in their language selection. See Account manager, paragraph 3.2 Grant the user access permissions.
• Save: To save your results. After saving your work, the newly created language will appear in the list of languages, ready for further action.
• Cancel: To cancel your action and return to the Translate Tool overview.

When the results are saved, the language is added:

tools_translatee_tool_language_added.png

By selecting the (added) language, you can start translating. This is discussed in the next paragraph.

3.3 Translate a language

tools_translatee_tool_translate_language_new_user.png

In the Menu the different parts of Website@School to be translated can be selected. The selection is underlined General. That's the translation to start with. By clicking the other blue links in the Menu, you can translate other parts of Website@School.

On the right side of the Menu, the Translation for Language-'language code'-'Part' can be seen. Below, as example, French:

NEW USERS: Do not be frightended by by the text below. It is difficult indeed and we can explain it via mail or Skype. Just start translating and forget the '~' (tilde) stuff for the moment. Your translation is more important! We will come back on the ~ (tilde) stuff later. Pleas do read about things not to touch, like texts in RED.

Below is a copy of the text you see in the picture below. We split it in two parts for the NOTICE below:

NOTICE:
The best way of working is to not even touch things like {HOTKEY}, {SITENAME}, {ALERTS}, et cetera. In short: stay out of stuff in RED!

NEW USERS: Do not be scared by the text that follows. It is difficult indeed and we can explain it via mail or Skype. Just start translating and forget the '~' (tilde) for the moment. Your translation is more important! We will come back on the tilde stuff later.

tools_translatee_tool_translate_language_top.png

Let's take, as example, sentence number 2:

tools_semtemce2_en+es.png

The first line is in English. That's the basic language, the mother language of Website@School.
The second line is the line to be translated. It is now in Spanish. That was the language the translator of French prefeered to replace with French words. This language was selected for you when we created your account. It cannot be changed any more.

Another example. It could be that the picture above is also fine for a translator who understands Spanish and a bit of English. She can now replace the language in Chinese, by replacing the Spanish text:

tools_semtemce2_en+zh.png

You also see text and signs in RED or something like {MIN_LENGTH}, {MIN_DIGIT} and similar stuff. Please, please, when translating leave those parts untouched. It is computer code! Here is an example:

tools_translatee_tool_translate_language_red_text.png

NOTICE:
Please save often (at least every quarter of an hour or even more). This is done by scrolling down (or with Page Down on the keyboard) to the bottom of the page and clicking the [Save] button. Remember, your work is only on your computer and has to be send to the server sonwhere in the Neterlands. It would be a small disaster if you have translated for a couple of hours and the connection was lost during translating. All your precious work gone! Please save often!

tools_translatee_tool_translate_language_saved.png

NOTICE:
Saving takes time. Please wait for the confirmation message in the yellow bar.

After saving your text, you can continue translating untill that part is done.
At the bottom of the text you can send notes to us:

tools_translatee_tool_translate_language_bottom.png

Explanation:

• Submit this translation: Please leave this option checked. Better submit an unfinished translation than to forget it accidentally.
• Translator name: Enter your name here.
• Translator email address: Enter your email address, so we can reach you if necessary.
• Translator notes: Space for your own notes or message(s) to us.
• Save: To save your results and submit the translation. After saving you stay in the same dialogue.
• Cancel: To cancel your action and return to the translate tool overview.

Now please read what is on top of the page where you started. Here is that difficult text again:

Translation for Français (fr) - General

Also note the '~' (tilde) is used as a shorthand notation to define hotkeys in dialogs. For example, a field labeled ~File could be selected by pressing the keycombination [Alt-F] or [Cmnd-F]. The German translation could be ~Datei, with hotkey [Alt-D] or [Cmnd-D].
It is important that a hotkey is unique within a dialog, i.e. if you, the translator, have used the letter D already in that dialog, your German translation might become Dat~ei, yielding hotkey [Alt-E] or [Cmnd-E].
In short: it is up to you, the translator, to choose a good set of hotkeys by carefully placing the tildes.

Maybe, after having translated a bit, i.e. have some working experience, the text is not that difficult to understand. If not, please mail us so we can help you.

We thank you on behalf of every pupil, parent, teacher and school in your country. You do a wonderful job for them.

3.3.1 Tips for tranalstors

DE: Geben Sie Ihre E-Mail Adresse an, und Ihr momentan gültiges Passwort wird an die Kontakt E-Mail Adresse geschickt. 

HU: Írd be az e-mail címedet és hamarosan megkapod e-mailben a jelszavadat.

Please also read on http://translate.websiteatschool.eu the page 'Tips'. It might contain last minute information provided by one of your colleagues.

You can also look on the internet (Goole is your friend) for computer terms dictionaries. Or ask help from another teacher or a neighbour. Everyone, like you, wants to help education.

NEW USER:
Dear new user, here ends the manual part for new translators. When you have questions, please mail us.

3.4 Edit language properties

tools_translatee_tool_edit_language_properties.png

Explanation:
NOTICE: This dialogue is the same as the Add a language dialogue. You can correct errors in the name of the language and change 'active'. The language code and parent language cannot be changed.

• Language code (ISO 639): The chosen language code cannot be changed. This is a feture.
• Name (expressed in the language itself): Errors can be corrected.
• Parent language: Once chosen, the parent language cannot be changed.
• Mark the language as active: When the box is checked the language is selectable by the users in their language selection. See Account manager, section 2.3 Give the user privileges.
• Save: To save your results. After saving you return to the Translate Tool overveiew.
• Cancel: To cancel your action and return to the Translate Tool overview.

3.5 Small language adaptations

• Go the the right place for the text you want to channge.
• Make the changes and save them.
• Log out and in.
• Inspect the changes.
• Send them to us.

3.5.1 High visibility adaptions

Page Manager

• Trashcan/Delete icon= D = 63
• Pencil/Edit icon= E = 67
• Home icon = H = 71
• Not home = _=72
• Preview/Page icon = P = 78
• Folder opened icon = - = 84, 90, 96
• Folder closed icon = + = 81, 87, 93
• Visible icon = _ = 100
• Invisible icon = I = 105

Configuration Manager (Areas)

• Home icon = H = 261
• Not home = _ = 262
• Delete icon = D = 268
• Edit icon = E = 272

Account manager

• Trashcan/Delete icon = D = 409, 552
• Edit icon = E = 412, 555

File Manager

• Folder icon = + = 698

Tools (Translate Tool)

• Edit icon = E = 747

3.5.2 Export changes

(top)

4. Backup tool

4.1 Database backup

tools_backup_tool_open.png

Explanation:
To create a backup, proceed as follows:

• Click on the link 'Download Backup'.
• A window on your own computer opens.
• Select a directory to save the backup. The backup has a name like:
  exemplum.eu-was-was-20110104-185127.zip Which reads as: [ebsite]-[database name]-[prefix]-[YYYMMDD]-[hhmmss].zip.
• Ready!

4.2 Data backup

All docs and pics are not backed up.
They are in the CMS data foler. Example:
/home/httpd/wasdata/md5/ 

(top)

5. Log viewer

tools_log_viewer_open.png

(top)

6. Update manager

Download the upgrade (either a program update, or a manual, language or module update ) and unzip or untgz jin the CMS Root Folder. After unzipping, log in wiht the root account (webmaster, Wilhelmina Bladergroen). For a core update you are directly sent to the Update Manager dialogue.
For other updates, go Tools > Update manager.

6.1 Core update

Log in as webmaster to be directed to the Update Managerdialogue:

tools_update_manager_core_update.png

Depending on the performed upgrade differences in internal and external version numbers can be observed, as well as, in the Status column Update:

tools_update_manager_core_updated.png

WRONG PIC

After pressing the Update link, the internal and external versn numbers correspond and your Website@School is updated, up and running.

NOTICE:
Further information on the internal version number can be found in chapter Configuration Manager, paragraph 6. Site

6.2 Other updates

tools_update_manager_language_update.png

(top)

7. Concluding remarks

(top)