web: Add 3.1.3-beta20
[gpg4win.git] / README
1 ----------------------------------------------------------------------
2                            gpg4win Web Site
3 ----------------------------------------------------------------------
4
5 INTRODUCTION:
6
7 Getting the source:
8
9 You can work on the website independently of the rest of gpg4win.
10 First clone GIT repository:
11
12   git clone  git://git.gnupg.org/gpg4win.git
13
14 the switch to the web branch
15
16   git checkout website
17
18
19 File organisation:
20
21 The .html files are build from the *.htm4 files using GNU m4.  The
22 *.htm4 files consist of mainly simple plain HTML and some macros
23 implementing the overall page layout.
24
25 The structure of the .htm4 files should be rather self explaining.
26
27
28 BUILDING:
29
30 WARNING: you might need a latin1 locale for m4 to work correctly.
31
32 To build to web site do this:
33
34    cd web
35    make
36
37
38 INSTALLING:
39
40 To install the generated web site you need a gpg4win docwriter or
41 developer account on wald.intevation.org.
42
43 Installing is done from within the "web" directory,
44 just type:
45
46   make online
47
48 You will have to enter the ssh password of your account at wald.intevation.org.
49
50 If you are interested on web site management on wald.intevation.org
51 in general, please read the online manual:
52 http://wald.intevation.org/docman/view.php/1/34/project-websites.txt
53
54 If you need the website as offline version for some other
55 purposes just run:
56
57   make tar
58
59 After thar you have the file "www.gpg4win.org.tar.gz".
60
61 TEMPLATES:
62
63 versions.m4 : Definitions of some macros, holding the current versions
64               of gpg4win and the included software packages.  If any
65               version changes this file should be changed accordingly.
66               This file is included by `template_header.m4'.
67               The current version numbers of the packages installed by
68               gpg4win can be found here:
69               ftp://ftp.gpg4win.org/gpg4win/packages.current
70
71 template.m4 : Contains the definition of the main macros PAGE_START
72               and PAGE_BOXES as well as some helper macros normally
73               not used in the .htm4 files.  Authors should not need to
74               change this file.
75
76 template_header.m4: Contains the actual page layout.  This file is
77                     included by `template.m4'.  Authors should not
78                     need to change this file, but if additional
79                     languages are added the navigation must be added
80                     in here.