Difference between revisions of "archive"

From GeneWeb
Jump to: navigation, search
(Archive (en) interim)
 
m (A2 moved page Archive to archive: minuscule)
 
(13 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 is a convenient alternative to the publicly accessible server to facilitate sharing without forcing the user to pre-install GeneWeb.
  
to be translated!!
+
== Archiving on a write-once media ==
  
'''Archiver une version mobile de GeneWeb incluant vos bases de données sur un support de stockage externe pour le distribuer''' rend vos données accessibles sans que l’utilisateur ait à installer le logiciel ou les bases de données.
+
Here are the steps necessary to construct an autonomous CD_ROM containing one or several bases and the necessary executables.
  
== Archivage sur support non inscriptible ==
+
*'''[[clean|Clean]]''' your base(s), in particular if you have made several updates.
Bien que GeneWeb soit peu volumineux, il vous faudra au minimum un disque compact enregistrable (CD-R) et un graveur.
+
* 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 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 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 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.
 +
:# The bases folders whose extensions are {{c|.gwb}}.
 +
:# 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).
 +
*# 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}}.
 +
* 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 {{c|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 {{c|Staging}} folder is written protected, you still have complete functionality.
 +
:: 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.
  
Voici les étapes détaillées pour créer une archive mobile, les trois premières étant facultatives :
+
====Typical structure for a multi-platform, multi-base distribution====
* '''[[clean/fr|Nettoyer]]''' la ou les base(s) en profondeur. Cette étape vous permet de distribuer une base de données optimisée en mémoire et en temps d’accès. Elle est inutile si votre base de données vient d'un fichier GEDCOM ou d'un fichier source GeneWeb et que vous n'avez pas fait de modifications.
+
This structure can obviously be simplified in the case of a single platform and/or single base.
* Lancez le calcul de l'index des notes ('''[[Man/fr#Utilities|update_nldb]]''') et le '''[[consang/fr|calcul des consanguinités]]''' si vous voulez qu’elles s'affichent dans les pages personnelles et dans les calculs de parenté. Si vous ne la faites pas, les calculs de parenté fonctionneront quand même mais les consanguinités ne s'afficheront pas.
+
 
* Entrez dans votre base et faites un calcul de parenté quelconque, par exemple entre un père et son fils. Cette étape est destinée à optimiser l'accès à la base. En effet, le premier calcul de parenté fabrique un fichier {{c|tstab}} dans la base de données qui permet aux calculs de parenté suivants d’être plus rapide. Si ce fichier n’a pas été créé et que l’ensemble est figé sur un CD-R, sa création ne sera plus possible et les calculs de parenté seront plus lents.
+
{{arbre début}}
* Créer un {{c|répertoire de destination}} pour y mettre tous les éléments suivants que vous allez copier dans votre archive :
+
* {{d}} Staging
:# les bases de données : ce sont les répertoires se terminant par {{c|.gwb}}. Par exemple, si votre base s'appelle {{c|grimaldi}}, c'est un répertoire qui s'appelle {{c|grimaldi.gwb}} contenu dans le répertoire {{c|bases}} (sa location dépend de votre installation : Windows, Mac OS X, Unix…).
+
** {{d}} Windows
:# les [[configuration/fr|fichiers de configuration]] des bases {{c|.gwf}}, pour l’exemple {{c|grimaldi.gwf}}, il se trouve à la racine du répertoire {{c|bases}}. S’il n’y en a pas, ajoutez un [[password/fr|mot de passe magicien]] simple à la configuration, par exemple {{c|1=wizard_passwd=a}}. C’est facultatif, mais cela permet d'éviter de proposer une « mise à jour » dans les pages personnelles qui, de toutes façons, ne fonctionnerait pas sur un support non inscriptible.
+
*** {{d}} bases
:# le programme {{c|gwd}} (généralement dans le répertoire {{c|gw}}) dans le répertoire de destination. Sur les systèmes Windows, il porte l'extension {{c|.exe}}  
+
**** {{d}} mybase1.gwb
:# les répertoires {{c|etc}}, {{c|images}}, {{c|lang}} et {{c|src}} dont la présence est obligatoire. Ils doivent se trouver dans le même répertoire que le programme gwd.
+
**** {{f}} mybase1.gwf
*Dans le répertoire {{c|lang}} du répertoire de destination, éditez le fichier {{c|start.txt}} et supprimez le groupe de lignes qui contiennent les liens pour accès "magicien". Elles commencent par quelque chose comme :
+
**** {{d}} mybase2.gwb
 +
**** {{f}} mybase2.gwf
 +
**** {{f}} friends1.auth
 +
**** {{f}} friends2.auth
 +
**** {{d}} etc
 +
***** {{branche finale}}{{d}} mybase1
 +
****** {{branche finale}}{{f}} trl.txt        # base specific template files
 +
**** {{d}} src
 +
***** {{branche finale}}{{d}} mybase1
 +
****** {{f}} file1.txt                        # files included with m=SRC;v=file1
 +
****** {{branche finale}}{{d}} images
 +
******* {{branche finale}}{{f}} image1.jpg    # images obtained with m=IMH;s=image1.jpg
 +
**** {{d}} images
 +
***** {{branche finale}}{{d}} mybase1
 +
****** {{branche finale}}{{f}} first_name.oc.last_name.jpg # portraits displayed on personal page
 +
**** {{branche finale}}{{d}} lang
 +
***** {{branche finale}}{{d}} mybase1
 +
****** {{branche finale}}{{f}} file1.txt      # base specific language files
 +
*** {{d}} gw
 +
**** {{d}} etc      # template files
 +
**** {{d}} images    # pictograms and icons
 +
**** {{d}} lang      # language dictionaries
 +
**** {{f}} gwd.exe  # executable
 +
**** {{f}} tags.txt  # authorised HTML tags
 +
**** {{branche finale}}{{f}} gwd.arg    # arguments for gwd launch
 +
*** {{f}} README    # Some explanations for installing and launch
 +
*** {{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
 +
** {{d}} Linux
 +
*** # same structure with OS specific changes (Binaries, line-end for text files…)
 +
*** {{branche finale}}{{f}} gwd.sh      # gwd launch file
 +
** {{branche finale}}{{d}} Mac-OSX
 +
*** # same structure with OS specific changes (Binaries, line-end for text files…)
 +
*** {{branche finale}}{{f}} gwd.command  # gwd launch file
 +
{{arbre fin}}
 +
 
 +
With the structure as above, the content of {{c|gwd.bat}}, {{c|gwd.command}} and the two {{c|gwd.arg}} files should be:
 +
==== Windows ====
 +
Note that arguments can be passed to gwd either through the {{c|.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
 +
<!-- 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
 +
* In the folder {{c|lang}}, edit the file {{c|start.txt}} removing the lines relative to ''wizard'' access between
 
  <td align=center>[
 
  <td align=center>[
 
  af: <a href="%sw=w"><em>Medewerkers</em></a> toegang<br> (password)
 
  af: <a href="%sw=w"><em>Medewerkers</em></a> toegang<br> (password)
 
  ca: accés <a href="%sw=w"><em>administrador</em></a><br> (clau)
 
  ca: accés <a href="%sw=w"><em>administrador</em></a><br> (clau)
:et finissent par:
+
: and
 
  pl: <a href="%sw=w"><em>"Wizard"</em></a> dostêp<br> (has³o)
 
  pl: <a href="%sw=w"><em>"Wizard"</em></a> dostêp<br> (has³o)
 
  pt: Entrada <a href="%sw=w"><em>feiticeiro</em></a><br> (palavra chave)
 
  pt: Entrada <a href="%sw=w"><em>feiticeiro</em></a><br> (palavra chave)
 
  sv: <a href="%sw=w"><em>Uppdaterings</em></a> tillträde<br> (passord)
 
  sv: <a href="%sw=w"><em>Uppdaterings</em></a> tillträde<br> (passord)
 
  ]<br></td>
 
  ]<br></td>
:Cette étape n'est pas obligatoire mais évite que la page d'accueil propose un accès magicien qui, de toutes façons, ne servirait à rien.
+
: This step is not mandatory, but will avoid displaying wizard access buttons which would be inoperative anyway.
* '''Étape importante''' : l'exécutable gwd fabrique des fichiers dans son répertoire courant. S'il ne peut pas le faire, ça peut bloquer son fonctionnement (en particulier sous Windows, ça le bloquera certainement). Il faut donc lui indiquer une option pour qu'il utilise le disque dur (note: ces fichiers ne sont pas gros, sont temporaires et les détruire volontairement ou involontairement pendant ou après une visite ne perturbera pas le fonctionnement de gwd).
+
-->
 
+
{{manual}}
Pour cela, créez un fichier {{c|gwd.arg}} et collez-y :
+
* pour Windows :
+
-wd
+
c:\temp\geneweb
+
*pour Unix ou Mac OS X :
+
-wd
+
/tmp/geneweb
+
* Si votre base de données a des images, mettez-les dans le répertoire "images", sous-répertoire portant le nom de votre base ("images/xyz" si votre base s'appelle "xyz").
+
* Après toutes ces étapes, vous disposez d'une installation minimum, obligeant l'utilisateur à lancer lui-même gwd et à ouvrir l'adresse URL pour accéder à la base. Vous pouvez améliorer cela en fournissant des fichiers HTML et/ou des scripts (shell, batch) qui lanceront tout cela tout seul. Vous pouvez aussi mettre plusieurs bases de données, d'autres fichiers HTML, etc, etc.
+
 
+
<!-- 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 -->
+
:Remarque: si vous voulez que votre base de données soit lisible sur d'autres Systèmes d'Exploitation (Windows, MacOS X, Unix) que vous utilisez, vous pouvez créer un répertoire par SE et y mettre la version de gwd pour ce SE-là. Bien sûr il vous faudra avoir téléchargé toutes les versions de GeneWeb des SE que vous voulez rendre disponibles. Il faut également revoir l'installation des fichiers gwd.arg et en particulier leur indiquer le chemin d'accès aux fichiers système et à la base (options -hd et -bd de gwd)._
+
 
+
* Avant de graver votre disque, faites un test. Pour cela, rendez le répertoire destination non inscriptible ainsi que tous ses sous-répertoires et fichiers. Puis lancez la commande gwd (par double-clic si votre système le permet ou par une commande intéractive). Ouvez dans votre navigateur l'adresse {{c|http://127.0.0.1:2317/grimaldi}} et vérifiez si ça fonctionne.
+
 
+
* Gravez l’intégralité du {{c|répertoire de destination}} avec son contenu.
+
 
+
== Archivage sur un support inscriptible ==
+
Une petite clé USB convient également : sauf une base exceptionnelement grosse, une clé 512 Mo suffira largement en tablant sur un bon millier de photos.
+
  
[… à détailler]
+
[[Category:Manual]]
[[Category:Manuel]]
+

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