Document Information

Last modified:
2011/02/22 12:31 (external edit)

This is documentation for qooxdoo 0.7.x only. You might be interested in consulting the latest docs.

Makefile defaults

The variables in the Makefile come in the form of key=value pairs. Default values are given for most variables. After setting a variable you can later refer to its value using the $(<variable_name>) syntax. See below.

(How is this list compiled? See here).


(version 11904)

REQUIRED SETTINGS

QOOXDOO_PATH

default: PLEASE_DEFINE_QOOXDOO_PATH

Path to the folder of your qooxdoo distribution. Can either be a) a relative path to the location of this Makefile (preferred) or b) an absolute path starting at the root of your file system Example: If you put the skeleton folder next to the qooxdoo SDK folder, you can use the following relative path: QOOXDOO_PATH = ../qooxdoo-0.6.5-sdk Please note that Windows users should always use relative paths. It should end with the last directory. Please omit a trailing slash.

APPLICATION_NAMESPACE

default: custom

Namespace of your application e.g. custom Even complexer namespaces are possible like: net.sf.custom

BASIC SETTINGS

APPLICATION_CLASSNAME

default: Application

Full application classname

QOOXDOO_URI

default: ../$(QOOXDOO_PATH)

Similar to QOOXDOO_PATH, but from the webserver point of view. Starting point is now the application HTML file in the source folder (source/index.html by default). In most cases just prepend a "../" to QOOXDOO_PATH from above. Example: QOOXDOO_URI = ../../qooxdoo-0.6.5-sdk The assigned value should end in a directory name. Please omit trailing slashes.

APPLICATION_NAMESPACE_PATH

default: $(shell echo $(APPLICATION_NAMESPACE) | sed s:\\.:/:g)

Namespace defined as a directory path. Even complexer stuff is possible like: net/sf/custom Normally the namespace given will be automatically translated.

APPLICATION_ID

default: $(APPLICATION_NAMESPACE)

ID of your application. Should be one word (just characters and numbers) Also used for the filename of your compiled Adobe AIR application Default is identical to your custom namespace.

APPLICATION_TITLE

default: $(APPLICATION_ID)

Title used in your API viewer or AIR application Default is the uppercase variant of your normal title.

APPLICATION_MAKE_TITLE

default: $(shell echo $(APPLICATION_TITLE) | tr "[:lower:]" "[:upper:]")

Title used during the make process. Default is the uppercase variant of your normal title.

APPLICATION_VERSION

default: 1.0

Version of your application e.g. 0.1

APPLICATION_DESCRIPTION

