Difference between revisions of "User manual translations"

From Gramps
Jump to: navigation, search
(Not enabled)
m (Not enabled: add anchor to beginning of list of superseded manuals)
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{languages|User_manual}}
+
{{languages|User_manual_translations}}
{{man tip| 1=Need Help? |2=Enabled manuals are available from within Gramps by pressing {{man key press|F1}}, through the {{Man menu|Help}} menu, or by pressing the {{man button|Help}} button.  
+
{{man tip| 1=Need Help? See the [[Gramps_{{Version manual}}_Wiki_Manual|Gramps user manual]]. |2=Targeted manual sections are available from within Gramps by pressing {{man key press|F1}}, through the {{Man menu|Help}} menu, or by pressing the {{man key press|Help}} button.  
  
These 'Help' shortcuts ''enable'' the user to quickly find the appropriate documentation webpage, which ''enables'' them to understand the options of a feature.}}
+
We call these '''''Enabled Manuals''''' since the 'Help' shortcuts ''enable'' the user to quickly find the appropriate documentation webpage, which ''enables'' them to understand the options of a feature.}}
 +
[[File:Menubar-Help-overview-example-50.png|thumb|right|450px|Menubar - "Help  - F1"]]
  
The Gramps user manual is only available online, so you need an internet connection to be able to read the manual. You can access the user manual from within Gramps by pressing {{man key press|F1}}, or through the help menu via {{man menu|Help > User Manual}}. The user manual provides instructions on the use of Gramps.
+
The '''[[Gramps_{{Version manual}}_Wiki_Manual|Gramps user manual]]''' is only available online, so you need an internet connection to be able to read the manual. You can access the user manual from within Gramps by pressing {{man key press|F1}}, or through the help menu via {{man menu|Help > User Manual}}. The user manual provides instructions on the use of Gramps.
  
If you encounter an error or have a question about Gramps, please feel free to [[Contact]] us.
+
If you encounter an error or have a question about the Gramps program or user manual, please feel free to [[Contact]] us via the Gramps user mailing list.
 +
 
 +
All edits made to this manual are dual-licensed under the GPL and GNU Free Documentation Licenses, this is due to distribution reasons.
 +
 
 +
The motivation for a using a wiki to maintain the user manual is because the wiki is editable by all users and allows cross linking to normal wiki content, greatly improving the quality of the manuals. It does make translating the manual harder.
 +
 
 +
==Translating the Gramps User manual==
  
 
You can also translate the user manual in to your language, as explained in [[Translating the Gramps User manual]]
 
You can also translate the user manual in to your language, as explained in [[Translating the Gramps User manual]]
Line 13: Line 20:
 
<!--{{man menu|Unreleased manual see Gramps 5.0 below}}-->
 
<!--{{man menu|Unreleased manual see Gramps 5.0 below}}-->
  
The Gramps user manual is only available online, so you need an internet connection to be able to read the manual.
+
The [[Gramps_5.1_Wiki_Manual|Gramps user manual]] is only available online, so you need an internet connection to be able to read the manual.
  
 
===User manual (English) Statistics===
 
===User manual (English) Statistics===
Line 175: Line 182:
  
 
===Enabled===
 
