diff --git a/docs/config_misc.html b/docs/config_misc.html index f2bc13c4a..266ac615f 100644 --- a/docs/config_misc.html +++ b/docs/config_misc.html @@ -371,11 +371,34 @@

Translation

Description

- A FileSetCheck that ensure the correct - translation of code by checking property files for consistency regarding their - keys. Two property files describing one and the same context are consistent if + A FileSetCheck that ensures the correct + translation of code by checking property files for consistency regarding their + keys. Two property files describing one and the same context are consistent if they contain the same keys.

+

+ Consider the following properties file in the same directory: + +

+      #messages.properties
+      hello=Hello
+      cancel=Cancel
+
+      #messages_de.properties
+      hell=Hallo
+      ok=OK
+      
+

+ The Translation check will find the typo in the german hello key, the + missing ok key in the default resource file and the missing cancel key + in the german resource file: +

+      messages_de.properties: Key 'hello' missing.
+      messages_de.properties: Key 'cancel' missing.
+      messages.properties: Key 'hell' missing.
+      messages.properties: Key 'ok' missing.
+      
+

Example

To configure the check: