Trace:
This is an old revision of the document!
Table of Contents
Mini Tutorial ¶
The goal of this tutorial is to quickly show you how you can realize an application. To start, install Jelix as indicated on the installation page. We will consider that you are using the default configuration, then you didn't modify the tree structure of Jelix.
Jelix scripts ¶
After that, open a console and go to the lib/jelix-scripts/ directory.
under linux : cd lib/jelix-scripts/ under windows : cd lib\jelix-scripts\
This directory contains a script, jelix.php, which can make easy the creation and modification of different files of an application based on Jelix. You have to use it with the command line version of PHP and give it as parameter a Jelix command with some other parameters and options.
php jelix.php [--application_name] command_name [options] [parameters]
To avoid giving the name of the application for each command, use this one :
export JELIX_APP_NAME=helloapp set JELIX_APP_NAME=helloapp (windows)
Creation of an application ¶
Let's create the tree structure of the application using the createapp command :
php jelix.php createapp
You will then get a helloapp/ directory, at the same level as the lib/ directory. His content is the following :
helloapp/ modules/ the modules of your application plugins/ the plugins of your application var/config/ the configuration files of your application var/log/ the log files var/themes/ the different possible themes in your application var/overloads/ will contain the different files that will have redefined, from other modules. www/ the root of the site
Creation of a module ¶
A module gathers a whole of actions. At least one is necessary in an application. Let's create our first module “hello” :
php jelix.php createmodule hello
Here is the directory which has been created :
helloapp/modules/ hello/ the directory of the module module.xml file describing the identity of the module controllers/ the classes processing the actions default.classic.php a default controller classes/ your business classes and services daos/ the object-relational mapping files locales/ locales files ("properties files") en_EN/ fr_FR/ templates/ templates of the module zones/ objects processing specific zones in a page