[qooxdoo-commit] SF.net SVN: qooxdoo:[26534] trunk/qooxdoo/documentation/manual/source/pages /mobile/mobile_overview.rst

[<tb...@us...>]

Revision: 26534
          http://qooxdoo.svn.sourceforge.net/qooxdoo/?rev=26534&view=rev
Author:   tbtz
Date:     2011-03-31 21:00:37 +0000 (Thu, 31 Mar 2011)

Log Message:
-----------
[BUG #4707] Added first version of mobile manual

Modified Paths:
--------------
    trunk/qooxdoo/documentation/manual/source/pages/mobile/mobile_overview.rst

Modified: trunk/qooxdoo/documentation/manual/source/pages/mobile/mobile_overview.rst
===================================================================
--- trunk/qooxdoo/documentation/manual/source/pages/mobile/mobile_overview.rst	2011-03-31 18:18:59 UTC (rev 26533)
+++ trunk/qooxdoo/documentation/manual/source/pages/mobile/mobile_overview.rst	2011-03-31 21:00:37 UTC (rev 26534)
@@ -1,14 +1,101 @@
 Mobile Framework
 ****************
 
-This is an introduction into qooxdoo's mobile framework.
+.. note::
 
-Heading2
+    This is an experimental feature.
+
+This is an introduction into qooxdoo's experimental mobile framework. qooxdoo mobile
+provides a optimized widget set to build applications for mobile devices.
+
+Supported Mobile Operating Systems
+==================================
+
+qooxdoo mobile was tested with the native browsers of the following operating
+systems:
+
+* iOS
+* Android >= 1.6
+
+Supported Desktop Browsers
+==========================
+
+qooxdoo mobile was tested with the following desktop browsers:
+
+* Safari 5
+* Chrome >= 10
+
+Features
 ========
 
-blah
+* `Mobile widget set <http://demo.qooxdoo.org/%{version}/apiviewer/#qx.ui.mobile>`_
+* Theming via CSS
+* iOS theme
+* Android theme
+* Touch events: touchstart, touchmove, touchend, touchcancel 
+* Gesture events: swipe, tap
+* Animations between pages
+* Touch event emulation for debugging in desktop browser
+* Fixed toolbars and momentum scrolling via `iScroll <http://cubiq.org/iscroll>`_
+* Basic `PhoneGap <http://www.phonegap.com/>`_ support
 
-Heading3
---------
+API Documentation
+=================
 
-details of blah
+* `qx.application.Mobile <http://demo.qooxdoo.org/%{version}/apiviewer/#qx.application.Mobile>`_:
+  The mobile application.
+* `qx.ui.mobile <http://demo.qooxdoo.org/%{version}/apiviewer/#qx.ui.mobile>`_:
+  This package contains all mobile widgets. See the API documentation for more
+  information.
+
+
+Getting Started
+===============
+
+To create an mobile application ``mobileapp`` in your home directory with your shell, change to your home directory (just ``cd``). With a qooxdoo SDK available at ``/opt/qooxdoo-%{version}-sdk``, call the script as follows:
+
+::
+
+    /opt/qooxdoo-%{version}-sdk/tool/bin/create-application.py --type=mobile --name=mobileapp --out=.
+
+Environment Keys
+================
+
+The following environment keys are available:
+
+* ``qx.mobile.emulatetouch: true|false`` - Enables desktop browser touch emulation.
+  Enable this option if you want to debug the application in your desktop browser.
+* ``qx.mobile.nativescroll: true|false`` - Whether to use native scrolling or
+  `iScroll <http://cubiq.org/iscroll>`_ for scrolling.
+
+Differences between Desktop Widgets
+===================================
+
+The qooxdoo mobile widget set is optimized for the use on mobile devices. In fact,
+the qooxdoo mobile widget set is up to six times faster than the desktop widget set
+on mobile devices.
+We have tried to keep the differences of the API as low as possible, so that a qooxdoo
+developer will have his first qooxdoo mobile application running within minutes.
+Of course, respecting the speed advantage, not all features of the desktop widget set
+could be retained. There are some differences, listed below:
+
+* Theming: The theming is done via CSS files. Have a look into the existing themes, to see
+  how the styling is done. You can find the themes under ``framework/source/resource/qx/mobile/css/``.
+* No Layout Item: Only a few, essential, styles are provided by a widget. You
+  should set all other styles of a widget via CSS, using the ``addCssClass`` method of a widget.
+* No Queues: Elements are created directly. There is no element, layout, display queue.
+* Layouts: Layouts are done vis CSS(3). HBox / VBox layouts are implemented using the
+  `flexible box layout <http://www.w3.org/TR/css3-flexbox/>`_
+  
+How to contribute?
+==================
+
+You can contribute in different ways:
+
+* Testing: Test qooxdoo mobile on your mobile device and give us feedback
+* Theming: You can optimize the current CSS files or even create your own theme
+* Widgets: Widget / Feature missing? Create an widget an post it back to us
+* Bugs: If you have found a bug, or when you have fixed it already, please open
+  a bug report in the qooxdoo `Bugzilla <http://bugzilla.qooxdoo.org/>`_ with the
+  ``core-mobile`` component.
+* Discussion/Feedback: Please post questions to `our mailinglist <http://lists.sourceforge.net/lists/listinfo/qooxdoo-devel>`__. 
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.