README

   1 * Quick intro
   2 To create a website using shweb:
   3
   4 shweb <site-pre> <site-pos>
   5
   6 This will process the directory tree bellow site-pre and create a site in
   7 <site-pos>. After this, if you make <site-pos> the root directory of your web
   8 server, everything should work.
   9
  10 * File structure
  11 shweb works directly on the directory structure whithout any type of
  12 configuration files. The type of every file that is found below <site-pre>, as
  13 determined by the it's extension, is used to decide which action should be
  14 performed on the file. Every file that is of an unrecognized type is copied as
  15 is to the destination website. As to files that are recognized, the result of
  16 the processing is placed in the <site-pos> in the same name relative place it
  17 was in <site-pre>, only with the extension changed to htm.
  18
  19 Currently the following file types are recognized:
  20         - bwh: content is put in the "content" section of a webpage with header,
  21           menu and footer.
  22         - No more file types are recognized at the moment.
  23
  24 * Templates
  25 Currently templates are used for the header, footer and stylesheet files. The
  26 default templates are in /usr/share/shweb/templates/default folder. User
  27 templates can be used with the -t option.
  28         - header.htm: is placed as is in the begining of the body section of the htm
  29           file.
  30         - footer.htm: is placed as is in the end of the body section of the htm file.
  31         - style.css: is copied to <site-pos> and used as the stylesheet.
  32
  33 * Index files
  34 Index files are special because they do not apear in the menus. By default,
  35 every file whose name in <site-pos> is index.htm is considered an index file.
  36
  37 The index file name can be configured with the option -i.
  38
  39 * Navigation Menu
  40 A navigation menu is created automatically for some pages.
  41 The menu only contains links to folders and files that result in htm files in
  42 <site-pos>, with the exception of index files.