# multilang Herramientas multilenguaje (primeramente para Markdown) [](https://npmjs.org/package/multilang) [](https://npmjs.org/package/multilang) [](https://github.com/codenautas/multilang/actions/workflows/build-and-test.yml) [](https://coveralls.io/r/codenautas/multilang) [](https://socket.dev/npm/package/multilang) [](https://github.com/codenautas/multilang/actions/workflows/qa-control.yml) idioma:  también disponible en: [](README.md) - [](LIESMICH.md) En un archivo tipo Markdown o html se escribe la documentación en varios idiomas. Uno de esos lenguajes es el principal, los otros están comentados con  y  Luego con `multilang` se extraen los otros lenguajes generando un archivo para cada uno de los otros lenguajes definidos ## Instalación ```sh $ npm install multilang -g ``` ## Uso ``` $ multilang doc-en.md ``` Genera los archivos especificados en la cabecera del archivo para los idiomas secundarios. ## Formato del documento multilenguaje Un documento multilenguaje es un documento HTML o Markdown escrito en un idioma principal, que contiene dentro del mismo documento la traducción a uno o varios idiomas secundarios. ### Ejemplo ``` language:  also available in: [Spanish](LEEME.md) [French](LISEZMOI.md) [German](LIESMICH.md) This is a little example "*" means all languages All you need is multilang! ``` El documento tiene en algún lugar un renglón con la directiva multilenguaje. Ejemplo: ``` ``` * *v0* es la versión del formato multilenguaje, * *en* es el lenguaje principal [ISO 639-1](http://es.wikipedia.org/wiki/ISO_639-1), en este caso inglés * *README.md* es el nombre del archivo principal, el que contiene el documento que se está procesando * *es* y *fr* son los lenguajes secundarios (español y francés) * *LEEME.md* es el nombre del documento en español * *LISEZMOID.md* es el nombre del documento en francés El siguiente renglón después de la directiva multilenguaje es la directiva que indica la presencia de los links a los otros documentos. Tiene el siguiente formato ``` ``` Lo siguientes renglones son los botones y links a los otros lenguajes. Las directivas terminan con un renglón en blanco. El resto del documento tiene el texto en los distintos idiomas, intercalando los idiomas en el orden en que están definidos en la directiva multilenguaje. Las secciones o subsecciones donde se cambia de idioma están señaladas con la directiva ``` [!--lang:fr--] ``` * *fr* en este ejemplo se indica que los renglones siguientes están escritos en francés * las secciones pueden empezar o terminar con [ o < y > o ] Cuando una parte del texto sea para todos los idiomas se puede poner un asterisco "*" en vez del código de idioma. Cuando empiece la sección del idioma principal en vez de un corchete "]" la directiva cierra con un signo de mayor ">"; así se cierra el comentario HTML. Cuando termina la sección del idioma principal el siguiente indicador de idioma comienza con un signo de menor "<" en vez de un corchete "[" para que empiece un nuevo cometario HTML y no se visualice el texto en los idiomas secundarios. ## API ```js var fs = require('fs'); var multilang = require('multilang'); var englishText = fs.readFileSync('README.md', {encoding:'utf8'}); var warnings = multilang.getWarnings(englishText); if(warnings.lengt){ console.log('WARN', warnings); } var spanishText = multilang.changeDoc(englishText,'es'); console.log('spanish.md',spanishText); ``` (nota acerca del ejemplo anterior: no use funciones ***Sync***rónicas en producción, use las versiones asincrónicas o basadas en [promesas](http://npmjs.com/package/fs-promise) como se ilustra en [codenautas](https://github.com/codenautas/codenautas/blob/master/examples/promises.md) función | uso ---------------------|------------------------------- changeDoc(text,lang) | dado un texto multilang y un código de lenguaje obtiene el texto correspondiente a ese lenguaje getWarnings(text) | obtiene una lista de advertencias a partir de un texto multilang ## License [MIT](LICENSE) ...................................