Difference between revisions of "bases"

From GeneWeb
Jump to navigation Jump to search
(Sub-folders are mybase rather than mybase.gwb!)
m (→‎Bases folder in GeneWeb 7: rereorg, files after directories ; new suggestions in parenthesis for a constant .txt extension on config. files)
Line 56: Line 56:
 
* {{d}} [[distribution]]
 
* {{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}} perso_lexicon.txt: UTF-8 personnal complementary lexicon (loaded with {{c|-add_lexicon}} at [[gwd]] start)
 
−
*** {{f}} tags.txt: alternate list of [[tags|authorized HTML tags]] (loaded with {{c|-allowed_tags}} 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]]
+
**** {{d}} documents: image/txt/pdf/html files, subdirectories allowed <!--except portraits?-->
−
**** {{f}} mybase-f.auth: example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}} in {{c|params.gwf}})
+
***** {{d}} portraits: portraits images
−
**** {{f}} mybase-w.auth: example of password file for wizards ({{c|1=wizard_passwd_file=}} in {{c|params.gwf}})
+
****** {{f}} first_name.occurence.last_name.jpg
−
**** {{f}} counts.txt: access counts
+
****** {{branche finale}}{{f}} other_first_name.occurence.last_name.jpg
−
**** {{f}} history: history of modifications
+
***** {{f}} myimage.jpg: images called with {{c|1=m=IMG}} or {{c|1=m=IMH}} ({{c|1=m=IM}} kept for backward compatibility)
−
**** {{f}} particles.txt: particles list for this base.
 
−
**** {{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}}
+
***** {{branche finale}}{{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)
+
**** {{d}} etc: configurations files and personnalized 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: personnalized variants of perso_modules files
 
***** {{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}} mybase.conf (mybase-config.txt?): [[configuration|configuration/parameters file]] (old {{c|.gwf}})
−
***** {{branche finale}}{{f}} trl.txt: base specific trailer file
+
***** {{f}} mybase.count (mybase-counts.txt?): access counts
−
**** {{d}} history_d: folder with all diff files (this folder may be located elsewhere according to {{c|1=history_path=}} in {{c|params.gwf}})
+
***** {{f}} mybase-f.auth (mybase-friend-auth.txt?): example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}} in {{c|mybase.conf}})
−
**** {{d}} portraits: portraits images
+
***** {{f}} mybase-w.auth (mybase-wizard-auth.txt?): example of password file for wizards ({{c|1=wizard_passwd_file=}} in {{c|mybase.conf}})
−
***** {{f}} first_name.occurence.last_name.jpg
+
***** {{f}} particles.txt (mybase-particles.txt?): particles list for this base.
−
***** {{branche finale}}{{f}} other_first_name.occurence.last_name.jpg
+
***** {{branche finale}}{{f}} hed.txt and trl.txt: base specific header/trailer files
−
**** {{branche finale}}[…] base, base.acc, cache_info […] names.inx, notes_links, patches (internal files and folders of the database)
+
**** {{d}} history_d: folder with all diff files (this folder may be located elsewhere according to {{c|1=history_path=}} in {{c|mybase.conf}})
 +
***** {{d}} a
 +
***** {{d}} b
 +
***** {{d}} …
 +
***** {{branche finale}}{{f}} history(.txt?): history of modifications
 +
**** {{d}} notes_d: folder with all the notes
 +
***** {{branche finale}}{{f}} notes(.txt?): summary/index of all the notes
 +
**** {{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}}
 
*** {{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
 
**** {{branche finale}}[…] the organisation is the same for each database see description for mybase.gwb folder above
−
*** {{branche finale}}{{d}} cnt: holding the robot file, locks, and memorising the access counts for each base
+
*** {{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}} actlog: file temporary storing the tokens needed for login in CGI mode
 
**** {{f}} mybase.lck: lock file for mybase
 
**** {{f}} mybase.lck: lock file for mybase
 
**** {{branche finale}}{{f}} [[access#Robots management|robot]]: list IP addresses of detected robots
 
**** {{branche finale}}{{f}} [[access#Robots management|robot]]: list IP addresses of detected robots
 +
*** {{f}} comm.log (log.txt?): 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}} at [[gwd]] start)
 +
*** {{branche finale}}{{f}} tags.txt: alternate list of [[tags|authorized HTML tags]] (loaded with {{c|-allowed_tags}} at [[gwd]] start)
 
** {{d}} gw
 
** {{d}} gw
−
** {{branche finale}}[…] gwd/gwsetup launch scripts, CHANGES.txt, README, etc.
+
** {{branche finale}}{{f}}… gwd/gwsetup launch scripts, CHANGES.txt, README, etc.
 
{{arbre fin}}
 
{{arbre fin}}
  
 
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 {{c|gw}} folder and possibly new copies of gwd/gwsetup launch scripts, CHANGES.txt, README, etc (the last two lines of the tree above).
 
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 {{c|gw}} folder and possibly new copies of gwd/gwsetup launch scripts, CHANGES.txt, README, etc (the last two lines of the tree above).

Revision as of 02:52, 12 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 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
      • directory mybase.gwb: folder of the genealogical database called mybase
        • directory documents: image/txt/pdf/html files, subdirectories allowed
          • directory portraits: portraits images
            • file first_name.occurence.last_name.jpg
            • file other_first_name.occurence.last_name.jpg
          • file myimage.jpg: images called with m=IMG or m=IMH (m=IM kept for backward compatibility)
          • 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
        • directory etc: configurations files and 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 mybase.conf (mybase-config.txt?): configuration/parameters file (old .gwf)
          • file mybase.count (mybase-counts.txt?): access counts
          • file mybase-f.auth (mybase-friend-auth.txt?): example of password file for friends (friend_passwd_file= in mybase.conf)
          • file mybase-w.auth (mybase-wizard-auth.txt?): example of password file for wizards (wizard_passwd_file= in mybase.conf)
          • file particles.txt (mybase-particles.txt?): particles list for this base.
          • file hed.txt and trl.txt: base specific header/trailer files
        • directory history_d: folder with all diff files (this folder may be located elsewhere according to history_path= in mybase.conf)
          • directory a
          • directory b
          • directory …
          • file history(.txt?): history of modifications
        • directory notes_d: folder with all the notes
          • file notes(.txt?): summary/index of all the notes
        • file… base, base.acc, cache_info […] names.inx, notes_links, patches (all 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
      • file comm.log (log.txt?): 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 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).

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