La documentación de Jeedom está centralizada en este sitio, mediante varios mecanismos. Al igual que Jeedom’s Core, se puede acceder a la documentación en Github y es de código abierto (licencia MIT).
Para participar en la documentación, debe tener una cuenta Github.
Por supuesto, siempre puede hacer un mensaje en el Foro, poniendo la etiqueta documentation-jeedom en su mensaje.
Esto se diferencia en tres categorías :
Las páginas de documentación general son aquellas que no provienen directamente del Core.
Por ejemplo :
Estas páginas están disponibles en presentación de documentación
Siguiendo la URL en el sitio de documentación, puede encontrar el archivo md correspondiente. Ejemplos :
Entonces puedes hacer relaciones públicas (Solicitudes de extracción) en estos archivos .md.
Puede ver en este directorio, los directorios principales, complementos, etc. Estos se administran automáticamente, por lo que no es necesario hacer relaciones públicas aquí (leer más).
La documentación del Core está en el repositorio del Core, en el directorio doc : https://github.com/jeedom/core/tree/alpha/docs/fr_FR
Para cada página de Jeedom, hay un archivo de página.md correspondiente.
Estas son las páginas a las que puede acceder (?) En la parte superior derecha de la interfaz de su Jeedom, y ubicadas en las secciones :
Entonces puedes hacer relaciones públicas (Solicitudes de extracción) en archivos .md, preferiblemente en la rama alfa.
Siguiendo el mismo principio que la documentación principal, la de los complementos se recupera automáticamente del repositorio de complementos.
Por ejemplo, para el complemento OpenZWave
Allí tienes que buscar el repositorio del complemento en cuestión y luego ir a su directorio doc/fr_FR. Al distinguir entre complementos oficiales complementos de terceros. Además, no se puede acceder a los complementos pagos (oficiales o de terceros), porque en repositorios privados. En este caso, siempre puede hacer un mensaje en el Foro, con la etiqueta documentation-jeedom o el complemento.
Las traducciones están presentes en los archivos de otros idiomas. El directorio docs / i18n / contiene archivos .json por idioma para la traducción de las cadenas de caracteres de la propia interfaz Core.
Estos son generados automáticamente por un sistema de traducción específico de Jeedom. Por lo tanto, no es necesario modificarlo, ya que el sistema lo sobrescribirá. Si desea mejorar las traducciones, puede informarlo en Comunidad. Si domina uno de los idiomas de Jeedom y desea ir más allá, puede solicitar acceso al sistema de traducción, que le permite corregir todas las traducciones de cada idioma de las diferentes versiones del Core y de los complementos oficiales : contacta con el equipo del proyecto.
En el código puede especificar cadenas para traducir así :
En php : $ myString = __ ('Mi oración que será traducida', __FILE __);
En JavaScript : var myString = '{{Mi oración que será traducida}}'
El sistema de traducción se encargará entonces de su traducción y de su referencia en los archivos json (docs/i18n/) y el Core se encargará de su reemplazo en la interfaz.
Si desea vincular a otra página de documentación, puede agregar / fr_FR / contrib / doc. Al traducir, la parte fr_FR se adaptará automáticamente.