Improve docs
This commit is contained in:
Senén Rodero Rodríguez
@@ -24,21 +24,21 @@ Also these are the files where you can apply some customization:
|
|||||||
|
|
||||||
## Translation interface
|
## Translation interface
|
||||||
|
|
||||||
The aim of this functionality is to allow the introduction of all the dynamic contents of the application (proposals, debates, budgetary investments and comments) in different languages. From the administration panel you can activate or deactivate the 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
|
#### Enable module
|
||||||
To activate the functionality you must follow 2 steps:
|
To activate this feature you must follow 2 steps:
|
||||||
1. Execute the following command `bin/rake settings:create_translation_interface_setting RAILS_ENV=production`
|
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).
|
||||||
1. Accessing through the administration panel of your application to the section **Configuration > Funcionalidades** and activate the module **Translation Interface** as you can see below:
|
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:
|
||||||
|
|
||||||
|
|
||||||
#### Use Cases
|
#### Use Cases
|
||||||
|
|
||||||
* When the translation interface is active:
|
* When the translation interface is active:
|
||||||
As we can see in the image appears a selector to add languages where each time we select one appears in the selector of languages in use and the translatable fields appears with a blue background. Also we have a button `Remove language` to delete a language in case of needing it.
|
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 both for the creation pages and for the editing pages.
|
This feature is visible during creation and edition of translatable resources.
|
||||||
|
|
||||||
|
|
||||||
* When the translation interface is disabled:
|
* When the translation interface is disabled:
|
||||||
As you can see in the image when this feature is deactivated, the current rendering is maintained in both the creation and edition forms:
|
When this feature is deactivated users will see standard forms without translation interface and without translation highlight.
|
||||||
|
|
||||||
|
|||||||
@@ -24,21 +24,22 @@ Aparte de estos directorios también cuentas con ciertos ficheros para:
|
|||||||
|
|
||||||
## Interfaz de traducción
|
## Interfaz de traducción
|
||||||
|
|
||||||
Esta funcionalidad tiene como objetivo permitir introducir todos los contenidos dinámicos de la aplicación (propuestas, debates, inversiones presupuestarias y comentarios) en diferentes idiomas. Desde el panel de administración se puede activar o desactivar la 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
|
#### Activar funcionalidad
|
||||||
Para activar la funcionalidad deberá realizar 2 pasos:
|
Para activar la funcionalidad deberá realizar 2 pasos:
|
||||||
1. Ejecutar el siguiente comando `bin/rake settings:create_translation_interface_setting RAILS_ENV=production`
|
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. Acceder a través del panel de administración de su aplicación a la sección **Configuración > Funcionalidades** y activar el módulo de **Interfaz de traducción** como se puede ver a continuación:
|
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:
|
||||||
|
|
||||||
|
|
||||||
#### Funcionalidad
|
#### 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:
|
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:
|
* Cuando la interfaz de traducción esta activa:
|
||||||
Como podemos ver en la imagen aparece un selector para añadir idiomas donde cada vez que seleccionamos uno aparece en el selector de idiomas en uso y se visualizan los campos traducibles con un fondo azul. También disponemos de un botón `Eliminar idioma` para eliminar un idioma en caso de necesitarlo.
|
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.
|
Esta funcionalidad está visible tanto para las páginas de creación como para las páginas de edición.
|
||||||
|
|
||||||
|
|
||||||
* Cuando la interfaz de traducción esta desactivada:
|
* Cuando la interfaz de traducción esta desactivada:
|
||||||
Como se puede ver en la imagen al tener desactivada esta funcionalidad se mantiene la renderización actual en los formularios tanto de creación como de edición:
|
Cuando esta funcionalidad está desactivada los formularios se renderizan sin la interfaz de traducción y sin resaltar los campos traducibles con fondo azul.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user