QxTransformer Wiki

Create an application skeleton

Now you are ready to create a new application with qooxdoo and QxTransformer. Let's go!

Generate a skeleton


QxTransformer has a skeleton-generator script, which creating the basic structure of a QxTransformer application with all necessary files. Use the skeleton generator as a starting point for your new application.

1) Run a terminal (or Cygwin terminal on a Windows machine) and go to QxTransformer SDK directory

  cd path/to/qxtransformer/sdk/

2) Start the skeleton generator

     make generate-skeleton

3) Go through a wizard and specify parameters
   
    It looks like this:
   
    *****************************************************************************
  [QxTransformer]: Starting skeleton generator script...
  *****************************************************************************
 
  -----------------------MAIN PROPERTIES-----------------------------------------
   Please define main properties.
   Current dir: /home/someuser//projects/qxtransformer-0.3a1-sdk
  -------------------------------------------------------------------------------
   
    Current directory is QxTransformer SDK folder and all relative paths start from this folder.

     1)Path to new application: ../example
     2)Path to qooxdoo: ../qooxdoo-0.7.3-sdk
     3)Application namespace: Example
     4)qooxdoo version: 0.7
   -------------------------------------------------------------------------------
   
1) Path to the new application. Absolute or relative (starts from curret dir).
        2) Path to qooxdoo SDK. Absolute or relative.
        3) Namespace of the application. (APPLICATION_NAMESPACE property)
        4) Version of qooxdoo (You must use 0.7 instead of 0.7.3. It includes all branches of 0.7 version.)

        After you have given the necessary information,the script shows the generated folder structure:      

    Generate following folder's structure:

    Root: ../example
      -backend
        * define your folders under if you need
      -frontend
        -source
          -class
             example
             * define your packages under if you need
          -resource
          -translation
          -xml
            * add additional folders if you need
           index.html
         Makefile
   -------------------------------------------------------------------------------
      
       You also can define some important properties.

          Do you want define additional properties? (y/n):y
   
   -------------------------ADDITIONAL PROPERTIES---------------------------------
    Please define additional properties.
    If you want skip any property(will be used default value) input '-'.
   -------------------------------------------------------------------------------
      1)Application's locales (separated by space): en
      2)Application's files (separated by space): -
      3)Enable QxTransformer logging (y/n): y

       1) Locales of the application. Just leave with default value (type '-') if you have only one locale. Default value is en. (APPLICATION_LOCALES property)
       2) Files that will be copied from the source directory into the build directory. Default value is index.html. (APPLICATION_FILES property)
       3) Allows enabling progress output to console during transformation. Default value is false. (ECHO_ON property)

       The next section allows adding custom properties.

    Do you want define custom pairs PROPERTY_NAME=value? (y/n):y

    -------------------------NATIVE PROPERTIES-------------------------------------
     Please define custom pairs PROPERTY_NAME=value.
     This properties will be added to generated Makefile.
     For exit type ':q'.
    -------------------------------------------------------------------------------
    Enter PROPERTY_NAME=value : CUSTOM_QOOXDOO_PROPERY=somevalue
    Enter PROPERTY_NAME=value : :q

    Skeleton of application was successfully generated.
       For more details about makefile properties please see http://qooxdoo.org/documentation/0.7/makefile_defaults .


Now we have successfully generated a skeleton of application with the following folder structure:



See the next step: How to build a simple "Hello World" application.

  Sign in   Home   Sitemap   Terms   Report Abuse   Print  |  Powered by Google Sites