Sitetool

DESCRIPTION

Sitetool is a CMS that should work with (or without) the autotools.

The project should aid developers building their projects web-sites without having to write HTML directly (or via strange machineries) while having a "coding" approach to the generation of their contents.

Sitetool content production is divided in two layers: backend and frontends.

The backend is the lower layer, it decouples the different frontends using SXML as common format.

Frontends form the upper layer, each frontend translates a content from its format to the backend format using a chain of filters. Filters chains are automatically formed (or manually specified) in order to transform each content from its input format to the backend format.

Filters

A filter is nothing more than a program which takes an input file and traslates it to an output file, usually in a different format. Sitetool comes with a set of filters:

Examples:

In order to use third-party filters or your own filters, the sitetool-config script should be used to find the filters installation directory:

     Usage: sitetool-config [OPTIONS]

     OPTIONS:
	[-h|--help]
	[--version]
	[--filters-dir]
	[--styles-dir]

Simply place additional filters into the filters directory: cp my-filter `sitetool-config --filters-dir`

Use

Sitetool is composed by a bunch of utilities. Each utility could be invoked manually or by the main program sitetool via the --mode option. The main program invocation has the advantage of handling the inter-utility dependencies automatically.

The complete input file grammar is available.

A common set of parameters is available to each utility.

     Usage: sitetool [OPTION]... [-- [MODE-ARG]...]

     Options:
	-M, --mode=MODE            Running mode is MODE

     [COMMON-PARAMETERS]

Current available modes are:

parse
     Usage: sitetool-parse [OPTIONS]

	    -i, --input=FILE            use FILE as input file
	    -o, --output=FILE           use FILE as output file

     [COMMON-PARAMETERS]
initialize
     Usage: sitetool-initialize [OPTIONS]

	    -w, --work-dir=DIR          working directory is DIR
	    -o, --output-dir=DIR        output directory is DIR

     [COMMON-PARAMETERS]
clean
     Usage: sitetool-clean [OPTIONS]

	  -c, --configuration=FILE    configuration file is FILE
	  -w, --work-dir=DIR          use DIR as a working directory
	  -o, --output-dir=DIR        place output into directory DIR

     [COMMON-PARAMETERS]
build
     Usage: sitetool-build [OPTIONS]

	    -c, --configuration=FILE    configuration file is FILE
	    -w, --work-dir=DIR          use DIR as a working directory
	    -o, --output-dir=DIR        place output into directory DIR

    [COMMON-PARAMETERS]
check
     Usage: sitetool-check [OPTIONS]

	    -c, --configuration=FILE    configuration file is FILE
	    -o, --output-dir=DIR        use DIR as output directory

    [COMMON-PARAMETERS]
digest
     Usage: sitetool-digest [OPTIONS]

	    -c, --configuration=FILE    configuration file is FILE
	    -o, --output-dir=DIR        use DIR as output directory

    [COMMON-PARAMETERS]
preprocess
     Usage: sitetool-preprocess [OPTIONS]

	    -D, --define=VAR=VALUE      define variable VAR to value VALUE
	    -U, --undefine=VAR          undefine variable VAR
	    -i, --input=FILE            use FILE as input file
	    -o, --output=FILE           use FILE as output file

    [COMMON-PARAMETERS]
validate
     Usage: sitetool-validate [OPTIONS]

	    -c, --configuration=FILE    configuration file is FILE
	    -o, --output-dir=DIR        use DIR as output directory

    [COMMON-PARAMETERS]

COPYING

Sitetool is licensed under the GNU General Public License, version 2

MAINTAINERS

Francesco Salvestrini <salvestrini AT gmail DOT com>

AUTHORS

Francesco Salvestrini <salvestrini AT gmail DOT com>
Alessandro Massignan <ff0000 DOT it AT gmail DOT com>

RELEASES

Sorry, no public release available at the moment.

MAILING LISTS

Sitetool has a single moderated mailing list, with an archive. In order to post a message to the mailing list you must be subscribed. Please consult the Sitetool mailing list page for more information on subscribing to the mailing list.

REPORT A BUG

If you think you have found a bug in Sitetool then please send as complete a report as possible to <sitetool AT nongnu DOT org>. An easy way to collect all the required information, such as platform and compiler, is to include in your report the config.log file available at the end of the configuration procedure.

If you have a patch for a bug in Sitetool that hasn't yet been fixed in the latest repository sources, please be so kind to create it using the repository sources, not the release sources.

DEVELOPMENT

Browsing sources

You can browse the Git repository of this project with your web browser. This gives you a good picture of the current status of the source files. You may also view the complete histories of any file in the repository as well as differences among two versions.

Getting a copy of the Git Repository

Anonymous checkout: git clone git://git.savannah.nongnu.org/sitetool.git

Contribute

If you have time and programming skills, you can help us by developing missing features, regression tests or bug-fixing the present codebase. Subscribe to the mailing list, drop us a mail and start coding. Send your code to the mailing list under the form of patches for the current revision system.

If you have time but no programming skills, you can help with documentation, packaging, tests before releases etc ...