Difference between revisions of "bases"
(28 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 | + | 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 | + | 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]] | + | * {{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}} | + | ***** {{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 47: | Line 47: | ||
{{arbre fin}} | {{arbre fin}} | ||
− | ==Bases folder in | + | == 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 | + | {{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]] | + | * {{d}} [[distribution]] |
** {{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}} | ||
− | **** {{ | + | **** {{d}} documents: image/txt/pdf/html files, subdirectories allowed (except portraits/ and images/) |
− | **** {{ | + | ***** {{d}} portraits: portraits images called with {{c|1=m=IM&i=index}} (no sub-dirs here!) |
− | **** {{f}} | + | ****** {{f}} first_name.occurence.last_name.jpg |
− | **** {{f}} | + | ****** {{f}} other_first_name.occurence.last_name.jpg |
− | **** {{f}} | + | ****** {{branche finale}}{{d}} saved: saved portraits called with {{c|1=m=IMS&i=index}} |
− | **** {{ | + | ***** {{d}} images: other images associated with a person shown in a carrousel |
− | **** {{d}} documents | + | ****** {{d}} first_name.occurence.last_name: other images associated with a person (no sub_dirs) |
− | ***** {{f}} | + | ******* {{f}} ''otherimage.jpg'': images called with {{c|1=m=IM&i=index&s=otherimage.jpg}} |
− | ***** {{f}} | + | ******* {{f}} ''otherimage.txt'': comment associated with otherimage |
− | ***** {{f}} | + | ******* {{branche finale}}{{d}} saved: saved images and comments called with {{c|1=m=IMS&i=index&s=otherimage.jpg}} |
− | ***** {{branche finale}}{{f}} | + | ***** {{d}} ''subfolder'': the documents folder may contain subfolders |
− | **** {{d}} etc: personnalized variants of template files, used in priority over the generic {{c|gw/etc}} files (see [[templates]]) | + | ***** {{f}} ''myimage.jpg'': images called with {{c|1=m=DOC&s=myimage.jpg}} or {{c|1=m=IM&s=myimage.jpg}} |
− | ***** {{d}} | + | ***** {{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}} | + | ***** {{f}} config.txt: [[configuration|configuration/parameters file]] (old {{c|mybase.gwf}}) |
− | ***** {{branche finale}}{{f}} trl.txt: base specific trailer | + | ***** {{f}} ''mybase-f.auth'': example of [[password#Specific access|password file for friends]] ({{c|1=friend_passwd_file=}} in {{c|config.txt}}) |
− | **** {{d}} | + | ***** {{f}} ''mybase-w.auth'': example of password file for wizards ({{c|1=wizard_passwd_file=}} in {{c|config.txt}}) |
− | **** {{d}} | + | ***** {{f}} particles.txt (mybase-particles.txt?): particles list for this base. |
− | ***** {{f}} | + | ***** {{branche finale}}{{f}} hed.txt and trl.txt: base specific header/trailer files |
− | ***** {{branche finale}}{{f}} | + | **** {{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}} | + | ***** {{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 | ||
− | *** | + | *** {{d}} cnt: admin files |
− | **** {{f}} actlog: | + | **** {{f}} actlog: file temporary storing the tokens needed for login in CGI mode |
− | **** {{f}} | + | **** {{f}} gwd.lck: lock file |
**** {{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}} | + | ** {{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). |
Revision as of 22:39, 14 December 2018
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.
- distribution: details all the other files and subfolders out of
bases
folder, like the programs or template files.- bases: The folder containing the GeneWeb databases
- mybase.gwb: folder of the genealogical database called
mybase
- mybase.gwf: associated .gwf configuration/parameters file
- mybase-f.auth example of password file for friends (
friend_passwd_file=
) - mybase-w.auth example of password file for wizards (
wizard_passwd_file=
) - mybase2.gwb: folder of a second genealogical database
mybase2
- mybase2.gwf/auth configuration files associated to mybase2, etc.
- cnt: holding the robot file, locks, and memorising the access counts for each base
- actlog: file temporary storing the tokens needed for login in CGI mode
- robot list IP address of robots
- mybase.txt access counts for mybase
- mybase.lck lock file for mybase
- etc: used in priority over the generic
gw/etc
files (see templates) - images
- lang: containing some base specific language related template text files (lexicon for instance)
- src
- mybase.gwb: folder of the genealogical database called
- gw
- […] gwd/gwsetup launch scripts, README, etc.
- bases: The folder containing the GeneWeb databases
Bases folder in GeneWeb 7
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 tar
, zip
or rar
to store a single database folder in an archive (see save for details and comments).
- distribution
- bases: The folder containing the GeneWeb databases
- mybase.gwb: folder of the genealogical database called
mybase
- documents: image/txt/pdf/html files, subdirectories allowed (except portraits/ and images/)
- portraits: portraits images called with
m=IM&i=index
(no sub-dirs here!) - images: other images associated with a person shown in a carrousel
- subfolder: the documents folder may contain subfolders
- myimage.jpg: images called with
m=DOC&s=myimage.jpg
orm=IM&s=myimage.jpg
- mytext.txt: text files called with
m=DOC&s=mytext.txt
orm=SRC&v=mytext
(See translation note below) - mydoc.pdf: PDF files called with
m=DOC&s=mydoc.pdf
- mypage.html: HTML pages called with
m=DOC&s=mypage.html
- portraits: portraits images called with
- etc: configurations files and personnalized variants of template files, used in priority over the generic
gw/etc
files (see templates)- cnt: holding access counts for the base and several access logs
- comm.log: result of a gwsetup command on this base
- lang: local complements to the language lexicon (loaded with
-add_lexicon
at gwd start) - modules: personnalized variants of modules files
- templatex: personnal variant of templatex files
- config.txt: configuration/parameters file (old
mybase.gwf
) - mybase-f.auth: example of password file for friends (
friend_passwd_file=
inconfig.txt
) - mybase-w.auth: example of password file for wizards (
wizard_passwd_file=
inconfig.txt
) - particles.txt (mybase-particles.txt?): particles list for this base.
- hed.txt and trl.txt: base specific header/trailer files
- history: folder with all diff files (this folder may be located elsewhere according to
history_path=
inconfig.txt
) - notes: folder with all the notes and linked pages
- … base, base.acc, cache_info […] names.inx, notes_links, patches (all internal files and folders of the database)
- documents: image/txt/pdf/html files, subdirectories allowed (except portraits/ and images/)
- mybase2.gwb: folder of a second genealogical database
mybase2
- […] the organisation is the same for each database see description for mybase.gwb folder above
- cnt: admin files
- actlog: file temporary storing the tokens needed for login in CGI mode
- gwd.lck: lock file
- robot: list IP addresses of detected robots
- comm.log: execution log of the last base creation with a
gwc
command (when the base name is not available) - tags.txt: alternate list of authorized HTML tags (loaded with
-allowed_tags
at gwd start)
- mybase.gwb: folder of the genealogical database called
- gw
- … gwd/gwsetup launch scripts, CHANGES.txt, README, etc.
- bases: The folder containing the GeneWeb databases
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).