Difference between revisions of "archive"
Jump to navigation
Jump to search
(11 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:Archive and distribute your base on a removable media (CD-ROM)}} | {{DISPLAYTITLE:Archive and distribute your base on a removable media (CD-ROM)}} | ||
{{languages|archive}} | {{languages|archive}} | ||
− | Archiving your GeneWeb base on a permanent and removable media such as a CD-ROM protects your data and | + | Archiving your GeneWeb base on a permanent and removable media such as a CD-ROM protects your data and is a convenient alternative to the publicly accessible server to facilitate sharing without forcing the user to pre-install GeneWeb. |
== Archiving on a write-once media == | == Archiving on a write-once media == | ||
Line 9: | Line 9: | ||
*'''[[clean|Clean]]''' your base(s), in particular if you have made several updates. | *'''[[clean|Clean]]''' your base(s), in particular if you have made several updates. | ||
* Launch '''[[Man#Utilities|update_nldb]]''' (notes index construction) and '''[[consang|consanguinity]]''' computation if you have requested their display on personal pages ({{c|1=show_consang=yes}}, see [[configuration]]) | * Launch '''[[Man#Utilities|update_nldb]]''' (notes index construction) and '''[[consang|consanguinity]]''' computation if you have requested their display on personal pages ({{c|1=show_consang=yes}}, see [[configuration]]) | ||
− | * Connect to your base, and perform one relationship | + | * Connect to your base, and perform one relationship computing (path between two individuals). The first occurrence of a relationship computing computes a file ({{c|tstab}}) which optimises further relationship computing. When on a CD-ROM, creation of this file would not be possible, but its absence does not prevent relationship computing from happening. |
− | * Create a {{c|Staging}} folder whose entire content will be written on the removable media. In this folder, place copies of: | + | * Create a {{c|Staging}} folder whose entire content will be written on the removable media. In this folder, place copies of the following files or folders: |
:# The {{c|gwd}} executable file (on windows systems, it usually has {{c|.exe}} extension), and its {{c|.arg}} argument file. Make sure that this files has the proper ''executable'' property. | :# The {{c|gwd}} executable file (on windows systems, it usually has {{c|.exe}} extension), and its {{c|.arg}} argument file. Make sure that this files has the proper ''executable'' property. | ||
+ | :# The folders {{c|etc}} (template files), {{c|images}} (portraits), {{c|lang}} (language dictionaries) and {{c|src}} (text and image files). They must be located in the same folder as '''gwd'''. | ||
:# Any {{c|tags.txt}} (see [[tags|tags]]) and {{c|file.auth}} (see [[access|access]]) files needed for proper execution of your base. | :# Any {{c|tags.txt}} (see [[tags|tags]]) and {{c|file.auth}} (see [[access|access]]) files needed for proper execution of your base. | ||
:# The bases folders whose extensions are {{c|.gwb}}. | :# The bases folders whose extensions are {{c|.gwb}}. | ||
:# The {{c|.gwf}} [[configuration]] file(s) associated with your bases. | :# The {{c|.gwf}} [[configuration]] file(s) associated with your bases. | ||
− | :# | + | * Perform the following tasks: |
− | + | *# In the {{c|.gwf}} configuration file associated with your base(s), add the line {{c|1=wizard_passwd=xyz}}. This will prevent display of wizard related stuff which would be inoperative anyway. | |
− | * If your base proposes portraits for persons, install the corresponding {{c|.jpg}} files in a {{c|images/mybase}} folder (see example below). | + | *# If your base proposes portraits for persons, install the corresponding {{c|.jpg}} files in a {{c|images/mybase}} folder (see example below). |
− | * ''' | + | *# Do the same for base specific template files in {{c|etc}}, texts and images in {{c|src}} (see [[images]] for details) and language data in {{c|lang}}. |
− | : This parameter is provided in the {{c|gwd.arg}} or in the command launching gwd (see example below): | + | * Verify and write-out: |
− | * | + | ** '''Identify a temporary writable folder'''. '''gwd''' builds several temporary files (in its working directory by default). If executed from a non-writable media, a parameter '''must''' indicate where temporary files can be written. These files are of modest size, and can be deleted with no harm. |
− | : Launching GeneWeb should be done by clicking on the appropriate {{c|gwd.bat}}, {{c|gwd.sh}} or {{c|gwd.command}} file. Make sure that those files have the proper ''executable'' property. | + | :: This parameter is provided in the {{c|gwd.arg}} or in the command launching gwd (see example below): |
− | : After launch, opening your base | + | :* Make a final test before writing out to your CD-ROM, verifying that while the {{c|Staging}} folder is written protected, you still have complete functionality. |
− | * Write-out the content of {{c|Staging}} to the removable media. | + | :: Launching GeneWeb should be done by clicking on the appropriate {{c|gwd.bat}}, {{c|gwd.sh}} or {{c|gwd.command}} file. Make sure that those files have the proper ''executable'' property. |
+ | :: After launch, opening your base should be done by entering {{c|http://127.0.0.1:2317/mybase1}} into the URL line of your browser, or by clicking on a link of a {{c|start.html}} page that you may have prepared. | ||
+ | :* Write-out the content of {{c|Staging}} to the removable media. | ||
+ | * Clean-up. | ||
− | ==== | + | ====Typical structure for a multi-platform, multi-base distribution==== |
This structure can obviously be simplified in the case of a single platform and/or single base. | This structure can obviously be simplified in the case of a single platform and/or single base. | ||
Line 55: | Line 59: | ||
**** {{d}} etc # template files | **** {{d}} etc # template files | ||
**** {{d}} images # pictograms and icons | **** {{d}} images # pictograms and icons | ||
− | **** {{d}} lang # language | + | **** {{d}} lang # language dictionaries |
**** {{f}} gwd.exe # executable | **** {{f}} gwd.exe # executable | ||
**** {{f}} tags.txt # authorised HTML tags | **** {{f}} tags.txt # authorised HTML tags | ||
**** {{branche finale}}{{f}} gwd.arg # arguments for gwd launch | **** {{branche finale}}{{f}} gwd.arg # arguments for gwd launch | ||
− | *** {{f}} README # Some explanations for | + | *** {{f}} README # Some explanations for installing and launch |
− | *** {{f}} start.html # Some | + | *** {{f}} start.html # Some optional start file containing the various <nowiki><a href="http://127.0.0.1:2317/mybase1">MyBase1</a></nowiki> lines |
*** {{branche finale}}{{f}} gwd.bat # gwd launch file | *** {{branche finale}}{{f}} gwd.bat # gwd launch file | ||
** {{d}} Linux | ** {{d}} Linux | ||
− | *** # same structure with OS specific changes (Binaries, line-end for text | + | *** # same structure with OS specific changes (Binaries, line-end for text files…) |
*** {{branche finale}}{{f}} gwd.sh # gwd launch file | *** {{branche finale}}{{f}} gwd.sh # gwd launch file | ||
** {{branche finale}}{{d}} Mac-OSX | ** {{branche finale}}{{d}} Mac-OSX | ||
− | *** # same structure with OS specific changes (Binaries, line-end for text | + | *** # same structure with OS specific changes (Binaries, line-end for text files…) |
*** {{branche finale}}{{f}} gwd.command # gwd launch file | *** {{branche finale}}{{f}} gwd.command # gwd launch file | ||
{{arbre fin}} | {{arbre fin}} | ||
Line 79: | Line 83: | ||
c:\temp\geneweb | c:\temp\geneweb | ||
* gwd.bat | * gwd.bat | ||
− | + | cmd /c start "gwd - GeneWeb" /min gw\gwd -hd gw -bd bases -wd %temp% | |
==== Unix and Mac OSX ==== | ==== Unix and Mac OSX ==== | ||
Line 92: | Line 96: | ||
# Shutdown daemon allready running | # Shutdown daemon allready running | ||
killall gwd | killall gwd | ||
− | + | DIR=$(dirname "$0") | |
− | cd | + | cd $DIR |
− | + | ./gw/gwd -hd ./gw -bd ./bases -wd /tmp/geneweb | |
− | |||
− | |||
− | |||
<!-- Ne me demandez pas comment on fait un CDrom qui lance tout automatiquement quand on l'insère sur son support: ça doit pouvoir se faire mais je ne sais pas comment. > autorun.inf à documenter --> | <!-- Ne me demandez pas comment on fait un CDrom qui lance tout automatiquement quand on l'insère sur son support: ça doit pouvoir se faire mais je ne sais pas comment. > autorun.inf à documenter --> | ||
− | |||
<!-- kept for possible reuse | <!-- kept for possible reuse | ||
* In the folder {{c|lang}}, edit the file {{c|start.txt}} removing the lines relative to ''wizard'' access between | * In the folder {{c|lang}}, edit the file {{c|start.txt}} removing the lines relative to ''wizard'' access between |
Latest revision as of 13:00, 22 April 2016
Language: | English • français |
---|
Archiving your GeneWeb base on a permanent and removable media such as a CD-ROM protects your data and is a convenient alternative to the publicly accessible server to facilitate sharing without forcing the user to pre-install GeneWeb.
Archiving on a write-once media
Here are the steps necessary to construct an autonomous CD_ROM containing one or several bases and the necessary executables.
- Clean your base(s), in particular if you have made several updates.
- Launch update_nldb (notes index construction) and consanguinity computation if you have requested their display on personal pages (
show_consang=yes
, see configuration) - Connect to your base, and perform one relationship computing (path between two individuals). The first occurrence of a relationship computing computes a file (
tstab
) which optimises further relationship computing. When on a CD-ROM, creation of this file would not be possible, but its absence does not prevent relationship computing from happening. - Create a
Staging
folder whose entire content will be written on the removable media. In this folder, place copies of the following files or folders:
- The
gwd
executable file (on windows systems, it usually has.exe
extension), and its.arg
argument file. Make sure that this files has the proper executable property. - The folders
etc
(template files),images
(portraits),lang
(language dictionaries) andsrc
(text and image files). They must be located in the same folder as gwd. - Any
tags.txt
(see tags) andfile.auth
(see access) files needed for proper execution of your base. - The bases folders whose extensions are
.gwb
. - The
.gwf
configuration file(s) associated with your bases.
- The
- Perform the following tasks:
- In the
.gwf
configuration file associated with your base(s), add the linewizard_passwd=xyz
. This will prevent display of wizard related stuff which would be inoperative anyway. - If your base proposes portraits for persons, install the corresponding
.jpg
files in aimages/mybase
folder (see example below). - Do the same for base specific template files in
etc
, texts and images insrc
(see images for details) and language data inlang
.
- In the
- Verify and write-out:
- Identify a temporary writable folder. gwd builds several temporary files (in its working directory by default). If executed from a non-writable media, a parameter must indicate where temporary files can be written. These files are of modest size, and can be deleted with no harm.
- This parameter is provided in the
gwd.arg
or in the command launching gwd (see example below):
- Make a final test before writing out to your CD-ROM, verifying that while the
Staging
folder is written protected, you still have complete functionality.
- Launching GeneWeb should be done by clicking on the appropriate
gwd.bat
,gwd.sh
orgwd.command
file. Make sure that those files have the proper executable property. - After launch, opening your base should be done by entering
http://127.0.0.1:2317/mybase1
into the URL line of your browser, or by clicking on a link of astart.html
page that you may have prepared.
- Write-out the content of
Staging
to the removable media.
- This parameter is provided in the
- Clean-up.
Typical structure for a multi-platform, multi-base distribution
This structure can obviously be simplified in the case of a single platform and/or single base.
- Staging
- Windows
- bases
- gw
- README # Some explanations for installing and launch
- start.html # Some optional start file containing the various <a href="http://127.0.0.1:2317/mybase1">MyBase1</a> lines
- gwd.bat # gwd launch file
- Linux
- Mac-OSX
- Windows
With the structure as above, the content of gwd.bat
, gwd.command
and the two gwd.arg
files should be:
Windows
Note that arguments can be passed to gwd either through the .arg
file, or through the launch command line.
- gwd.arg
-bd ../bases -wd c:\temp\geneweb
- gwd.bat
cmd /c start "gwd - GeneWeb" /min gw\gwd -hd gw -bd bases -wd %temp%
Unix and Mac OSX
- gwd.arg
-bd ../bases -wd /tmp/geneweb
- gwd.command
#!/bin/sh # Shutdown daemon allready running killall gwd DIR=$(dirname "$0") cd $DIR ./gw/gwd -hd ./gw -bd ./bases -wd /tmp/geneweb
GeneWeb Manual
- Download and install GeneWeb program under GNU/Linux, Mac OS X, Microsoft Windows, FreeBSD; on Mac OS X, Linux or Windows using Docker; or in CGI mode behind a web server.
- Understand GeneWeb server, homonym, consanguinity.
Use and manage genealogical databases
- Import Gedcom
.ged
or GeneWeb.gw
files with gwsetup or in command-line. - Update datas (add/remove individuals and families), merge duplicates, type dates.
- Use wikitext syntax, macros, keyboard shortcuts.
- Clean, recover, rename, save, archive a database.
- Merge and split multiples databases.
Technical annex
- Personalize CSS, header and trailer, templates, lexicon and declension.
- Configuration file
.gwf
(for templm), wizard notes, passwords for friends/wizards and access restrictions to databases. - Add images in notes, further remarks for experts.