default: qooxdoo (http://qooxdoo.org) powered $(APPLICATION_TITLE) application

Description of your application

APPLICATION_COPYRIGHT

default:

Copyright of your application

APPLICATION_WIDTH

default: 950

Width of your application window (using Adobe AIR)

APPLICATION_HEIGHT

default: 600

Height of your application window (using Adobe AIR)

APPLICATION_ICON_PATH

default: $(FRAMEWORK_SOURCE_PATH)/resource/icon/Nuvola

Icon path where icons of sizes 16, 32, 48 and 128 stored (each in a folder of the size)

APPLICATION_ICON

default: apps/office-organizer.png

Icon to use for the application. Relative to icon path defined, too.

APPLICATION_FILES

default:

Files that will be copied from the source directory into the build directory (space separated list). The default list is empty.

APPLICATION_LOCALES

default:

Locales to use (space separated list) To set a specific locale like "en_US" the generic locale "en" has to be added as well Example: APPLICATION_LOCALES = en en_US de de_DE es

APPLICATION_HTML_TO_ROOT_URI

default: .

Defines the position of the HTML/PHP etc. file used to include your application JavaScript code in relation to root directory. The root directory meant here is your source or build directory. Even if we this is about directories all the time, this setting configure the URI and not a file system path. If your HTML file is placed directly in source/build you can simply use the default "." (without quotation) here. If your HTML file is placed in source/html/page.html you can configure this setting to "../" (without quotation) for example.

SILENCE

default:

SILENCE

default: @

By default the complete command line of the called programs is hidden. Setting VERBOSE to true shows the complete commands.

GENERATOR OPTIONS

APPLICATION_COMPLETE_BUILD

default: false

Whether all JavaScript files of only the files needed by the application should be included into the build version of the program.

APPLICATION_COMPLETE_SOURCE

default: true

APPLICATION_COMPLETE_API

default: true

Whether all JavaScript files of only the files needed by the application should be included into the source version of the program.

APPLICATION_LINEBREAKS_BUILD

default: true

Customize line break settings If enabled line breaks are inserted into the compiled application. This makes the generated code better readable and produces saner error messages, but bigger, too.

APPLICATION_LINEBREAKS_SOURCE

default: true

Customize line break settings If enabled line breaks are added to the loader script of the source version.

APPLICATION_OPTIMIZE_STRINGS

default: true

Enables string optimization for the build version. String optimization gives a perforcmance boost on the Internet Explorer 6, obfuscates the code and may reduce the size. This should always be enabled for deployment versions.

APPLICATION_OPTIMIZE_VARIABLES

default: true

Renames local variables to shorter names for the build version. This option reduces the code size and obfuscates the code. Warning: If local variable names are used inside of "eval" statement this may break the code.

APPLICATION_OPTIMIZE_BASE_CALL

default: true

Inlines calls to "this.base(arguments)" to speed up calls to the super class. It is safe to enable this setting.

APPLICATION_OPTIMIZE_PRIVATE

default: false

Renames private methods and fields (methods/fields starting with "__") to shorter names. This makes it impossible for other classes to call private methods because the new names of the private members is unknown outside the class. This setting obfuscates the code and can help to enforce the privacy of methods.

APPLICATION_OBFUSCATE_ACCESSORS

default: false

This setting obfuscates the code

APPLICATION_OPTIMIZE_BROWSER

default: false

If enabled optimized builds for each supported browser given in APPLICATION_INDIVIDUAL_BROWSERS and a generic loader script are generated. This increases the time to build the application but optimizes both code size and runtime of the application.

APPLICATION_INDIVIDUAL_BROWSERS

default: gecko mshtml opera webkit

Individual browsers that an optimized build is generated for, if APPLICATION_OPTIMIZE_BROWSER is enabled.

APPLICATION_OPTIMIZE_REMOVE_DEBUG

default: true

Remove debug code. This sets the variant qx.debug to "off" and removes all code paths for qx.debug "on". Production code should set this always to true, because qooxdoo uses extensive runtime checks, which will be disabled by this setting.

APPLICATION_OPTIMIZE_REMOVE_COMPATIBILITY

default: false

Remove compatibility for qooxdoo 0.6 style class declarations.

APPLICATION_OPTIMIZE_REMOVE_ASPECTS

default: true

Remove AOP support

APPLICATION_ENABLE_GUI

default: true

Configure if support for widgets should be included If enabled qooxdoo initializes the whole widget and event stack. Disable this if you don't need the qooxdoo widgets but want to use only the core functionality of qooxdoo (e.g. RPC, Ajax, DOM, XML, …)

APPLICATION_RESOURCE_FILTER

default: false

Configure resource filter If enabled all application classes needs a embed configuration, too.

APPLICATION_INCLUDES

default: false

List of directories containing contributions or external projects to include code from. Additionally qooxdoo-contrib includes can be used by using the following URL scheme: contrib:ProgressBar/0.1</note> ===== RUNTIME SETTINGS ===== ==== APPLICATION_THEME ==== default: qx.legacy.theme.ClassicRoyale <note> Set the default meta theme.</note> ==== APPLICATION_THEME_COLOR ==== default: <note> Set the default color theme.</note> ==== APPLICATION_THEME_BORDER ==== default: <note> Set the default border theme.</note> ==== APPLICATION_THEME_FONT ==== default: <note> Set the default font theme.</note> ==== APPLICATION_THEME_ICON ==== default: <note> Set the default icon theme</note> ==== APPLICATION_THEME_WIDGET ==== default: <note> Set the default widget theme</note> ==== APPLICATION_THEME_APPEARANCE ==== default: <note> Set the default appearance theme.</note> ==== APPLICATION_SOURCE_LOG_LEVEL ==== default: debug <note> Set the default log level for the source version</note> ==== APPLICATION_BUILD_LOG_LEVEL ==== default: debug <note> Set the default log level for the build version</note> ==== APPLICATION_SOURCE_LOG_APPENDER ==== default: qx.legacy.log.appender.Native <note> Set the default log appender for the source version</note> ==== APPLICATION_BUILD_LOG_APPENDER ==== default: qx.legacy.log.appender.Native <note> Set the default log appender for the build version</note> ===== SOURCE TEMPLATE SETUP ===== ==== APPLICATION_TEMPLATE_INPUT ==== default: ==== APPLICATION_TEMPLATE_OUTPUT ==== default: ==== APPLICATION_TEMPLATE_REPLACE ==== default: &lt;!– qooxdoo-script-block –&gt; <note> Template to patch (e.g. XHTML mode)</note> ===== DETAILED PATH CONFIGURATION ===== ==== APPLICATION_SOURCE_PATH ==== default: ./source <note> The source folder of your application from the directory which contains the Makefile (if defined relatively). This folder should contain all your application class files and resources. The default is ./source.</note> ==== APPLICATION_BUILD_PATH ==== default: ./build <note> The build folder of your application relative to the directory, which contains the Makefile (if defined relatively). This is the folder where the application self-contained build is generated to. The default is ./build.</note> ==== APPLICATION_API_PATH ==== default: ./api <note> The API folder of your application from the directory which contains the Makefile (if defined relatively). This is the destination target where the self-contained API viewer should reside after a "make api". The default is ./api.</note> ==== APPLICATION_DEBUG_PATH ==== default: ./debug <note> Define the debug location from the directory which contains the Makefile (if defined relatively). The default is ./debug.</note> ==== APPLICATION_PUBLISH_PATH ==== default: ./publish <note> Define the publishing location from the directory which contains the Makefile (if defined relatively). Could be any rsync compatible url/path The default is ./publish.</note> ==== APPLICATION_TEST_PATH ==== default: ./test <note> The folder that will contain a unit test appliction for your classes, defined from the directory which contains the Makefile (if defined relatively). This is the destination folder for the "make test" target. The default is ./test.</note> ==== APPLICATION_TOOL_PATH ==== default: ./tool <note> The folder that will contain assorted tools (e.g. buildtool) that can be generated for the current application, defined from the directory which contains the Makefile (if defined relatively). This is the destination folder for targets like "make buildtool", which will create its own subfolder. The default is ./tool.</note> ==== APPLICATION_BUILDTOOL_PATH ==== default: $(APPLICATION_TOOL_PATH)/buildtool <note> The folder that will contain the buildtool application, defined from the directory which contains the Makefile (if defined relatively). This is the destination folder for the "make buildtool" target. The default is $(APPLICATION_TOOL_PATH)/tool.</note> ===== OUTPUT OPTIONS ===== ==== APPLICATION_SCRIPT_FOLDERNAME ==== default: script ==== APPLICATION_CLASS_FOLDERNAME ==== default: class ==== APPLICATION_TRANSLATION_FOLDERNAME ==== default: translation <note> Redefine folder names (inside build/source) It is not recommended to change these fundamental settings.</note> ==== APPLICATION_SCRIPT_FILENAME ==== default: $(APPLICATION_NAMESPACE).js <note> File name of the generated script</note> ===== LINT OPTIONS ===== ==== LINT_ALLOWED_GLOBALS ==== default: <note> A list of valid global identifiers. These identifiers will not be reported as errors.</note> ===== PROFILER OPTIONS ===== ==== APPLICATION_PROFILE_SOURCE ==== default: false <note> Whether to enable the profiler (source version)</note> ==== APPLICATION_PROFILE_BUILD ==== default: false <note> Whether to enable the profiler (build version)</note> ===== ADDITIONAL CONFIGURATION ===== ==== APPLICATION_ADDITIONAL_CLASS_PATH ==== default: ==== APPLICATION_ADDITIONAL_CLASS_URI ==== default: <note> Additional class paths and URIs. These should be comma separated. The generator option will be automatically added</note> ==== APPLICATION_ADDITIONAL_SOURCE_OPTIONS ==== default: <note> Additional options to pass to the generator call of the source version. e.g. "–script-output-encoding=ISO-8859-1"</note> ==== APPLICATION_ADDITIONAL_BUILD_OPTIONS ==== default: <note> Additional options to pass to the generator call of the build version. e.g. "–script-output-encoding=ISO-8859-1"</note>

Information

Last modified:
2011/02/22 12:31 (external edit)

Account

 
 
A book on qooxdoo RIAs, authored  by community members
JS Tutorial, JavaScript Tutorial, JavaScript Guide, Learn JavaScript JS, How To Learn JS, Learning JavaScript
 

Bad Behavior has blocked 0 potential spam attempts in the last 7 days.