README 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. Directory Structure
  2. -------------------
  3. Contained in the repository:
  4. bin - contains the build scripts
  5. etc - Template Toolkit configuration
  6. lib - various include files for the templates and the site map used to generate
  7. the navigation menus
  8. src - the actual site content
  9. Generated:
  10. dest - the output of the build script (the finished website docroot)
  11. Build Requirements
  12. ------------------
  13. * expat library
  14. * Perl modules:
  15. * Template Toolkit
  16. * XML::XPath
  17. Debian: apt-get install expat libtemplate-perl libtemplate-plugin-xml-perl libxml-xpath-perl
  18. Building the Site
  19. -----------------
  20. To build manually:
  21. * cd into the directory containing this README file
  22. * run "bin/build"
  23. * The "dest" directory will be created if it doesn't exist, and the tree will be
  24. built there.
  25. To build from a cron job:
  26. * Same as above, but run "bin/build-exclusive.pl" instead, which does locking
  27. to ensure build jobs don't overlap.
  28. HTML files will be processed by Template Toolkit. This means you can use Template
  29. Toolkit directives in your pages for creative content or site-wide variables that
  30. you define in one of the config files. See http://www.template-toolkit.org/ for
  31. documentation.
  32. The main site look (banner, navigation, etc) is in lib/wrapper.tmpl
  33. Configuration Files
  34. -------------------
  35. Most config files are self-documenting. Read the comments in the files.