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 Edit language properties
    3.5 Small language adaptions
       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

• The Translate Tool to translate the Website@School program.
• The Backup Tool to make backups of the Website@School database.
• The Log View to keep track of what happens on your Website@School installation.
• The Updates Manager to automatically install updates.

1.1 Features

1.2 Assumptions

(top)

2. Tools manager overview

tools_open.png

The opening screen is split in two parts, the Menu pane and the Tools pane.

• Menu: The Menu pane has two modes:
  • Task selection: Select a specific management task by clicking on Translate Tool, Backup Tool, Log View or Update Manager. The task becomes underlined and is opened in the workplace pane.
  • Managing a task: When a task is selected, its configuration options become available in the workplace pane.
• Tools:
  Here you can find various tools.

  With the Translate Tool you can add new translations to the program or modify existing translations.

  The Backup Tool allows for downloading the complete database for this site.

  Log View allows you to browse through log messages.

  Please select a tool from the menu

(top)

3. Translate Tool

The Translate Tool is a special, very easy to use device to translate the program in a new language or to adapt a language to the schools preferences. The Translate Tool has the following features:

• Selectable language: When translating, two languages are available for easy reference: English and a selectable language.
• UTF-8: Fully UTF-8 (8-bit Unicode Transformation Format) compatible. That is, no problems with diacritical characters and non Western languages like Chinese, Hindi, et cetera.
• Shortcuts: Shortcut keys can be assigned language dependent.
• Notes: Notes can be added to translations.
• Submit language: A copy of your translation is send per e-mail to the Website@School project. Default the option is checked. The copy is sent to the address specified in the Configuration Manager < Site < Website From: e-mail address.

3.1 Translate Tool Overview

tools_translate_tool_open.png

The list of languages is visible.

Explanation:

• Menu: The selected tool is underlined. The other tools can be grayed out, i.e. not accessible for the logged in User.
• Translate Tool: Workplace header text.
  • Add a language: Clicking on this link opens the Add a new language dialogue. Adding a language is discussed in section 3.2 Add a new language.
  • Pencil icon: Clicking the pencil opens 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:
    Language name (ll).
    The language name is shown in that language, i.e. not as 'French', but as 'Français'. This options will be discussed in section 3.4 Edit language properties.

3.2 Add a new language

tools_translate_tool_add_language.png

Explanation:

• Language code (ISO 639): A two or three character code representing the language must be entered here. The official ISO-639 complete code table can be found at http://www-01.sil.org/iso639-3/codes.asp.
  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: Français, اردو Tiếng Việt български.
• Parent language:
  

  tools_translate_tool_add_language_parents_list.png
  Website@School uses a mother and a parent language. The mother language is always English. The parent language can if available, be selected in the dropdown menu. By replacing words and sentences from the parent language in your language, you create the new language.
  If the default (none) is selected, English will be the parent language.

  NOTE:
  Carefully choose the parent language. The choice of the parent language is permanent and cannot be changed or undone.

• Active [  ] Mark the language as active: If checked, the language is selectable by the administrator when she selects the language for a user. This is explained in the Account Manager chapter, paragraph 3.2 User properties, access permissions, group/capacity memberships.
• Save, Done, Cancel: Please see Save, Done, Cancel in the Basic procedures for beginners.

After clicking [Done], the new language is added:

tools_translatee_tool_language_added.png

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

3.3 Translate a language

tools_translate_tool_translate_language_new_user.png

• Menu pane

  The different parts of Website@School program to be translated. By clicking the other links in the Menu, the other parts become accessible. '

• Workplace pane: Here the actual translation precess takes place. It is extensively described in chapter Translate Website@School Program

tools_translate_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. Most translators use this part to ask us questions about the (sometimes confusing) meaning of words.
• Save, Done, Cancel: Please see Save, Done, Cancel in the Basic procedures for beginners.

tools_translate_tool_translate_language_saved.png

Also an e-mail is sent to the webmaster with a backup copy as attachment.

  -------- Original Message --------
From: اردو  Tiếng Việt български  العربية 中文 - First Name Last Name <webmaster@websiteatschool.eu>
Subject: Website@School Translation: اردو (ur) - admin
To: translations@websiteatschool.eu (Website@School Translations)
CC: اردو  Tiếng Việt български  العربية 中文 - First Name Last Name <translators@websiteatschool.eu>

Language name:   اردو
Language key:    ur
Language domain: admin
  

3.4 Edit language properties

tools_translate_tool_edit_language_properties.png

• Language code (ISO 639): The chosen language code cannot be changed. This is a feature.
• 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, Done, Cancel: Please see Save, Done, Cancel in the Basic procedures for beginners.

3.5 Small language adaptations

• Go the the right place for the text you want to change.
• Make the changes and save them.
• Log out and in.
• Inspect the changes.
• Please send them to us so others can use them as well.

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

• General: Easily create backups of the Website@School database.
• Database file format: The file has the format:
  exemplum.eu-was-yyymmdd-hhmmss.zip

  It's also possible to make a plain SQL or .zip backup with:
  ../admin.php?job=tools&task=backuptool&download=zip or
  ../admin.php?job=tools&task=backuptool&download=sql

• File name: Each backup has its own unique name. No risk of overwriting older backups.
• Backup tool and memory: NOTE: database backups can be quiite large. Observe the memory_limit in php.ini in regards to the database size.

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-20140104-185127.zip Which reads as:
  [website]-[dbname]-[prefix]-[YYYMMDD]-[hhmmss].zip.
• Ready!

4.2 Data backup

NOTE: These data are not backed up by Website@School. You can backup them on the server with the tools available.

(top)

5. Log viewer

tools_log_viewer_open.png

(top)

6. Update manager

NOTE:
Ater a successful update the new features are not available on the Exemplum Primary School area. Only in a new installation with demodata the new features are installed without the need of adding them via 'Add a page'.

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.

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

After unzipping and checking security, 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

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

tools_update_manager_core_update.png

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

tools_update_manager_core_updated.png

Do as said en remove obsolete files!

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

6.2 Other updates

(top)

7. Concluding remarks

(top)