Localization/Translation FAQ
+ (2007-2011)
by Ran Rutenberg, Pavel Sanda, Michael Gerz
- February 2007
+
+PART I - Interface translation
+------------------------------
This file is mainly intended for those who have no or little experience using
-.po files, but want to contribute by translating the LyX interface into their
-native language.
+.po files, but want to contribute by translating the LyX interface (i.e. menu
+and dialog items, console messages) into their native language.
1) WHERE DO I START?
-The file you need to edit it an xx.po file where xx stands for your language's
-two letter code. German would be for example de.po and Polish pl.po. For a list
-of languages codes look at:
+The file you need to edit is an xx.po file where xx stands for your language's
+two letter code. For a list of languages codes look at:
http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#Language-Codes
pl.po. This file is generated in the "po" directory of the source tree during
the compilation.
+There are basically two source trees you can start to work with - trunk
+(development version) and branch (stable version). Unless the development
+version is shortly before release it is better idea to start your translating
+work on the stable version. If you have no idea how to get those trees you
+can follow http://www.lyx.org/HowToUseSVN page.
+
2) HOW DO I EDIT PO FILES?
invent your own working shortcuts for dialog and menu entries and resolve
possible conflicts of the same shortcut chars in one menu...
-Note also that there are already used global shortcuts (such as p k x c m) and
-you should avoid to use these characters for first-level menu shortcuts.
+Note also that there are already used global shortcuts (such as p k x c m s a)
+and you should avoid to use these characters for first-level menu shortcuts.
'$' and '%' are usually used as handlers for formatting or variables to be
inserted into the strings. Character sequences like %1$s or %1$d MUST also
This is a small script located in the "po" directory of the source that helps
you find common errors in your translation. In order to use this script you have
to have the script language Perl installed.
+Run ./pocheck.pl -h to see all possible switches.
6) HOW CAN I TEST MY TRANSLATION?
7) HOW TO CONTRIBUTE MY WORK?
-You can manually use diff utility to make patch; usually the most comfortable
-way is to run something like (after you edit xx.po):
-
- svn diff xx.po > xx.po.patch
-
-This file should be sent to po-updates@lyx.org.
+Send your edited xx.po file to po-updates@lyx.org.
Also you can check http://www.lyx.org/trac/browser/lyx-devel/trunk to track
changes or watch updates.
-8) REFERENCES
+8) SHALL ALL THE UNUSED STRINGS AT THE BOTTOM OF .PO FILE BE REMOVED,
+ OR SHALL THEY STAY?
+
+As you wish. They can be reused for generating fuzzy hints when completely
+new strings appear, no other function.
+
+
+9) REFERENCES
For some basic idea on how the translation works, you can look at
Consider subscribing to the documentation list at lyx-docs@lists.lyx.org (rather
silent one) or developer's mailing list lyx-devel@lists.lyx.org (high volume).
+
+
+
+PART II - Translation of Math environments and Floats in the final output
+-------------------------------------------------------------------------
+
+As of 2.0 LyX allows automatic translation in tex/dvi/ps/pdf output for math
+environment strings (and some floats) which are not automatically translated via
+babel package to the localized form. For example the environment "Exercise"
+becomes "Aufgabe" in the output of the documents with language set to german.
+
+These translations are taken from the previously translated .po file before the
+final major LyX release (e.g. 2.0.0) and are fixed for all next minor releases
+(e.g. 2.0.x) in order to have fixed output of LyX documents.
+
+The current translation for your language can be found in lib/layouttranslations
+file. Easy way to check many of the translation is to simply load
+lib/examples/localization_test.lyx in LyX and read its instructions.
+
+The problematic strings can be then fixed in the .po file. For inspiration the
+typical places in .po files, where to fix the translation, can be seen on the
+following commit: http://www.lyx.org/trac/changeset/38169 .
+
+If you need to manually regenerate layouttranslations file from .po files run
+`make ../lib/layouttranslations' in po directory. Python polib library is
+needed for building the output file.
+
+Q: Running make ../lib/layouttranslations return with just saying
+ ../lib/layouttranslations is up to date.
+A: To force regerenation, use something like (XX is your language)
+ make -W XX.po ../lib/layouttranslations
projects / lyx.git / blobdiff