Saltar al contenido principal

Traducción

Esta guía cubre cómo contribuir con traducciones al Subway Builder Modded Wiki. Los traductores son responsables de asegurarse de que sus contribuciones sean precisas, claras y consistentes con el contenido original. Todas las contribuciones deben seguir la gramática adecuada, mantener el formato y enviarse mediante Pull Request (PR) para revisión.

Tabla de Contenidos

  1. Contribuir a un idioma existente
  2. Contribuir un nuevo idioma
  3. Guía de MDX e i18n para traductores
  4. Notas específicas por idioma
  5. Notas importantes
  6. Actualización de traducciones

important

A lo largo de esta guía, YOUR_LOCALE_CODE se referirá al idioma en el que estés trabajando. Por ejemplo, para español sería es. Para inglés, sería en. Para una lista completa, consulta aquí. Para países que tienen múltiples dialectos regionales (como el chino con zh-CN y zh-TW), deberías usar ese como YOUR_LOCALE_CODE.

Contribuir a un idioma existente

Si deseas contribuir con traducciones a un idioma que ya existe en el proyecto:

1. Navega a la carpeta correspondiente a tu idioma en i18n/YOUR_LOCALE_CODE. Por ejemplo, las traducciones al español se encuentran en i18n/es.

2. Eres responsable de todos los archivos en esta carpeta, incluyendo, pero no limitado a:

  • code.json
  • tags.yml
  • Cualquier otro archivo .json o .yml

3. Asegúrate de que todo el texto esté correctamente traducido mientras se mantiene el formato original (encabezados, listas, bloques de código, notas, consejos, admoniciones e imágenes).

4. Requisitos de PR:

  • Cualquier PR que se fusione con la etiqueta needs-translating debe traducirse a tu idioma.
  • Las PR de traducción deben comenzar con el prefijo [Translation - YOUR_LOCALE_CODE].

6. Envía tus cambios mediante Pull Request. Un mantenedor del wiki revisará tu envío antes de fusionarlo.


Contribuir un nuevo idioma

Si deseas agregar un idioma completamente nuevo:

Paso 1 - Configura tu Localidad

1. Abre docusaurus.config.js.

2. Agrega tu idioma en la sección localeConfigs. Ejemplo para italiano:

locales: ['en', 'es', 'fr', 'it'],
localeConfigs: {
en: {
label: 'English',
htmlLang: 'en-US',
},
es: {
label: 'Español',
htmlLang: 'es-ES',
},
fr: {
label: 'Français',
htmlLang: 'fr-FR',
},
it: {
label: 'Italiano',
htmlLang: 'it-IT',
},
},
important

Si estás usando un dialecto regional de un idioma que ya existe (como chino con zh-CN y zh-TW), deberías usar eso en lugar de un código de 2 letras como fr. Ejemplo:

locales: ['en', 'es', 'zh-CN', 'zh-TW'],
localeConfigs: {
en: {
label: 'English',
htmlLang: 'en-US',
},
es: {
label: 'Español',
htmlLang: 'es-ES',
},
zh-CN: {
label: '中文(简体)',
htmlLang: 'zh-CN',
},
zh-TW: {
label: '中文(繁體)',
htmlLang: 'zh-TW',
},
},

3. Guarda el archivo.

Paso 2 - Generar Carpetas de Traducción

Ejecuta el siguiente comando para generar una estructura de traducción nueva:

npx docusaurus write-translations --locale YOUR_LOCALE_CODE

Paso 3 - Organiza tu Área de Traducción

1. Dentro de docusaurus-plugin-content-docs y docusaurus-plugin-content-modding-docs, crea una carpeta llamada current.

2. Copia todos los archivos de docs/ y modding-docs/ en sus respectivas carpetas current.

3. Comienza a traducir estos archivos. Mantén el formato original, incluyendo:

  • Encabezados
  • Listas
  • Bloques de código
  • Notas (:::note)
  • Consejos (:::tip)
  • Advertencias importantes (:::important)
  • Imágenes y subtítulos

4. Traduce todos los demás archivos en el directorio, como code.json y tags.yml.

5. Recuerda que los enlaces, IDs de página, nombres y referencias de imágenes no deben traducirse.

Paso 4 - Envía tu PR

  • Una vez que todos los archivos estén traducidos, envía un Pull Request.
  • Un mantenedor del wiki revisará tu traducción antes de fusionarla.
  • Ten en cuenta que tu contribución es responsable de todo en la carpeta de tu idioma.
  • Asegúrate de que todas las traducciones sean precisas, consistentes y mantengan el formato original.
  • Las PR de traducción deben comenzar con [Translation - YOUR_LOCALE_CODE].

