Interface Text Customization

This document dwells on interface text customization methods. It implies you are familiar with the concept of language bundles.

These are the following alternative ways to customize texts:

• With packages

  (HS 2.4 and up)

  In this case, you build new language bundles into a portable package easily installed on other H-Sphere's.

• Compiling bundles

  (HS 2.4 and up)

  This new scheme of customizing bundles implemented in HS 2.4 enables you to apply modifications by merging custom bundles with default bundles without building and installing packages. Read more about compiling bundles.

  1. Log into CP server as cpanel user.

     All affected files must have cpanel:cpanel ownership.

  2. Create custom bundle directory, e.g., ~shiva/custom/bundles if it is not created yet.

  3. Set custom bundle location in hsphere.properties (if it's not set):

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

  4. Find the string you want to modify among default or custom bundles. Create the corresponding custom bundle file if it doesn't exist to place modified string there.

     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.

  5. Copy the line with the identifier and the value you want to change into the custom bundle 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}

  6. Run language bundle compiler to implement customization:

     java psoft.hsphere.LangBundlesCompiler