Difference between revisions of "configuration"

From GeneWeb
Jump to: navigation, search
(Configuration (en) pass 1)
 
(added evar and bvar)
Line 61: Line 61:
  
 
* '''history_diff''' indicates that detailed modifications are logged for each person (à la wiki).
 
* '''history_diff''' indicates that detailed modifications are logged for each person (à la wiki).
 +
 +
== Environment variables, bvar, evar ==
 +
 +
GeneWeb proposed a general purpose mechanism allowing the user/programmer to extend at will the notion of variable described here.
 +
 +
If a new variable is defined in the {{c|.gwf}} configuration file, then it will be possible to test for the value of this variable in the context of a template file. For instance, if we have added
 +
new_var=some-text
 +
in {{c|.gwf}}, then the following code in the template will be able to perform some specific action:
 +
%if; (bvar.new_var = "sometext" )
 +
    ... perform some specific action ...
 +
%end;
 +
 +
Similarly, if we have added a new variable in the URL of the query to GeneWeb ({{c|localhost:2317/base?p=first-name;n=last-name;lang=fr;tree=3}}, then it is possible to test for this variable with code such as:
 +
 +
%if; (evar.tree = 3 )
 +
    ... display 3 generation tree ...
 +
%end;
 +
 +
The value itself of such variables can be inserted in the body of a template by typing {{c|%evar.tree;}}, for instance
 +
 +
<nowiki><title>Tree with %evar.tree; generations</title></nowiki>
  
 
Return to[[Manual]]
 
Return to[[Manual]]

Revision as of 17:52, 31 October 2015

150px-Geographylogo svg.png Language: English • français

The configuration file for a given base is a text file with extension .gwf bearing the same name as your base and sitting next to the basename.gwb folder. It contains variables controlling the behavior of the gwd program. If no configuration file is supplied, gwd will fall back on a standard configuration located at bindir/gw/a.gwf. This a.gwf file contains all variables with some description of their actions, some being commented out. Additional files may provide other configuration variables as for the templm template.

If you create a fresh base with gwsetup, you will be proposed the following default simpler configuration file:

access_by_key=yes
disable_forum=yes
hide_private_names=no
use_restrict=no
show_consang=yes
display_sosa=yes
place_surname_link_to_ind=yes
max_anc_level=8
max_anc_tree=7
max_desc_level=12
max_desc_tree=4
max_cousins=2000
max_cousins_level=5
latest_event=20
template=*
long_date=no
counter=no
full_siblings=yes
hide_advanced_request=no

The gwsetup base creation interface allows direct modification of several of the variables above.

Detailed description of variables

This description is limited to some important variables. For others, see a.gwf.

  • body_prop content of the %b macro typically inserted in the "<body>" HTML tag. Syy your HTML documentation for details.

Example:

body_prop=background=monfond.jpg vlink=yellow
This applies to all pages produced by GeneWeb.
  • friend_passwd allows global access control for persons potentially still alive. See private_years in a.gwf. defualt value is 150 years.
If a value is supplied for this variable, only visitors having entered that value as password will see data about persons born less than "private_years" years.
friend_passwd_file allows for a user level access control.
  • wizard_passwd allows global access control to modification rights in the base.
If a value is supplied for this variable, only visitors having entered that valus as password will have modification rights.
wizard_passwd_file allows for a user level access control.
  • wizard_just_friend allows to temporarily prevent modifications
  • default_lang specifies the default language. Default value is french. Possibilities are: "af" (afrikaans), "bg" (bulgaran), "br" (breton), "cs" (czech), "ca" (catalan), "de" (greman), "da" (danish), "en" (english), "eo" (espéranto), "es" (spanish), "et" (estonian), "fi" (finnish), "fr" (french), "he" (hebrew), "is" (icelandic), "it" (italian), "lv" (latvian), "nl" (dutch), "no" (norvegian), "pl" (polish), "pt" (portugeese), "pt-br" (bresilian portugeese), "ro" (romanian), "ru" (russian), "sl" (slovenian), "sv" (sueedish), "zh" (chineese),
Note that at any time, independant of this setting, you may change the inetrface language by clicking on the appropriate flag of the welcome page (unless you have edited it out!), or by inserting {{{1}}} directly in the URL window of your browser.
  • can_send_image allows wizards to send or modify images associated with persons. See Update. Default value is "no"; to allow, enter "yes".
Those images may take some space; manage carefully.
  • renamed indicates a new name for this base (useful if many links into your base exist on the web. A page with the new link will be displayed for the user to copy/paste and to follow to the content of his request.
  • history indicates that your base logs modification to its content (kept in {{c|bases/basename.gwb/history) and visible from the welcome page if the file exists.
  • history_diff indicates that detailed modifications are logged for each person (à la wiki).

Environment variables, bvar, evar

GeneWeb proposed a general purpose mechanism allowing the user/programmer to extend at will the notion of variable described here.

If a new variable is defined in the .gwf configuration file, then it will be possible to test for the value of this variable in the context of a template file. For instance, if we have added

new_var=some-text

in .gwf, then the following code in the template will be able to perform some specific action:

%if; (bvar.new_var = "sometext" ) 
    ... perform some specific action ...
%end;

Similarly, if we have added a new variable in the URL of the query to GeneWeb ({{{1}}}, then it is possible to test for this variable with code such as:

%if; (evar.tree = 3 )

    ... display 3 generation tree ...
%end;

The value itself of such variables can be inserted in the body of a template by typing %evar.tree;, for instance

<title>Tree with %evar.tree; generations</title>

Return toManual