Guía de MDX e i18n para Traductores

Docusaurus usa i18n para gestionar traducciones, y nuestro wiki usa MDX para un formato avanzado. Los traductores deben comprender ambos.

Responsabilidades Clave

  • Traducir todo el contenido textual en la carpeta de tu idioma, incluyendo code.json, tags.yml, archivos .mdx y cualquier metadato.
  • Mantener todo el formato MDX:
    • El encabezado de la página (id y title) debe permanecer sin cambios, salvo por los títulos traducidos.
    • Listas, encabezados, bloques de código y citas deben mantenerse consistentes.
    • Admoniciones (notas, consejos, advertencias importantes):
:::note

Esta es una nota. Puedes traducir el texto interno.

:::
  • Imágenes y subtítulos: no traduzcas nombres de archivo ni subtítulos que hagan referencia a nombres propios.
  • Los IDs de página, enlaces y referencias de archivos no deben traducirse.
  • Sigue la gramática y ortografía adecuadas de tu idioma.
  • Todos los encabezados deben ser estáticos. Esto significa que si quieres tener ### Responsibilities, debería ser ### Responsabilidades {#responsibilities} (sensible a mayúsculas). Los nombres reales de los encabezados deben traducirse, los anclajes estáticos no.

Ejemplo MDX

---
id: example-page
title: Página de Ejemplo
---

## Encabezado \{#heading}

Contenido del texto aquí.

:::

Este es un consejo para el usuario.

:::
  • Todo el texto dentro del contenido MDX puede traducirse, incluyendo admoniciones, listas y párrafos.
  • No traduzcas nada dentro de bloques de código, nombres de archivos, enlaces o IDs.
  • Todos los nombres de ciudades y países deben traducirse para coincidir con la variante en el idioma.

Notas Específicas por Idioma

Aquí están los detalles para los idiomas actualmente soportados:

  • Español (es-ES)

    • Usar ortografía y gramática estándar del español europeo.
    • Evitar mezclar expresiones latinoamericanas.
    • Asegurarse de que los acentos y caracteres especiales (ñ, á, é, í, ó, ú) sean correctos.
  • Catalán (ca-ES)

    • Usar ortografía y gramática estándar del catalán.
    • Mantener acentos y diacríticos correctos (à, ç, é, è, í, ï, ó, ò, ú, ü).
    • Evitar mezclar expresiones en español; mantener frases naturales para lectores catalanes.
  • Francés (fr-FR)

    • Usar francés formal; evitar frases demasiado informales.
    • Prestar atención a las palabras con género y concordancia.
  • Alemán (de-DE)

    • Usar alemán estándar (Hochdeutsch).
    • Mantener la capitalización de los sustantivos.
    • Las palabras compuestas deben conectarse correctamente.
  • Italiano (it-IT)

    • Usar ortografía estándar italiana.
    • Mantener el uso correcto de acentos.
    • Usar un tono formal de manera consistente.
  • Danés (da-DK)

    • Usar gramática y ortografía danesa estándar.
    • Tener cuidado con caracteres especiales (æ, ø, å).
  • Sueco (sv-SE)

    • Usar sueco estándar; prestar atención a palabras compuestas.
    • Mantener acentos y letras correctas (å, ä, ö).
  • Noruego (nb-NO)

    • Usar Bokmål (no Nynorsk) a menos que se indique lo contrario.
    • Mantener caracteres especiales correctos (æ, ø, å).
  • Mandarín (zh-CN)

    • Usar chino simplificado.
    • Asegurarse de que la puntuación siga las convenciones de China continental.
  • Chino tradicional (zh-TW)

    • Usar caracteres chinos tradicionales.
    • Seguir la terminología y convenciones de Taiwán cuando aplique.
    • Asegurarse de que la puntuación siga los estándares del chino tradicional.

Notas Importantes

  • Pull Requests requeridos: Todas las traducciones deben enviarse mediante PR y revisadas por un mantenedor del wiki.
  • Nombre de PR: Las PR de traducción deben comenzar con [Translation - YOUR_LOCALE_CODE].
  • Etiqueta Needs-Translating: Cualquier PR fusionada con la etiqueta needs-translating necesita ser traducida por los colaboradores.
  • Formato Importante: Mantén los bloques de código, notas, encabezados, listas y referencias de imágenes exactamente como en los archivos originales.

Actualización de Traducciones

1. Obtén los últimos cambios desde la rama principal.

2. Revisa cualquier archivo nuevo o actualizado en docs/ y modding-docs/.

3. Traduce cualquier contenido nuevo en tu carpeta de idioma.

4. Envía actualizaciones mediante PR usando el prefijo [Translation - YOUR_LOCALE_CODE]. .