X-Git-Url: https://pere.pagekite.me/gitweb/text-madewithcc.git/blobdiff_plain/00545823bae68875dda23f0513f4bef9062c5905..71ea7715bccbad08c5d6e136e873db85a8aab0d6:/HOWTO.md diff --git a/HOWTO.md b/HOWTO.md index a14ccee..0de9858 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -45,6 +45,16 @@ Inside the `po` directory, we have one directory per target _locale_ are stronger, such as Portuguese (would probably be `po/pt_BR` vs. `po/pt_PT`). +## Quick and easy: How to rebuild the sources + +You don't really need to follow this script; it's all scripted in a +`Makefile`. To update the `.pot` (translation template) file, just +run: + + `make pot` + +That is enough to get you to the _Editing the Gettext files_ section. + ## Markdown conversion Markdown is an easy to edit format, with very little markup, and @@ -57,6 +67,18 @@ We use Pandoc to convert the `odt` file into Markdown: We also include the source Markdown file, mostly as documentation, in the Git repository root directory. +### Markdown fixup + +The generated Markdown file is correct, but somewhat _dirty_. I came +up with a quick-and-dirty(er) script to fix several issues, +`fixup.rb`, and intend to update it as needed: + + ruby fixup.rb source.md dest.md + +I still need to add to this fixup the needed markup so that the built +material reflects the book's structure. It will happen :-) It will, of +course, happen earlier if you send me some patches! + ## Extracting strings for translation Gettext works by presenting each particular string to be edited. We @@ -96,7 +118,7 @@ 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 + po4a-translate -f text -m MadewithCreativeCommonsmostup-to-dateversion.md -p po/es/mwcc.po -l MadewithCreativeCommonsmostup-to-dateversion.es.md -l MadewithCreativeCommonsmostup-to-dateversion.es.md -L utf8 -M utf8 -k 20 What does it all mean? @@ -104,7 +126,7 @@ What does it all mean? The base format to/from which the translation is done is plain text. - -m MadewithCreativeCommonsup-to-dateversion.md + -m MadewithCreativeCommonsmostup-to-dateversion.md The name of your source document. @@ -112,7 +134,7 @@ The name of your source document. Which translation to use. In this case, Spanish translation. - -l MadewithCreativeCommonsup-to-dateversion.es.md + -l MadewithCreativeCommonsmostup-to-dateversion.es.md Filename to use for the created translation. Do note that I'm specifying a name that implies Spanish.