Admin/page/HOWTO
author haftmann
Mon, 06 Jun 2005 14:12:07 +0200
changeset 16301 f9f2e1643593
parent 15811 ef719c524227
permissions -rw-r--r--
migrated scripts to new webiste
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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.
15811
kleing
parents: 15810
diff changeset
     2
See the bottom of the file for a short overview of the setup.
kleing
parents: 15810
diff changeset
     3
kleing
parents: 15810
diff changeset
     4
== Changes to main ==
kleing
parents: 15810
diff changeset
     5
kleing
parents: 15810
diff changeset
     6
To make changes to the content of the main pages:
kleing
parents: 15810
diff changeset
     7
kleing
parents: 15810
diff changeset
     8
 * Edit or add the appropriate Admin/page/main-content/*.content files
kleing
parents: 15810
diff changeset
     9
 * Run "make clean main" in Admin/page/
kleing
parents: 15810
diff changeset
    10
 * Check generated html in Admin/page/main/
kleing
parents: 15810
diff changeset
    11
 * Check changes in main-content into cvs
kleing
parents: 15810
diff changeset
    12
 * Run "make pub-main" to publish to the Munich web site
kleing
parents: 15810
diff changeset
    13
 * Run "mirror-main" in Cambridge to synchronize
kleing
parents: 15810
diff changeset
    14
kleing
parents: 15810
diff changeset
    15
kleing
parents: 15810
diff changeset
    16
== Changes to dist ==
15810
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    17
15811
kleing
parents: 15810
diff changeset
    18
These should be rare and are a bit more involved at the moment. The
kleing
parents: 15810
diff changeset
    19
principle is the same as for the main pages, but the script needs
kleing
parents: 15810
diff changeset
    20
access to the distribution files to calculate sizes etc:
kleing
parents: 15810
diff changeset
    21
kleing
parents: 15810
diff changeset
    22
 * Edit or add the appropriate Admin/page/dist-content/*.content files
kleing
parents: 15810
diff changeset
    23
 * Make sure the Isabelle package files are available in directory Admin/page.
kleing
parents: 15810
diff changeset
    24
   On sunbroy2, the following does the trick (in directory Admin/page):
kleing
parents: 15810
diff changeset
    25
   
kleing
parents: 15810
diff changeset
    26
   ln -s /home/html/isabelle/html-data/dist/contrib
kleing
parents: 15810
diff changeset
    27
   for f in /home/html/isabelle/html-data/dist/*.tar.gz; do ln -s $f; done
kleing
parents: 15810
diff changeset
    28
 
kleing
parents: 15810
diff changeset
    29
 * Run "make clean dist" in Admin/page/
kleing
parents: 15810
diff changeset
    30
 * Check generated html in Admin/page/dist/
kleing
parents: 15810
diff changeset
    31
 * Check changes in dist-content into cvs
kleing
parents: 15810
diff changeset
    32
 * Run "make pub-dist" to publish to the Munich web site 
kleing
parents: 15810
diff changeset
    33
   (will only copy *.html files, will not update other distribution files)
kleing
parents: 15810
diff changeset
    34
 * Run "mirror-dist" in Cambridge and notify other mirrors to synchronize
kleing
parents: 15810
diff changeset
    35
kleing
parents: 15810
diff changeset
    36
kleing
parents: 15810
diff changeset
    37
== Overview ==
15810
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    38
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    39
The pages are separated into two sets:
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    40
 * main, for the main home page in Munich and Cambridge, and 
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    41
 * dist, for the current Isabelle distribution more widely mirrored.
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
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
    44
puts them into a common template.
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
This is supposed to achieve the following:
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    47
 * separation of layout and content
15811
kleing
parents: 15810
diff changeset
    48
 * automatic consistency between contents of distribution and web
kleing
parents: 15810
diff changeset
    49
   page, including name of the distribution, file sizes of download
kleing
parents: 15810
diff changeset
    50
   packages, and documentation generated from isabelle/Doc
15810
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    51
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    52
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
    53
support files:
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    54
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    55
Admin/page/DISTNAME   (name of the distribution, e.g. Isabelle2004)
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    56
Admin/page/Contents   (same as Distribution/doc/Contents at the time 
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    57
                       of the Isabelle release)
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    58
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    59
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
    60
the Isabelle distribution is generated and maintained manually in
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    61
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
    62
between releases Admin/page/Contents can be different from
2c119fed01f0 howto for changing web pages, simplified makefile access
kleing
parents:
diff changeset
    63
Distribution/doc/Contents)