diff --git a/docs/en/customization/introduction.md b/docs/en/customization/introduction.md index 213701c42..5b9daff30 100644 --- a/docs/en/customization/introduction.md +++ b/docs/en/customization/introduction.md @@ -100,3 +100,24 @@ class RemoteTranslationsCaller end ``` + +## Translation interface + +The aim of this feature is to allow users the introduction of dynamic contents in many languages at the same time. From the administration panel you can activate or deactivate it. If you deactivate this feature (default configuration) users will be able to enter one single translation. + +#### Enable module +To activate this feature you must follow 2 steps: +1. Execute the following command `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (This is only required for already existing intallations, for new consul installations this step is not needed). +2. Accessing as administrator user to the administration panel of your Consul application to the section **Configuration > Features** and activating the feature called **Translation Interface** as you can see next: +![Active interface translations](../../img/translations/interface_translations/active-interface-translations-en.png) + +#### Use Cases + +* When the translation interface is active: +As you can see in the image below translation interface has two selectors, the firt one "Select language" is to switch between enabled languages and the second one "Add language" is to add new languages to the form. Translatable fields appears with a blue background to facilitate users to distinguish between translatable and not translatable fields. Additionally interface provides a link `Remove language` to delete the current language shown at "Select language". If a user accidentally removes a translation he can recover it re-adding it to the form. +This feature is visible during creation and edition of translatable resources. +![Translations inteface enabled](../../img/translations/interface_translations/translations-interface-enabled-en.png) + +* When the translation interface is disabled: +When this feature is deactivated users will see standard forms without translation interface and without translation highlight. +![Translations inteface enabled](../../img/translations/interface_translations/translations-interface-disabled-en.png) diff --git a/docs/es/customization/introduction.md b/docs/es/customization/introduction.md index 3cc7d1b60..efcfe582b 100644 --- a/docs/es/customization/introduction.md +++ b/docs/es/customization/introduction.md @@ -100,3 +100,25 @@ class RemoteTranslationsCaller end ``` + +## Interfaz de traducción + +Esta funcionalidad permite a los usuarios introducir contenidos dinámicos en diferentes idiomas a la vez. Cualquier usuario administrador de Consul puede activar o desactivar esta funcionalidad a través del panel de administración de la aplicación. Si desactivas esta funcionalidad (configuración de la funcionalidad por defecto) los usuarios sólo podrán introducir un idioma. + +#### Activar funcionalidad +Para activar la funcionalidad deberá realizar 2 pasos: +1. Ejecutar el siguiente comando `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (Este paso sólo es necesario para instalaciones de Consul existentes que incorporan esta funcionalidad, para nuevas instalaciones no es necesario) +1. Accedediendo como usuario administrador a través del panel de administración de su aplicación a la sección **Configuración > Funcionalidades** y activando el módulo de **Interfaz de traducción** como se puede ver a continuación: +![Active interface translations](../../img/translations/interface_translations/active-interface-translations-es.png) + +#### Casos de uso +Dependiendo de si activamos o desactivamos el módulo de **Interfaz de traducción** veremos los formularios accesibles por el usuario de la siguiente manera: + +* Cuando la interfaz de traducción esta activa: +Como podemos ver en la imagen a continuación la interfaz de traducción tiene 2 selectores, el primero "Seleccionar idioma" permite cambiar entre los lenguajes activos y el segundo selector "Añadir idioma" permite añadir nuevos idiomas al formulario. Los campos traducibles se pueden distinguir fácilmente mediante un fondo azul de los que no lo son. También disponemos de un botón `Eliminar idioma` para eliminar un idioma en caso de necesitarlo. Si un usuario elimina accidentalmente un idioma puede recuperarlo añadiendo dicho idioma otra vez al formulario. +Esta funcionalidad está visible tanto para las páginas de creación como para las páginas de edición. +![Translations inteface enabled](../../img/translations/interface_translations/translations-interface-enabled-es.png) + +* Cuando la interfaz de traducción esta desactivada: +Cuando esta funcionalidad está desactivada los formularios se renderizan sin la interfaz de traducción y sin resaltar los campos traducibles con fondo azul. +![Translations inteface enabled](../../img/translations/interface_translations/translations-interface-disabled-es.png) diff --git a/docs/img/translations/interface_translations/active-interface-translations-en.png b/docs/img/translations/interface_translations/active-interface-translations-en.png new file mode 100644 index 000000000..2fcb2d0ff Binary files /dev/null and b/docs/img/translations/interface_translations/active-interface-translations-en.png differ diff --git a/docs/img/translations/interface_translations/active-interface-translations-es.png b/docs/img/translations/interface_translations/active-interface-translations-es.png new file mode 100644 index 000000000..ade7d236f Binary files /dev/null and b/docs/img/translations/interface_translations/active-interface-translations-es.png differ diff --git a/docs/img/translations/interface_translations/translations-interface-disabled-en.png b/docs/img/translations/interface_translations/translations-interface-disabled-en.png new file mode 100644 index 000000000..926eb8b32 Binary files /dev/null and b/docs/img/translations/interface_translations/translations-interface-disabled-en.png differ diff --git a/docs/img/translations/interface_translations/translations-interface-disabled-es.png b/docs/img/translations/interface_translations/translations-interface-disabled-es.png new file mode 100644 index 000000000..befd10fc5 Binary files /dev/null and b/docs/img/translations/interface_translations/translations-interface-disabled-es.png differ diff --git a/docs/img/translations/interface_translations/translations-interface-enabled-en.png b/docs/img/translations/interface_translations/translations-interface-enabled-en.png new file mode 100644 index 000000000..565a8f389 Binary files /dev/null and b/docs/img/translations/interface_translations/translations-interface-enabled-en.png differ diff --git a/docs/img/translations/interface_translations/translations-interface-enabled-es.png b/docs/img/translations/interface_translations/translations-interface-enabled-es.png new file mode 100644 index 000000000..2d09e2cc6 Binary files /dev/null and b/docs/img/translations/interface_translations/translations-interface-enabled-es.png differ