Difference between revisions of "manual"

From GeneWeb
Jump to: navigation, search
(Use: distinguish wizard from friends and visitors)
 
(52 intermediate revisions by 6 users not shown)
Line 5: Line 5:
 
== Starting ==
 
== Starting ==
 
* [[Download]]  
 
* [[Download]]  
* Install GeneWeb program under [[Linux|GNU/Linux]], [[OSX|Mac OS X]], [[Windows|Microsoft Windows]]; on Mac, Linux or Windows [[Docker|using Docker]]; in [[CGI|CGI mode behind a web server]], with [[https|HTTPS access]].
+
* Install the GeneWeb program:
 +
** On [[Linux|GNU/Linux]], [[OSX|Mac OS X]], [[Windows|Microsoft Windows]], [[FreeBSD]].
 +
** In [[CGI|CGI mode behind a web server]], specifically on a [[raspbian|Raspberry Pi]].
 +
** With [[https|HTTPS access]].
 +
** Using [[Docker|{{c|Docker]]||}}.
 
* Configure:
 
* Configure:
** a server (launch parameters for [[gwd]])
+
** Start [[gwd|GeneWeb daemon]] [[man|launch parameters]].
** operation of a base (parameters in a [[configuration|base_name.gwf]] file)
+
** [[configuration|Database]] editing {{c|base_name.gwf}} file.
** appearance of a base ([[templates|templates]])
+
* [[man|Start]] GeneWeb.
+
  
