H-Sphere Customization Guide

Interface Text Customization

(outdated in version 2.4)

 

Related Docs:  

Understanding Templates Introduction to Bundles Interface Text Customization (2.4 and up)

This document explains how to edit H-Sphere interface texts. It implies you are familiar with interface text bundles.

Step 1: Log in as cpanel user, under root:

su -
su - cpanel

All modified files must have the cpanel:cpanel ownership.

Step 2: Create the custom bundle directory ~cpanel/shiva/custom/bundles/. If this directory already exists, skip this step.

Step 3: In default bundles located in the ~cpanel/shiva/psoft/hsphere/lang directory, find the string you want to modify. Next, in the newly created directory, create a new empty file (if it doesn't exist) with exactly the same name as the one with the original string.

For example, you are going to change the label Shell Access to SSH Access. It is set in the ~cpanel/shiva/psoft/hsphere/lang/hsphere_lang.properties file. Create the file ~cpanel/shiva/custom/bundles/hsphere_lang.properties if it isn't there already.

Step 4: Copy the line with the identifier and the value you want to change into the new file and change its value the way you want. You should use two single quotes (apostrophes) instead of one in labels containing curly brackets, such as {0}. For example:

search.view_invoice = View Client's Invoice

but

billing.del_no = No, I don''t want to delete {0}

WARNING:
Don't copy the texts you are not changing! This will override the default settings, and you will not see the changes that come with new versions!

Step 5: Make sure the file is owned by cpanel:cpanel.

Step 6: Now you need to declare the custom bundles. In the hsphere.properties file, uncomment the line that corresponds to the file you have created:

CUSTOM_TEMPLATE_BUNDLE = custom.bundles.hsphere_lang
CUSTOM_MENU_BUNDLE = custom.bundles.menu
CUSTOM_USER_BUNDLE = custom.bundles.messages

It means H-Sphere will search for custom bundles in the ~cpanel/shiva/custom/bundles directory.

Step 7: Create two symlinks in your document root if they don't exist:

  • hsphere_lang_en.properties to hsphere_lang.properties, and
  • menu_en.properties to menu.properties

Step 8: Log in as root (log off from cpanel) and restart H-Sphere. You don't need to restart H-Sphere if you did nothing on step 4.

 


Related Docs:  

Understanding Templates Introduction to Bundles Interface Text Customization (2.4 and up)



© Copyright 1998-2006. Positive Software Corporation.
All rights reserved.