add option to provide translation strings

Author: unverbuggt

README.md

@@ -46,6 +46,7 @@ The content is encrypted with AES-256 in Python using PyCryptodome, and decrypte
     * [Add button](#add-button)
     * [Reload scripts](#reload-scripts)
     * [Self-host crypto-js](#self-host-crypto-js) **(NEW)**
+    * [Translations](#translations) **(NEW)**
   * [Contributing](#contributing)
 
 
@@ -62,7 +63,7 @@ Install the package from source with pip:
 ```bash
 cd mkdocs-encryptcontent-plugin/
 python setup.py sdist bdist_wheel
-pip install dist/mkdocs_encryptcontent_plugin-2.4.1-py3-none-any.whl
+pip install dist/mkdocs_encryptcontent_plugin-2.4.2-py3-none-any.whl
 ```
 
 Enable the plugin in your `mkdocs.yml`:
@@ -524,6 +525,22 @@ plugins:
         selfhost_download: false
 ```
 
+### Translations
+
+If the plugin is used in conjunction with the [static-i18n](https://ultrabug.github.io/mkdocs-static-i18n/) plugin you can provide `translations` for the used `i18n_page_file_locale`.
+
+```yaml
+    - encryptcontent:
+        #...
+        translations:
+          de:
+            title_prefix: '[Verschlüsselt] '
+            summary: 'Der Inhalt dieser Seite ist mit AES verschlüsselt. '
+            placeholder: 'Mit Strg+Enter wird das Passwort global gesetzt'
+            password_button_text: 'Entschlüsseln'
+            decryption_failure_message: 'Falsches passwort.'
+            encryption_info_message: 'Bitte wenden Sie sich an den Systemadministrator um auf diese Seite zuzugreifen.'
+```
 
 
 # Contributing

encryptcontent/plugin.py

@@ -81,6 +81,7 @@ class encryptContentPlugin(BasePlugin):
         ('inject', config_options.Type(dict, default={})),
         ('selfhost', config_options.Type(bool, default=False)),
         ('selfhost_download', config_options.Type(bool, default=True)),
+        ('translations', config_options.Type(dict, default={}, required=False)),
         # legacy features, doesn't exist anymore
         ('disable_cookie_protection', config_options.Type(bool, default=False)),
         ('decrypt_search', config_options.Type(bool, default=False)),
@@ -335,6 +336,23 @@ def on_page_context(self, context, page, config, **kwargs):
         :param nav: global navigation object
         :return: dict of template context variables
         """
+        if hasattr(page, 'html_to_encrypt') or self.config['inject']:
+            if 'i18n_page_file_locale' in context:
+                locale = context['i18n_page_file_locale']
+                if locale in self.config['translations']:
+                    translations = self.config['translations'][locale]
+                    if 'title_prefix' in translations:
+                        self.config['title_prefix'] = translations['title_prefix']
+                    if 'summary' in translations:
+                        self.config['summary'] = translations['summary']
+                    if 'placeholder' in translations:
+                        self.config['placeholder'] = translations['placeholder']
+                    if 'password_button_text' in translations:
+                        self.config['password_button_text'] = translations['password_button_text']
+                    if 'decryption_failure_message' in translations:
+                        self.config['decryption_failure_message'] = translations['decryption_failure_message']
+                    if 'encryption_info_message' in translations:
+                        self.config['encryption_info_message'] = translations['encryption_info_message']
         if hasattr(page, 'html_to_encrypt'):
             page.content = self.__encrypt_content__(
                 page.html_to_encrypt,