Difference between revisions of "bases"

From GeneWeb
Jump to: navigation, search
m
(split distrib and bases folders)
 
(91 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Geneweb bases folder}}
 
{{DISPLAYTITLE:Geneweb bases folder}}
{{languages|Bases folder}}
+
{{languages|bases}}
  
 +
<!-- [[File:Folder-Bases.png|thumb|500px|right|Folder structure for GeneWeb bases (Genealogy data).]] -->
 +
The '''bases folder''' is by default a subfolder of the [[distribution|GeneWeb distribution]] named {{c|bases}}, or may be a separate isolated folder anywhere in your machine. It contains all your personal data: the genealogical databases themselves with their notes, images, authentification files, template personalisation, etc. It can be moved or renamed according to your preferences (a launch parameter of [[gwd]] will specify where the bases are located). <!-- HS : Similarly, the choice of names for your bases and {{c|.auth}} files is unconstrained.-->
  
A typical installation will position the folder holding one or several of your genealogy bases at the root of your hosting service.
+
In each of its {{c|etc}}, {{c|images}}, {{c|lang}} and {{c|src}} folders, subfolders carrying the name of the base {{c|mybase}} hold the specific data for each base.
 +
<!-- (Note that the picture on the right has been taken off a personal computer where the bases are stored in a folder names {{c|GeneWeb-Bases}}, as opposed to {{c|bases}} in the remote server structure proposed here). -->
  
<!-- [[File:Folder-Bases.png|thumb|500px|right|Folder structure for GeneWeb bases (Genealogy data).]] -->
+
{{arbre début}}
The {{c|bases}} folder should contain the same information structure as in the case of installation on a personal computer. Its location is, by default, within the [[distribution]] folder with the name {{c|bases}}, but it can be located elsewhere and named otherwise according to your preferences.  
+
* {{d}} [[distribution]]: details all the other files and subfolders out of {{c|bases}} folder, like the programs or template files.
 +
** {{d}} gw
 +
** {{branche finale}}[…] gwd/gwsetup launch scripts, README, etc.
 +
* {{d}} bases: The folder containing the GeneWeb databases
 +
** {{d}} mybase.gwb: folder of the genealogical database called {{c|mybase}}
 +
***{{f}} A set of binary files holding the base data (base, *.acc, cache_visited, *.dat, *.inx, nb_persons, notes_links, synchro_patches, tstab)
 +
***{{f}} forum; a text file containing the forum
 +
***{{f}} history; a text file containing the history of modifications
 +
***{{d}} history_d: folder containing history diffs
 +
***{{f}} notes; a text file containing the main note of the base (m=NOTES)
 +
***{{d}} notes_d: folder containing notes (m=NOTES;f=file)
 +
***{{f}} particles.txt: a text file containing particles (must contain the whole set)
 +
***{{branche finale}}{{d}} wiznotes: folder containing wizard notes
 +
** {{f}} mybase.gwf: associated [[configuration|.gwf configuration/parameters file]]
 +
** {{f}} mybase-f.auth example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}})
 +
** {{f}} mybase-w.auth example of password file for wizards ({{c|1=wizard_passwd_file=}})
 +
** {{d}} mybase2.gwb: folder of a second genealogical database {{c|mybase2}}
 +
** {{f}} mybase2.gwf/auth configuration files associated to mybase2, etc.
 +
***{{f}} tags.txt list of authorized tags. Supplied to gwd with -allowed_tags (full path name)
 +
** {{d}} cnt: holding the robot file, locks, and memorising the access counts for each base
 +
*** {{f}} actlog: file temporary storing the tokens needed for login in CGI mode
 +
