]> pere.pagekite.me Git - text-madewithcc.git/commitdiff
Instructions on how to generate a first output document
authorGunnar Wolf <gwolf@gwolf.org>
Wed, 19 Jul 2017 05:00:48 +0000 (00:00 -0500)
committerGunnar Wolf <gwolf@gwolf.org>
Wed, 19 Jul 2017 05:00:48 +0000 (00:00 -0500)
HOWTO.md

index 8a664dbcf7deb5c4119b312250fe63e4f39f73ed..a14ccee18b86883e589757df22c4bc37374b5cc9 100644 (file)
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -87,3 +87,44 @@ 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.
 [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.
+
+## Building the translated Markdown file
+
+`po4a` provides a tool to integrate the translation back into a
+Markdown document, `po4a-translate`. I have only made first attempts
+with it, and we need to find ways to do several improvements. However,
+the following command will give you a good glimpse on how your
+finished translation looks:
+
+    po4a-translate -f text -m MadewithCreativeCommonsup-to-dateversion.md -p po/es/mwcc.po -l MadewithCreativeCommonsup-to-dateversion.es.md -l MadewithCreativeCommonsup-to-dateversion.es.md -L utf8 -M utf8 -k 20
+
+What does it all mean?
+
+    -f text
+
+The base format to/from which the translation is done is plain text.
+
+       -m MadewithCreativeCommonsup-to-dateversion.md
+
+The name of your source document.
+
+       -p po/es/mwcc.po
+
+Which translation to use. In this case, Spanish translation.
+
+       -l MadewithCreativeCommonsup-to-dateversion.es.md
+
+Filename to use for the created translation. Do note that I'm
+specifying a name that implies Spanish.
+
+       -L utf8 -M utf8
+
+Which character sets to use, both for the source and destination
+files.
+
+       -k 20
+
+Minimum translation percentage for which to produce output. The
+default is 80% — To get a glimpse of your work in the early stages of
+a translation, use `-k` with a value smaller than the percentage you
+have achieved.