• Home
  • News
  • Usage guide
  • Download
  • Development
  • Samples
  • FAQ
  • English
  • Romana

staticxjam usage guide

This document explains the basic usage of a simple static web site generation program named staticxjam. staticxjam is writen in java and should be able to run on all platforms that support java. You might be curious what does the name mean. Also, you must know your html.

Why use it?

Actually you are not expected to use it since it is basically a tool for the author. I use it to generate my website.

The reasons in using this tool could be:

  • Your server doesn't have any dinamic support(php, jsp,etc).
  • Your server doesn't support includes
  • You are tired of copy-pasting the same copyright info and menu to every page
  • Your site is written in more than one language and keeping track of independent files is hard.

What does it do?

Very shortly, it does the following:

  • Allows you to define unique copyright, menu and header files. There will be used for the generation of the rest of the site. Automatically the copyright will be placed at the end of the contents, the menu at the beginnig and the header in it's proper place.
  • Automatically generates files for every language. Files have tags like this:
    <lang>
    	<en>
    		English paragraph here.
    	</en>
    	<de>
    		German paragraph here.
    	</de>
    </lang>
    
    and thus it's a lot easyer to keep track of every translation.
  • All input files are XML so you get XHTML compliance for free.
  • Allows references between site files and generates relative links. This means that you may move the site with no problem from a server / folder to another.
    	We are in site://project/link.html and
    	<link ref='site://school/a.html'>go<link> becomes
    	<a href='../school/a.html'>go<a>
    

Examples

Plese note that the xml sources for the files you are reading now should be next to the xjam files. You might look there after you read the samples..

Let's proceed to some samples.

This file is copyrighted (C) 2004 by Emilian Bold under the GNU Free Documentation License.

This file was generated using xjam.

Many thanks to Patrick Riley (SIMS, U.C. Berkeley)

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

Thanks to sourceforge for the hosting.