Website Section

PageGroup Section

The PageGroup section holds common information for a group of Pages. There can be multiple PageGroup sections in the Website section. The common content items fall into two categories: attributes and subsections. The following subsections can be defined within a PageGroup section:

• SubTagGroup

• PagePart

• PageOrder

• Theme

Attributes will be discussed first. Table 3-2 lists the PageGroup attributes.

* Can be overridden in PageParts and Pages. If part_dir is not specified, source_dir will be used for PageParts.

** Can be overridden in Pages.

*** The filename is optional when the Timestamp format is requested. But even if one is given, no data is stored in it. When the Timestamp format is requested, only the source pages have bearing on the update process. This means changing SubTags, Depends, or other entities that would normally be tracked, will not have there state cached.

The include_tagname subtag is used to specify a tag name for including a file during the make process. For instance:

  include_tagname    "include(%s)"

The specified tag name requires the characters "%s" somewhere in the string to represent the name of the file to be included. This means that for every occurrence in the source where the string "include(" is found, with some filename text and a ")" after it, Wsmake will replace it with the contents of the filename given:

This is HTML. Now a file will be included:
include(/web/include.txt).
    

This will take the entire string "include(/web/include.txt)" and replace it with the contents of the file /web/include.txt. The start and stop string before and after the filename is required.

If the filename doesn't begin with a '/' character, the file is first looked for relative to the source file that is being parsed, and the in the directory defined by include_dir, if specified. Globs, however, are only looked for relative to the source file.

The subtag_format definition can be used to abstract a common part of all subtags so that you can define them without the common part. For example, if every SubTag you use on a website is of the form:

`subtag`
    

Then you can specify a ssubtag_format of:

subtag_format "`%s`"
    

Then when you specify SubTags, it is not necessary to include the extra information in the subtag_format:

SubTag "test" "here is the value"
    

With the subtag_format definition above, Wsmake will look for `test` when it parses the source data.

As in the Website section, the include files will be looked for relative to the configuration file if not prefixed with a '/'. The same is true for the depend attribute.

PageGroup {
  database_filename      "website.db"
  lastmod_tagname        "`LASTMOD`"
  wsmake_version_tagname "`WSMAKEVERSION`"
  web_path_tagname       "`FILEPATH`"
  source_tagname         "`FILESOURCE`"
  output_tagname         "`FILEOUTPUT`"
  include_tagname        "include(%s)"
  header_tagname         "`CGI_HEADER`"
  footer_tagname         "`CGI_FOOTER`"
  source_dir             "/web/source"
  output_dir             "/web/docs"
  part_dir               "/web/templates"
  include_dir            "/web/includes"
  command                "myparser.pl"
  options                "<%i >%o"
  depend                 "pagegroups.ws"
  include                "pages.ws"
}
     

SubTagGroup {
  name "default"
  SubTag "`EMAILLNK`" "<a href=\"mailto:`EMAIL`\">`EMAIL`</a>"
  SubTag "`EMAIL`"    "mike@wsmake.org"
  SubTag "`FONTFACE`" "Arial, Helvetica"
  SubTag "`HOST`"     "http://wsmake.org/~mike/"
}
      

PagePart {
  name      "header"
  filename  "header.html"
  directory "templates"

  SubTag    "`INFO`" "Header piece"

  subtaggroup "default"
  parse     YES
}
      

PageOrder {
  name "default"
  part "header"
  data
  part "footer"
}
      

Theme {
  name "home"
  SubTag "`SECTION`" "Home"
  subtaggroup "home"
  pageorder "home"
}
      

Page Section

The Page section defines a Page on the website. Each Page represents an item to be "made" by the make process. The following attributes can be defined in a Page section:

** Either web_page or source_page may be defined. They are both considered the same. It may be more readable to use web_page if both the source_page and output_page are the same value.

There can only be one web_page/source_page, source_dir, output_dir, page_type, parse, cgi_header, and cgi_footer definition for each Page. When the page_type is CGI, the output of the header and footer information (if any) goes to the files defined by cgi_header and cgi_footer. If cgi_header or cgi_footer is not defined, "header.html" or "footer.html" is used as a default, respectively.

For options, '%i' is replaced by the full path to the wsmake parsed source file and '%o' is replaced by the full path to the output file at make time. Other options are '%s', the full path to the source file, '%w' the web path of the page, '%ds', the full path to the directory of the source file, '%do', the full path to the directory of the output file. If options is not specified, but the command is, the default options from the PageGroup section are not used.

Page {
  web_page   "index.html"
  source_dir "html"
  output_dir "docs"

  SubTag "`FONTFACE`" "Courier"

  subtaggroup "default"
  pageorder   "default"

  page_type   NORMAL
  parse       YES
}