Difference between revisions of "bases"

From GeneWeb
Jump to: navigation, search
m ( Bases folder in GeneWeb 7)
m (Bases folder in GeneWeb 7)
 
(37 intermediate revisions by 2 users not shown)
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}} 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]] (details the description of the program folder {{c|gw/}}, only {{c|bases/}} is described here)
+
* {{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 18: Line 18:
 
*** {{f}} mybase2.gwf/auth configuration files associated to mybase2, etc.
 
*** {{f}} mybase2.gwf/auth configuration files associated to mybase2, etc.
 
*** {{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
+
**** {{f}} actlog: file temporary storing the tokens needed for login in CGI mode
 
**** {{f}} [[access#Robots management|robot]] list IP address of robots
 
**** {{f}} [[access#Robots management|robot]] list IP address of robots
 
**** {{f}} mybase.txt access counts for mybase  
 
**** {{f}} mybase.txt access counts for mybase  
Line 24: Line 24:
 
*** {{d}} etc: used in priority over the generic {{c|gw/etc}} files (see [[templates]])
 
*** {{d}} etc: used in priority over the generic {{c|gw/etc}} files (see [[templates]])
 
**** {{d}} mybase: template folders for mybase
 
**** {{d}} mybase: template folders for mybase
***** {{d}} perso_module
+
***** {{d}} modules
 
****** {{branche finale}}{{f}} module_xx.txt
 
****** {{branche finale}}{{f}} module_xx.txt
 
***** {{f}} header.txt base specific header file  
 
***** {{f}} header.txt base specific header file  
Line 44: Line 44:
 
**** {{branche finale}}{{d}} mybase2: idem
 
**** {{branche finale}}{{d}} mybase2: idem
 
** {{d}} gw
 
** {{d}} gw
** {{f}} gwd/gwsetup launch scripts, README, etc.
+
** {{branche finale}}[…] gwd/gwsetup launch scripts, README, etc.
 
{{arbre fin}}
 
{{arbre fin}}
  
== Bases folder in GeneWeb 7 ==
+
== Bases folder in GeneWeb 7 ==
GeneWeb 7 simplify the archival of databases sorting all files needed for a single database under the same folder.
+
{{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]] (details the description of the program folder {{c|gw/}}, only {{c|bases/}} is described here)
+
* {{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 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
 
 
*** {{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/ and images/)
**** {{f}} mybase-f.auth: example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}})
+
***** {{d}} portraits: portraits images called with {{c|1=m=IM&i=index}} (no sub-dirs here!)
**** {{f}} mybase-w.auth: example of password file for wizards ({{c|1=wizard_passwd_file=}})
+
****** {{f}} first_name.occurence.last_name.jpg
**** {{f}} history: history of modifications
+
****** {{f}} other_first_name.occurence.last_name.jpg
**** {{f}} particles.txt: particles list for this base.
+
****** {{branche finale}}{{d}} saved: saved portraits called with {{c|1=m=IMS&i=index}}
**** {{d}} documents: image/txt/pdf/html files, subdirs allowed
+
***** {{d}} images: other images associated with a person shown in a carrousel
***** {{f}} mytext.txt: text files called with {{c|1=m=TXT}} or {{c|1=m=SRC}}  
+
****** {{d}} first_name.occurence.last_name: other images associated with a person (no sub_dirs)
***** {{f}} mydoc.pdf: PDF files called with {{c|1=m=PDF}}
+
******* {{f}} ''otherimage.jpg'': images called with {{c|1=m=IM&i=index&s=otherimage.jpg}}
***** {{f}} mypage.html: HTML pages called with {{c|1=m=HTM}}
+
******* {{f}} ''otherimage.txt'': comment associated with otherimage
***** {{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}}{{d}} saved: saved images and comments called with {{c|1=m=IMS&i=index&s=otherimage.jpg}}
**** {{d}} etc: personnalized variants of template files, used in priority over the generic {{c|gw/etc}} files (see [[templates]])
+
***** {{d}} ''subfolder'': the documents folder may contain subfolders
***** {{d}} perso_module: personnalized variants of perso_modules files
+
***** {{f}} ''myimage.jpg'': images called with {{c|1=m=DOC&s=myimage.jpg}} or {{c|1=m=IM&s=myimage.jpg}}
 +
***** {{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)
 +
***** {{f}} ''mydoc.pdf'': PDF files called with {{c|1=m=DOC&s=mydoc.pdf}}
 +
***** {{branche finale}}{{f}} ''mypage.html'': HTML pages called with {{c|1=m=DOC&s=mypage.html}}
 +
**** {{d}} etc: configurations files and personnalized variants of template files, used in priority over the generic {{c|gw/etc}} files (see [[templates]])
 +
***** {{d}} cnt: holding access counts for the base and several access logs
 +
****** {{f}} counts.txt: access counts
 +
****** {{f}} counts.lck: access lock
 +
****** {{f}} wizards.log access logs for wizards
 +
****** {{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
 
****** {{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}} config.txt: [[configuration|configuration/parameters file]] (old {{c|mybase.gwf}})
***** {{branche finale}}{{f}} trl.txt: base specific trailer file
+
***** {{f}} ''mybase-f.auth'': example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}} in {{c|config.txt}})
**** {{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-w.auth'': example of password file for wizards ({{c|1=wizard_passwd_file=}} in {{c|config.txt}})
**** {{d}} portraits: portraits images
+
***** {{f}} particles.txt (mybase-particles.txt?): particles list for this base.
***** {{f}} first_name.occurence.last_name.jpg
+
***** {{branche finale}}{{f}} hed.txt and trl.txt: base specific header/trailer files
***** {{branche finale}}{{f}} other_first_name.occurence.last_name.jpg
+
**** {{d}} history: folder with all diff files (this folder may be located elsewhere according to {{c|1=history_path=}} in {{c|config.txt}})
**** {{branche finale}}[] base, base.acc, cache_info, ... names.inx, notes_links, patches (internal files and folders necessary for the normal operation of GeneWeb).
+
***** {{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}}
 
*** {{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: admin files
**** {{f}} actlog:
+
**** {{f}} actlog: file temporary storing the tokens needed for login in CGI mode
**** {{f}} mybase.txt: access counts for mybase.
+
**** {{f}} gwd.lck: lock file
**** {{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: 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)
 
** {{d}} gw
 
** {{d}} gw
** {{branche finale}}{{f}} 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).
+
'''Translations''': All text files read through the m=SRC&v=file or m=DOC&s=file.txt commands are processed by GeneWeb which expands some macros ({{c|%s,}} {{c|%v}}, {{c|%i}}, {{c|%k}}) and performs translations ({{c|[text to be translated]}}). 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.
 +
 
 +
'''Files names''' in ''italic'' are user chosen. ''tags.txt'' is provided with its full path.
 +
 
 +
'''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).

Latest revision as of 22:39, 14 December 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 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 (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

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 (except portraits/ and images/)
          • directory portraits: portraits images called with m=IM&i=index (no sub-dirs here!)
            • file first_name.occurence.last_name.jpg
            • file other_first_name.occurence.last_name.jpg
            • directory saved: saved portraits called with m=IMS&i=index
          • directory images: other images associated with a person shown in a carrousel
            • directory first_name.occurence.last_name: other images associated with a person (no sub_dirs)
              • file otherimage.jpg: images called with m=IM&i=index&s=otherimage.jpg
              • file otherimage.txt: comment associated with otherimage
              • directory saved: saved images and comments called with m=IMS&i=index&s=otherimage.jpg
          • directory subfolder: the documents folder may contain subfolders
          • file myimage.jpg: images called with m=DOC&s=myimage.jpg or m=IM&s=myimage.jpg
          • file mytext.txt: text files called with m=DOC&s=mytext.txt or m=SRC&v=mytext (See translation note below)
          • file mydoc.pdf: PDF files called with m=DOC&s=mydoc.pdf
          • file mypage.html: HTML pages called with m=DOC&s=mypage.html
        • directory etc: configurations files and personnalized variants of template files, used in priority over the generic gw/etc files (see templates)
          • directory cnt: holding access counts for the base and several access logs
            • file counts.txt: access counts
            • file counts.lck: access lock
            • file wizards.log access logs for wizards
            • file friends.log access logs for friends
            • file update.log modifications logs
          • file comm.log: result of a gwsetup command on this base
          • directory lang: local complements to the language lexicon (loaded with -add_lexicon at gwd start)
          • directory modules: personnalized variants of modules files
            • file module_xx.txt
          • directory templatex: personnal variant of templatex files
          • file config.txt: configuration/parameters file (old mybase.gwf)
          • file mybase-f.auth: example of password file for friends (friend_passwd_file= in config.txt)
          • file mybase-w.auth: example of password file for wizards (wizard_passwd_file= in config.txt)
          • file particles.txt (mybase-particles.txt?): particles list for this base.
          • file hed.txt and trl.txt: base specific header/trailer files
        • directory history: folder with all diff files (this folder may be located elsewhere according to history_path= in config.txt)
          • directory a
          • directory b
          • directory
          • file history.txt: history of modifications
        • directory notes: folder with all the notes and linked pages
          • file notes.txt: (reserved name) main notes for the base, displayed in the welcome page
          • file linked_page.txt: other "linked_page" obtained with [[[linked_page/text]]]
        • 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: admin files
        • file actlog: file temporary storing the tokens needed for login in CGI mode
        • file gwd.lck: lock file
        • file robot: list IP addresses of detected robots
      • file comm.log: execution log of the last base creation with a gwc command (when the base name is not available)
      • 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.

Translations: All text files read through the m=SRC&v=file or m=DOC&s=file.txt commands are processed by GeneWeb which expands some macros (%s, %v, %i, %k) and performs translations ([text to be translated]). 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 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).