Documentation

Cyclone3 consists of many modules and parts. Every part should have documentation but currently we are rewriting most of the documentation to a new standard and English language is it still has many parts missing. We are filling in updated documentation daily directly from code comments or docbook documents.

What can I do when I'm missing crucial documentation?

You have more choices. First you can directly contact developers and ask them your question. Or you can post your request for missing documentation, submit your own comment at that page or you can help write documentation yourself.

Main documentation articles are available in multiple languages but source code documentation is strictly English.

What is Cyclone3?

Cyclone3 is flexible open source framework designed to develop content management systems, custom intranet applications. Cyclone3 was originally a proprietary framework used for commercial purposes for almost 7 years. Read more.

How to start with Cyclone3?

Before you start installing Cyclone3 please try our demo. If you decide to give Cyclone3 a try please read how to install Cyclone3 Framework. After Installation you will probably want to read our guide on how to setup and create new domain service which is in most cases a web page.

Documented parts of Cyclone3

This section summarises Cyclone3 documentation from the developers point of view.

Cyclone3 Framework

Framework is the main part of the Cyclone3 project. It is written exclusively with Perl. The documentation consists of documented standard libraries and default Cyclone3 services (eg. web portals)

Cyclone3 XULadmin

Cyclone3 XULadmin is the first open source content management GUI built upon Mozilla Application Framework - it is the interface for Cyclone3 content management features based on XUL, JavaScript and AJAX technologies (flash video)