===Enabled===
Manuals are described as 'Enabled' when native language Wiki content is available from within Gramps by pressing {{man key press|F1}}, or through the Help menu. Once you have [[Translating_the_Gramps_User_manual|created your translation]], you may [[Translating_the_Gramps_User_manual#Links_to_wiki_manual|update]] (or request a developer to update) the Gramps program code to enable the newly [[Translating_Gramps#Translating_wiki_manual|translated user manual]].
+
Manuals are described as 'Enabled' when targeted '''''native''''' language Wiki content is available from within Gramps by pressing {{man key press|F1}}, or through the Help menu. Once you have [[Translating_the_Gramps_User_manual|created your translation]], you may [[Translating_the_Gramps_User_manual#Links_to_wiki_manual|update]] (or request a developer to update) the Gramps program code to 'enable' the newly [[Translating_Gramps#Translating_wiki_manual|translated user manual]].
 
<!--  active user manuals in Gramps 5.1
 
<!--  active user manuals in Gramps 5.1
 
https://github.com/gramps-project/gramps/blob/master/gramps/gui/display.py#L40
 
https://github.com/gramps-project/gramps/blob/master/gramps/gui/display.py#L40
Line 270: Line 277:
  
 
===Not enabled===
 
===Not enabled===
Not enabled manuals are where translated versions are not yet available for targeted Help pages. So the Help buttons & the {{man key press|F1}} key from within Gramps only link to English documentation pages and these pages only 'enable' the English reading users.
+
"Not enabled" manuals are where the targeted Help pages have been translated but are not yet linked from within the translated Gramps interface. So the Help buttons & the {{man key press|F1}} key from within Gramps only link to English documentation pages and these shortcuts only 'enable' learning for the English reading users.
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
! <!-- ISO-639-1 --> [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Code]
 
! <!-- ISO-639-1 --> [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Code]
Line 407: Line 414:
  
 
{{-}}
 
{{-}}
 +
<span id="superseded"></span>
  
 
==Gramps 5.0.x Manual==
 
==Gramps 5.0.x Manual==
Line 562: Line 570:
  
 
==Gramps 3.1.x Manual==
 
==Gramps 3.1.x Manual==
 
From Gramps 3.0.x, the manual is no longer distributed with Gramps, and only available online, so you need an internet connection to be able to read the manual. It is available from within Gramps by pressing {{man key press|F1}}, or through the help menu, and provides in depth instructions on the use of Gramps.
 
  
 
* English: [[Gramps 3.1 Wiki Manual | Gramps 3.1 Manual]], download [[Media:Gramps-manual-3.1-en.tar.gz|offline HTML version (draft)]]. Please, see [[Manual Generation 3.0|Manual Generation]].
 
* English: [[Gramps 3.1 Wiki Manual | Gramps 3.1 Manual]], download [[Media:Gramps-manual-3.1-en.tar.gz|offline HTML version (draft)]]. Please, see [[Manual Generation 3.0|Manual Generation]].
Line 580: Line 586:
 
* Slovene : [[Gramps_3.1_Wiki_Manual/sl| Gramps različice 3.1]]
 
* Slovene : [[Gramps_3.1_Wiki_Manual/sl| Gramps različice 3.1]]
 
* Português : [[PT:Manual Wiki GRAMPS 3.1|Manual Wiki Gramps 3.1]]
 
* Português : [[PT:Manual Wiki GRAMPS 3.1|Manual Wiki Gramps 3.1]]
 
Note that for distribution reasons, all edits to this manual must be dual-license: as GPL and GNU Free Documentation License.
 
 
The aim is to be also able to create a distributable manual. See [[Manual Generation 3.0]] for ideas on how to do this.
 
 
The motivation for a wiki manual is that it is editable by all users and allows cross linking to normal wiki content, greatly improving the quality of the manuals. It does make translating the manual harder. Ideas are welcome to improve this.
 
  
 
==Gramps 3.0.x Manual==
 
==Gramps 3.0.x Manual==
Line 603: Line 603:
 
* Slovak : download complete Gramps_3.0_SK.pdf  [[Media:Manual30gramps_SK.pdf|offline version]]
 
* Slovak : download complete Gramps_3.0_SK.pdf  [[Media:Manual30gramps_SK.pdf|offline version]]
 
* Slovene : [[Gramps_3.0_Wiki_Manual/sl| Gramps različice 3.0]]
 
* Slovene : [[Gramps_3.0_Wiki_Manual/sl| Gramps različice 3.0]]
 
Note that for distribution reasons, all edits to this manual must be dual-license: as GPL and GNU Free Documentation License.
 
 
The aim is to be also able to create a distributable manual. See [[Manual Generation 3.0]] for ideas on how to do this.
 
 
The motivation for a wiki manual is that it is editable by all users and allows cross linking to normal wiki content, greatly improving the quality of the manuals. It does make translating the manual harder. Ideas are welcome to improve this.
 
  
 
==Gramps 2.2.x Manual==
 
==Gramps 2.2.x Manual==
The Gramps 2.2.x manual has been translated into 3 languages: French, Dutch and Slovak. You can browse the manuals online or download a pdf in book format (2.5 Mb download, 100 pages, 55 figures).
 
  
{| {{prettytable}}
+
* English [https://gramps-project.org/gramps-manual/2.2/en/index.html HTML Online Manual] / [https://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-en-USletter.pdf PDF letter] size and [https://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-en-A4.pdf PDF A4] size.
|+ Manual links
+
* Français [https://gramps-project.org/gramps-manual/2.2/fr/index.html HTML Manuel] / [https://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-fr-A4.pdf PDF en format A4] - Français: Gramps est une application Open Source définie pour la recherche généalogique.
|-
+
* Nederlands [https://gramps-project.org/gramps-manual/2.2/nl/index.html HTML Handleiding] / [https://gramps-project.org/gramps-manual/2.2/gramps-manual-nl-A4.pdf PDF in A4 formaat] - Nederlands: Gramps is een open source, gratis genealogish software pakket. De handleiding is vertaald in het nederlands, en kan hier geraadpleegd worden
! English
+
* Slovak [https://gramps-project.org/gramps-manual/2.2/sk/index.html HTML Manuál] / [https://gramps-project.org/gramps-manual/2.2/gramps-manual-sk-A4.pdf A4 PDF] - Slovak: Gramps je software typu Open Source určený pre genealogický výskum. Úplné verzie manuálu sú len vo formáte PDF.
| [http://gramps-project.org/gramps-manual/2.2/en/index.html Online Manual]
 
| PDF in [http://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-en-USletter.pdf letter] and [http://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-en-A4.pdf A4] size
 
|
 
|-
 
!Français
 
| [http://gramps-project.org/gramps-manual/2.2/fr/index.html HTML Manuel]
 
| [http://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-fr-A4.pdf PDF en format A4]
 
| Français: Gramps est une application Open Source définie pour la recherche généalogique.
 
|-
 
! Nederlands
 
| [http://gramps-project.org/gramps-manual/2.2/nl/index.html HTML Handleiding]
 
| [http://gramps-project.org/gramps-manual/2.2/gramps-manual-nl-A4.pdf PDF in A4 formaat]
 
| Nederlands: Gramps is een open source, gratis genealogish software pakket. De handleiding is vertaald in het nederlands, en kan hier geraadpleegd worden
 
|-
 
!Slovak
 
| [http://gramps-project.org/gramps-manual/2.2/sk/index.html HTML Manuál]
 
| [http://gramps-project.org/gramps-manual/2.2/gramps-manual-sk-A4.pdf A4 PDF]
 
| Slovak: Gramps je software typu Open Source určený pre genealogický výskum. Úplné verzie manuálu sú len vo formáte PDF.
 
|}
 
  
==Technical info==
+
==See also==
Some technical info related to the manuals:
+
Some technical information related to the creation and maintance of the user manuals:
 
* How do we go from one version of the manual to the next one? See: [[Rollover for the manual]]
 
* How do we go from one version of the manual to the next one? See: [[Rollover for the manual]]
* How the 3.3 offline English manual was made -- see [[Manual Generation 3.0 Prince|this page]]
 
  
{{languages|User_manual}}
+
The aim is to be also able to create a distributable manual. See [[Manual Generation 3.0]] for ideas on how to do this.
 +
* How was the Gramps 3.3 offline English manual created? See: [[Manual Generation 3.0 Prince]]
 +
 
 +
{{languages|User manual translations}}
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Revision as of 15:36, 10 June 2020

Tango-Dialog-information.png
Need Help? See the Gramps user manual.

Targeted manual sections are available from within Gramps by pressing F1, through the Help menu, or by pressing the Help button.

We call these Enabled Manuals since the 'Help' shortcuts enable the user to quickly find the appropriate documentation webpage, which enables them to understand the options of a feature.

Menubar - "Help - F1"

The Gramps user manual is only available online, so you need an internet connection to be able to read the manual. You can access the user manual from within Gramps by pressing F1, or through the help menu via Help > User Manual. The user manual provides instructions on the use of Gramps.

If you encounter an error or have a question about the Gramps program or user manual, please feel free to Contact us via the Gramps user mailing list.

All edits made to this manual are dual-licensed under the GPL and GNU Free Documentation Licenses, this is due to distribution reasons.

The motivation for a using a wiki to maintain the user manual is because the wiki is editable by all users and allows cross linking to normal wiki content, greatly improving the quality of the manuals. It does make translating the manual harder.

Translating the Gramps User manual

You can also translate the user manual in to your language, as explained in Translating the Gramps User manual

Gramps 5.1.x Manual

The Gramps user manual is only available online, so you need an internet connection to be able to read the manual.

User manual (English) Statistics

Page Number 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 Total
Images on Page 0 0 0 1 10 47 22 5 0 18 0 34 21 22 18 3 54 3 0 0 9 41 21 59 19 3 40 26 14 0 0 0 0 24 1 519
Images Needing Updates - - 0 1 10 47 22 5 - 18 - 34 21 22 18 3 54 3 - - 9 41 21 59 19 3 40 15 14 - - - - 24 0 519
Text Updated? Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y 15

Enabled

Manuals are described as 'Enabled' when targeted native language Wiki content is available from within Gramps by pressing F1, or through the Help menu. Once you have created your translation, you may update (or request a developer to update) the Gramps program code to 'enable' the newly translated user manual.

Code Language Coverage(Wiki) PDF/eBook Notes Contact (Translators(s))
en English-USA(Default): Gramps 5.1 Manual
100%
(enabled)
Some images and parts need updating Developers & Users
sq Albanian: Doracak per Gramps 5.1
90%
(enabled)
Issues: Page titles in English/Images:some translated & uses manual numbering (Inactive:User:Vloraj in 2008 for Gramps 3.0)
de Deutsch: Gramps 5.1 Handbuch
95%
(enabled)
Issues:some sections out of sync with English /Images:some translated User:Leonhaeuser
fi Finnish: Gramps 5.1 Käyttöohje
40%
(enabled)
Issues: Some pages partially translated/Images:some translated User:PeterPower/User:Niememat
fr Français: Manuel Gramps 5.1
90%
(enabled)
Issues: Untranslated sections /Images:some translated User:Romjerome/User:Chris_31
mk Macedonian: Упатство за Gramps 5.1
90%
(enabled)
Issues:some sections out of sync with English /Images:some translated (Inactive:(User:Vlatkop in 2008)/(User:Biljanab in 2008))
nl Nederlands: Gramps 5.1 Wiki Handleiding
90%
(enabled)
Issues:some sections out of sync with english /Images:most translated User:Tofkamp, User:Sigmo
ru Russian: Руководство Gramps 5.1
75%
(enabled)
Issues:some sections out of sync with english/missing sections /Images:? User:Armatura
sk Slovak: Gramps manual 5.1
1%
(enabled??? why as not on wiki)
Issue:Leads to translated wiki page that Links to a 165page translated PDF for Gramps 3.2
90%
/ one other page is translated(about)
(Inactive:(User:Citydweller in 2013)) also see Other pages
0%


Not enabled

"Not enabled" manuals are where the targeted Help pages have been translated but are not yet linked from within the translated Gramps interface. So the Help buttons & the F1 key from within Gramps only link to English documentation pages and these shortcuts only 'enable' learning for the English reading users.

Code Language Coverage PDF/eBook Notes Contact (Translators(s))
bg Bulgarian: Gramps 5.1 Manual
2%
(not enabled)
Issues:1 page translated & two others partially (Inactive:User:Borilg in 2011 for Gramps 3.2)
it Italian: Gramps manuale 5.1
15%
(not enabled)
Issues: Some pages partially translated/Images:some translated User:Mschirato in 2016 (Inactive:(User:Fernandopescia in 2009)/(User:MainIt in 2008))
nb Norwegian (bokmål)‬: Gramps 5.1 brukerhåndbok
1%
(not enabled)
Issues:6 pages partially translated/Images:none translated User:Alynx86
(Inactive:(User:Gravejester in 2011))
pl Polish: Podręcznik Gramps 5.1
15%
(not enabled)
Issues:Index translated and some pages partially/Images:? (Inactive:(User:Niedzviedz in 2012))
pt Portuguese:
Manual Wiki Gramps 5.1
2%
(not enabled)
Issues:Index translated and some pages partially/Images:none translated User:Pagramps in 2017 / User:Paulohpmoraes in 2016 (Inactive:(User:Lcc in 2009))
pt (pt-BR) Brazilian Portuguese:
Manual Wiki Gramps 5.1
0%
(not enabled)
Issues:partial Index translated and some pages partially/Images:none translated

User manual/pt-BR - português do Brasil

10205 - New manual/wiki language add ISO pt_PT for Portugal translations
2020: User:Pmra
sl Slovenian: Gramps različice 5.1
1%
(not enabled)
Issues:Index partial translated and 1 page/Images:none translated User:Beernarrd
es Spanish: Manual Wiki para Gramps 5.1
20%
(not enabled)
Issues:Index translated and at least 20 percent of pages, lots of pages missing/Images:many translated (Inactive:(User:Jsanchez in 2012))
ca Catalan: Gramps manual 5.1
1%
(not enabled)
About 3 pages (Inactive:(User:Allman in 2011))
cs Czech: Gramps manual 5.1
0%
(not enabled)
Not started ?
da Danish: Gramps manual 5.1
1%
(not enabled)
Index partially done (Inactive:User:Cedeel)
ja Japanese: Gramps manual 5.1
0%
(not enabled)
Not Started ?
lt Lithuanian: Gramps manual 5.1
0%
(not enabled)
Not started. ?
sv Swedish: Gramps manual 5.1
1%
(not enabled)
1 partial page (Inactive:(User:GoBack in 2011))
zh Chinese: Gramps manual 5.1
1%
(not enabled)
3.5 pages (Active: User:Lyqof908 in 2017 / Inactive: User:Honeyword in 2011 )
ta Tamil: Gramps manual 5.1
0%
Partial Index only (Inactive: User:Udhay 2016)
he Hebrew: Gramps manual 5.1
0%
User:avma
0%


Gramps 5.0.x Manual

Gramps 4.2.x Manual

Gramps 4.1.x Manual

Gramps 4.0.x Manual

Gramps 3.4.x Manual

Gramps 3.3.x Manual

Gramps 3.2.x Manual

Gramps 3.1.x Manual

Gramps 3.0.x Manual

Gramps-notes.png
From Gramps 3.0.x, the manual is no longer distributed with Gramps, and only available online,

so you need an internet connection to be able to read the manual. It is available from within Gramps by pressing F1, or through the help menu, and provides in depth instructions on the use of Gramps.

Gramps 2.2.x Manual

  • English HTML Online Manual / PDF letter size and PDF A4 size.
  • Français HTML Manuel / PDF en format A4 - Français: Gramps est une application Open Source définie pour la recherche généalogique.
  • Nederlands HTML Handleiding / PDF in A4 formaat - Nederlands: Gramps is een open source, gratis genealogish software pakket. De handleiding is vertaald in het nederlands, en kan hier geraadpleegd worden
  • Slovak HTML Manuál / A4 PDF - Slovak: Gramps je software typu Open Source určený pre genealogický výskum. Úplné verzie manuálu sú len vo formáte PDF.

See also

Some technical information related to the creation and maintance of the user manuals:

The aim is to be also able to create a distributable manual. See Manual Generation 3.0 for ideas on how to do this.