Difference between revisions of "distribution"

From GeneWeb
Jump to: navigation, search
m
(/etc sub folders (css, js, modules), -add_lexicon)
 
(17 intermediate revisions by 2 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 uncompresssed into a folder whose structure is:
 
+
<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
+
(server):~#nv gw-7.00-alpha-linux geneweb-distribution
+
</pre>
+
 
+
You may rename the {{c|gw-7.00-alpha-linux}} folder to any name of your choice, as long as you use this same name in the {{c|cgi-bin/gwd.sh}} launch script and the {{c|gw}} link to the style and JavaScript files at the web_root.
+
  
 
{{arbre début}}
 
{{arbre début}}
 
*
 
*
** {{d}} geneweb-distribution : The folder containing the GeneWeb distribution.
+
** {{d}} geneweb-distribution: the folder containing the GeneWeb distribution
*** {{d}} bases : a proposed location for storing bases
+
*** {{d}} [[bases]]: default location for databases (see the [[bases]] section for a complete description of bases folder)
*** {{f}} CHANGES.txt
+
**** {{branche finale}}
*** {{s}} geneweb.ext  : launch gwsetup, gwd and START.html page (file extension varies according to OS)
+
 
*** {{d}} gw
 
*** {{d}} gw
**** {{f}} a.gwf  : standard version for the configuration parameters of a base
+
**** {{d}} etc: files of [[templates]]
**** {{e}} [[consang]]
+
***** {{f}} template_x.txt (multiple templates for capture and display of data)
**** {{d}} etc  : [[templates|template]] files
+
***** {{d}} css: for css styles
**** {{f}} [[ged2gwb]], ged2gwb2, [[gwb2ged]] : base creation and extraction with GED format
+
***** {{d}} js: for JavaSrcipt programs
**** {{e}} [[gwc]], gwc1, gwc2, [[gwu]] : gwc to create a base, gwu to extract a .gw archive file
+
***** {{d}} modules: for [[templates#Personnalisation Modules|personnalisation]] modules
**** {{e}} [[gwd]] : the main GeneWeb server
+
***** {{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
**** {{e}} [[gwsetup]] : auxiliary server for base management
+
**** {{d}} lang: language files used in template construction such as [[lexicon]]s and starts file
**** {{d}} images  : icons used by gwd
+
***** {{f}} alias_lg.txt
**** {{d}} lang  : language files used in template construction
+
***** {{f}} lex_utf8.txt utf_8 version of the lexicon
**** {{f}} only.txt : access restriction for gwsetup
+
***** {{branche finale}}{{f}} lexicon_perso.txt private lexicon supplementing lex_utf8 (see -add_lexicon in [[gwd]])
**** {{d}} setup  : gwsetup template files
+
**** {{d}} setup: gwsetup template files
**** {{f}} tags.txt : list of authorized HTML tags
+
**** {{f}} a.gwf: standard version for the [[configuration|configuration parameters of a base]]
**** {{branche finale}}{{d}} update_nldb : update the [[cross links]] between notes and pages
+
**** {{e}} [[consang]]: tool to calculate consanguinity
*** {{s}} gwd.ext  : minimal launch script for gwd (file extension varies according to OS)
+
**** {{f}} [[ged2gwb]], ged2gwb2, [[gwb2ged]]: base creation and extraction with GED format
*** {{s}} gwsetup.ext  : minimal launch script for gwsetup (file extension varies according to OS)
+
**** {{e}} [[gwc]], gwc2, [[gwu]]: gwc to create a base, gwu to extract a .gw archive file
 +
**** {{e}} [[gwd]]: the main GeneWeb server
 +
**** {{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
 
*** {{f}} LIZEZMOI.txt
 
*** {{f}} LIZEZMOI.txt
Line 49: Line 45:
 
{{arbre fin}}
 
{{arbre fin}}
  
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.
+
{{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 choose to keep this organisation rather than maintaining a separate 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:46, 9 November 2018

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 uncompresssed into a folder whose structure is:

    • 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 choose to keep this organisation rather than maintaining a separate 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 cgi-bin/gwd.sh launch script and the gw link to the style and JavaScript files at the web_root.