emanuel@155: ----------------------------------------------------------------------
stephan@162:                            MXD2map Web Site
emanuel@155: ----------------------------------------------------------------------
emanuel@155: 
emanuel@155: INTRODUCTION:
emanuel@155: 
emanuel@155: Getting the source:
emanuel@155: 
stephan@162: You can work on the website independently of the rest of MXD2map.
emanuel@155: First check out the website from SVN repository:
emanuel@155: 
stephan@162:   svn checkout svn+ssh://USER@svn.wald.intevation.org/MXD2map/trunk/doc/website
emanuel@155: 
emanuel@155: where USER is you name at wald.intevation.org.
stephan@162: If you are not a member of the MXD2map project at wald.intevation.org,
emanuel@155: you can also checkout anonymously:
emanuel@155: 
stephan@162:   svn checkout https://svn.wald.intevation.org/MXD2map/trunk/doc/website
emanuel@155: 
stephan@162: but of course you can not update the official website www.MXD2map.org
emanuel@155: this way.
emanuel@155: 
emanuel@155: 
emanuel@155: File organisation:
emanuel@155: 
emanuel@155: The .html files are build from the *.htm4 files using GNU m4.  The
emanuel@155: *.htm4 files consist of mainly simple plain HTML and some macros
emanuel@155: implementing the overall page layout.
emanuel@155: 
emanuel@155: The structure of the .htm4 files should be rather self explaining.
emanuel@155: 
emanuel@155: 
emanuel@155: BUILDING:
emanuel@155: 
emanuel@155: Building the web site is _not_ incorporated into the autotools based
emanuel@155: build process.
emanuel@155: WARNING: you might need a latin1 locale for m4 to work correctly.
emanuel@155: 
emanuel@155: To build to web sites use the file `buildhtml.mk':
emanuel@155: 
emanuel@155:   make -f buildhtml.mk
emanuel@155: 
emanuel@155: 
emanuel@155: INSTALLING:
emanuel@155: 
stephan@162: To install the generated web site you need a MXD2map docwriter or
emanuel@155: developer account on wald.intevation.org.
emanuel@155: 
emanuel@155: Installing is done from within the "doc/website" directory,
emanuel@155: just type:
emanuel@155: 
emanuel@155:   make -f buildhtml.mk online
emanuel@155: 
emanuel@155: You will have to enter the ssh password of your account at wald.intevation.org.
emanuel@155: 
emanuel@155: If you are interested on web site management on wald.intevation.org
emanuel@155: in general, please read the online manual:
emanuel@155: http://wald.intevation.org/docman/view.php/1/34/project-websites.txt
emanuel@155: 
emanuel@155: If you need the website as offline version for some other
emanuel@155: purposes just run:
emanuel@155: 
emanuel@155:   make -f buildhtml.mk tar
emanuel@155: 
stephan@162: After thar you have the file "www.MXD2map.org.tar.gz".
emanuel@155: 
emanuel@155: TEMPLATES:
emanuel@155: 
emanuel@155: template.m4 : Contains the definition of the main macros PAGE_START
emanuel@155:               and PAGE_BOXES as well as some helper macros normally
emanuel@155:               not used in the .htm4 files.  Authors should not need to
emanuel@155:               change this file.
emanuel@155: 
emanuel@155: template_header.m4: Contains the actual page layout.  This file is
emanuel@155:                     included by `template.m4'.  Authors should not
emanuel@155:                     need to change this file, but if additional
emanuel@155:                     languages are added the navigation must be added
emanuel@155:                     in here.