View source for templates

{{DISPLAYTITLE:Using templates}}
{{languages|templates}}

The '''[[gwd]]''' server produces HTML code displayed by the client browser according to instructions stored in text files. Examples of such files are:
* welcome.txt the welcome page shown when you connect to <code>localhost:2317/basename</code>.
* perso.txt the page that displays one individual of the base.
* updfam.txt the page containing the form to update a family.

A template is a set of such files organized into a coherent user interface. Template files are stored in folders named [[distribution|{{c|distribution/gw/etc/template_name}}]] and [[bases|{{c|bases/etc/basename/template_name}}]]. Note that when searching for a template file, GeneWeb will search in the following order:
* {{c|bases/etc/basename/file}}
* {{c|bases/etc/template_name/file}}
* {{c|distribution/gw/etc/template_name/file}}
* {{c|distribution/gw/etc/file}} ?

If no file is found, then the search continues with the list of templates defined by the configuration variable {{c|template}} found in [[configuration|base.gwf]].
<!-- (this needs to be verified. Are {{c|bdir/etc/base/template}} and {{c|gw/etc/base}} looked into? Behavior changed between 6.08 and 7.00 [[User:Henri83|Henri83]] ([[User talk:Henri83|talk]]) 18:02, 16 October 2015 (CEST)).-->

As a result, you may limit your editing to the file whose content you want to change. All the other files will be found in the default folder according to the sequence above.

Templates are invoked by adding (through a clickable button if available, or manually if not) {{c|1=templ=templ_name;}} in the URL at the top of your browser. GeneWeb will "remember" this request for a template use and will automatically add the appropriate text in all subsequent URL requests.

