Mercurial > mxd2map

annotate website/README @ 325:ebe500ec8a91

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update and clarify release instructions
author Andre Heinecke <aheinecke@intevation.de>
date Mon, 15 Oct 2012 11:42:28 +0200
parents dd4bb5869f86
children
rev   line source
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
1 ----------------------------------------------------------------------
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
2 MXD2map Web Site
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
3 ----------------------------------------------------------------------
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
4
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
5 INTRODUCTION:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
6
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
7 Getting the source:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
8
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
9 You can work on the website independently of the rest of MXD2map.
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
10 First check out the website from SVN repository:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
11
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
12 svn checkout svn+ssh://USER@svn.wald.intevation.org/MXD2map/trunk/doc/website
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
13
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
14 where USER is you name at wald.intevation.org.
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
15 If you are not a member of the MXD2map project at wald.intevation.org,
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
16 you can also checkout anonymously:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
17
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
18 svn checkout https://svn.wald.intevation.org/MXD2map/trunk/doc/website
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
19
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
20 but of course you can not update the official website www.MXD2map.org
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
21 this way.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
22
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
23
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
24 File organisation:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
25
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
26 The .html files are build from the *.htm4 files using GNU m4. The
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
27 *.htm4 files consist of mainly simple plain HTML and some macros
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
28 implementing the overall page layout.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
29
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
30 The structure of the .htm4 files should be rather self explaining.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
31
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
32
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
33 BUILDING:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
34
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
35 Building the web site is _not_ incorporated into the autotools based
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
36 build process.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
37 WARNING: you might need a latin1 locale for m4 to work correctly.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
38
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
39 To build to web sites use the file `buildhtml.mk':
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
40
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
41 make -f buildhtml.mk
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
42
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
43
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
44 INSTALLING:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
45
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
46 To install the generated web site you need a MXD2map docwriter or
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
47 developer account on wald.intevation.org.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
48
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
49 Installing is done from within the "doc/website" directory,
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
50 just type:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
51
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
52 make -f buildhtml.mk online
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
53
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
54 You will have to enter the ssh password of your account at wald.intevation.org.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
55
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
56 If you are interested on web site management on wald.intevation.org
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
57 in general, please read the online manual:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
58 http://wald.intevation.org/docman/view.php/1/34/project-websites.txt
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
59
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
60 If you need the website as offline version for some other
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
61 purposes just run:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
62
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
63 make -f buildhtml.mk tar
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
64
162
dd4bb5869f86 replaced mapWOC with MXD2map
Stephan Holl <stephan.holl@intevation.de>
parents: 159
diff changeset
65 After thar you have the file "www.MXD2map.org.tar.gz".
155
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
66
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
67 TEMPLATES:
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
68
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
69 template.m4 : Contains the definition of the main macros PAGE_START
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
70 and PAGE_BOXES as well as some helper macros normally
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
71 not used in the .htm4 files. Authors should not need to
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
72 change this file.
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
73
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
74 template_header.m4: Contains the actual page layout. This file is
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
75 included by `template.m4'. Authors should not
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
76 need to change this file, but if additional
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
77 languages are added the navigation must be added
5a882b5773c9 initial website.
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff changeset
78 in here.
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)