Tools

Contents

1. Introduction
    1.1 Features
       1.1.1 Translate Tool
       1.1.2 Backup tool
       1.1.3 Log View
       1.1.4 Update Manager     1.2 Assumptions
    1.3 Convetions

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

4. Backup tool
    4.1 Database backup
    4.2 Data backup

5. Log viewer

6. Update manager

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 updtes 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

  • Logs everything.

    1.1.4 Update Manager

  • :
  • :

    1.2 Assumptions

    This chapter builds on other chapters. We assume you have an installation with demo data and the Website@School Users Guide. and you have full access to Website@School.
    Next to that we assume you have read the Introduction, Logging in and out and completely performed the Guided Tour.

    1.3 Conventions

    Some general features of W@S are not that easily found. Some corrrespond with the markup of this manual text, so we explain them both here.

    (top)

    2. Tools manager overview

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

    [ tools main window ]
    tools_open.png

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

    (top)

    3. Translate Tool

    3.1 Translate Tool Overview

    In the Menu, clicking the 'Translate Tool' link brings you to the Translate Tool overveiw:

    [ translate tool overview ]
    tools_translatee_tool_open.png

    Explanation:

    3.2 Add a new language

    Cliciing on hte 'Add new language' link opens its dialogue:

    [ translate tool add language ]
    tools_translatee_tool_add_language.png

    Explanation:

    When the results are saved, the language is added:

    [ translate tool language added ]
    tools_translatee_tool_language_added.png

    3.3 Translate a language

    By selecting the added language, you can start translating.

    NOTICE: Please read the instructions carefully before starting to translate. Here they are 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.

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

    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.

    [ translate tool translate language top  ]
    tools_translatee_tool_translate_language_top.png
    Explanation:
    In the Menu the different parts of the Website@school program can be selected for translation. The selected part is underlined.
    In the Translation section the lines can be translated.

    [ translate tool translate language bottom  ]
    tools_translatee_tool_translate_language_bottom.png
    Explanation:

    3.4 Edit language properties

    [ translate tool 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.

    3.5 Small language adaptions

    Suppose you want to change the content of an alert letter, or want to add some capacities to the groups in the Account Manager. The way it's done is by:

    (top)

    4. Backup tool

    4.1 Database backup

    In the Menu, clicking the 'Backup Tool' link brings you to the Backup Tool:

    [ backup tool open ]
    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 viewer open ]
    tools_log_viewer_open.png

    (top)

    6. Update manager

    After an update, you may encounter error 50 on the school website.

    Go to http://exemplum.eu/admin.php (fictional URL) to login as webmaster to enter the Update Managerdialogue:

    [ update manager update ]
    tools_update_manager_update.png

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

    [ update manager updated ]
    tools_update_manager_updated.png

    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

    (top)

    7. Concluding remarks

    No concluding remarks yet

    (top)

    Author: Dirk Schouten <schoutdi@knoware.nl>
    Last updated: 2011-01-04