Difference between revisions of "Translating the Gramps User manual"

From Gramps
Jump to: navigation, search
(Links to wiki manual)
(Assumtions)
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{languages}}
 
{{languages}}
An explanation of how you can translate the [[User manual|Gramps User manual]]. This manual is also available from within Gramps using the {{man key press|F1}} key (which opens this manual in a browser window), or from the help menu.
+
{{out of date}}
 +
{{man note|The user manual|is also available from within Gramps using the {{man key press|F1}} key (which opens this manual in a browser window), or from the help menu.}}
 +
An explanation of how you can translate the [[User manual|Gramps User manual]].
  
 
==Getting started==
 
==Getting started==
Line 11: Line 13:
  
 
==Translating==
 
==Translating==
 +
 +
===Recommendations===
 +
Recommended that when updating any of the user manuals:
 +
* You use Gramps in that language and not guess the words
 +
* Do not have any third party addons loaded(eg use a vanilla version of Gramps).
 +
* Also preferably use the [[Example.gramps]] family tree for any screenshots in your preferred language.
 +
 
===Screenshots===
 
===Screenshots===
 
* Figures: localized screenshots are nice in the localized manual
 
* Figures: localized screenshots are nice in the localized manual
Line 43: Line 52:
 
</pre>
 
</pre>
  
*Every 'manual|...' entry in the gramp.pot file refers to a section in the manual, so make sure to use good section headings so this does not change too much over time.
+
*Every '<code>manual|...</code>' entry in the gramp.pot file refers to a section in the manual, so make sure to use good section headings so this does not change too much over time.
  
 
Note that reports/tools link to a section in the page with the same name as the report name in Gramps.
 
Note that reports/tools link to a section in the page with the same name as the report name in Gramps.

Revision as of 07:42, 20 September 2016

Gramps-notes.png This page's factual accuracy may be compromised due to out-of-date information. Please help improve the Gramps Wiki as a useful resource by updating it.
Gramps-notes.png
The user manual

is also available from within Gramps using the F1 key (which opens this manual in a browser window), or from the help menu.

An explanation of how you can translate the Gramps User manual.

Getting started

Translating Gramps' documentation into a new language is a worthwhile process and the Gramps team thanks you.

Since Gramps version 3.0 the documentation was moved completely to this wiki. So for translation you don't need to use or even install any fancy applications to help us. You can use your browser and start immediately. Just go to the User manual page, select the current manual and then click on your language. You should could keep the English manual open to check if there is a help page missing.

The general wiki help page will help you editing wiki pages. This wiki uses the MediaWiki software, which is the same that is used by Wikipedia, so it could feel familiar.

Translating

Recommendations

Recommended that when updating any of the user manuals:

  • You use Gramps in that language and not guess the words
  • Do not have any third party addons loaded(eg use a vanilla version of Gramps).
  • Also preferably use the Example.gramps family tree for any screenshots in your preferred language.

Screenshots

  • Figures: localized screenshots are nice in the localized manual
    • If you can provide figures on your own this is great. Upload them to this wiki with the following naming convention: figure_name_zz.png (zz is your language code). If the figure is language independent just call it figure_name.png.
    • A command to take screenshots that works for me, is by using imagemagick (should be installed with every linux distribution, if not, get it):
      import -quality 100 -trim -delay 200 -resize 500 -density 100x100 -frame -channel RGB -depth 8 screenshot.png 
      This creates a fully compressed (-quality 100), timed screenshot after 2 seconds (-delay 200) of size 500 pixels wide (-resize 500), with resolution 100 (-density 100x100), with the window frame attached (-frame) in RGB mode (-channel RGB) and bbp 24 (-depth 8). This creates images of 5 inches wide, which fit nicely on a book page, as well as on a HTML page.
    • If it's too much trouble for you, just let us know and perhaps somebody else will do it for you. Fortunately, one does not have to speak the language to make screenshots :-)
    • For maintenance, it could be more easy to follow a naming scheme :
      • filename-{gramps version number}-{locale}.png
        Mainwin-40-fr.png
      • filename_{gramps version number}_{locale}.png
        Mainwin_40_fr.png

Links to wiki manual

To have your recently translated manual available from within Gramps. You need to activate the manual by editing the following file: gramps/gui/display.py to contain your language code, you may also contact the developers of Gramps by opening a Feature request for the new language on the Bug tracker.

In that file, you see:

MANUALS = {
    'nl' : '/nl',
}

This maps a language code to the extension used on the wiki, so to add french, change this to:

MANUALS = {
    'nl' : '/nl',
    'fr' : '/fr',
}
  • Every 'manual|...' entry in the gramp.pot file refers to a section in the manual, so make sure to use good section headings so this does not change too much over time.

Note that reports/tools link to a section in the page with the same name as the report name in Gramps.

  • You should be able to edit directly on wiki or using tools like txt2po.

Also previous gettext file for the manual and Translation Memory may help you to upgrade deprecated/old gettext files.

Possible improvement

A project like GnuCash provides a complete web site environment by using gettext files, see README file and current environment.