templates/README

   1 File      : README      - This file
   2 Directory : doc         - Contains XSL for generating web pages from spec.xml and filter.xml
   3 Directory : web         - Contains all other web content
   4 File      : gen.pl      - Script which generates the web pages
   5 File      : wrapper.xsl - The HTML wrapper. The stuff that's common across all web pages
   6
   7 gen.pl does all the magic. Run it with no arguments to get a list of options. It takes the stylesheets wrapper.xsl, and those inside the "web" and "doc" directories and creates a website from them. You also tell it where to find spec.xml and filter.xml and it will create the documentation pages from that. Here are some examples:
   8
   9 ## Example 1:
  10
  11 ./gen.pl --latest 4.72 --web --tmpl ./ --docroot /var/www/
  12
  13 This copies all of the files from the "templates/web" directory into "/var/www/". When it comes across .xsl files, it generates html from them instead. For non .xsl files, if the last-modified timestamp of the file is the same as the one already in /var/www/ it's ignored.
  14
  15 ## Example 2:
  16
  17   ./gen.pl --latest 4.72 --spec specs/*/spec.xml --tmpl ./ --docroot /var/www/
  18
  19 If there are multiple spec.xml files in "specs/*/" for different versions of the documentation, this command will generate the appropriate webpages in /var/www-exim-html-$VERSION/. spec.xml contains the version number it's self, so it uses that in $VERSION
  20
  21 ## Example 3:
  22
  23   ./gen.pl --latest 4.72 --filter filter/*/filter.xml --tmpl ./ --docroot /var/www/
  24
  25 Pretty much the same as Example 2, except generates the filter documentation
  26
  27 ## Example 4:
  28
  29  ./gen.pl --latest 4.72 --web --spec specs/*/spec.xml --filter filter/*/filter.xml --tmpl ./ --docroot /var/www/
  30
  31 Combine all of the 3 examples above into a single command
  32
  33 All of the above examples make sure the exim-html-current symlink is kept in place. When a new version of Exim is released, we need to generate the new spec and filter documentation, and update the main web pages to reflect the new version number. That would be as simple as running a command like that in Example 4, with the latest version number, and just for the latest spec.xml and filter.xml files.
  34
  35 If you wanted to, for example, add a new link to the navigation bar on all pages, you would need to re-generate *all* web pages. This is a drawback of having a static website without frames. You would only need to edit one file though, specifically wrapper.xsl. Once that is done, you would run gen.pl with --web, --spec and --filter, providing the filter.xml and spec.xml files for every piece of online documentation.
  36
  37 --latest should always specify the current stable version of Exim. Even if you're generating documentation pages for an older version. The script needs to know what the current version of Exim is, as it is mentioned in several places on the website, and is also needed to create the correct symlink for exim-html-current.