Toolbox Customization

From Service Grid Documentation

Jump to: navigation, search

We provide the information of Toolbox customization in this page. Please install the Toolbox package and confirm that your installed Toolbox works properly before you read this page for Toolbox customization.

Contents

Logo configuration

The Toolbox Logo in the installation package is the one for Toolbox site that is operated by NICT. Please follow the steps below to customize the logo.

In the installation package, the Toolbox logo exists in the following location((We will use ${toolbox_dir} to describe the Toolbox installation directory.)).

${toolbox_dir}/html/themes/default/common/img/logo.gif

You can change the logo by replacing the above file. The logo size is 206(width)*103(height) pixel. An example of customized logo is as follows.

Sample logo changed.png

If you want to create your own logo, use the following file as a backgroud.

Top page customization

You can replace the Toolbox top page that is included in the installation package. The top page is described in the following file.

${toolbox_dir}/html/themes/default/top.html

The top page can be customized by replacing the following parts of the file.

<div id="contents_left_box_top">
  <div id="top_main_img">
    (This part is for description of the main functions of Toolbox)
  </div>
...

A simple example of the customization is provided below(For the purpose of localization, the messages are not always directly described in the HTML in the Toolbox. Please refer to "Localization of messages" for localization.).

<div id="contents_left_box_top">
 <div id="top_main_img">
    <p>This is my own Toolbox.</p>
  </div>
...

To customize the HTML file(HTML template), you need to delete the caches in directory of ${toolbox_dir}/html/templates_c. The same operations are required for the following HTML files. After above customization, the top page will be shown in the browser as Figure 2.

Sample top changed.jpg

Footer customization

When you open your own Toolbox, you can customize the copyright description in the footer part.

The footer is described in the following file.

${toolbox_dir}/html/themes/default/theme.html

The parts for customize copyright information is as follows. You can add the organization that provides Toolbox in the red part.

<div id="footer_inner">
  <address>&color(#F00){Copyright(C) 2009 MY ORGANIZATION. All rights reserved.};</address>
  <div class="poweredby">
  <img src="<{$xoops_imageurl}>common/img/pb_icon_Langrid02.gif" alt="Powered by Language Grid" width="80" height="30" />
  </div>
...
</div>

After the customization, the copyright information is shown as Figure 3.

Sample footer changed.jpg

Customization of Terms of Use

When you open your own Toolbox, please modify the Terms of Use according to your purposes.

To customize the Terms of Use, please access the XOOPS management page by the following URL. If the URL of Toolbox top page is http://localhost/toolbox/html, the management page can be displayed if you enter http://localhost/toolbox/html/admin.php in the browser.

In the left menu of management interface, choose User Module -> Preferences, set “Display disclaimer?” as “Yes”, enter the contents of Terms of Use in “Registration disclaimer”, and you can customize the Terms of Use.

Localization of messages

In Toolbox, the display language of user interface can be configured in the profile page. In the following part, we will introduce the steps for adding display languages of user interface. We use the example of adding the Chinese language to describe the steps.

First, please set the following values to add a language.

  • Language Code of Toolbox system: zh
  • Folder name of language resources: Chinese
  • Display language: Chinese

Based on the above value, please customize the following file to add a language.

${toolbox_dir}/html/modules/cubeUtils/include/conf_ml.php

Please customize the parts below.

7th line: define('CUBE_UTILS_ML_LANGS','ja,en');
→ define('CUBE_UTILS_ML_LANGS','ja,en,zh');
13th line: define('CUBE_UTILS_ML_LANGNAMES','ja_utf8,english');
→ define('CUBE_UTILS_ML_LANGNAMES','ja_utf8,english,chinese');
16th line: define('CUBE_UTILS_ML_LANGDESCS','Japanese,English');
→ define('CUBE_UTILS_ML_LANGDESCS','Japanese,English,Chinese');

Next, you can create the file to describe messages. You can copy the description file for an existed language, customize the parts of contents, and then you can create description file for a new language.

The following file describes the messages for Toolbox themes in XOOPS.

(in the case of English)${toolbox_dir}/html/themes/default/language/english.php

To create description file for Chinese messages, please copy the above file as “chinese.php” in the same file. In this file, messages are described in the forms as follows.

define('_THEME_MENU_TEXT00_LB', 'Top');

_THEME_MENU_TEXT00_LB is the symbol that is used in the HTML file(HTML template), and is replaces by the string "Top" when displaying the Toolbox top page. You can replace the "Top" by Chinese to define the Chinese messages.

Using the same steps, you can define other messages in all modules. The message description files of modules are as follows.

${toolbox_dir}/html/modules/${module_dir}/${language}/*.php

${module_dir} is the folder for modules. Main pages for Toolbox is as follows.

Toolbox pages ${module_dir}
BBS forum
Text translation document
Language resources dictionary
Profile, User registration user
Settings, Service import langrid
Login cubeUtils, legacy

${language} denotes the string for languages. In the above example, the string is "chinese". You can copy the folders for each language, change the folder name as "chinese", and change the message descriptions in the php files.

The descriptions of login messages and timezone messages exist in the following places. Please use the same steps as above to customize the messages.

${toolbox_dir}/html/language/${language}/user.php
${toolbox_dir}/html/language/${language}/timezone.php
${toolbox_dir}/html/language/${language}/api.php

Moreover, menu display of the configuration interface should also be localized in multiple languages. Please access the management interface described in [[Customization of Terms of Use>#ka3d6b5d]]], select “Legacy System” - “Module Management” and show the module list. For the modules that messages are described, the module name in the added language should be defined. Take the instance of the module of “document”, you can set as follows to define the English, Japanese, Chinese module names.

[en]Translation[/en][ja]翻訳[/ja][zh]翻译[/zh]

After configuration, you should click the “Update” button to finish.

Style customization

You can customize the style sheet to change the display styles of Toolbox. There are style sheets that is for the whole Toolbox, or individual pages and modules.

The style sheets that are shared for multiple pages are located in the following folder.

${toolbox_dir}/html/themes/default/common/css/

The style sheets for the top page are located in the following folder.

${toolbox_dir}/html/themes/default/css/

The style sheets for the pages of XOOPS modules are located in the following folder.

${toolbox_dir}/ html/modules/${module_dir}/css/

For ${module_dir}, please refer to Localization of messages. Also, there might be some modules that do not have any style sheets.

Personal tools
In other languages