Building links to GeneWeb

From GeneWeb
Revision as of 00:43, 25 October 2015 by A2 (Talk | contribs) (Requests to gwd server: un peu lourd tout ça à relire…)

Jump to: navigation, search
150px-Geographylogo svg.png Language: English

gwd is the GeneWeb server that accepts requests and returns results. Its interfaces are entirely web based: it behaves like a HTTP server.

All query parameters for the gwd server are directly available in the URL window of your web browser to build links to GeneWeb pages.

They may be useful both to GeneWeb users, and to persons who, without knowledge of GeneWeb, may want to insert in some of their web documents a link to a page produced by a GeneWeb server that they may have found on the Web.

Base address of a GeneWeb database

The welcome page of a GeneWeb base can be found at an URL of the form http://server:port/base where:

  • server is the IP address or DNS name of the server hostion the GeneWeb daemon;
  • port is the TCP port on which the daemon is listening, the default value being 2317 for base access with gwd and 2316 for management with gwsetup (these two parameters may be changed at launch time of these two programs);
  • base the name of the GeneWeb base.

To ease things, gwd opens up by displaying the standard page welcome.txt on which a multiplicity of text capture zones and clickable buttons provides a convenient way to build a complex request.

Requests to gwd server

Requests to gwd server are formulated as URLs loaded with parameters. The question mark ? after the base adress marks the beginning of the request: http://server:port/base?request.

It may be sometimes necessary to manually edit the URL to obtain the desired effect because some parameters aren't available for selection and/or clicking for all pages of the interface.

The request in itself is the sum of all query parameters added to the end of the url after the question mark. The gwd server analyse the differents parameters and will render a specific page. Depending on the situation, the delimiter between the query parameters in the URLs may change between ; and &. Both can be used simultaneously.

Results are returned as text. If you send the URL request from a browser (it can also be sent from any HTTP compatible program), then the text will be treated as HTML code.

Links to persons, access_by_key and opt=no_index

Within GeneWeb, persons can be identified through two main methods, names and id:

  • p=first_name;n=last_name (exact match);
  • p=first_name;n=last_name;oc=occurrence if there are homonyms;
  • i=1234 GeneWeb internal id.

GeneWeb id numbers are unique across a base, but may change over time after cleanup for instance. Les numéros d’id des individus sont modifiés par la commande gwc si vous faites un nettoyage de la base. Ils ne sont donc pas pérrènes.

Obtaining permanent links is achieved through two methods:

  • using option access_by_key=yes in the .gwf configuration file of your base, which will prevent the use of internal ids for URL construction;
  • adding opt=no_index to an URL containing id numbers will return the URL with unique but bulkier keys of individuals p=firstname;n=lastname;oc=occurence instead of id numbers.
Link to use without i=, obtained adding opt=no_index in the URL.

This last remark applies to all GeneWeb queries, particularly those about parental relationship where many individuals are referenced.

Language

lang=

Template

templ=

Pedigree collapse, dag=on

Ascendants tree with dag=on: common ancestors are merged.

On ascendant and descendant trees, dag=on will merge common anscestors.

Origin of a person, opt=from

The opt=from option is used to determine which source file a particular person's data comes from. See merging bases for details. This information appears in italic after the family os the person, and is visible only to wizards.

Cancel GeneWeb links, cgl=on/off

Use the cgl=off (cancel geneweb links) option to cancel GeneWeb links in a given page. This may be useful for printing, or to do a copy/paste operation of a page into some other document where you don not want to transport the various GeneWeb links.

Names for one person, opt=misc

The opt=misc option will display at the end of the page all the first_name last_name alias combinations considered valit-d to invoque a particular person.

Hidden titles, all_titles

all_titles=on

Refresh modified pages, escache

escache=0