Difference between revisions of "Translating the Gramps User manual"

From Gramps
Jump to: navigation, search
m
m (Screenshots: 40)
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{languages}}
 
{{languages}}
An explaination of how you can translate the [[Gramps 3.3 Wiki Manual|GRAMPS manual]]. This 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 [[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.
  
 
==Getting started==
 
==Getting started==
Translating GRAMPS' documentation into a new language is a long, tedious, and boring process, just like with any complex text :-) Since version 3.0 the documentation is completely inside this wiki. So you don't need to use or even install fancy applications to help us. You can use your browser and start immediately. Just go to the [[Gramps 3.0 Wiki Manual|User Manual]] page, click on your language. You should could keep the english manual open to check if there is a help page missing.
+
 
 +
Translating Gramps' documentation into a new language is a long, tedious, and boring process, just like with any complex text :-)
 +
 
 +
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 [[Help:Contents|wiki help page]] will help you editing wiki pages. This wiki uses the [http://www.mediawiki.org/ MediaWiki] software, which is the same that is used by [http://en.wikipedia.org/wiki/Wikipedia Wikipedia], so it could feel familiar.
 
The general [[Help:Contents|wiki help page]] will help you editing wiki pages. This wiki uses the [http://www.mediawiki.org/ MediaWiki] software, which is the same that is used by [http://en.wikipedia.org/wiki/Wikipedia Wikipedia], so it could feel familiar.
  
 
==Translating==
 
==Translating==
 +
===Screenshots===
 
* Figures: localized screenshots are nice in the localized manual
 
* 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: <code>figure_name_zz.png</code> (<code>zz</code> is your language code). If the figure is language independent just call it <code>figure_name.png</code>.
 
** If you can provide figures on your own this is great. Upload them to this wiki with the following naming convention: <code>figure_name_zz.png</code> (<code>zz</code> is your language code). If the figure is language independent just call it <code>figure_name.png</code>.
** A command to take screenshots that works for me, is by using imagemagick (should be installed with every linux distribution, if not, get it): <pre>import -quality 100 -trim -delay 200 -resize 500 -density 100x100 -frame -channel RGB -depth 8 screenshot.png </pre>This creates a fully compressed (<code>-quality 100), timed screenshot after 2 seconds (<code>-delay 200</code>) of size 500 pixels wide (<code>-resize 500</code>), with resolution 100 (<code>-density 100x100</code>), with the window frame attached (<code>-frame</code>) in RGB mode (<code>-channel RGB</code>) and bbp 24 (<code>-depth 8</code>). This creates images of 5 inches wide, which fit nicely on a book page, as well as on a HTML page.
+
** A command to take screenshots that works for me, is by using imagemagick (should be installed with every linux distribution, if not, get it): <pre>import -quality 100 -trim -delay 200 -resize 500 -density 100x100 -frame -channel RGB -depth 8 screenshot.png </pre>This creates a fully compressed (<code>-quality 100</code>), timed screenshot after 2 seconds (<code>-delay 200</code>) of size 500 pixels wide (<code>-resize 500</code>), with resolution 100 (<code>-density 100x100</code>), with the window frame attached (<code>-frame</code>) in RGB mode (<code>-channel RGB</code>) and bbp 24 (<code>-depth 8</code>). 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 :-)
 
** 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 :  
 
** For maintenance, it could be more easy to follow a naming scheme :  
*** filename-''{gramps version number}-{locale}''.png <pre>Mainwin-31-mk.png</pre>
+
*** filename-''{gramps version number}-{locale}''.png <pre>Mainwin-40-fr.png</pre>
*** filename_''{gramps version number}_{locale}''.png <pre>Mainwin_31_mk.png</pre>
+
*** filename_''{gramps version number}_{locale}''.png <pre>Mainwin_40_fr.png</pre>
 +
 
 +
*[[Screenshots]]
  
 
==Links to wiki manual==
 
==Links to wiki manual==
To have the link working in GRAMPS, you need to have or edit the '''GrampsDisplay.py''' file to contain your language.
 
On line 30 of that file, you see:
 
  
MANUALS = {
+
To have your recently translated manual available from within Gramps. You need to activate the manual by editing the following file: '''[http://svn.code.sf.net/p/gramps/code/trunk/gramps/gui/display.py 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 [[Using_the_bug_tracker |Bug tracker]].
 +
 
 +
On line 32 of that file, you see:
 +
 
 +
<pre>
 +
MANUALS = {
 
     'nl' : '/nl',
 
     'nl' : '/nl',
}
+
}
 +
</pre>
  
This maps a language code to the extension used on the wiki, so to add french, change this too:
+
This maps a language code to the extension used on the wiki, so to add french, change this to:
  
MANUALS = {
+
<pre>
 +
MANUALS = {
 
     'nl' : '/nl',
 
     'nl' : '/nl',
     'fr': '/fr',
+
     'fr' : '/fr',
}
+
}
 +
</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 '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.
+
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 [http://translate.sourceforge.net/wiki/toolkit/txt2po#mediawiki txt2po].
 +
 
 +
Also previous gettext file for the manual and [http://en.wikipedia.org/wiki/Translation_memory Translation Memory] may help you to upgrade deprecated/old gettext files.
 +
 
 +
==Possible improvement==
  
*You should be able to edit directly on wiki or using tools like [http://translate.sourceforge.net/wiki/toolkit/txt2po txt2po]. Also previous gettext file for the manual and [http://en.wikipedia.org/wiki/Translation_memory Translation Memory] may help you to upgrade deprecated/old gettext files.
+
A project like [http://www.gnucash.org/ GnuCash] provides a complete web site environment by using gettext files, see [http://svn.gnucash.org/repo/htdocs/trunk/README README file] and current [http://svn.gnucash.org/repo/htdocs/trunk/ environment].
  
 
[[Category:Translators/Categories]]
 
[[Category:Translators/Categories]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Revision as of 20:31, 12 February 2013

An explanation of how you can translate the Gramps User manual. This manual is also available from within Gramps using the F1 key (which opens this manual in a browser window), or from the help menu.

Getting started

Translating Gramps' documentation into a new language is a long, tedious, and boring process, just like with any complex text :-)

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

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: 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.

On line 32 of 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.