]> git.lyx.org Git - lyx.git/blobdiff - README.localization
Fix bad escapes
[lyx.git] / README.localization
index da34ab8c95357a323fea595c0335738a9200ee1d..7e4d3d7cdbe628103efd14130aeeff97ca8a156a 100644 (file)
@@ -1,6 +1,6 @@
 
        Localization/Translation FAQ
-                (2007-2015)
+                (2007-2018)
 
     by Ran Rutenberg, Pavel Sanda, Michael Gerz
 
@@ -18,7 +18,7 @@ and dialog items, console messages) into their native language.
 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 language codes look at:
 
-  http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#Language-Codes
+  https://www.gnu.org/software/gettext/manual/html_mono/gettext.html#Language-Codes
 
 If you want to start from scratch then you should obtain a copy of the lyx.pot
 and name it after your language. German would be for example de.po and Polish
@@ -29,16 +29,18 @@ 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 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/HowToUseGIT page.
+can follow https://www.lyx.org/HowToUseGIT page.
 
 
 2) HOW DO I EDIT PO FILES?
 
 PO files can be edited with any text editor available for your system (e.g.
-Vim, NotePad etc.). Yet another option is to use a specialized editor for .po
-files. You can e.g. use the editors "poEdit" or "jEdit", Linux users can
-additionally use e.g. "kbabel". Using these editors usually makes things easier
+Vim, jEdit etc.). Yet another option is to use a specialized editor for .po
+files. You can e.g. use the editor "Poedit", Linux users can
+additionally use e.g. "Lokalize". Using these editors usually makes things easier
 as they have many tools to assist the translator.
+If you use Poedit, please uncheck in its settings the option to break lines after
+80 characters.
 
 
 3) WHAT DO I NEED TO TRANSLATE?
@@ -118,16 +120,16 @@ compile updated xx.po translation and then run LyX.
 For advanced users - if you want to remerge your files against current source:
 
 - on Linux: execute the command: make update-po
-- on Windows: either build the update-po target in MSVC
-              or run the command: msbuild po\update-po.vcxproj
-              (depending on the directory you are in)
+- on Windows: if you compile LyX in install mode, the po files are automatically
+       updated and output to the folder <compilation output folder>\po
+       Another option is to build the target "update-po" in MSVC.
 
 
 7) HOW TO CONTRIBUTE MY WORK?
 
 Send your edited xx.po file to po-updates@lyx.org.
 
-Also you can check http://www.lyx.org/trac/browser/lyxgit/?rev=master to track
+Also you can check https://www.lyx.org/trac/browser/lyxgit/?rev=master to track
 changes or watch updates.
 
 
@@ -142,12 +144,12 @@ new strings appear, no other function.
 
 For a basic idea of how the translation works, you can look at
 
-  http://en.wikipedia.org/wiki/Gettext
+  https://en.wikipedia.org/wiki/Gettext
 
 For detailed reference (including a full list of country and language codes),
 have a look at
 
-  http://www.gnu.org/software/gettext/manual/gettext.html
+  https://www.gnu.org/software/gettext/manual/gettext.html
 
 
 Consider subscribing to the documentation list, lyx-docs@lists.lyx.org (rather
@@ -175,11 +177,27 @@ 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.
+following commit: https://www.lyx.org/trac/changeset/38169.
 
 If you need to manually regenerate the layouttranslations file from .po files
-run `make ../lib/layouttranslations' in the po directory. The Python polib
-library is needed for building the output file.
+- Under Linux: If using autotools, execute the command
+ `make ../lib/layouttranslations'
+ in the po directory. If using CMake, execute the command
+ `make layouttranslations1'
+ in the build directory.
+ The Python polib library is needed for building the output file.
+- Under Windows:
+ 1. install the Python extensions "polib". To do this,
+ 1.1 open a commen line prompt in the folder where you find the file "pip.exe"
+     withing the python installation folder.
+ 1.2 execute the command
+     pip install polib
+ 2. close the command prompt and open the file "lyx.sln" with MSVC. You find
+    file in the compilation result folder you set for LyX
+ 3. right click in MSVC on the target "layouttranslations1" and choose "Rebuild"
+
+Optionally - to quickly check whether some new translatable strings appeared
+for your language you can always check ../lib/layouttranslations.review.
 
 Q: Running make ../lib/layouttranslations returns with just saying
    ../lib/layouttranslations is up to date.