Tools

Contents

1. Introduction
    1.1 Features
    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.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
    5.1 Download log
    5.2 Prune log

6. Update Manager
    6.1 Core update
    6.2 Other updates

7. Session Tool

8. Concluding remarks

1. Introduction

The Tools Manager contains several tools:

• 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 Session Tool to remove sessions and associated locks.
• The Updates Manager to install updates.

1.1 Features

The features of each tool are discussed in their own sections.

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 open the Tools manager, please click on the Tools Manager icon to open the Tools dialogue:

tools_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, Session 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.
  • The Session Tool allows for forcefully ending stray sessions, and unlocking locked pages and sections in the process.
  • Log View allows you to browse through log messages.
  • The Update Manager is used whenever a new, updated version of Website@School has to be installed on an existing website.

(top)

3. Translate Tool

NOTE:
For Website@School program translators the Translate Tool is extensively explained in chapter Translate Website@School Program. Please go there when you want to translate the program.

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

To enter the Translate Tool, in the Menu click on the Translate Tool link to open the Translate Tool dialogue:

tools_translate_tool_open.png

The list of languages is visible.

Explanation:

• Menu: The selected tool is underlined. The other tools may be grayed out, i.e. not accessible for the currently 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

Clicking on the Add a language link opens the Add a new language dialogue:

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.

  NOTICE:
  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 section 3.2 User properties, access permissions, group/capacity memberships in chapter Account Manager.
• [Save], [Done], [Cancel]: Please refer to section 2.3.3 [Save], [Done] and [Cancel] in the chapter Basic procedures for beginners for more information.

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

tools_translate_tool_language_added.png

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

3.3 Translate a language

Click on the language name, for example Svenska (sv), to enter the Translation for language name (cc) - Domain dialogue:

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 process takes place. It is extensively described in chapter Translate Website@School Program.

At the bottom of this screen there are a few housekeeping fields. These are used as a means of communication between the translator and the Website@School project and the webmaster of the website.

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 out to 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 and phrases.
• [Save], [Done], [Cancel]: Please refer to section 2.3.3 [Save], [Done] and [Cancel] in the chapter Basic procedures for beginners for more information.

tools_translate_tool_translate_language_saved.png

If the Submit this translation box was checked, an e-mail message is sent to the Website@School project and the webmaster of the website. Attached to this message is a backup copy of the translation.

NOTICE
As a rule the size of the submitted file (sv-was.bin in this example) is small. This is because only the changes are submitted rather than the full translation.

3.4 Edit language properties

tools_translate_tool_edit_language_properties.png

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 cannot be changed.

Explanation:

• 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 translation of a domain (e.g. General, Login or Administration) is started, all untranslated phrases will be in the parent language. If the parent language is changed, it applies only to new translations, e.g. whenever a new module or theme is added to Website@School.
• Mark the language as active: When the box is checked the language is selectable by the users in their language selection. See also section 3.2.1 Basic: Edit User username (Full Name) in chapter Account manager and section 3. Edit profile in chapter My page.
• [Save], [Done], [Cancel]: Please refer to section 2.3.3 [Save], [Done] and [Cancel] in the chapter Basic procedures for beginners for more information.

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:

• 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

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

• 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

To be done soon.

(top)

4. Backup tool

The Backup Tool has the following features:

• General: Easily create backups of the Website@School database.
• Unique filename: Each backup has its own unique name. No risk of overwriting older backups.
• Access control: only Users with permissions for Tools (Backups) can create backups (see section 3.2.4 Administrator permissions: username (Full Name) in chapter Account manager).

NOTICE:
Database backups can be quite large. Observe the memory_limit in php.ini in relation with the database size.

NOTICE:
The backup tool only makes a backup of the database. To make a backup of the Website@School data you need to use another tool, e.g. the Filezilla File Transfer Program (FTP), see http://filezilla-project.org.

4.1 Database backup

In the Menu, clicking the Backup Tool link opens the Backup Tool dialogue:

tools_backup_tool_open.png

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.
• Save the backup in that directory. The backup has a name like: exemplum.eu-was-was-20160707-135523.zip, which is patterned after this format: [website]-[dbname]-[prefix]-[yyyymmdd]-[hhmmss].zip.
• Ready!

NOTICE:
The link Download Backup provides a backup in .ZIP-format. You can force the Backup Tool to generate an uncompressed backup by using the URL http://exemplum.eu/admin.php?job=tools&task=backuptool&download=sql instead of http://exemplum.eu/admin.php?job=tools&task=backuptool&download=zip

4.2 Data backup

Website@School uses a separate folder to store the data that are not a part of the database like pictures and documents. That is, materials uploaded with the File Manager. These files are stored in the data directory that was created during the installation of Websit@School. They are stored in the CMS Data Folder. An example file path: /home/httpd/wasdata/88a7a1aa15bc1664764e9b154894e173

Note that these data files are not backed up by the Backup Tool. You can backup them on the server with the tools available. Contact your ISP or systems administrator for information.

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

(top)

5. Log viewer

A systems administrator once said: "Your logs are your friends". In Website@School many events are logged to the log table. If you have the necessary privileges Tools (Log viewer) you can browse the contents of the log table.

(See section 3.2.4 Administrator permissions: username (Full Name) in chapter Account manager for more information about privileges).

In the Menu click on Log view to open the Log Viewer:

tools_log_viewer_open.png

Explanation:

