Difference between revisions of "distribution"

From GeneWeb
Jump to: navigation, search
m
m
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Distribution folder}}
+
{{DISPLAYTITLE:GeneWeb distribution folder}}
{{languages|Distribution}}
+
{{languages|distribution}}
  
A GeneWeb distribution, available as a compressed file ({{c|.tar}} er {{c|.tgz}} or {{c|.zip}}) can be unfolded into a distribution folder whose structure is described here. This description starts from an example of an existing  [[download|downloaded]] distribution file:
+
'''GeneWeb distribution''' are available as compressed .tar, .gz or .zip archive files (or as an installer for some Windows releases). The archives can be uncompressed into a folder whose structure is as follows (remember that the bases folder can be moved anywhere):
 
+
<pre>
+
(server):~#cd
+
(server):~#ls -al gw-7.00-alpha-linux.tgz
+
-rw-r--r-- 1 username usergroup 5616960 Nov 24 14:21 gw-7.00-alpha-linux.tgz
+
gw-7.00-alpha-linux/
+
gw-7.00-alpha-linux/gw/
+
gw-7.00-alpha-linux/gw/gwd.arg
+
gw-7.00-alpha-linux/gw/convert_hist
+
....
+
gw-7.00-alpha-linux/gwsetup
+
</pre>
+
  
 
{{arbre début}}
 
{{arbre début}}
 
*
 
*
** {{d}} gw-7.00-alpha-linux: The folder containing the GeneWeb distribution.
+
** {{d}} geneweb-distribution: the folder containing the GeneWeb distribution
*** {{f}} CHANGES.txt
+
*** {{d}} [[bases]]: default location for databases (see the [[bases]] section for a complete description of bases folder)
 +
**** {{branche finale}}
 
*** {{d}} gw
 
