CSSCurrent en:Restructured Language Packages

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche

Changes to the structure of the language package

The structure of the language packages has been simplified with version 22. Instead of several properties files per directory, there is now one property file that replaces the directory. This file then contains all the properties of all the files that were previously in the directory.

The names of some files have been revised. For example, what was previously under "application" has been moved to "web-app.properties" and what was under "common" is now in "web-common.properties". In addition, a new file "system.properties" has been added. Certain properties that are not exclusively used by the user interface but also within the application (e.g. WSDL interface) have been moved here. Thus, there are only directories for the templates. All other properties are available directly via the respective file at the top level.

Directory structure of a Cryptshare Server language package (version 21 and older)

   │   administration
   │       Addon.properties
   │       ...
   │   application
   │       BasePage.properties
   │       ...
   │   common
   │       AbstractDropDown.properties
   │       ...
   │   mail
   │       mail.properties
   │   
   └───templates

Directory structure of the current Cryptshare Server language package (version 22 and newer)

   │   administration.properties
   │   mail.properties
   │   system.properties
   │   version.xml
   │   web-app.properties
   │   web-common.properties
   │   
   └───templates


Example Property old / new:

Name of property Version 21 Version 22
label.addon.clientID=Client ID Addon.properties in directory administration administration.properties
application.title=Cryptshare BasePage.properties in directory application web-app.properties
mail.heading.archivingFailed=Archiving Failed mail.properties in directory mail mail.properties

Changes to the structure of the templates

The templates have been revised in such a way that the HTML files only contain outline elements and property keys and all texts are in the respective "conf.properties". This means that when adapting the texts, only one file per template needs to be revised. Markdown can now be used in the texts.

Example downloadSummary message.html (old)

Message old html.png

Example downloadSummary message.html (new)

Message new html.png

The texts are now completely in the conf.properties:

Conf.properties download summary.png

In addition, functions are used in the HTML file to generate HTML from the text if it is written in Markdown.

Function Explanation
$render.eval(text) If the text itself contains variables, then this function is needed to replace the variables with the real values.
$esc.html(text) This function removes certain characters to prevent the resulting HTML from containing elements that an attacker can use to cause damage.
$md.toHtmlInline(text) Generates HTML from the Markdown text. This removes the enclosing paragraph and the last line break, if present.
$md.toHtml(text) Generates HTML from the Markdown text.