Skip to end of metadata
Go to start of metadata



About Modification and Creation of Language Packs

You can customize the language resources on your Cryptshare Server to your liking. You can change both the language resources that are shipped together with the Cryptshare Server, as well as create additional language resources yourself in order to present Cryptshare in further languages which are not part of the scope of delivery.

Language Packs and Server Updates

Please note that the update routines for Cryptshare Server may overwrite existing language packs on the server with newer versions. This is always the case when the server version you want to update to includes new features for which additional language resources are required for display.

Cryptshare performs an automatic backup of the previous version of Cryptshare Server before each update. This backup also includes the language packages so that any changes that you have made are not lost when language packs are overwritten during the update. However, they must be manually copied from the backed-up version of the language package and entered into the updated version of the language pack accordingly.

You can find the backups in the sub-folder "backup" of your Cryptshare Server program directory. Open the .zip archive from which you want to restore the language packs and navigate into the folder system\resources\lang

Pre-Conditions

In general it is sufficient to only include those files into the package, which shall be changed (normally translated). If an element is missing within a language package the corresponding element from the fallback package will be used instead.

Apart from that the following conditions must be met:

File/s

Condition

version.xml

Encoding has to be UTF-8 without BOM

All Files

Do not contain a language code in the file name

<*.properties>

Encoding has to be ISO-8859-1.

<*.html>

Encoding has to be UTF-8 without BOM

When not using the encodings listed above this can cause errors in the User Interface and in email notifications.

Therefore it is recommended to use an editor supporting different encodings for editing the files.

The Windows editor 'Notepad' does not support a suitable format. Editors supporting additional formats are for example:

Table of Contents

Related Knowledge Base Articles





Package Descriptor (version.xml)

Language Packages are defined and recognized (when installed) by their respective Descriptor-File (version.xml). The file describes the following details about the package:

  1. Version of the Package
  2. Language, and optionally the Country of the Package (ISO-639-1)
  3. Product-Key for which this package is made

Language Package Version

The version number of a package consist of a Major Version Number and a Minor Version Number: <Major>.<Minor>.
The Major-Number describes the compatibility with the product for which the package is made. The Minor-Number is count up for any change that has been made to the package.

Example

The Cryptshare Server v3.10 requires at least a language package of major version 4. An accepted package therefore must at least have version 4.0.

Custom Version Number

In order to know on which language package your custom package is based on you can use the original version number and multiply the major version number by 10: v6.1 --> v60.1

Language Package Product-Key

The new language package management can differentiate between packages made for different Cryptshare Products. This is specifically interesting for the Email Templating-Engine in order to install different notifications on the server for different products. For instance, Cryptshare for Outlook defines two different Email templates for the sender- and recipient notification.

Product-NameProduct-Key
Cryptshare Serverserver
Cryptshare for Outlookclient.outlook
Cryptshare for Notesclient.notes
Cryptshare Robotclient.robot
Cryptshare .NET APIapi.dotnet
Cryptshare Java APIapi.java
 Click to see the XML Markup for a 'version.xml' file ...
<locale>
    <value key="vendor" type="string">[VENDOR]</value>
    <value key="version" type="string">[LANG_VERSION]</value>
    <value key="locale" type="string">[LANGUAGE]</value>
    <value key="product" type="string">[PRODUCT]</value>
</locale>
 Click to see an example for a 'version.xml' file ...
<locale>
    <value key="vendor" type="string">Cryptshare AG</value>
    <value key="version" type="string">4.0</value>
    <value key="locale" type="string">de_DE</value>
    <value key="product" type="string">client.outlook</value>
</locale>

Structure of a language package

Cryptshare Server

A regular Cryptshare Server Language Package (server version 3 or above) has the following structure:

Path

Content

Mandatory

version_<isocode>.xml

Contains meta information about the language package:

  • Package language in form of a ISO-639-1 Code
  • Package Version: Versions not supported will be declined by the Cryptshare Server
  • Product: The product type of the package
Yes

administration -> <*.properties>

Contents for the Administration Interface

Only required if a translation of the Administration Interface is desired.

application -> <*.properties>

Contents for the User Interface

Only required if a translation of the User Interface is desired.

common -> <*.properties>

Contents used for the User Interface as well as the Administration Interface.

If either the Administration or the User Interface is modified, these resources should be modified as well.

help -> administration -> DynamicHelp_<isocode>.properties

Contents for the short-texts of the on-site help in the Administration Interface:


 

Only required if the short-text help within the Administration Interface shall be translated.

help -> administration -> html

Help contents for the detailed help of the Administration Interface.

Only required if the help content of the Administration Interface shall be translated

help -> administration -> img

Picture-contents for the detailed help of the Administration Interface

Required if the Administration Interface has been translated as well.

help -> application -> html

Help contents for the on-site help of the User Interface.

Only required for help contents within the User Interface.
mail -> mail_<isocode>.propertiesContains text snippets for email notificationsYes
templatesContains all email templates required for email notificationsYes, otherwise the defined fallback package is used.
Directory structure for a Cryptshare Server Language Package

Cryptshare for Outlook


PathContentMandatory
version_<isocode>.xml

Contains meta information about the language package:

  • Package language in form of a ISO-639-1 Code
  • Package Version: Versions not supported will be declined by the Cryptshare Server
  • Product: The product type of the package
Yes
lang_<isocode>.xmlContains resources for the Cryptshare for Outloook User InterfaceYes
templates → recipientThe email template for the recipient notification when performing a transfer via Cryptshare for OutlookYes
templates → sentThe email template for the email stored in the sent-items folder of Outlook when performing a transfer via Cryptshare for OutlookYes
templates → smsThe email template for the SMS notification when performing a transfer via Cryptshare for Outlook and choosing to send the password via SMSYes
Directory structure for a Cryptshare for Outlook Language Package