*** {{d}} gw
**** {{f}} a.gwf  : standard version for the configuration parameters of a base
+
**** {{d}} etc: files of [[templates]]
**** {{f}} consang
+
***** {{f}} template_x.txt (multiple templates for capture and display of data)
**** {{d}} etc  : template files
+
***** {{d}} css: for css styles
**** {{f}} ged2gwb, ged2gwb2, gwb2ged : (for convenience multiple executables are listed on the same line)
+
***** {{d}} js: for JavaSrcipt programs
**** {{f}} gwc, gwc1, gwc2, gwu
+
***** {{d}} modules: for [[templates#Personnalisation Modules|personnalisation]] modules
**** {{f}} gwd
+
***** {{d}} [[templates#Modules|folders]] for additional styles of template
**** {{f}} gwd.arg  : execution parameters for gwd
+
***** {{branche finale}}{{f}} robots.txt !! contains “User-Agent: * Disallow: /” ? !!
**** {{f}} gwd.log  : execution traces for gwd (as specified at gwd launch)
+
**** {{d}} images: icons used by gwd
**** {{f}} gwsetup
+
**** {{d}} lang: language files used in template construction such as [[lexicon]]s and starts file
**** {{d}} gwtp_tmp  :???
+
***** {{f}} alias_lg.txt
**** {{d}} images  :  
+
***** {{f}} lex_utf8.txt utf_8 version of the lexicon
**** {{d}} lang
+
***** {{branche finale}}{{f}} lexicon_perso.txt private lexicon supplementing lex_utf8 (see -add_lexicon in [[gwd]])
**** {{f}} mk_consang  :???
+
**** {{d}} setup: gwsetup template files
**** {{f}} only.txt : access restriction for gwsetup
+
**** {{f}} a.gwf: standard version for the [[configuration|configuration parameters of a base]]
**** {{d}} setup  : gwsetup template files
+
**** {{e}} [[consang]]: tool to calculate consanguinity
**** {{f}} tags.txt : list of authorized HTML tags
+
**** {{f}} [[ged2gwb]], ged2gwb2, [[gwb2ged]]: base creation and extraction with GED format
**** {{branche finale}}{{d}} update_nldb
+
**** {{e}} [[gwc]], gwc2, [[gwu]]: gwc to create a base, gwu to extract a .gw archive file
*** {{f}} gwd : minimal launch script for gwd
+
**** {{e}} [[gwd]]: the main GeneWeb server
*** {{f}} gwsetup : minimal launch script for gwsetup
+
**** {{f}} [[CGI#Windows|gwd.arg]]: static execution parameters for gwd
 +
**** {{f}} gwd.log: execution traces for gwd (as specified at gwd launch)
 +
**** {{f}} gwd.xlc: [[access#Black list|black list]] to exclude access to specific web domain or users.
 +
**** {{e}} [[gwsetup]]: auxiliary server for base management
 +
**** {{f}} only.txt: [[access#Managing the GeneWeb server|access restriction for gwsetup]]
 +
**** {{f}} tags.txt: list of [[tags|authorized HTML tags]]
 +
**** {{branche finale}}{{e}} update_nldb: update the [[wikitext#Internal links|internal links]] between notes and pages
 +
*** {{f}} CHANGES.txt: [[changelog]]
 +
*** {{s}} geneweb: launch gwsetup, gwd and START.html page
 +
*** {{s}} gwd: minimal launch script for gwd
 +
*** {{s}} gwsetup: minimal launch script for gwsetup
 
*** {{f}} LICENSE.txt
 
*** {{f}} LICENSE.txt
*** {{branche finale}}{{f}} START.htm
+
*** {{f}} LIZEZMOI.txt
 +
*** {{f}} README.txt
 +
*** {{branche finale}}{{f}} START.htm : a minimal start page (assumes that gwd and gwsetup have been started)
 
{{arbre fin}}
 
{{arbre fin}}
  
You may rename the {{c|gw-7.00-alpha-linux}} folder to any name of your choice.
+
{{c|geneweb}} and {{c|gwd}} script files have {{c|.bat}} extension on Windows and {{c|.command}} extension on macOS.
 +
 
 +
Note also that the minimal {{c|gwd}} start script provided in this distribution folder installs a {{c|bases}} folder in the distribution folder itself. You may keep this organisation or choose to maintain a separate folder (as shown in [[bases]]) which facilitates the installation of new revisions of GeneWeb (all local modifications stay untouched).
  
Note also that the minimal {{c|gwd}} start script provided in this distribution folder installs a {{c|base}} folder in the distribution folder itself. You may choose to keep this organisation rather than maintaining a separate bases folder.
+
You may also rename the main folder to any name of your choice, but don't forget to use the same name if you use [[CGI]] mode in the {{c|cgi-bin/gwd.sh}} launch script and the {{c|gw}} link to the style and JavaScript files at the web_root.

Latest revision as of 17:03, 9 November 2020

150px-Geographylogo svg.png Language: English

GeneWeb distribution are available as compressed .tar, .gz or .zip archive files (or as an installer for some Windows releases). The archives can be uncompressed into a folder whose structure is as follows (remember that the bases folder can be moved anywhere):

    • directory geneweb-distribution: the folder containing the GeneWeb distribution
      • directory bases: default location for databases (see the bases section for a complete description of bases folder)
      • directory gw
        • directory etc: files of templates
          • file template_x.txt (multiple templates for capture and display of data)
          • directory css: for css styles
          • directory js: for JavaSrcipt programs
          • directory modules: for personnalisation modules
          • directory folders for additional styles of template
          • file robots.txt !! contains “User-Agent: * Disallow: /” ? !!
        • directory images: icons used by gwd
        • directory lang: language files used in template construction such as lexicons and starts file
          • file alias_lg.txt
          • file lex_utf8.txt utf_8 version of the lexicon
          • file lexicon_perso.txt private lexicon supplementing lex_utf8 (see -add_lexicon in gwd)
        • directory setup: gwsetup template files
        • file a.gwf: standard version for the configuration parameters of a base
        • alt exe consang: tool to calculate consanguinity
        • file ged2gwb, ged2gwb2, gwb2ged: base creation and extraction with GED format
        • alt exe gwc, gwc2, gwu: gwc to create a base, gwu to extract a .gw archive file
        • alt exe gwd: the main GeneWeb server
        • file gwd.arg: static execution parameters for gwd
        • file gwd.log: execution traces for gwd (as specified at gwd launch)
        • file gwd.xlc: black list to exclude access to specific web domain or users.
        • alt exe gwsetup: auxiliary server for base management
        • file only.txt: access restriction for gwsetup
        • file tags.txt: list of authorized HTML tags
        • alt exe update_nldb: update the internal links between notes and pages
      • file CHANGES.txt: changelog
      • script file geneweb: launch gwsetup, gwd and START.html page
      • script file gwd: minimal launch script for gwd
      • script file gwsetup: minimal launch script for gwsetup
      • file LICENSE.txt
      • file LIZEZMOI.txt
      • file README.txt
      • file START.htm : a minimal start page (assumes that gwd and gwsetup have been started)

geneweb and gwd script files have .bat extension on Windows and .command extension on macOS.

Note also that the minimal gwd start script provided in this distribution folder installs a bases folder in the distribution folder itself. You may keep this organisation or choose to maintain a separate folder (as shown in bases) which facilitates the installation of new revisions of GeneWeb (all local modifications stay untouched).

You may also rename the main folder to any name of your choice, but don't forget to use the same name if you use CGI mode in the cgi-bin/gwd.sh launch script and the gw link to the style and JavaScript files at the web_root.