Tools

Contents

1. Introduction
    1.1 Features
       1.1.1 Translate tool
       1.1.2 Backup tool
       1.1.3 Log viewer
       1.1.4 Update manager
    1.2 Assumptions

2. Tools manager overview

3. Translate tool
    3.1 Translate Tool overview
    3.2 Add a new language
    3.3 Translate a language
        3.3.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

With the Tools Manager -provided you have access permissions to one or more of its parts- you create translations, make backups of the Website@School database, view logs and manage updates of the system.

1.1 Features

The general idea of the manager was described above. Below follows the features of each manager.

1.1.1 Translate Tool

The Translate Tool has the following features:

1.1.2 Backup Tool

The Backup Tool has the following features:

1.1.3 Log Viewer

Log viewer features

1.1.4 Update Manager

1.2 Assumptions

This chapter elaborates on other chapters. We assume you have read and done the General part of the Table of Contents.

(top)

2. Tools manager overview

To go to the Tools manager, please click on the Tools Manager icon [ tools ] to open its main window:
[ Tools ]
tools_open.png

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

(top)

3. Translate Tool

A special, very easy to use tool is available to translate Website@School in a new language.

This chapter is written in such a way that persons who have never seen Website@School can start translating words like 'OK' and 'Save' and sentences like 'You entered a wrong password' in your language. We assume you are unfamiliar with translating in a web browser, and maybe expect to work with pen and paper, which is not the case.
Please carefully read the 'NEW USERS' texts. Other parts are for Website@School webmasters and can be skipped.

NEW USERS:

What you need to successfully and easily translate the Website@School Content Management System (CMS):

When all the above conditions are met, you are ready for the real stuff. Here we go!

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 fields. Below is an example. The password is invisible, you only see ********.

[ Translators site, log in with username and password ]
tools_translate_tool_log_in_name_passw.png

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

[ Welcome, greyed out icons ]
tools_translate_tool_startcenter.png

Most icons in the upper left corner are greyed out, meaning you have no access to them. If you want full access to a Website@School site, please read the Guided Tour and look for the 'Sandbox'.

Please click on the [ tools ] Tools Manager icon to open the Tools dialogue:

[ Tools, summary, greyed out tools in Menu ]
tools_translate_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

You have just clicked on the Translate Tool link and have entered the Translate Tool itself:
[ Translate Tool, list of languages ]
tools_translate_tool_open.png

The list of languages is visible, but is now much longer. Thank you all!
We already have entered the language you are going to translate. Please look for the name of the language you are going to translate.

NOTICE:
Please, do NOT touch the other translations!!

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

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

Explanation:

3.2 Add a new language

Clicking on the Add language link opens the Add a new language dialogue:
[ Add a new language, entry fields ]
tools_translate_tool_add_language.png

Explanation:

After saving the results, the new language is added:

