Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • When starting JOC Cockpit a temporary directory is created with the temp folder:

    Image Modified

  • Within the temporary directory hierarchy find language files in the following folder structure:

    Image Modified

Language File Development

Adding new Language Files

  • Open the translationlocales.js file to find a single function array to which you can add a new language by specifying country code, language code, country name and language name .Create a new language files like this:
    • {
        "en": {
          "lang": "en",
          "country": "US",
          "name": "English"
        },
        "fr": {
          "lang": "fr",
          "country": "FR",
          "name": "French"
        },
        "de": {
          "lang": "de",
          "country": "DE",
          "name": "German"
        },
        "ja": {
          "lang": "ja",
          "country": "JA",
          "name": "Japanese"
        }
      }
  • Create a new general language file - preferably by starting from a copy of the English general language file - for en.json and the naming convention <language code>.json.
    • Translate the assignments for each line of the general language file.
  • Create a new editor language file - preferably by starting from a copy of the English editor language file json-editor-text_en.json and the naming convention json-editor-text_<language code>.json.
    • Translate assignments for each line of the editor language file.

Editing Files

  • Language files use a JSON format and can be modified with any text editor.
  • Be careful when it comes to use of quotes and commas that have to be in place as visible from the examples. A missing quote or comma invalidates a language file.
  • Validate your language files with a JSON validator utility, a number of online resources are available.

Development Cycle

  • Language files are read by JOC Cockpit on first use. Any changes to a language file after this point in time are not considered.
  • Therefore the following development cycle applies:
    1. Store the working copy of your general language files file and editor language file in a folder outside of the JOC Cockpit installation.
    2. Start the JOC Cockpit service/daemon.
    3. Copy the modified version of your language file files and of the translationslocales.js file json file to the target folder as indicated with the above chapter.
    4. Log in to JOC Cockpit and optionally modify your user profile to use the newly added language. Any new language added to translationslocales.js should json should become available with your profile.
    5. Test your changes to the language filefiles.
    6. Any modifications to the language file files are not immediately considered but require a restart of JOC Cockpit as in step 2).

...

...