4,610
edits
Changes
m
These 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"]]
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.
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.
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.
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}}|+ Manual links|-! * English| [httphttps://gramps-project.org/gramps-manual/2.2/en/index.html HTML Online Manual]| PDF in / [httphttps://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-en-USletter.pdf PDF letter] size and [httphttps://gramps-project.org/gramps-manual/2.2/gramps-manual-2.2-en-A4.pdf PDF A4] size.| |-!* Français| [httphttps://gramps-project.org/gramps-manual/2.2/fr/index.html HTML Manuel]| / [httphttps://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| [httphttps://gramps-project.org/gramps-manual/2.2/nl/index.html HTML Handleiding]| / [httphttps://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| [httphttps://gramps-project.org/gramps-manual/2.2/sk/index.html HTML Manuál]| / [httphttps://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.|}
* How the 3.3 offline English manual was made -- see [[Manual Generation 3.0 Prince|this page]]
→Not enabled: add anchor to beginning of list of superseded manuals
{{languages|User_manualUser_manual_translations}}{{man tip| 1=Need Help? See the [[Gramps_{{Version manual}}_Wiki_Manual|Gramps user manual]]. |2=Enabled manuals 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 buttonkey press|Help}} button.
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 the Grampsprogram or user manual, please feel free to [[Contact]] usvia 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]]
<!--{{man menu|Unreleased manual see Gramps 5.0 below}}-->
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===
===Enabled===
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
https://github.com/gramps-project/gramps/blob/master/gramps/gui/display.py#L40
===Not enabled===
"Not enabled " manuals are where the targeted Help pages have been translated versions but are not yet available for targeted Help pageslinked 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 pages shortcuts only 'enable' learning for the English reading users.
{| class="wikitable sortable"
! <!-- ISO-639-1 --> [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Code]
|-
| <!-- ISO-639-1 --> [[:Category:Pt:Documentation|pt]]
| <!-- Language & Translated name -->[https://en.wikipedia.org/wiki/Portuguese_language Portuguese]: <br> {{call_lang|Gramps 5.1 Wiki Manual|pt|Manual Wiki Gramps 5.1}}
| <!-- Estimated % Coverage of translation -->{{progress|2}}(not enabled)
| <!-- Download links for PDF/ebook -->
| <!-- Notes -->Issues:Index translated and some pages partially/Images:none translated<br>[[:User manual/pt-BR]]
| <!-- Contact -->[[User:Pagramps]] in 2017 / [[User:Paulohpmoraes]] in 2016 (Inactive:([[User:Lcc]] in 2009))
|-
| <!-- ISO-639-1 --> [[:Category:Pt:Documentation|pt]] (pt-BR)
| <!-- Language & Translated name -->[https://en.wikipedia.org/wiki/Brazilian_Portuguese Brazilian Portuguese]:<br> {{call_lang|Gramps 5.1 Wiki Manual|pt-BR|Manual Wiki Gramps 5.1}}
| <!-- Estimated % Coverage of translation -->{{progress|0}}(not enabled)
| <!-- Download links for PDF/ebook -->
| <!-- Notes -->Issues:partial Index translated and some pages partially/Images:none translated<br><br>[[:User manual/pt-BR]] - português do Brasil <br><br>{{bug|10205}} - New manual/wiki language add ISO pt_PT for Portugal translations
| <!-- Contact -->2020: [[User:Pmra]]
|-
| <!-- ISO-639-1 --> sl
{{-}}
<span id="superseded"></span>
==Gramps 5.0.x Manual==
==Gramps 3.1.x Manual==
* 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]].
* 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]]
==Gramps 3.0.x Manual==
* 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]]
==Gramps 2.2.x Manual==
==Technical infoSee also==Some technical info 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]]
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_manualUser manual translations}}
[[Category:Documentation]]