== Use ==
+
== Use (wizard) ==
* Data entry and update:
+
* Data entry and update for:
** [[Update#Updating persons|individuals]] and [[Update#Updating families|families]],  
+
** [[Update#Updating persons|Individuals]] and [[Update#Updating families|Families]],  
** [[Fusion|merge duplicates]],
+
** [[Fusion|Finding and merging duplicate records]].
** enter [[date]]s.
+
** Entering [[date]]s.
** [[declension|declensions]]
+
** [[declension|Using declensions]]; alternate name spellings (in GeneWeb 6).
* [[wikitext|Wikitext]] syntax,
+
* [[wikitext|Wikitext]] syntax.
* [[macros|Macros]],
+
* [[macros|Writing Macros]].
* [[shortcuts|Keyboard shortcuts]].
+
* [[shortcuts|Using keyboard shortcuts]].
 +
* Change the appearance of a base using [[templates]].
 +
* Functional extensions through [[plugins|Plugins]].
 +
 
 +
== Use (friend or visitor) ==
 +
 
 +
Friends and visitors can only search and read the content of the base. Friends, being authenticated, may have privileges over simple visitors. See [[password]] for details.
 +
 
 +
Entry and navigation into the base is achieved through the following mechanisms:
 +
* the welcome page offering a main search capability and access to tools such as notes, forum, history, dictionaries, ...
 +
* the advanced search page
 +
* the search pop-up triggered by the magnifying glass button in the top right corner
 +
* the menu bar offering access to various pages such as trees, lists, tables, ...
 +
 
 +
Furthermore, on pages, many items are clickable and allow navigation into the base.
 +
 
 +
=== Search with the welcome page ===
 +
 
 +
The welcome page being the first entry point into the base, it is worth describing in more details the basic search mechanism it proposes.
 +
Beyond clickable buttons, whose function should be self explanatory, the welcome page offers four data entry lines.
 +
The two first lines allow capture of first_names and surnames, the order in which they are entered being governed by the parameter {{c|welcome_fn_sn}} in the {{c|.gwf}} file.
 +
The two other lines allow search by title or by domain.
 +
For first_name and surname entry, it is not always necessary to capture them into their respective line. Entering first_name surname into the first line will suffice most of the time, that is when exact matches are found for this combination.
 +
Splitting first_name and surname into each of their entry line is necessary when exact match is not expected, for instance when only one first_name is entered and the target person has multiple first_names.
 +
 
 +
Examples:
 +
Assume that the base contains
 +
* Henri Dupont
 +
* Henri Marie Xavier Dupont
 +
* Henri.1 Dupont
 +
 
 +
The following will happen:
 +
* Entering {{c|Henri Dupont}} into the first line will yield answers 1 and 3
 +
* Entering {{c|Henri Marie Xavier Dupont}} into the first line will yield answers 2
 +
* Entering {{c|Henri}} into the first line and {{c|Dupont}} into the second will yield answers 1, 2 and 3
 +
* Entering {{c|Henri}} into the first line and {{c|Dupont}} into the second and checking the "exact" tick mark for first_name will yield answers 1 and 3
 +
* Entering {{c|Henri Marie}} into the first line and {{c|Dupont}} into the second will yield answers 2
 +
 
 +
These rules apply also to the search pop-up appearing when clicking on the magnifying glass at the top right corner (default template only).
 +
 
 +
Note that when there are more than one entry, a selection list is proposed, and when only one entry is returned, the page for that person is opened.
 +
Note also that the first entry line can also be used to enter a Sosa number, a public name or an alias.
 +
 
 +
When no match is found, GeneWeb tries a last effort by reducing the search entry, and the names in the base through a compression algorithm (crush) and comparing the results.
 +
The compression algorithm performs the following:
 +
* suppress vowels
 +
* soppress trailing s
 +
* replace double consons by one conson
 +
* replaces ph by f, k or q by c, z by s
  
 
== Manage ==
 
== Manage ==
* Import GEDCOM {{c|.ged}} or [[GWformat|GeneWeb {{c|.gw}}]] databases with [[gwsetup]] or in [[man|command-line]].
+
* Import GEDCOM {{c|.ged}} or [[GWformat|GeneWeb {{c|.gw}}]] databases with {{c|[[gwsetup]]}} or with terminal [[man|commands]].
*[[Merge]] and [[Divide|split]] multiples databases.
+
*[[Merge]] and [[Divide|split]] multiple databases.
* [[Clean]], [[recover]], [[rename| rename or move]], [[save]], [[archive]] a database.
+
* [[Clean]], [[recover]], [[rename| rename (or move)]], [[save]], and [[archive]] a database.
  
== Technical annex ==
+
== Technical Annex ==
* Understand the [[Gwd|gwd]] server.
+
* Understand the [[Gwd|{{c|gwd}}]] server.
* Understand [[namesake|homonym]].
+
* Understand [[namesake|homonym]]s (how duplicate names are handled).
* Configure appearance:
+
* Configure appearance with:
** cascaded style sheets ([[CSS]])
+
** Cascaded style sheets [[CSS|{{c|.css}}]] files).
** [[header|header and trailer]], [[lexicon]]
+
** [[header|Header and trailer]] files; the [[lexicon]] files (how languages and handled in GeneWeb).
** [[templates]]  
+
** [[templates|Editable template files]]  
* Configure operations:
+
* Configure operations (program actions), with:
**[[configuration|configuration file {{c|.gwf}}]]  
+
** The tool [[configuration|{{c|gwf}}]].
** specific parameters for (for [[templm]])
+
** Specific parameters (for {{c|[[templm]]}}) .
**[[password|passwords for friends/wizards]] and [[access|access restrictions]] to databases  
+
**[[password|Passwords for Friends/Wizards]] and handling [[access|access permissions]] for databases.
  
* Add [[image]]s in notes
+
* Syntax to add [[image]]s to Notes fields.
* Understand Geneweb file format (.gw)
+
* Understand the Geneweb human-readable, archival format of [[GWformat|{{c|.gw}}]] files .
* Compute [[consang|consanguinity]]
+
* How to compute [[consang|Consanguinity]] (genetic relationships between people).
 
* Further remarks for [[expert]]s.
 
* Further remarks for [[expert]]s.
  
 
[[Category:Manual| ]]
 
[[Category:Manual| ]]

Latest revision as of 11:06, 7 January 2022

150px-Geographylogo svg.png Language: English • Deutsch • français
Manuel support.jpg

Starting

Use (wizard)

Use (friend or visitor)

Friends and visitors can only search and read the content of the base. Friends, being authenticated, may have privileges over simple visitors. See password for details.

Entry and navigation into the base is achieved through the following mechanisms:

  • the welcome page offering a main search capability and access to tools such as notes, forum, history, dictionaries, ...
  • the advanced search page
  • the search pop-up triggered by the magnifying glass button in the top right corner
  • the menu bar offering access to various pages such as trees, lists, tables, ...

Furthermore, on pages, many items are clickable and allow navigation into the base.

Search with the welcome page

The welcome page being the first entry point into the base, it is worth describing in more details the basic search mechanism it proposes. Beyond clickable buttons, whose function should be self explanatory, the welcome page offers four data entry lines. The two first lines allow capture of first_names and surnames, the order in which they are entered being governed by the parameter welcome_fn_sn in the .gwf file. The two other lines allow search by title or by domain. For first_name and surname entry, it is not always necessary to capture them into their respective line. Entering first_name surname into the first line will suffice most of the time, that is when exact matches are found for this combination. Splitting first_name and surname into each of their entry line is necessary when exact match is not expected, for instance when only one first_name is entered and the target person has multiple first_names.

Examples: Assume that the base contains

  • Henri Dupont
  • Henri Marie Xavier Dupont
  • Henri.1 Dupont

The following will happen:

  • Entering Henri Dupont into the first line will yield answers 1 and 3
  • Entering Henri Marie Xavier Dupont into the first line will yield answers 2
  • Entering Henri into the first line and Dupont into the second will yield answers 1, 2 and 3
  • Entering Henri into the first line and Dupont into the second and checking the "exact" tick mark for first_name will yield answers 1 and 3
  • Entering Henri Marie into the first line and Dupont into the second will yield answers 2

These rules apply also to the search pop-up appearing when clicking on the magnifying glass at the top right corner (default template only).

Note that when there are more than one entry, a selection list is proposed, and when only one entry is returned, the page for that person is opened. Note also that the first entry line can also be used to enter a Sosa number, a public name or an alias.

When no match is found, GeneWeb tries a last effort by reducing the search entry, and the names in the base through a compression algorithm (crush) and comparing the results. The compression algorithm performs the following:

  • suppress vowels
  • soppress trailing s
  • replace double consons by one conson
  • replaces ph by f, k or q by c, z by s

Manage

Technical Annex

  • Syntax to add images to Notes fields.
  • Understand the Geneweb human-readable, archival format of .gw files .
  • How to compute Consanguinity (genetic relationships between people).
  • Further remarks for experts.