Difference between revisions of "archive"
Jump to navigation
Jump to search
(Archive (en) interim) |
m (Archive (en) pass 1) |
||
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 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|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]]) | |
+ | * 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. | ||
+ | * Create a {{c|Staging}} folder whose entire content will be written on the removable media. In this folder, place copies of: | ||
+ | :# 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. | ||
+ | :# 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. | ||
+ | :# 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'''. | ||
+ | : In the {{c|.gwf}} configuration file associated with your base(s), add the line {{c|1=wizard_passwd=xyz}} | ||
+ | * 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. | ||
+ | : This parameter is provided in the {{c|gwd.arg}} or in the command launching gwd (see example below): | ||
+ | * 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. | ||
+ | : 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 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. | ||
+ | * Write-out the content of {{c|Staging}} to the removable media. | ||
− | + | ====Typicall 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. | |
− | * | + | |
− | * | + | {{arbre début}} |
− | * | + | * {{d}} Staging |
− | + | ** {{d}} Windows | |
− | + | *** {{d}} bases | |
− | + | **** {{d}} mybase1.gwb | |
− | + | **** {{f}} mybase1.gwf | |
− | * | + | **** {{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 dictionnaries | ||
+ | **** {{f}} gwd.exe # executable | ||
+ | **** {{f}} tags.txt # authorised HTML tags | ||
+ | **** {{branche finale}}{{f}} gwd.arg # arguments for gwd launch | ||
+ | *** {{f}} README # Some explanations for install 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 | ||
+ | *** {{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 | ||
+ | to be completed | ||
+ | |||
+ | ==== Unix and Mac OSX ==== | ||
+ | |||
+ | * gwd.arg | ||
+ | -bd | ||
+ | ../bases | ||
+ | -wd | ||
+ | /tmp/geneweb | ||
+ | * gwd.command | ||
+ | #!/bin/sh | ||
+ | cd ./bases | ||
+ | ../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 --> | ||
+ | |||
+ | <!-- 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) | ||
− | : | + | : 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> | ||
− | : | + | : This step is not mandatory, but will avoid displaying wizard access buttons which would be inoperative anyway. |
− | + | --> | |
− | + | {{manual}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | [[Category:Manual]] | |
− | [[Category: |
Revision as of 14:00, 20 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 facilitates sharing withour requiring GeneWeb installation.
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 conputing (path between two individuals). The first occurence of a relationship computing computes a file (
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. - Create a
Staging
folder whose entire content will be written on the removable media. In this folder, place copies of:
- 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. - 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 folders
etc
(template files),images
(portraits),lang
(language dictionnaries) andsrc
(text and image files). They must be located iin the same folder as gwd.
- The
- In the
.gwf
configuration file associated with your base(s), add the linewizard_passwd=xyz
- If your base proposes portraits for persons, install the corresponding
.jpg
files in aimages/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.
- This parameter is provided in the
gwd.arg
or in the command launching gwd (see example below):
- Before writing out to your CD-ROM, make a final test, verifying that while the
Staging
folder is write 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 will 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.
Typicall 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 install and launch
- start.html # Some optionnal 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
to be completed
Unix and Mac OSX
- gwd.arg
-bd ../bases -wd /tmp/geneweb
- gwd.command
#!/bin/sh cd ./bases ../gw/gwd -hd ../gw -bd . -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.