Trace:

Differences ¶

This shows you the differences between two versions of the page.

--- en:tutorials:minitutorial:1.1.x [2009/01/03 00:09] – created laurent
+++ en:tutorials:minitutorial:1.1.x [2009/01/07 21:43] – bibo
@@ Line 1: / Line 1: @@
 ====== Mini Tutorial ======
-The goal of this tutorial is to quickly show you how you can develop an application with Jelix 1.1.
+The goal of this tutorial is to quickly show how you can develop an application with Jelix 1.1.
 ===== Download and installation =====
-First, [[en:download:stable:1.1#developer-edition|download the "developer" edition of Jelix]]. Jelix needs at least PHP 5.2.
+First, [[en:download:stable:1.1#developer-edition|download the "developer" edition of Jelix]]. Jelix requires at least PHP 5.2 (See [[en:manual-1.1:installation:requirements|here a detailed list of requirements]])
-Unarchive then the file you have downloaded, with your uncompress software. For example, with tar:
+Then, unpack the archive file you have downloaded, with your archiver software companion. For example, with tar:
 <code bash>
@@ Line 14: / Line 14: @@
 </code>
-After this, you have a directory @@F@jelix-1.1/lib/@@ in which there are all libraries used by jelix, and jelix itself.
+After this, you have a directory @@F@jelix-1.1/lib/@@ in which you'll find all libraries used by jelix, and jelix itself.
-For this tutorial, move the jelix-1.1 directory in the directory of your web site, so it will be accessible with a browser, at this URL for example: @@http://localhost/jelix-1.1/@@. (You can rename @@F@jelix-1.1/@@ as you wish).
+For the purpose of this tutorial, move jelix-1.1 folder in a directory of your web site. So that it will be accessible with a browser, at this URL for example: @@http://localhost/jelix-1.1/@@ (You can rename @@F@jelix-1.1/@@ as you wish).
 ===== Jelix scripts =====
-A script for command line, @@F@jelix.php@@, is available in the @@F@lib/jelix-scripts/@@ directory. This script allows you to create quickly some different files for your application. So open a console and go into this directory :
+A script for command line, @@F@jelix.php@@, is available in the @@F@lib/jelix-scripts/@@ directory. This script allows you to create quickly different files of your application. Open a console and go into this directory :
 <code bash>
@@ Line 27: / Line 27: @@
 </code>
-You have to use @@F@jelix.php@@ with the command line version of PHP and give it as parameter a Jelix command with some other parameters and options.
+You have to use @@F@jelix.php@@ with the command line version of PHP. this script requires, as parameter, a Jelix command. Each command defines a number of required parameters and options.
+To invoke a command :
 <code bash>
 php jelix.php --application_name command_name [options] [parameters]
+</code>
+To invoke help:
+<code bash>
+php jelix.php help // generic help, lists all commands available
+php jelix.php help command_name // specific command help
 </code>
-===== Creation of an application =====
+===== Application creation =====
-Let's create the tree structure of the application using the @@createapp@@ command. Our application will be named "example":
+Let's create the tree structure of your application using @@createapp@@ command. Suppose your application will be named "example":
 <code bash>
@@ Line 42: / Line 49: @@
 </code>
-You will then get a @@F@example/@@ directory, at the same level as the @@F@lib/@@ directory. Its content is the following :
+As a result, you'll get an @@F@example/@@ directory, at the same level as the @@F@lib/@@ directory. Its content wil be :
   example/
@@ Line 55: / Line 62: @@
-===== Creation of a module =====
+===== Module creation =====
-A module gathers a whole of actions. At least one is necessary in an application. This is why a module is created automatically when you run @@createapp@@ command.
+A module gathers a whole set of actions dispatched in controllers. At least one is necessary in an application. This is why a module is created automatically when you run @@createapp@@ command.
 Here is the directory which has been created:
@@ Line 76: / Line 83: @@
-If you want to create other modules later, you can use the @@createmodule@@ command:
+If you want to create other modules later, use @@createmodule@@ command :
 <code bash>
@@ Line 87: / Line 94: @@
 ===== First display =====
-Before to display the start page of your new application, you should put write access on some directories for the web server. This directories are @@F@temp/example@@ and @@F@example/var/log@@ :
+Before displaying the start page of your new application, you have to be sure your web server has write access to directories @@F@temp/example@@ and @@F@example/var/log@@ :
 For example, on linux (ubuntu or debian) :
@@ Line 96: / Line 103: @@
 </code>
-We are now ready to display the page. Your application is accessible at this URL: http://localhost/jelix-1.1/example/www/. Enter this URL in your browser. you should see:
+You are now ready for prime. Your application is accessible at this URL: @@http://localhost/jelix-1.1/example/www/@@. Enter this URL in your browser. you should see:
 {{en:tutorials:minitutorial:start_page_white_en.png}}
-You notice this message saying that a CSS file is missing. Copy the @@F@jelix-1.1/lib/jelix-www@@  directory in @@F@jelix-1.1/example/www@@  by renaming it to "jelix" (on a dedicated apache server, it is better to create an alias). This directory is important because it contains some files needed by jForms or other components.
+Noticed this message saying that a CSS file is missing ? Copy the @@F@jelix-1.1/lib/jelix-www@@  directory into @@F@jelix-1.1/example/www@@  by renaming it to "jelix" (on a dedicated apache server, it is better to create an alias). This directory is important because it contains some files needed by jForms or other components.
 Now you should see:
@@ Line 106: / Line 113: @@
 {{en:tutorials:minitutorial:start_page_en.png}}
-If there are some error messages in "installation check", fix them.
+If there are some error messages in the "installation check" section, fix them.
 ===== Implementing an action =====
-Let's implement a default action. An action is a process which generates a page. It is implemented as a method in a class called a "controller", and a controller can implement several actions. Open the @@F@example/modules/example/controllers/default.classic.php@@ file:
+Let's implement a default action. An action is a process which generates a page. It is implemented as a method in a class called a "controller". A controller can implement several actions.
+Open @@F@example/modules/example/controllers/default.classic.php@@ file:
 <code php>
@@ Line 128: / Line 137: @@
 </code>
-We state here that we retrieve a @@C@jResponseHtml@@ object throw the @@M@getResponse()@@ method because of the "html" type as it is indicated. Then we return it to indicate that its content must be returned to the browser.
+What this code means is that **index** action of **default** controller retrieves a @@C@jResponseHtml@@ object through the @@M@getResponse()@@ method by passing "html" as argument. After processing, the action returns this response thus indicating that its content must be returned to the browser.
-@@C@jResponseHtml@@ has a @@P@body@@ property, which is a @@C@jTpl@@ object. jTpl is a template engine provided by Jelix. In the controller, you see that the @@C@assignZone()@@ method is called. It says: get the content of the 'check_install' zone which is stored in the 'jelix' module, and put this content into the template variable named @@V@MAIN@@. You will see what is a zone later. 'Check_install' zone is a zone which show the main content of the start page. As we don't need it anymore, delete this line so you will have this in your controller:
+@@C@jResponseHtml@@ has a @@P@body@@ property, which is a @@C@jTpl@@ object. jTpl is a template engine provided by Jelix.
+In the action code above, you see a call to @@C@assignZone()@@ method. This means : get the content of the 'check_install' zone which is stored in the 'jelix' module, and assign this content to the template variable named @@V@MAIN@@ (You will see what is a zone in details later). 'Check_install' is a zone which shows results of install checkings. If those results are ok, you don't need it anymore. delete this line so you will have this in your controller:
 <code php>
@@ Line 146: / Line 157: @@
 ==== Response object ====
-The @@C@jResponseHtml@@ object generates a HTML response (a HTML page). It generates automatically the @@<head>@@ part of HTML, from some of its properties. Let's define the title of the page. Add this in the @@M@index()@@ method, before the return:
+a @@C@jResponseHtml@@ object generates an HTML response (an HTML page). It automatically generates the @@<head>@@ part of HTML, from some of its properties.
+Let's define the title of the page. Add this in the @@M@index()@@ method, just before returning the response object :
 <code php>
@@ Line 152: / Line 165: @@
 </code>
-Reload the page. The title of the page is now display in your browser title bar. But the page contains this:
+Reload the page. The page title should now correctly display in your browser title bar. But still your page contains this:
 {{en:tutorials:minitutorial:minituto_1_en.png}}
@@ Line 180: / Line 193: @@
 </code>
-@@{$MAIN}@@ is an instruction which says: display the content of the template variable named @@V@MAIN@@. @@{@jelix~jelix.newapp.h1@}@@ is an instruction which says: display the localized string (a string dependings of the lang) identified by the "jelix.newapp.h1" key and stored in the "jelix" module.
+@@{$MAIN}@@ is an instruction which says: display the content of the template variable named @@V@MAIN@@. {@jelix~jelix.newapp.h1@} is an instruction which says: display the localized string (a string which value depends on the lang) identified by the "jelix.newapp.h1" key and stored in the "jelix" module.
 The method @@M@doAfterActions@@ is called after each action. In the example, it assigns @@"<p>no content</p>"@@ to the MAIN template variable if this variable doesn't exist yet  (so, if it is not set by the action).

en/tutorials/minitutorial/1.1.x.txt · Last modified: 2012/04/15 08:36 by laurent