From 30696fbba860eeb3deba5b53579f498ad1e50e60 Mon Sep 17 00:00:00 2001 From: Gunnar Wolf Date: Thu, 29 Jun 2017 13:23:40 -0500 Subject: [PATCH] Translate HOWTO and README into English --- HOWTO.md | 109 ++++++++++++++++++++++++++++++++++-------------------- README.md | 23 ++++++++---- 2 files changed, 85 insertions(+), 47 deletions(-) diff --git a/HOWTO.md b/HOWTO.md index 1951f8c..8a664db 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -1,60 +1,89 @@ -# Este archivo +# This file -Es simplemente un volcado del cerebro de Gunnar, siendo hoy el 9 de -junio de 2017, 19:45 GMT-5, para no olvidar el camino ya recorrido. +This is just a braindump from Gunnar, from the Spanish translation, +documenting his steps to get from the book to the source translation +material. The following instructions are valid as of June 9, 2017, +19:45 GMT-5, and are mainly written in order not to forget the way +this was done (and in case a future version import comes up, or we +write some scripts to refine the results) -# ¿Cómo construir este proyecto? +# How is the project built? -Estamos en las etapas iniciales para echar a andar la infraestructura, -pero ya no quiero que esto viva únicamente en mi computadora personal. +How did we get the `.po` files for the project? -¿Cómo generé los archivos que estoy subiendo en este momento? +## First, an `.odt` -## Primero, el .odt +I don't think an Open Document Text (`.odt`) file is the ideal source +format for this project, but according to the conversations I've had +with Sarah, probably it's the best we can do with: It is, after all, +the file they worked with. I would rather start conversion from the +published EPUB file, but the conversion ends up much "noisier". -No creo que un odt sea la forma ideal para trabajar este proyecto, -pero a partir de las conversaciones que he tenido con Sarah, -probablemente sea lo mejor que tenemos. Preferiría partir del EPUB -oficial, pero la conversión lleva mucho más "ruido". +I downloaded +[the .odt file in the repository](./MadewithCreativeCommonsmostup-to-dateversion.odt) +by following the link listed as +[editable version of the book (GDoc)](https://docs.google.com/document/d/1c2BXTQcWZrtW99GlGmv3waXy3AVpV-Biifw4NdDwMZg/edit#heading=h.3s5bd22z8pw5). +from [the book's web page](https://madewith.cc). I am not that happy +about this being an _unstable_ version (it is after all termed the +_most up-to-date version_). -El .odt que estoy incluyendo aquí lo obtuve de la liga que aparece en -la [página del libro](https://madewith.cc/) como -[versión editable del libro (GDoc)](https://docs.google.com/document/d/1c2BXTQcWZrtW99GlGmv3waXy3AVpV-Biifw4NdDwMZg/edit#heading=h.3s5bd22z8pw5). Sé -que esta _no es estable_ (es siempre la «most up-to-date version»), -asi que me gustaría hacerme de un mejor punto de partida. +## Directory structure for the translation -## Estructura de directorios para la traducción +Most translation tools based on +[GNU Gettext](https://www.gnu.org/software/gettext/) use a +standardized directory structure where all translations reside in the +`po` directory. It can feel a bit strange here, as the whole +repository is the translation itself (Gettext is often used to +translate programs, not text), but it's better not to upset common +practice ;-) -Para vivir a gusto con las herramientas comunes, vamos a hospedar todo -lo relacionado con la traducción gettext dentro del directorio -`po`. La traducción al español vivirá dentro del directorio `po/es`; -en caso de requerir _locales_ específicos del español (aunque no -preveo que sea el caso), serán `po/es_MX`, `po/es_AR`, etcétera +Inside the `po` directory, we have one directory per target _locale_ +(per target translation). The Spanish translation lives within the +`po/es` directory; in case we were to require country-specific locales +(I don't forsee it being the case), they would be named `po/es_MX`, +`po/es_AR`, etc. This is common in languages where national variations +are stronger, such as Portuguese (would probably be `po/pt_BR` +vs. `po/pt_PT`). -## Conversión a Markdown +## Markdown conversion -Empleo Pandoc: +Markdown is an easy to edit format, with very little markup, and +supporting basic HTML tags where needed. + +We use Pandoc to convert the `odt` file into Markdown: pandoc -f odt MadewithCreativeCommonsmostup-to-dateversion.odt -t markdown > MadewithCreativeCommonsmostup-to-dateversion.md -## Extracción de cadenas para la traducción +We also include the source Markdown file, mostly as documentation, in +the Git repository root directory. + +## Extracting strings for translation -Para generar un archivo template para Gettext, usé -«[PO for anything](https://po4a.alioth.debian.org/)» (po4a), -particularmente la herramienta `po4a-gettextize` para generar la -plantilla (`.pot`): +Gettext works by presenting each particular string to be edited. We +used the [PO for anything](https://po4a.alioth.debian.org/) (po4a) +tool, particularly the `po4a-gettextize` tool, to analyze the Markdown +file and generate the Gettext template (`.pot`): po4a-gettextize -f text -m MadewithCreativeCommonsmostup-to-dateversion.md -p po/mwcc.pot -M utf-8 -En un primer momento, copié este `.pot` a `po/es/mwcc.po` para iniciar -la traducción; habrá que hacer lo propio con algún otro lenguaje -futuro. Por ahora, queda únicamente como documentación. +`.pot` files are the base from which to start a translation, but are +not to be modified, just updated when new versions come up. We copied +this `.pot` file into the Spanish directory, with a `.po` suffix, and +started the translation from there: + + cp po/mwcc.pot po/es/mwcc.po + +Should you want to start a new translation, that's the main step to do +to start from. Note that for any future updates, the `.pot` should +_not_ be copied over (as that would destroy all the translation done +so far), but updated using your favorite Gettext tool. -## Editar el Gettext +## Editing the Gettext files -Utilicé la herramienta `poedit`, que he usado para traducir -programas. No creo que sea la herramienta definitiva; voy a hablar con -Michal Cihar para pedirle que nos hospede la traducción en -[Weblate](https://weblate.org/en), un servicio de traducción en línea -basado en infraestructura y software libre, y que presenta muchas de -las características que buscamos. +There are many tools you can use to translate this file. If you prefer +to work on your client (and mainly if you expect to do a high volume +of changes), we suggest you to use the `poedit` tool; we have also +been accepted as a hosted project +[hosted project in the Weblate online translation coordination service](https://weblate.org/projects/madewithcc). Weblate +is completely based on free software tools, we invite you to get +familiar with their interface. diff --git a/README.md b/README.md index da6db6d..c68ef39 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ -# Traducción al español de «Made With Creative Commons» +# «Made With Creative Commons» translation project -Este repositorio hospeda el proyecto de traducción al español del -libro [Made With Creative Commons](https://madewith.cc/), de Paul -Stacey y Sarah Hinchliff Pearson. +This repository hosts the translation project for the +[Made With Creative Commons](https://madewith.cc/) book, by Paul +Stacey and Sarah Hinchliff Pearson. -La traducción fue iniciada por [Leo Arias](https://elopio.net) y -[Gunnar Wolf](https://gwolf.org); te invitamos a participar si puedes -contribuir con nosotros. +The repository started off by pushing for Spanish translation only; +after it was +[accepted in the Weblate translation platform](https://hosted.weblate.org/projects/madewithcc/), +we decided to open it for any other translations. Welcome on board! + +## Translation teams + +- Translation into Spanish was started by + [Leo Arias](https://elopio.net) and [Gunnar Wolf](https://gwolf.org); + we welcome you on board if you can contribute with us. + +Any other teams, please add your information here. -- 2.47.2