README

   1 Website generator for phpMyAdmin
   2 ================================
   3
   4 This is currently in alpha state, but later it will hopefully replace
   5 phpMyAdmin homepage.
   6
   7
   8 Requirements
   9 ------------
  10
  11 Python - http://www.python.org/
  12 (2.5 tested, other should work also)
  13 Genshi -  http://genshi.edgewall.org/
  14 (0.5.0 tested)
  15 python-feedparser - http://www.feedparser.org
  16 (4.1 tested)
  17 GitPython - http://gitorious.org/projects/git-python/
  18 (0.1.6 tested)
  19 polib - http://bitbucket.org/izi/polib/src/
  20 (0.5.1 tested)
  21
  22
  23 Security announcements
  24 ----------------------
  25
  26 To create a new security announcement, copy templates/security/_PMASA_ to
  27 templates/security/PMASA-YYYY-N and edit its contents.
  28
  29
  30 Page generating
  31 ---------------
  32
  33 All page has its own template. For most things it means inclusion of
  34 other templates to generate full page. These partial includes should be
  35 named with underscore as first character (eg. _page.tpl).
  36
  37 To add a new page, simply put a file named something.tpl to the templates
  38 directory and it will be automatically used as a template on next run.
  39
  40 All pages should at the end include _page.tpl to get layout and other
  41 common things. You can see example page at templates/_sample_.tpl
  42
  43 Static data required for generating pages is stored in data/ folder.
  44
  45 Menu
  46 ----
  47
  48 Menu is configured in data/menu.py, the first element always means page name
  49 (extension is added automatically) second menu item title.
  50
  51
  52 Themes
  53 ------
  54
  55 Themes require additional metadata, which is stored in data/themes.py.
  56
  57
  58 Awards
  59 ------
  60
  61 All awards are listed in data/awards.py.
  62
  63
  64 Screenshots
  65 -----------
  66
  67 All screenshots are listed in data/screenshots.py.
  68
  69
  70 Markup rules
  71 ------------
  72
  73 (See genshi docs for more details).
  74
  75 - $ is special char to indicate template variable, to escape it, use $$
  76 - comments which first char is ! (eg. <!--! comment -->) will not be in output
  77
  78
  79 Special pages
  80 -------------
  81
  82 Directory static contains some special pages, which have to be present
  83 on the website. First there is version.php script, which shows most
  84 current phpMyAdmin version, which is then offered as an update. The rest
  85 are currently just compatibility files with old website - security.php,
  86 which redirects security issues to new pages and _redirect.tpl which is
  87 used for generating redirects based on data/redirects.py.
  88
  89
  90 Generating website
  91 ------------------
  92
  93 The website itself is rendered using render.py, here are options which
  94 are currently used for http://www.phpmyadmin.net/home_page/:
  95
  96 ./render.py \
  97     --quiet \
  98     --server http://www.phpmyadmin.net \
  99     --base-url /home_page/ \
 100     --quiet-cache \
 101     --log render.log \
 102     --extension php
 103
 104 If you want to make log visible on website, copy it to output folder:
 105
 106 cp render.log output/
 107
 108 And finally rsync it to sourceforge:
 109
 110 rsync -az --delete output/ user,phpmyadmin@web.sourceforge.net:htdocs/home_page/
 111
 112 Automatic build
 113 ---------------
 114
 115 There is configured automatic build of website, which runs every hour.
 116 In case website is not updated, you might want to check the build log
 117 for any possible failures:
 118
 119 http://www.phpmyadmin.net/home_page/render.log
 120
 121 License
 122 -------
 123
 124 The website generator is licensed under GNU GPL version 2 or later.
 125
 126 Website itself uses mootools <http://mootools.net/>, slimbox
 127 <http://www.digitalia.be/software/slimbox>, fader and sorting_table
 128 <http://madhatted.com/2008/6/20/the-joy-of-tables-on-cows> which are
 129 licensed under terms of MIT license.
 130
 131 The website content is licensed under Creative Commons
 132 Attribution-Noncommercial-Share Alike 3.0 Unported License.
 133
 134 # vim: et ts=4 sw=4 sts=4 tw=72 spell spelllang=en_us