*** {{f}} [[access#Robots management|robot]] list IP address of robots
 +
*** {{f}} mybase.txt access counts for mybase
 +
*** {{branche finale}}{{f}} mybase.lck lock file for mybase
 +
** {{d}} etc: used in priority over the generic {{c|gw/etc}} files (see [[templates]])
 +
*** {{d}} mybase: template folders for mybase
 +
**** {{d}} modules
 +
***** {{branche finale}}{{f}} module_xx.txt
 +
**** {{f}} header.txt base specific header file
 +
**** {{branche finale}}{{f}} trl.txt base specific trailer file
 +
*** {{branche finale}}{{d}} mybase2: idem
 +
** {{d}} images
 +
*** {{d}} mybase: portraits images for mybase
 +
**** {{f}} first_name.occurence.last_name.jpg
 +
**** {{branche finale}}{{f}} other_first_name.occurence.last_name.jpg
 +
*** {{branche finale}}{{d}} mybase2: idem
 +
** {{d}} lang: containing some base specific language related template text files
 +
*** {{f}} lex_utf8.txt lexicon file
 +
*** {{f}} ''lex_additionnal.txt'' additionnal lexicon file used by gwd with -add_lexicon (must be here)
 +
*** {{d}} mybase
 +
*** {{branche finale}}{{d}} mybase2
 +
** {{branche finale}}{{d}} src
 +
*** {{d}} mybase
 +
**** {{d}} images: images called with {{c|1=m=IMH}}
 +
***** {{branche finale}}{{f}} ''myimage.jpg''
 +
**** {{branche finale}}{{f}} ''file1.txt'': text file called with {{c|1=m=SRC}}
 +
*** {{branche finale}}{{d}} ''mybase2'': idem
 +
{{arbre fin}}
  
In each of the {{c|etc}}, {{c|images}}, {{c|lang}} and {{c|src}} folders, sub-folders with names {{c|base-i}} hold the specific data for each base.
+
'''Translations''': All text files read through the m=SRC&v=file or m=DOC&s=file.txt commands are processed by GeneWeb which performs translations ({{c|[text to be translated]}}) and expands some macros ({{c|%s,}} {{c|%v}}, {{c|%i}}, {{c|%k}} see [http://geneweb.tuxfamily.org/wiki/macros|macros]). In addition, a more global translation of the text file can be obtained by appending {{c|_lg}} to the filename (where lg is the 2 letter acronym of a given language) which selects an entirely new file, specific to the selected language.
  
<!-- (Note that the picture on the right has been taken off a personnal computer where the bases are stored in a folder names {{c|GeneWeb-Bases}}, as opposed to {{c|bases}} in the remote server structure proposed here). -->
+
'''Files names''' in ''italic'' are user chosen. ''tags.txt'' is provided with its full path.
 +
 
 +
'''Note''' that with this configuration, all personalization happens in files stored in the base folder. A new release of GeneWeb may be installed safely by copying the new {{c|gw}} folder and possibly new copies of gwd/gwsetup launch scripts, CHANGES.txt, README, etc (the last two lines of the tree above).
 +
 
 +
<!--
 +
== Bases folder in GeneWeb 7 ==
 +
{{mbox|niveau=grave|titre=
 +
|texte=This section of the documentation is not yet fully implemented. The current version of GeneWeb v7 adheres to the old folder structure.}}
 +
 
 +
GeneWeb 7 simplifies the archival of databases regrouping all the files needed for a single database under the same folder. With this configuration, it becomes far simpler to use archival tools such as {{c|tar}}, {{c|zip}} or {{c|rar}} to store a single database folder in an archive (see [[save]] for details and comments).
  
 
{{arbre début}}
 
{{arbre début}}
*
+
* {{d}} [[distribution]]
** {{branche finale}}{{d}} bases: The folder containing the GeneWeb bases.
+
** {{d}} gw
*** {{d}} base-1.gwb : one or several '''base-i.gwb''' folders.
+
** {{branche finale}}{{f}}… gwd/gwsetup launch scripts, CHANGES.txt, README, etc.
*** {{f}} base-1.gwf : and their associated .gwf parameter file
+
* {{d}} bases: The folder containing the GeneWeb databases
*** {{d}} base-2.gwb
+
** {{d}} mybase.gwb: folder of the genealogical database called {{c|mybase}}
*** {{f}} base-2.gwf
+
*** {{d}} documents: image/txt/pdf/html files, subdirectories allowed (except portraits/ and images/)
*** {{d}} cnt  : memorizing the access count for the bases
+
**** {{d}} portraits: portraits images called with {{c|1=m=IM&i=index}} (no sub-dirs here!)
*** {{d}} etc : used in priority over the generic {{c|gw/etc}} files (see [[header]])
+
***** {{f}} first_name.occurence.last_name.jpg
**** {{d}} base-1  : template folders for base-1
+
***** {{f}} other_first_name.occurence.last_name.jpg
***** {{d}} perso_module
+
***** {{branche finale}}{{d}} saved: saved portraits called with {{c|1=m=IMS&i=index}}
****** {{branche finale}}{{f}} module_xx.txt
+
**** {{d}} images: other images associated with a person shown in a carrousel
***** {{branche finale}}{{f}} trl.txt
+
***** {{d}} first_name.occurence.last_name: other images associated with a person (no sub_dirs)
**** {{branche finale}}{{d}} base-2  : idem
+
****** {{f}} ''otherimage.jpg'': images called with {{c|1=m=IM&i=index&s=otherimage.jpg}}
*** {{d}} images
+
****** {{f}} ''otherimage.txt'': comment associated with otherimage
**** {{d}} base-1  : portraits images for base-1
+
****** {{branche finale}}{{d}} saved: saved images and comments called with {{c|1=m=IMS&i=index&s=otherimage.jpg}}
***** {{f}} first_name_1.occurence.last_name.jpg
+
**** {{d}} ''subfolder'': the documents folder may contain subfolders
***** {{branche finale}}{{f}} first_name-2.occurence.last_name.jpg
+
**** {{f}} ''myimage.jpg'': images called with {{c|1=m=DOC&s=myimage.jpg}} or {{c|1=m=IM&s=myimage.jpg}}
**** {{branche finale}}{{d}} base-2  : idem
+
**** {{f}} ''mytext.txt'': text files called with {{c|1=m=DOC&s=mytext.txt}} or {{c|1=m=SRC&v=mytext}} (See translation note below)
*** {{d}} lang  : containing some base specific language related template text files (lexicon for instance).
+
**** {{f}} ''mydoc.pdf'': PDF files called with {{c|1=m=DOC&s=mydoc.pdf}}
*** {{d}} src
+
**** {{branche finale}}{{f}} ''mypage.html'': HTML pages called with {{c|1=m=DOC&s=mypage.html}}
**** {{d}} base-1
+
*** {{d}} etc: configurations files and personnalized variants of template files, used in priority over the generic {{c|gw/etc}} files (see [[templates]])
***** {{d}} images : images called with m=IMH
+
**** {{d}} cnt: holding access counts for the base and several access logs
****** {{branche finale}}{{f}} image-1.jpg
+
***** {{f}} counts.txt: access counts
***** {{branche finale}}{{f}} file-1.txt : text file called with m=SRC
+
***** {{f}} counts.lck: access lock
**** {{branche finale}}{{d}} base-2  : idem
+
***** {{f}} wizards.log access logs for wizards
*** {{branche finale}}{{f}} wiz.auth  : as many wizards and friends authorization files as specified for each base in their respective .gwf parameter file.
+
***** {{f}} friends.log access logs for friends
 +
***** {{branche finale}}{{f}} update.log modifications logs
 +
**** {{f}} comm.log: result of a gwsetup command on this base
 +
**** {{d}} lang: local complements to the language lexicon (loaded with {{c|-add_lexicon}} at [[gwd]] start)
 +
**** {{d}} modules: personnalized variants of modules files
 +
***** {{branche finale}}{{f}} module_xx.txt
 +
**** {{d}} templatex: personnal variant of templatex files
 +
**** {{f}} config.txt: [[configuration|configuration/parameters file]] (old {{c|mybase.gwf}})
 +
**** {{f}} ''mybase-f.auth'': example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}} in {{c|config.txt}})
 +
**** {{f}} ''mybase-w.auth'': example of password file for wizards ({{c|1=wizard_passwd_file=}} in {{c|config.txt}})
 +
**** {{f}} particles.txt (mybase-particles.txt?): particles list for this base.
 +
**** {{branche finale}}{{f}} hed.txt and trl.txt: base specific header/trailer files
 +
*** {{d}} history: folder with all diff files (this folder may be located elsewhere according to {{c|1=history_path=}} in {{c|config.txt}})
 +
**** {{d}} a
 +
**** {{d}} b
 +
**** {{d}}
 +
**** {{branche finale}}{{f}} history.txt: history of modifications
 +
*** {{d}} notes: folder with all the notes and [[wikitext#Internal_links|linked pages]]
 +
**** {{f}} notes.txt: (reserved name) main notes for the base, displayed in the welcome page
 +
**** {{branche finale}}{{f}} ''linked_page.txt'': other "linked_page" obtained with <nowiki>[[[linked_page/text]]]</nowiki>
 +
*** {{branche finale}}{{f}}base, base.acc, cache_info […] names.inx, notes_links, patches (all internal files and folders of the database)
 +
** {{d}} mybase2.gwb: folder of a second genealogical database {{c|mybase2}}
 +
*** {{branche finale}}[…] the organisation is the same for each database see description for mybase.gwb folder above
 +
** {{d}} cnt: admin files
 +
*** {{f}} actlog: file temporary storing the tokens needed for login in CGI mode
 +
*** {{f}} gwd.lck: lock file
 +
*** {{branche finale}}{{f}} [[access#Robots management|robot]]: list IP addresses of detected robots
 +
** {{f}} comm.log: execution log of the last base creation with a {{c|gwc}} command (when the base name is not available)
 +
** {{branche finale}}{{f}} ''tags.txt'': alternate list of [[tags|authorized HTML tags]] (loaded with {{c|-allowed_tags}} at [[gwd]] start)
  
 
{{arbre fin}}
 
{{arbre fin}}
 +
 +
-->

Latest revision as of 17:01, 9 November 2020

150px-Geographylogo svg.png Language: English

The bases folder is by default a subfolder of the GeneWeb distribution named bases, or may be a separate isolated folder anywhere in your machine. It contains all your personal data: the genealogical databases themselves with their notes, images, authentification files, template personalisation, etc. It can be moved or renamed according to your preferences (a launch parameter of gwd will specify where the bases are located).

In each of its etc, images, lang and src folders, subfolders carrying the name of the base mybase hold the specific data for each base.

  • directory distribution: details all the other files and subfolders out of bases folder, like the programs or template files.
    • directory gw
    • […] gwd/gwsetup launch scripts, README, etc.
  • directory bases: The folder containing the GeneWeb databases
    • directory mybase.gwb: folder of the genealogical database called mybase
      • file A set of binary files holding the base data (base, *.acc, cache_visited, *.dat, *.inx, nb_persons, notes_links, synchro_patches, tstab)
      • file forum; a text file containing the forum
      • file history; a text file containing the history of modifications
      • directory history_d: folder containing history diffs
      • file notes; a text file containing the main note of the base (m=NOTES)
      • directory notes_d: folder containing notes (m=NOTES;f=file)
      • file particles.txt: a text file containing particles (must contain the whole set)
      • directory wiznotes: folder containing wizard notes
    • file mybase.gwf: associated .gwf configuration/parameters file
    • file mybase-f.auth example of password file for friends (friend_passwd_file=)
    • file mybase-w.auth example of password file for wizards (wizard_passwd_file=)
    • directory mybase2.gwb: folder of a second genealogical database mybase2
    • file mybase2.gwf/auth configuration files associated to mybase2, etc.
      • file tags.txt list of authorized tags. Supplied to gwd with -allowed_tags (full path name)
    • directory cnt: holding the robot file, locks, and memorising the access counts for each base
      • file actlog: file temporary storing the tokens needed for login in CGI mode
      • file robot list IP address of robots
      • file mybase.txt access counts for mybase
      • file mybase.lck lock file for mybase
    • directory etc: used in priority over the generic gw/etc files (see templates)
      • directory mybase: template folders for mybase
        • directory modules
          • file module_xx.txt
        • file header.txt base specific header file
        • file trl.txt base specific trailer file
      • directory mybase2: idem
    • directory images
      • directory mybase: portraits images for mybase
        • file first_name.occurence.last_name.jpg
        • file other_first_name.occurence.last_name.jpg
      • directory mybase2: idem
    • directory lang: containing some base specific language related template text files
      • file lex_utf8.txt lexicon file
      • file lex_additionnal.txt additionnal lexicon file used by gwd with -add_lexicon (must be here)
      • directory mybase
      • directory mybase2
    • directory src
      • directory mybase
        • directory images: images called with m=IMH
          • file myimage.jpg
        • file file1.txt: text file called with m=SRC
      • directory mybase2: idem

Translations: All text files read through the m=SRC&v=file or m=DOC&s=file.txt commands are processed by GeneWeb which performs translations ([text to be translated]) and expands some macros (%s, %v, %i, %k see [1]). In addition, a more global translation of the text file can be obtained by appending _lg to the filename (where lg is the 2 letter acronym of a given language) which selects an entirely new file, specific to the selected language.

Files names in italic are user chosen. tags.txt is provided with its full path.

Note that with this configuration, all personalization happens in files stored in the base folder. A new release of GeneWeb may be installed safely by copying the new gw folder and possibly new copies of gwd/gwsetup launch scripts, CHANGES.txt, README, etc (the last two lines of the tree above).