Difference between revisions of "bases"

From GeneWeb
Jump to: navigation, search
m ( Bases folder in GeneWeb 7)
m ( Bases folder in GeneWeb 7)
Line 53: Line 53:
 
* {{d}} [[distribution]] (details the description of the program folder {{c|gw/}}, only {{c|bases/}} is described here)
 
* {{d}} [[distribution]] (details the description of the program folder {{c|gw/}}, only {{c|bases/}} is described here)
 
** {{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).
 
*** {{f}} perso_lexicon.txt: UTF-8 personnal complementary lexicon loaded with {{c|-add_lexicon path/perso_lexicon.txt}} at gwd start.
 
*** {{f}} perso_lexicon.txt: UTF-8 personnal complementary lexicon loaded with {{c|-add_lexicon path/perso_lexicon.txt}} at gwd start.
 
*** {{f}} tags.txt: alternate list of [[tags|authorized HTML tags]] loaded with {{c|-allowed_tags path/tags.txt}} at gwd start
 
*** {{f}} tags.txt: alternate list of [[tags|authorized HTML tags]] loaded with {{c|-allowed_tags path/tags.txt}} at gwd start
 
*** {{d}} mybase.gwb: folder of the genealogical database called {{c|mybase}}
 
*** {{d}} mybase.gwb: folder of the genealogical database called {{c|mybase}}
 
**** {{f}} params.gwf: associated [[configuration|.gwf configuration/parameters file]]
 
**** {{f}} params.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-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=}})
+
**** {{f}} mybase-w.auth: example of password file for wizards ({{c|1=wizard_passwd_file=}})
 
**** {{f}} history: history of modifications
 
**** {{f}} history: history of modifications
 
**** {{f}} particles.txt: particles list for this base.
 
**** {{f}} particles.txt: particles list for this base.
 
**** {{d}} documents: image/txt/pdf/html files, subdirs allowed
 
**** {{d}} documents: image/txt/pdf/html files, subdirs allowed
***** {{f}} mytext.txt text files called with {{c|1=m=TXT}} or {{c|1=m=SRC}}  
+
***** {{f}} mytext.txt: text files called with {{c|1=m=TXT}} or {{c|1=m=SRC}}  
***** {{f}} mydoc.pdf PDF files called with {{c|1=m=PDF}}
+
***** {{f}} mydoc.pdf: PDF files called with {{c|1=m=PDF}}
***** {{f}} mypage.html HTML pages called with {{c|1=m=HTM}}
+
***** {{f}} mypage.html: HTML pages called with {{c|1=m=HTM}}
***** {{branche finale}}{{f}} myimage.jpg images called with {{c|1=m=IMG}} or {{c|1=m=IMH}})({{c|1=m=IM}} kept for backward compatibility).
+
***** {{branche finale}}{{f}} myimage.jpg: images called with {{c|1=m=IMG}} or {{c|1=m=IMH}})({{c|1=m=IM}} kept for backward compatibility).
**** {{d}} etc: personnal variants of template files, used in priority over the generic {{c|gw/etc}} files (see [[templates]])
+
**** {{d}} etc: personnalized variants of template files, used in priority over the generic {{c|gw/etc}} files (see [[templates]])
***** {{d}} perso_module
+
***** {{d}} perso_module: personnalized variants of perso_modules files
 
****** {{branche finale}}{{f}} module_xx.txt
 
****** {{branche finale}}{{f}} module_xx.txt
***** {{d}} templatex personnal variant of templatex files
+
***** {{d}} templatex: personnal variant of templatex files
***** {{f}} hed.txt base specific header file  
+
***** {{f}} hed.txt: base specific header file  
***** {{branche finale}}{{f}} trl.txt base specific trailer file
+
***** {{branche finale}}{{f}} trl.txt: base specific trailer file
 
**** {{d}} history_d: folder with all diff files (this folder may be located elsewhere according to {{c|1=history_path=}} in {{c|params.gwf}}).
 
**** {{d}} history_d: folder with all diff files (this folder may be located elsewhere according to {{c|1=history_path=}} in {{c|params.gwf}}).
 
**** {{d}} portraits: portraits images
 
**** {{d}} portraits: portraits images

Revision as of 14:24, 10 February 2017

150px-Geographylogo svg.png Language: English

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 /bases, but it can be located elsewhere and named otherwise according to your preferences. Similarly, the choice of names for your bases and .auth files is unconstrained.

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

  • directory distribution (details the description of the program folder gw/, only bases/ is described here)
    • 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 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
    • file gwd/gwsetup launch scripts, README, etc.

 Bases folder in GeneWeb 7

GeneWeb 7 simplify the archival of databases sorting all files needed for a single database under the same folder.

  • directory distribution (details the description of the program folder gw/, only bases/ is described here)
    • 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 path/perso_lexicon.txt at gwd start.
      • file tags.txt: alternate list of authorized HTML tags loaded with -allowed_tags path/tags.txt 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=)
        • file mybase-w.auth: example of password file for wizards (wizard_passwd_file=)
        • 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 necessary for the normal operation of GeneWeb).
      • 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 mybase.txt: access counts for mybase.
        • file mybase.lck: lock file for mybase.
        • file robot: list IP addresses of detected robots
    • directory gw
    • file 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).