Contents

1. Check out Getting Started page first
2. Understand How it is put together
3. Template Tag References
4. Expression Evaluation
5. Supported Content Format
6. Server Mode
7. Site Testing

Expression Evaluation

The expressions in the template are all evaluated by invoking the method on the site specification object, or in Ruby term, sending the message back to the site specification. When defining the method, it can take the path of the content file as the optional argument.

The following code demostrate how you can evaluate the expression “index_file?“

class MySiteSpec < BuildMaster::SiteSpec
#  ...

  def index_file?(content_path)
    return content_path =~ /index/
  end
  
#  ...
end

Content Format Support

BuildMaster supports different content file formats for people who enjoy Wiki style editing more than HTML. Current supported formats are:

• XHTML
• Textile
• Markdown

Server Mode

You need to have Webricks in your ruby environment, which is installed as part of the One-Click Ruby Installer on windows

Ideally, you would like something WYSIWYG, in the case where there are not enough bandwidth to do everything, we settle for the next best thing.

With the site spec file written (see Getting Started), you can launch a small webserver through command

ruby sitespec.rb server

Now, you can connect to this server using your browser at URL: http://localhost:2000

Because this HTTP server is being backed at the same engine as the site builder, it can convert the files on the fly, as well as serving the other resource files. This means that you can use any of your favorite editor to modify the files, swich back to browser, and refresh the browser to see the result changes that you have just made.

Site Testing

You need to have Watir in your Ruby environment.

As the number of the files grows bigger, it is hard to make sure that all of them are linked to each other and that the external links are still valid. BuildMaster has a easy class SiteTester that can crawl through the site, with the help of Watir, and test all the links for you.

With the site spec file written (see Getting Started), you can start the test through command

ruby sitespec.rb test

If you are not online (which is 80% of the cases when the documentation of this project is being written), you can tell your test to only test the local links:

ruby sitespec.rb test_offline

Other Site Testing

If you are not using BuildMaster to build your website but still want to check if there any broken link, you can do it by creating a ruby file with following content:

This is useful for you to run test against your website to make sure all the links are working.

require 'buildmaster'
BuildMaster::SiteTester.test('http://buildmaster.rubyforge.org')