Difference between revisions of "Talk:manual"

From GeneWeb
Jump to: navigation, search
(Created page with "== Some themes to introduce and discuss and unstructured questions == * define more clearly the notions of page, form, zone, data capture field, tick-marks, buttons, radio bu...")
 
(Some terminology proposals)
Line 6: Line 6:
 
: Identify the basic template to be discussed and adhere to its hierarchy
 
: Identify the basic template to be discussed and adhere to its hierarchy
 
* Prepare sub-sections for experts
 
* Prepare sub-sections for experts
* talk about places, occupations, sources dictionnaries and their use
+
* talk about places, occupations, sources dictionaries and their use
 
* Talk, and/or discuss in CHANGES.txt the big new features appearing in version 7
 
* Talk, and/or discuss in CHANGES.txt the big new features appearing in version 7
 
* Introduce very early the {{c|bases}} and {{c|gw}} folders and explain that most, if not all files will be prefixed by one or the other
 
* Introduce very early the {{c|bases}} and {{c|gw}} folders and explain that most, if not all files will be prefixed by one or the other
Line 13: Line 13:
 
* so far so good!!
 
* so far so good!!
 
23:42, 30 October 2015 (CET)
 
23:42, 30 October 2015 (CET)
 +
 +
== Terminology ==
 +
 +
When discussing GeneWeb, we will use across the documentation the following terms:
 +
* '''GeneWeb''': the service as a whole
 +
* '''gwd''', '''gwc''', '''gwu''', '''gwsetup''': the specific program executing some task. each program ahs specific control parameters
 +
:
 +
* '''Pages/page''': a HTML page returned by GeneWeb and displayed by your browser
 +
* '''Form/formulaire''': a page specialized in data capture
 +
* '''Zone/zone''': a form may be divided into several zones (father, mither, child, ...)
 +
* '''Field/champ''': a one line ou multi-line area where typing is possible
 +
* '''Tick-mark/case à cocher''': a field with yes/no meaning
 +
* '''Radio-button/bouton-radio''': a set of tick-marks with only one active at a time
 +
* '''Pull-down menu/menu déroulant''': a multiple choice menu
 +
* '''Buttons/boutons''': a clickable area with a label trigering some action
 +
 +
== Early description of folders ==
 +
 +
Once installed on your computer or server, GeneWeb files are organized into two main folders:
 +
* {{c|bases}} where the data specific to your base is stored
 +
* {{c|gw}} where the various executable programs of GeneWeb are located
 +
 +
Experts may organize these folders in several ways, some of which being discussed in the documentation
 +
The basic installation of GeneWeb organises these two folders next to each other under a main folder typically called {{c|geneweb}} which can itself be located at the place of your liking on your machine
 +
In the remainder of the documentation, we will refer to these two folders as '''{{c|bases}}''' and '''{{c|gw}}''' independently of their exact location on your machine. For instance, if you have installed {{c|geneweb}} under {{c|/Users/Myname/Genealogy/geneweb}}
 +
then
 +
bases
 +
will in fact designate
 +
  /Users/Myname/Genealogy/geneweb/bases
 +
will
 +
 +
== Filename extensions ==
 +
 +
In the documentation, filename extensions will always include a "." as in {{c|.gw}} or {{c|.gwf}}

Revision as of 07:44, 31 October 2015

Some themes to introduce and discuss and unstructured questions

  • define more clearly the notions of page, form, zone, data capture field, tick-marks, buttons, radio buttons, pull-down menus ...
  • explain that the pages/forms/zones are built from template files, and are "programmables"
To that extent, all templates do not adhere to the same hierarchy of pages/forms/sequences.
Identify the basic template to be discussed and adhere to its hierarchy
  • Prepare sub-sections for experts
  • talk about places, occupations, sources dictionaries and their use
  • Talk, and/or discuss in CHANGES.txt the big new features appearing in version 7
  • Introduce very early the bases and gw folders and explain that most, if not all files will be prefixed by one or the other
Similar discussion about bd, hd, ..--and the likes
  • get gwd and gwserver to follow more similar rules (both should use the same -bd argument !!)
  • so far so good!!

23:42, 30 October 2015 (CET)

Terminology

When discussing GeneWeb, we will use across the documentation the following terms:

  • GeneWeb: the service as a whole
  • gwd, gwc, gwu, gwsetup: the specific program executing some task. each program ahs specific control parameters
  • Pages/page: a HTML page returned by GeneWeb and displayed by your browser
  • Form/formulaire: a page specialized in data capture
  • Zone/zone: a form may be divided into several zones (father, mither, child, ...)
  • Field/champ: a one line ou multi-line area where typing is possible
  • Tick-mark/case à cocher: a field with yes/no meaning
  • Radio-button/bouton-radio: a set of tick-marks with only one active at a time
  • Pull-down menu/menu déroulant: a multiple choice menu
  • Buttons/boutons: a clickable area with a label trigering some action

Early description of folders

Once installed on your computer or server, GeneWeb files are organized into two main folders:

  • bases where the data specific to your base is stored
  • gw where the various executable programs of GeneWeb are located

Experts may organize these folders in several ways, some of which being discussed in the documentation The basic installation of GeneWeb organises these two folders next to each other under a main folder typically called geneweb which can itself be located at the place of your liking on your machine In the remainder of the documentation, we will refer to these two folders as bases and gw independently of their exact location on your machine. For instance, if you have installed geneweb under /Users/Myname/Genealogy/geneweb then

bases

will in fact designate

 /Users/Myname/Genealogy/geneweb/bases

will

Filename extensions

In the documentation, filename extensions will always include a "." as in .gw or .gwf