• Log view [nnn-nnn of nnn]: this title conveys which messages are currently displayed. By default Log View shows the last page of the message log, i.e. the most recent messages.
• Nr: in the log view all messages are always numbered from 1 to nnn (even after pruning)
• Date/time: indicates when an event happened.
• Address: the IP-address from which the event was triggered.
• User: if known, the name of the user associated with the event.
• Priority: usually LOG_INFO.
• Message: detailed description of the event.
• Download: this link leads to the download dialog, see section 5.1 Download log below
• Prune: this link leads to the prune dialog, see section 5.2 Prune log below
• Previous < nn nn nn > Next All: a navigation bar to make it easier to page through the usually long list of messages.

NOTICE:
The address 'cli' indicates that this event was ultimately generated from the command line interface of the PHP language interpreter that is used to run the Website@School program. As a rule these are the events that happen when the cron job is run. See 4.4 Configuring cron.php in chapter Installation for more information about running cron jobs.

5.1 Download log

If you click on the link Download, your browser will present you with a dialogue similar to the one below.

tools_log_viewer_download.png

If you click the button [OK] a file will be downloaded on your computer. This file will contain all log messages older than the first message that is currently visible on your screen. In the example given that would imply 880 messages recorded before 2016-07-06 15:29:49.

The format of the downloaded file is Comma Separated Values (CSV). Below is a snippet of an example file. This file can be imported in a spreadsheet program, for further processing.

5.2 Prune log

Eventually the log table may grow and grow and grow until it is huge. If you click on the link Prune, your browser will present you with a dialogue similar to the one below.

tools_log_viewer_prune.png

This confirmation dialog asks you if you are sure that you want to delete those 880 messages. It also gives you one last chance to download the selected log messages via de Download link. Clicking that link yields the download dialogue discussed in the previous section.

If you click the button [Delete], the selected log messages will all be deleted. Note that there is no way to ever undo this deletion.

After deleting is complete the following is displayed.

tools_log_viewer_prune_success.png

Note that the list of log messages is now not paginated (the title says Log view without the [nnn-nnn of nnn] postfix). Also note that the message that was numbered '881' now is the first (Nr=1) in the list.

(top)

6. Update manager

Upgrades become available on our download location, see section 6.1 Downloads in chapter Introduction or navigate directly to http://download.websiteatschool.eu

NOTICE:
Ater a successful update the new modules and themes are not automatically available in the demonstration data installed in the Exemplum Primary School areas. Only in a new installation with demodata the new features are installed without the need of adding them manually 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. See section 1.1.3 Webservers and folders in chapter Installation for more information about names of directories and folders.

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

After unzipping and checking security, log in with the guru 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 perform the upgrade.

Please log in as webmaster to be directed to the Update Manager dialogue:

tools_update_manager_core_update.png

Explanation:

The update manager lists version information for the core system and all languages, modules and themes. The last column contains either

• the word OK, indicating that the core, language, module or theme is up to date,
• the link Update, indicating that the core, language, module or theme must be updated, or
• the link Install, indicating that the a new language, module or theme must be installed.

In this example the core requires an update. If you click on the link Update, the core program will be updated. Aterwards a message like the following is displayed.

tools_update_manager_core_updated.png

The core is now up to date.

NOTICE:
Information on the internal version number can be found in section 4.1 Site configuration in chapter Configuration Manager.

6.2 Other updates

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

tools_update_manager_language_update.png

Explanation:

Here a single language needs to be updated. Follow the link Update to update this language. The following will be displayed.

tools_update_manager_language_updated.png

If there are no other pending updates or additions that need to be installed, your version of Website@School is completely up to date.

(top)

7. Session Tool

In some circumstances it happens that a page or a section is locked by a User and it is desirable to regain access to that locked page at short notice. See also section 7.1 Locked page in chapter Basic procedures for beginners.

If you have the necessary privileges Tools (Session Tool) you can forcefully end sessions and unlock pages and sections. See section 3.2.4 Administrator permissions: username (Full Name) in chapter Account manager for more information about privileges.

To solve the issue of the locked page, click Session Tool. A screen like the following will be displayed.

tools_sessions_overview.png

This screen provides an overview of all sessions that are considered active. In this example there are two sessions associated with Mary Astell:

• one from the computer with IP-address 192.168.0.50 (started at 15:30, session 31), and
• one from the computer with IP-address 192.168.0.99 (started at 15:32, session 33).

Note that session 33 has locked page 3 About us (Information about the school). This means that only Mary Astell is able to unlock this page; currently nobody else can unlock or edit this page.

NOTICE:
There is no garbage can next to session 34 because it should never be possible to end one's own session this way, not even by accident. In other words: wblade can end all sessions with the Session Tool except her own session.

Wilhelmina Bladergroen has enough permissions to use the Session Tool. Clicking the small garbage can next to session 33 yields the following dialogue.

tools_sessions_delete.png

By clicking the button [Delete] session 33 will be forcefully ended and also all locks held by this session will be released.

After succesfully removing the session from the database, the following dialogue is displayed.

tools_sessions_delete_success.png

Note that session 33 is no longer in the list of active sessions. This implies that page 3 is no longer locked.

NOTICE:
Ending a session this way is not very elegant; it might end a session where some User is legitmately editing a page. If the session is ended with force, all that User's changes that were not already saved are lost. The User will probably don't like that, so use this tool with care.

(top)

8. Concluding remarks

No concluding remarks yet.

(top)