Difference between revisions of "archive"

From GeneWeb
Jump to: navigation, search
m (Unix and Mac OSX)
m (A2 moved page Archive to archive: minuscule)
 
(10 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 facilitates sharing withour requiring GeneWeb installation.
+
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 conputing (path between two individuals). The first occurence of a relationship computing computes a file ({{c|tstab}}) which optimises further relationship computings. When on a CD-ROM, creation of this file would not be possible, but its absence does not prevent relationship computing from happening.  
+
* 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.
:# The folders {{c|etc}} (template files), {{c|images}} (portraits), {{c|lang}} (language dictionnaries) and {{c|src}} (text and image files). They must be located iin the same folder as '''gwd'''.
+
* Perform the following tasks:
: In the {{c|.gwf}} configuration file associated with your base(s), add the line {{c|1=wizard_passwd=xyz}}  
+
*# 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).
* '''Important step''': 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.  
+
*# 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:
* Before writing out to your CD-ROM, make a final test, verifying that while the {{c|Staging}} folder is write protected, you still have complete functionality.  
+
** '''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 will 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.
+
:* 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.
  
====Typicall structure for a multi-platform, multi-base distribution====
+
====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 dictionnaries
+
**** {{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 install and launch
+
*** {{f}} README    # Some explanations for installing and launch
*** {{f}} start.html # Some optionnal start file containing the various <nowiki><a href="http://127.0.0.1:2317/mybase1">MyBase1</a></nowiki> lines
+
*** {{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 files, ...!!)
+
*** # 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 files, ...!!)
+
*** # 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
to be completed
+
cmd /c start "gwd - GeneWeb" /min gw\gwd -hd gw -bd bases -wd %temp%
  
 
==== Unix and Mac OSX ====
 
==== Unix and Mac OSX ====
Line 94: Line 98:
 
  DIR=$(dirname "$0")
 
  DIR=$(dirname "$0")
 
  cd $DIR
 
  cd $DIR
  cd ./bases
+
  ./gw/gwd -hd ./gw -bd ./bases -wd /tmp/geneweb
../gw/gwd -hd ../gw -bd . -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 14:00, 22 April 2016

150px-Geographylogo svg.png 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:
  1. 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.
  2. The folders etc (template files), images (portraits), lang (language dictionaries) and src (text and image files). They must be located in the same folder as gwd.
  3. Any tags.txt (see tags) and file.auth (see access) files needed for proper execution of your base.
  4. The bases folders whose extensions are .gwb.
  5. The .gwf configuration file(s) associated with your bases.
  • Perform the following tasks:
    1. In the .gwf configuration file associated with your base(s), add the line wizard_passwd=xyz. This will prevent display of wizard related stuff which would be inoperative anyway.
    2. If your base proposes portraits for persons, install the corresponding .jpg files in a images/mybase folder (see example below).
    3. Do the same for base specific template files in etc, texts and images in src (see images for details) and language data in lang.
  • 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 or gwd.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 a start.html page that you may have prepared.
  • Write-out the content of 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.

  • directory Staging
    • directory Windows
      • directory bases
        • directory mybase1.gwb
        • file mybase1.gwf
        • directory mybase2.gwb
        • file mybase2.gwf
        • file friends1.auth
        • file friends2.auth
        • directory etc
          • directory mybase1
            • file trl.txt # base specific template files
        • directory src
          • directory mybase1
            • file file1.txt # files included with m=SRC;v=file1
            • directory images
              • file image1.jpg # images obtained with m=IMH;s=image1.jpg
        • directory images
          • directory mybase1
            • file first_name.oc.last_name.jpg # portraits displayed on personal page
        • directory lang
          • directory mybase1
            • file file1.txt # base specific language files
      • directory gw
        • directory etc # template files
        • directory images # pictograms and icons
        • directory lang # language dictionaries
        • file gwd.exe # executable
        • file tags.txt # authorised HTML tags
        • file gwd.arg # arguments for gwd launch
      • file README # Some explanations for installing and launch
      • file start.html # Some optional start file containing the various <a href="http://127.0.0.1:2317/mybase1">MyBase1</a> lines
      • file gwd.bat # gwd launch file
    • directory Linux
      • # same structure with OS specific changes (Binaries, line-end for text files…)
      • file gwd.sh # gwd launch file
    • directory Mac-OSX
      • # same structure with OS specific changes (Binaries, line-end for text files…)
      • file gwd.command # gwd launch file

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

Rembrandt Old Man Reading a Book.jpg

Use and manage genealogical databases

Technical annex