See the [[expert#Template programming|experts]] section for further discussion on template programming.

== Personnalisation Modules ==

La version 7 de GeneWeb offre nouvelle manière pour personnaliser l'aspect de la page personnelle. Cette solution repose sur l'existence d'une liste de modules définis dans le fichier de configuration [[configuration|base.gwf]] en associant chaque module à une lettre entre a et z (attention à ne pas mettre de texte supplémentaire après le nom de l'option - ni espaces, ni commentaires!).


example extracted from [https://github.com/geneweb/geneweb/blob/v7.0.0/etc/a.gwf#L373 a.gwf] reference file (version 7.0.0)
<pre>
 perso_module_i=individual
 perso_module_p=parents
 perso_module_u=unions
 ...
</pre>

Each module can be displayed with a choice of options.

The display of modules on a personal pages will be governed by a vector defining 
a selection amongst the modules above, the order in which they are displayed and the chosen option.

The vector appears as a string of letters and digits.
Each pair "letter, digit" identifies the selected module, 
and the value of its display options 
The modules are displayed in the order in which they appear in the {{c|p_mod}} parameter as
in the example below, "gd_parents", "individual", "parents", "unions", ...

 p_mod=g1i1p1u1r1c1f1s1

[[File:p_mod-configuration.png|thumb|400px|right|Pull-down menu for module and option selection.]]

Selecting {{c|1=p_mod=p1p2p3p4p5}} will display all five options for the module {{c|parents}}.

The menubar of the {{c|perso.txt}} page provides an interface to change the value of this {{c|p_mod}} parameter and to select options. As the mouse hovers on the option button, a pop-up showing the general aspect of the chosen option will appear. On the right of the selection window, these pop-ups will accumulate representing the resulting page..

You may choose any set of (single) letters (a-z) to designate modules.

* For geneweb version 7.0.0
 The default configuration file [https://github.com/geneweb/geneweb/blob/v7.0.0/etc/a.gwf#L373 a.gwf] provides the list of available modules.
* For geneweb version 7.1 (after beta version and next cid reference) the default list of modules is hardcoded in ''etc/perso_utils.txt'' as documented in [https://github.com/geneweb/geneweb/commit/81a6acbdd42984b31de6bfbb2f43d82b3834eda9 git cid 81a6acbdd]
Users have the possibility to add their own modules to be stored in the folder:

 bases/etc/perso_modules/new_module.txt

Note that the value of {{c|p_mod}} can be stored in the [[configuration|base.gwf]] parameter file. GeneWeb copies this value automatically in each URL in a fashion similar to the {{c|1=templ=}} variable.
It may therefore be stored in a shortcut memorized by your browser. This is particularly useful in the case of multi-user GeneWeb servers as GeneWeb cannot remember a user specific profile.

A graphical user interface facilitates the module and option selection. Thumbnails provide a graphical hint of the visual aspect of each option, and the right colums of the menu displays a mock-up of the resulting page. Personnal modules added by the user do not show up in this interface, but may be added through some editing of the {{c|gw/etc/p_mod.js}} file (use existing modules as examples).

Several modules have their own visual adjustment buttons (number of generations, with or without images, with or without half brothers ans sisters, ...)

About '''chronologie''' module the list of '''all''' events is only displayed if there is '''at least one event that differ'''
from default ones (birth, baptism, mariage, death and burial)
nevertheless we are able to suppress or force display of the list
with setup of <code>has_events=never/always</code> as already described in [[expert#Note_for_has_event_(v7)]]

==Perso.txt==
The file {{c|perso.txt}} controls the display of information associated with each person. Two modes of operation are provided through the following structure:

Import of utilities functions and menu bar.

 %import;perso_utils;
 %include.menubar;

Two display modes:

1/ two columns, fixed set of modules
<pre>
 %if;(p_mod="zz")
  %(Statique%)
  %( two columns if screen_width>=992px but full width for tablets/phone < 992px %)
    %if;(has_parents and (father.has_parents or mother.has_parents))
       <div class="collapse" id="collapseExample1">
          %let;op_m;1%in;%apply;show_templ("perso_module/gr_parents")
       </div>
    %end;
    <div class="row">
      %(be carefull h1 is full width then an opening <div class="col-8"> in individu module %)
      %let;op_m;3%in;%apply;show_templ("perso_module/individu")
      %let;op_m;2%in;%apply;show_templ("perso_module/unions")
      %let;op_m;1%in;%apply;show_templ("perso_module/chronologie")
      %let;op_m;1%in;%apply;show_templ("perso_module/notes")
      %let;op_m;2%in;%apply;show_templ("perso_module/sources")
      </div> %( closing the <div class="col-8"> in module individu %)
      <div class="d-none d-lg-block col-lg-4">%(second column above lg%)
        %let;op_m;2%in;%apply;show_templ("perso_module/arbre_3gen_photo")
        %let;op_m;1%in;%apply;show_templ("perso_module/fratrie")
        %let;op_m;1%in;%apply;show_templ("perso_module/relations")
      </div>
    </div>
</pre>

2/ One column. Modules modules labeled from a to z as defined in [[configuration|base.gwf]] and governed by the {{c|p_mod}} variable.
<pre>
 %else;(p_mod!="")
  %(Dynamic %)
    %for;i;0;p_mod_nbr;
      %let;mmi;%apply;mm(i)%in;
      %let;ooi;%apply;oo(i)%in;
      %if;(mmi!="" and ooi!=0)
        %apply;get_mod(mmi, ooi)
      %end
    %end;

%end;
</pre>

==Examples==

The result corresponding to each choice is as follows:

(These examples ware taken from a version 6 instance. Version 7 of GeneWeb may provide somewhat different results).

{|class="wikitable" style="border-width: 10px; text-align:left;"
!File name!! Example
|-
|etat_civil||| [[File:Etatcivil.jpg|thumb|500px|center|Personal data.]]
|-
|parent_simple|| [[File:Parent_simple.jpg|thumb|500px|center|Parents (simple).]]
|-
|parent_evolue|| [[File:Parent_evolue.jpg|thumb|500px|center|Parents (more complex).]]
|-
|parent_complet|| [[File:Parent_complet.jpg|thumb|500px|center|Parents (full).]]
|-
|parent_photo|| [[File:Parent_photo.jpg|thumb|500px|center|Parents (with photo).]]
|-
|union_simple|| [[File:Union_simple.jpg|thumb|500px|center|Union (simple).]]
|-
|union_evolue|| [[File:Union_evolue.jpg|thumb|500px|center|Union (more complex).]]
|-
|union_complet|| [[File:Union_complet.jpg|thumb|500px|center|Union (full).]]
|-
|union_photo|| [[File:Union_photo.jpg|thumb|500px|center|Union (with photo).]]
|-
|freresoeur_simple|| [[File:Freresoeur_simple.jpg|thumb|500px|center|Brothers and sisters (simple).]]
|-
|freresoeur_complet|| [[File:Freresoeur_complet.jpg|thumb|500px|center|Brothers and sisters (full).]]
|-
|famille|| [[File:Famille.jpg|thumb|500px|center|Family.]]
|-
|relations|| [[File:Relations.jpg|thumb|500px|center|Relations.]]
|-
|notes|| [[File:Notes.jpg|thumb|500px|center|Notes.]]
|-
|sources|| [[File:Sources.jpg|thumb|500px|center|Sources.]]
|-
|timeline|| [[File:Timeline.jpg|thumb|500px|center|Timeline.]]
|-
|arbre_3gen_v|| [[File:Arbre_nav3.jpg|thumb|500px|center|Tree, vertical, 3 generations.]]
|-
|arbre_nav3_photo|| [[File:Arbre_nav3photos.jpg|thumb|500px|center|Tree, vertical, 3 generations with photos.]]
|-
|arbre_4gen_v|| [[File:Arbre_nav4.jpg|thumb|500px|center|Tree, vertical, 4 generations.]]
|-
|arbre_5gen_h|| [[File:Arbre_nav5h.jpg|thumb|500px|center|Tree, horizontal, 5 generations.]]
|}

{{manual}}

[[Category:Manual]]