[ Translate Tool, message= succes, language 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

NEW USERS:
You have just selected a language, for example Français. Now you see something like:
[ Translation for LanguageName (language code) - Part. Page top ]
tools_translate_tool_translate_language_new_user.png

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

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 frightened by the text below. It is difficult indeed and we can explain it via mail, telephone 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, specially texts and signs 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:

Translation for Español (es) - General

Here you can modify the translations. Please note that codes like <strong> and {VALUE} should be left as-is (untranslated); these codes are necessary for the proper working of the program and should be copied verbatim.

NOTICE:
Stuff like <strong> and {VALUE} are part of the program code and must not be translated. The best way of working is to not even touch things like {HOTKEY}, {SITENAME}, {ALERTS},.
SUMMARY: stay out of stuff in RED!

Now we give some examples to illustrate translating.
[ Translation for LanguageName (language code) - Part, entry fields. Page top ]
tools_translatee_tool_translate_language_top.png

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

[ Numbered sentence (English) with translaton in entry field (Spanish) ]
tools_sentence2_en+es.png

The first line is in English. That's the basic language, the mother language of Website@School.
The second line, the parent language, is the line to be translated. It is now Spanish because that was the language the translator of French preferred to replace with French words. Spanish was selected for him when we created his 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:

[ Numbered sentence (English) with translation in entry field (Chinese) ]
tools_sentence2_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:

[ Numbered sentence (English) with translaton in entry field (French), texts in red ]
tools_translate_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 somewhere in the Netherlands. 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!

Saving takes time. After a while you see:
[ message= succes ]
tools_translate_tool_translate_language_saved.png

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

After saving your text, you can continue translating until that part is done. Below is the end part of a translation:

[ Translation for LanguageName (language code) - Part. Page bottom ]
tools_translate_tool_translate_language_bottom.png

Explanation:

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

Here you can modify the translations. Please note that codes like <strong> and {VALUE} should be left as-is (untranslated); these codes are necessary for the proper working of the program and should be copied verbatim.

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.

What is a 'hotkey'?
A hotkey is a key or a combination of keys on a computer keyboard that, when pressed at one time, performs a task [...] more quickly than by using a mouse or other input device. Source: http://whatis.techtarget.com/definition/hot-key.
In Website@School hotkeys are used for blind webmasters. They cannot use a mouse to put the cursor in the right field to enter data. A key combination can put the cursor in the right field. For example, when using the Firefox browser and adding a new user, the combination [Shift+Alt+N] puts the cursor in the 'Name' field. When the blind user arrives at the password confirmation field, she 'sees' (by listening to a screen reader or using a braille reader) 'Confirm password'and notices the bold and underlined character 'w'. In Firefox the combination [Shift+Alt+W] puts the cursor in the 'Confirm password' field. And that's because, when translating, you put the tilde before the 'w'. You can put the tilde wherever you like, but not twice on the same place on one web page.
On an Apple PC she would have used the [Cmd+W] key combination.

Maybe, after having translated a bit, i.e. have some working experience, the text is not that difficult to understand. If not, please mail, phone or Skype 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 translators

When translating, you find many computer terms which could be unfamiliar to you. Maybe we can be of help with these links:
  1. http://translate.websiteatschool.eu/xlate.php. These are the old translations of our previous Content Management Sytem. Available languages:
    BG (Bulgarian), BR (Brazilian), CZ (Czech), DA (Danish), DE (German), EN (English), ES (Spanish), FI (Finnish), FR (French), GB (Chinese), HU (Hungarian), IT (Italian), JP (Japanese), NL (Dutch), NO (Norwegian), PL (Polish), SE (Swedish), TR (Turkish).
  2. http:translate.websiteatschool.eu/waxlate.php. These are all available translations of Website@School.

How to use them? Enter 2 familiar languages, for example EN and SE (available in our old program, but not yet in the new, so use the first link) and you find many terms. Use the 'Find' or 'Search' option in your browser for a specific word. For example: password:

 6. logged_password_forget
EN: Forgot password?
SE: Glömt lösenordet?

You can also look on the Internet (Google 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, phone or Skype Dirk Schouten.

3.4 Edit language properties

[ Edit language properties, entry fields ]
tools_translate_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.

3.5 Small language adaptations

Suppose you want to change the content of an alert e-mail, or want to change the names of the capacities to suit your institutional hierarchies. The way it's done is by:

3.5.1 High visibility adaptions

If you are not happy with the abbreviations for the icons in high visibility mode, you can use the list below to change the abbreviations.
All adaptions are done in Tools > Translate Tool > Select a language > Select 'Administration'. Here you can change the characters and signs.

Page Manager

Configuration Manager (Areas)

Account manager

File Manager

Tools (Translate Tool)

3.5.2 Export changes

To be done soon.

(top)

4. Backup tool

4.1 Database backup

In the Menu, clicking the 'Backup Tool' link brings you to the Backup Tool:
[ Backup Tool ]
tools_backup_tool_open.png

Explanation:
To create a backup, proceed as follows:

'NOTICE:
It's a good idea to make regular backups, say once per night. There is an abundance of backup software that can do this job, either on the school server, a school worksation or a comuter at home.

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

[ Log View]
tools_log_viewer_open.png

(top)

6. Update manager

Upgrades become available on our JOIN UP download location. Please see chapter Intro, paragraph 6. Useful Website@school sites.

Download the compressed (.zip or .tgz) upgrade (either a program update, a manual update, a language pack or a module) and unpack it in the CMS Root Folder. Please see chapter Installation, paragraph 1..1.3 Webservers and folders. CMS Root Folder.

NOTICE:
Please read the 3. Tips for a secure installation in the Installation Guide before proceeding any further. Security is vital!

After unzipping and checking secrity, log in with 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

After a successful unzip of the Website@School program, you may encounter error 50 on the school website, indicating you did not yet upgrade.

Please log in as webmaster to be directed to the Update Managerdialogue:

[ update manager, core update ]
tools_update_manager_core_update.png

After pressing the 'core' Update link, notice the status message carefully:

[ Update Manager, core updated ]
tools_update_manager_core_updated.png

Do as said en remove obsolete files!

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

6.2 Other updates

After upgdating a module, manual or language, login as webmaster and check Tools > Update Manager.

(top)

7. Concluding remarks

No concluding remarks yet

(top)

Author: Dirk Schouten <schoutdi@knoware.nl>
Last updated: 2013-07-02