Difference between revisions of "gwd"
m |
m (→Insert images and text files: add manual category and navigation template) |
||
Line 73: | Line 73: | ||
For example, to display an image in notes we use {{c|1=<a href="%sm=IMH;s=image.jpg">Displayed text</a>}}. In this example, the “command” is the {{c|1=m=IMH}} part, {{c|%s}} is a [[macros|macro]] transformed into the server address, and the rest of the URL being the parameters passed to the command, here the name of the image. | For example, to display an image in notes we use {{c|1=<a href="%sm=IMH;s=image.jpg">Displayed text</a>}}. In this example, the “command” is the {{c|1=m=IMH}} part, {{c|%s}} is a [[macros|macro]] transformed into the server address, and the rest of the URL being the parameters passed to the command, here the name of the image. | ||
+ | |||
+ | {{manual}} | ||
+ | |||
+ | [[Category:Manual]] |
Revision as of 00:27, 17 April 2016
Language: | English • français |
---|
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 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.
Welcome page 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 hosting 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
is the name of the GeneWeb database.
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.
When further navigating with GeneWeb, you will discover that your requests translate into URL which contains a command (action) and related parameters (data).
Requests to gwd server
Requests to gwd server are formulated as URLs loaded with parameters. The question mark ?
after the base address marks the beginning of the request: http://server:port/base?request
.
It may sometimes be 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 different 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.
The gwd server assumes that the URL request comes from a standard HTTP client (a browser or any other HTTP compatible program), and returns its result page accordingly (i.e. prefixed by the standard Content-type text/html
header).
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 clean up for instance.
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 individualsp=firstname;n=lastname;oc=occurence
instead of id numbers.
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
On ascendant and descendant trees, dag=on
will merge common ancestors.
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 of 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 valid to call a particular person.
Hidden titles, all_titles
all_titles=on
Refresh modified pages, escache
escache=0
Insert images and text files
- m=IMH insert image
- m=SRC insert text file (typically HTML code)
For example, to display an image in notes we use <a href="%sm=IMH;s=image.jpg">Displayed text</a>
. In this example, the “command” is the m=IMH
part, %s
is a macro transformed into the server address, and the rest of the URL being the parameters passed to the command, here the name of the image.
GeneWeb Manual
- Download and install GeneWeb program under GNU/Linux, Mac OS X, Microsoft Windows, FreeBSD; on Mac OS X, Linux or Windows using Docker; or in CGI mode behind a web server.
- Understand GeneWeb server, homonym, consanguinity.
Use and manage genealogical databases
- Import Gedcom
.ged
or GeneWeb.gw
files with gwsetup or in command-line. - Update datas (add/remove individuals and families), merge duplicates, type dates.
- Use wikitext syntax, macros, keyboard shortcuts.
- Clean, recover, rename, save, archive a database.
- Merge and split multiples databases.
Technical annex
- Personalize CSS, header and trailer, templates, lexicon and declension.
- Configuration file
.gwf
(for templm), wizard notes, passwords for friends/wizards and access restrictions to databases. - Add images in notes, further remarks for experts.