author | kleing |
Fri, 22 Apr 2005 02:03:52 +0200 | |
changeset 15810 | 2c119fed01f0 |
child 15811 | ef719c524227 |
permissions | -rw-r--r-- |
15810
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
1 |
This file describes how to change and regenerate the Isabelle web pages. |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
2 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
3 |
= Overview = |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
4 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
5 |
The pages are separated into two sets: |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
6 |
* main, for the main home page in Munich and Cambridge, and |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
7 |
* dist, for the current Isabelle distribution more widely mirrored. |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
8 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
9 |
Both are generated by a script (genpage) that takes *.content files and |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
10 |
puts them into a common template. |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
11 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
12 |
This is supposed to achieve the following: |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
13 |
* separation of layout and content |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
14 |
* automtic consistency between contents of distribution and web page, |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
15 |
including name of the distribution, file sizes of download packages, |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
16 |
and documentation generated from isabelle/Doc |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
17 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
18 |
For this the web page generation script needs access to the following |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
19 |
support files: |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
20 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
21 |
Admin/page/DISTNAME (name of the distribution, e.g. Isabelle2004) |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
22 |
Admin/page/Contents (same as Distribution/doc/Contents at the time |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
23 |
of the Isabelle release) |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
24 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
25 |
Both files are set to the right values automatically by makedist when |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
26 |
the Isabelle distribution is generated and maintained manually in |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
27 |
between releases by the release manager in Admin/page in CVS. (In |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
28 |
between releases Admin/page/Contents can be different from |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
29 |
Distribution/doc/Contents) |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
30 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
31 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
32 |
= Changes to main = |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
33 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
34 |
To make changes to the content of the main pages: |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
35 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
36 |
* Edit or add the appropriate Admin/page/main-content/*.content files |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
37 |
* Run "make clean main" |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
38 |
* Check generated html in Admin/page/main/ |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
39 |
* Check into cvs |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
40 |
* Run "make pub-main" to publish to the Munich web site |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
41 |
* Run "mirror-main" in Cambridge to synchronize |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
42 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
43 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
44 |
= Changes to dist = |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
45 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
46 |
These should be rare and is a bit more involved at the moment. The |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
47 |
principle is the same as for the main pages, but the script needs |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
48 |
access to the distribution files to calculate sizes etc: |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
49 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
50 |
* Edit or add the appropriate Admin/page/dist-content/*.content files |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
51 |
* Make sure the Isabelle package files are available in directory Admin/page. |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
52 |
On sunbroy2, the following does the trick: |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
53 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
54 |
ln -s /home/html/isabelle/html-data/dist/contrib |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
55 |
for f in /home/html/isabelle/html-data/dist/*.tar.gz; do ln -s $f; done |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
56 |
|
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
57 |
* Run "make clean dist" |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
58 |
* Check generated html in Admin/page/dist/ |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
59 |
* Check into cvs |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
60 |
* Run "make pub-dist" to publish to the Munich web site |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
61 |
(will only copy *.html files, will not update other distribution files) |
2c119fed01f0
howto for changing web pages, simplified makefile access
kleing
parents:
diff
changeset
|
62 |
* Run "mirror-dist" in Cambridge and notify other mirrors to synchronize |