Difference between revisions of "bases"

From GeneWeb
Jump to: navigation, search
(link to distribution)
m (heavily simplify intro, the link distribution is nearly self sufficient)
Line 3: Line 3:
  
 
<!-- [[File:Folder-Bases.png|thumb|500px|right|Folder structure for GeneWeb bases (Genealogy data).]] -->
 
<!-- [[File:Folder-Bases.png|thumb|500px|right|Folder structure for GeneWeb bases (Genealogy data).]] -->
−
The folder of the databases should contain the same information structure as in the case of an 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. Similarly, the choice of names for your bases and {{c|.auth}} files is unconstrained.
+
The '''bases folder''' is by default a subfolder of the [[distribution|GeneWeb distribution]] named {{c|bases}} that contains all your personnal data: the genealogical databases themselves with their notes, images, authentification files, template personalisation, etc. It can be moved or renamed according to your preferences.<!-- HS : Similarly, the choice of names for your bases and {{c|.auth}} files is unconstrained.-->
  
−
In each of the {{c|etc}}, {{c|images}}, {{c|lang}} and {{c|src}} folders, sub-folders carrying the name of the base {{c|mybase.gwb}} hold the specific data for each base.
+
In each of its {{c|etc}}, {{c|images}}, {{c|lang}} and {{c|src}} folders, subfolders carrying the name of the base {{c|mybase.gwb}} 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). -->
 
<!-- (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). -->
  
 
{{arbre début}}
 
{{arbre début}}
−
* {{d}} [[distribution]] (only {{c|bases/}} is described here, details the description of the program folder {{c|gw/}} are found in the [[distribution]] section)
+
* {{d}} [[distribution]]: details all the other files and subfolders out of {{c|bases}} folder, like the programs or template files.
 
** {{d}} bases: The folder containing the GeneWeb databases
 
** {{d}} bases: The folder containing the GeneWeb databases
 
*** {{d}} mybase.gwb: folder of the genealogical database called {{c|mybase}}
 
*** {{d}} mybase.gwb: folder of the genealogical database called {{c|mybase}}
Line 54: Line 54:
  
 
{{arbre début}}
 
{{arbre début}}
−
* {{d}} [[distribution]] (only {{c|bases/}} is described here, details the description of the program folder {{c|gw/}} are found in the [[distribution]] section)
+
* {{d}} [[distribution]]
 
** {{d}} bases: The folder containing the GeneWeb databases
 
** {{d}} bases: The folder containing the GeneWeb databases
 
*** {{f}} comm.log: execution log of the last base creation with a {{c|gwc}} command
 
*** {{f}} comm.log: execution log of the last base creation with a {{c|gwc}} command

Revision as of 18:17, 11 November 2018

150px-Geographylogo svg.png Language: English

The bases folder is by default a subfolder of the GeneWeb distribution named bases that contains all your personnal data: the genealogical databases themselves with their notes, images, authentification files, template personalisation, etc. It can be moved or renamed according to your preferences.

In each of its etc, images, lang and src folders, subfolders carrying the name of the base mybase.gwb 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 bases: The folder containing the GeneWeb databases
      • directory mybase.gwb: folder of the genealogical database called mybase
      • 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.
      • 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 perso_module
            • 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 (lexicon for instance)
        • 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
    • directory gw
    • […] gwd/gwsetup launch scripts, README, etc.

Bases folder in GeneWeb 7
This section of the documentation is not yet 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 tar, zip or rar to store a single database folder in an archive (see save for details and comments).

  • directory distribution
    • directory bases: The folder containing the GeneWeb databases
      • file comm.log: execution log of the last base creation with a gwc command
      • file perso_lexicon.txt: UTF-8 personnal complementary lexicon (loaded with -add_lexicon at gwd start)
      • file tags.txt: alternate list of authorized HTML tags (loaded with -allowed_tags at gwd start)
      • directory mybase.gwb: folder of the genealogical database called mybase
        • file params.gwf: associated .gwf configuration/parameters file
        • file mybase-f.auth: example of password file for friends (friend_passwd_file= in params.gwf)
        • file mybase-w.auth: example of password file for wizards (wizard_passwd_file= in params.gwf)
        • file counts.txt: access counts
        • file history: history of modifications
        • file particles.txt: particles list for this base.
        • directory documents: image/txt/pdf/html files, subdirs allowed
          • file mytext.txt: text files called with m=TXT or m=SRC
          • file mydoc.pdf: PDF files called with m=PDF
          • file mypage.html: HTML pages called with m=HTM
          • file myimage.jpg: images called with m=IMG or m=IMH (m=IM kept for backward compatibility)
        • directory etc: personnalized variants of template files, used in priority over the generic gw/etc files (see templates)
          • directory perso_module: personnalized variants of perso_modules files
            • file module_xx.txt
          • directory templatex: personnal variant of templatex files
          • file hed.txt: base specific header file
          • file trl.txt: base specific trailer file
        • directory history_d: folder with all diff files (this folder may be located elsewhere according to history_path= in params.gwf)
        • directory portraits: portraits images
          • file first_name.occurence.last_name.jpg
          • file other_first_name.occurence.last_name.jpg
        • […] base, base.acc, cache_info […] names.inx, notes_links, patches (internal files and folders of the database)
      • directory mybase2.gwb: folder of a second genealogical database mybase2
        • […] the organisation is the same for each database see description for mybase.gwb folder above
      • 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 mybase.lck: lock file for mybase
        • file robot: list IP addresses of detected robots
    • directory gw
    • […] gwd/gwsetup launch scripts, CHANGES.txt, README, etc.

Note that with this configuration, all personnalization 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).

Retrieved from "https://geneweb.tuxfamily.org/w/index.php?title=bases&oldid=3441"