BuildPDFs

Differences between revisions 15 and 16
Revision 15 as of 2011-01-06 04:05:58
Size: 2732
Editor: c-24-91-83-115
Comment:
Revision 16 as of 2011-01-06 04:49:50
Size: 3232
Editor: c-24-91-83-115
Comment:
Deletions are marked like this. Additions are marked like this.
Line 52: Line 52:
And the generated Spanish pdf filename is: ''main-es.pdf''.

==== This (fr_CA) Doesn't Work Yet ====
Line 54: Line 58:
And the generated Spanish pdf filename is: ''main-es.pdf''. That ^^^ doesn't work because the fr_CA lingua is not fully configured. That is, it is not sufficient (as stated in Requirements above) to simply add the lingua to ''LINGUAS'' and to create the po file. Instead, each target lingua must have more, for example, in ''ubuntu-developer-manual.cls''

So adding linguas not previously configured in the Ubuntu Manual project (from which this toolchain and configuration inherits) involves additional work.

Build PDFs

You can build:

  • non-localized pdf
  • localized pdfs (if certain conditions are met)

Note: Localization is a moving target. The instructions are for trunk branch 59 (or thereabouts). Localization does not include images (screenshots and etc.) (yet).

What is a Localized PDF?

At this time, it is a pdf built from:

  • The source tex file (main.tex)

  • With translations from the target lingua's po file (if any -- that is, the lingua-specific po file can contain zero or more translated messages, and whatever is present and matches the source file string ("message") is used).

Note: Updating the pot file from main.tex is done manually on an as needed basis by maintainers. po files will be exported from Launchpad translations to trunk (thanks to Ubuntu Translators) and should not be modified.

What is a non-Localized PDF?

It is a pdf built from the the source tex file with no translations applied.

Caveat

The toolchain does not presently support all linguas (also called "locales"), notably (some) non-Latin ones such as Chinese.

Build Non-Localized PDF

Just run make in the root directory, as in:

make

This produces main.pdf.

Build Localized PDF(s)

Requirements

  1. LINGUAS file in root directory must contain the target locale code.

    • Note: For clarity, let's keep this with one locale per line and in alphabetical order.

  2. po/ must contain a po file for the target locale code.

    • Note: It is probably best that no one create po files and commit them to trunk. The plan is that po files will be exported to trunk (through Launchpad) based on the work of Ubuntu Translators.

Build All Target Lingua PDFs

Build PDFs for all configured target locales as follows.

  1. Be in trunk's root directory
  2. Create all PDFs:
    • ./lang_pdfs

This generates pdf files for each (valid and configured) lingua in LINGUAS file, named as follows: main-<lingua>.pdf

For example, the generated French pdf filename is: main-fr.pdf (because the LINGUAS file contains "fr" and the po/fr.po exists).

And the generated Spanish pdf filename is: main-es.pdf.

This (fr_CA) Doesn't Work Yet

If we had a configured French/Canada lingua (po/fr_CA.po file and fr_CA in LINGUAS), the generated file would be: main-fr_CA.pdf

That ^ doesn't work because the fr_CA lingua is not fully configured. That is, it is not sufficient (as stated in Requirements above) to simply add the lingua to LINGUAS and to create the po file. Instead, each target lingua must have more, for example, in ubuntu-developer-manual.cls

So adding linguas not previously configured in the Ubuntu Manual project (from which this toolchain and configuration inherits) involves additional work.

Build A Single Lingua PDF

In this case, we execute make and also specify the make target (langpdf). We also must pass a LANG=<lingua> argument to specify the language we want.

For example, to build a Spanish pdf:

make langpdf LANG=es

This generates: main-es.pdf

DesktopTeam/10.10/DeveloperManual/BuildPDFs (last edited 2011-01-11 22:17:14 by c-24-91-83-115)