Skip to content

Commit

Permalink
[BUG #6230] more 'tool' and label clean-ups
Browse files Browse the repository at this point in the history
  • Loading branch information
thron7 committed Mar 30, 2012
1 parent d3d1af6 commit bb23e0b
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 82 deletions.
4 changes: 1 addition & 3 deletions documentation/manual/source/index.rst
Expand Up @@ -48,9 +48,7 @@ Welcome to the manual of qooxdoo |version|. Here are some highlights of what you

+----------+-------------------------------------------------------------------------------------+
| |o_star| | **Getting Started** |
| | * :ref:`Prerequisites <pages/requirements#requirements>` |
| | * :ref:`Download and Installation<pages/getting_started/setup#setup>` |
| | * :ref:`"Hello World" <pages/getting_started/helloworld#create_your_application>` |
| | * :doc:`pages/getting_started` |
+----------+-------------------------------------------------------------------------------------+

.. rst-class:: toc
Expand Down
2 changes: 1 addition & 1 deletion documentation/manual/source/pages/introduction/about.rst
Expand Up @@ -13,7 +13,7 @@ You leverage its integrated tool chain to develop and deploy applications of any
Framework
---------

qooxdoo is entirely class-based and tries to leverage the features of object-oriented JavaScript. It is largely based on namespaces to allow for easy integration with other libraries and existing user code. Most :ref:`modern browsers <pages/requirements#client>` are supported (e.g. Firefox, Internet Explorer, Opera, Safari, Chrome). It comes with a `comprehensive API reference <http://api.qooxdoo.org>`_ that is auto-generated from Javadoc-like comments. The fast and complete JavaScript parser not only allows documentation generation but is an integral part of the automatic build process that makes optimizing, compressing, linking and deployment of custom applications very user-friendly. Internationalization and localization of applications for various countries and languages is a core feature and easy to use. `more ... <http://qooxdoo.org/about/framework>`_
qooxdoo is entirely class-based and tries to leverage the features of object-oriented JavaScript. It is largely based on namespaces to allow for easy integration with other libraries and existing user code. Most :ref:`modern browsers <pages/desktop/requirements#client>` are supported (e.g. Firefox, Internet Explorer, Opera, Safari, Chrome). It comes with a `comprehensive API reference <http://api.qooxdoo.org>`_ that is auto-generated from Javadoc-like comments. The fast and complete JavaScript parser not only allows documentation generation but is an integral part of the automatic build process that makes optimizing, compressing, linking and deployment of custom applications very user-friendly. Internationalization and localization of applications for various countries and languages is a core feature and easy to use. `more ... <http://qooxdoo.org/about/framework>`_


.. _pages/introduction/about#desktop:
Expand Down
1 change: 0 additions & 1 deletion documentation/manual/source/pages/tool.rst
Expand Up @@ -23,7 +23,6 @@ Introduction

tool/sdk_introduction
tool/sdk_requirements
tool/sdk_install_troubleshoot
tool/getting_started
tool/sdk_structure
tool/application_structure
Expand Down
Expand Up @@ -31,7 +31,7 @@ Making the interpreter available
The following is only required when installing the Windows package from `Python.org <http://python.org>`_. When installing the preferred `ActivePython <http://www.activestate.com/activepython/downloads>`_ this installation step is conveniently handled within its graphical installation wizard.


After your successful :ref:`Python installation <pages/requirements#tools>`, you need to add the installation folder to the so-called ``PATH`` environment variable, which contains a list of directories that are searched for executables.
After your successful :ref:`Python installation <pages/tool/requirements#python>`, you need to add the installation folder to the so-called ``PATH`` environment variable, which contains a list of directories that are searched for executables.

Suppose you installed Python to its default location ``C:\Python26``, open a Windows command shell (choose menu ``Start -> Run...`` and type ``cmd``). The following command prepends the installation folder to the value of ``PATH``, separated by a semicolon:

Expand Down
100 changes: 25 additions & 75 deletions documentation/manual/source/pages/tool/sdk_requirements.rst
@@ -1,77 +1,16 @@
.. _pages/requirements#requirements:
.. _pages/tool/requirements#requirements:

Requirements
************
SDK Requirements
****************

..
tool/troubleshooting
%{qooxdoo} offers a platform-independent and user-friendly tool chain, in form of an SDK. It comes with the :doc:`/pages/desktop` and :doc:`/pages/mobile` downloads. For those components you use it for *creating and developing* a %{qooxdoo} application. It is not needed for *running* the application. For the :doc:`/pages/website` and :doc:`/pages/server` components there are pre-build libraries to download, so you don't need the SDK.

Here are the requirements for developing and deploying a qooxdoo application. A qooxdoo application is a JavaScript-based piece of software that runs on one or more of the supported platforms. Platforms include various browsers and non-browser runtimes like Node.js and Rhino.

qooxdoo does not enforce any specific backend components, any server that is reachable through the platform-provided communication facilities should be fine. If you use the SDK you get a powerful tool chain that helps in developing and deploying applications.
.. _pages/tool/requirements#python:

Here is a detailed list of supported platforms for the various qooxdoo components.

.. _pages/requirements#client:

Desktop Browser
================

This section applies to you if you want to work with the :doc:`Website </pages/website/overview>` or :doc:`Desktop </pages/desktop/ui_overview>` components of qooxdoo. An application built with those components runs in all major web browsers - if you use qooxdoo's GUI widgets with identical look & feel:

.. list-table::

* - .. image:: /_static/ie.png
- Internet Explorer 6+
* - .. image:: /_static/ff.png
- Firefox 2+
* - .. image:: /_static/opera.png
- Opera 9+
* - .. image:: /_static/safari.png
- Safari 3+
* - .. image:: /_static/chrome.png
- Chrome 2+

Not only the end users of your application benefit from this true cross-browser solution. As a developer you can also pick *your* preferred development platform, i.e. combination of browser and operating system. Developers should note that with some browsers, such as Chrome and Firefox, there is a known issue loading reasonably complex qooxdoo applications (such as the API viewer or the demo browser) via the `file://` protocol. Either consult your browser's documentation (usually there is a command-line option to fix this), or use the HTTP protocol even while developing. In the latter case be sure to read and understand this `FAQ entry <http://qooxdoo.org/documentation/general/snippets#running_a_source_version_from_a_web_server>`__.


.. _pages/requirements#mobile:

Mobile Browser
==============

This section applies to you if you want to work with the :doc:`Mobile </pages/mobile/mobile_overview>` components of qooxdoo.

.. list-table::

* - .. image:: /_static/ie.png
- Internet Explorer
* - .. image:: /_static/ff.png
- Firefox
* - .. image:: /_static/opera.png
- Opera
* - .. image:: /_static/safari.png
- Safari
* - .. image:: /_static/chrome.png
- Chrome


.. _pages/requirements#server:

Server
Python
======

The qooxdoo :doc:`Server </pages/server/overview>` component supports Node.js and Rhino as non-browser environments. As these allow you to create server-side applications, we refer to them as *server* platforms. This doesn't stop you from creating simple console-based apps for them, test automation scripts, or console-based clients for custom network services, using the *Server* component.


.. _pages/requirements#tools:

SDK
=====

qooxdoo comes with a platform-independent and user-friendly tool chain. It comes with the :doc:`Desktop </pages/desktop/ui_overview>` and :doc:`Mobile </pages/mobile/mobile_overview>` downloads. For those components you use it for *creating and developing* a qooxdoo application. It is not needed for running the application. For the *Website* and *Server* components there are pre-build libraries to download, so you don't need the SDK.

The tool chain only requires to have `Python <http://www.python.org>`_ installed. Use a standard **Python 2.x** release, version 2.5 or above. Python 3 is currently `not supported <http://qooxdoo.org/documentation/general/python_3_support>`_. (If in doubt you can query the version of your local Python installation by running the command ``python -V``). As a qooxdoo user you do not need any Python knowledge, it is merely a technology used internally for the tools. Python comes either pre-installed on many systems or it can very easily be installed:
The tool chain only requires a `Python <http://www.python.org>`_ installation. Use a standard **Python 2.x** release, version 2.5 or above. Python 3 is currently `not supported <http://%{qooxdoo}.org/documentation/general/python_3_support>`_. (If in doubt you can query the version of your local Python installation by running the command ``python -V``). As a %{qooxdoo} user you do not need any Python knowledge, it is merely a technology used internally for the tools. Python comes either pre-installed on many systems or it can be installed very easily:


|image0| Windows
Expand Down Expand Up @@ -102,17 +41,28 @@ Python is **pre-installed** on Max OS X. No additional software needs to be inst

Python often comes **pre-installed** with your favorite distribution, just make sure they're still using a Python 2.x version. If not, simply use your package manager to install a suitable package.

.. _pages/getting_started/setup#setup:
.. _pages/tool/requirements#disk_space:

Disk Space
==========

The unpacked SDK will require around **%{sdk_unpacked} MB** disk space (a big part of this is due to media files like images).

During runtime the tool chain also uses a subdirectory in your system's ``TMP`` path, to cache intermediate results and downloaded files. Depending on your activities this cache directory can become between **%{cache_average_min}** and **%{cache_average_max} GB** in size. If the `default cache path <http://%{qooxdoo}.org/documentation/general/snippets#finding_your_system-wide_tmp_directory>`__ does not suite you, you can change it in your configuration.

.. _pages/tool/requirements#setup:

Installation and Setup
***********************
======================

Installation of qooxdoo components is easy. First, go to the `download section <http://qooxdoo.org/download>`_ and grab a suitable package for your purpose. It is either just downloading a library file and placing it in a URL-addressable path in your development environment. Or, in the case of the SDK, download the SDK and unzip it to a suitable path on your hard disk. For further information please refer to specific sections of the qooxdoo component you want to work with. There, you will also find simple, introductory examples that show you how to get started working with the component.
Installation of the SDK is just going to the `download section <http://%{qooxdoo}.org/download>`_ and grab the package suitable for your purpose. Choose either the *Desktop* or *Mobile* download, which both come as an SDK archive. Unzip it to a suitable path on your hard disk. The archive contains a single top-level folder, which in turn contains all the SDK's files and sub-folders.

This is all as far as the SDK is concerned. As an additional convenience you might want to add the ``<sdk-root-path>/tool/bin`` directory to your system environment ``PATH`` variable. This is a prerequisite for invoking the executable programs of the tool chain without the need to address them with their path.

Disk Space
==========
Installation Troubleshooting
==============================

Disk requirements will vary largely depending on the component you chose, with the library files usually small in footprint. The unpacked SDK will require around **%{sdk_unpacked} MB** disk space (most of this is due to media files, like images).
.. toctree::
:maxdepth: 1

The tool chain also uses a directory in your system's TMP path, to cache intermediate results and downloaded files. Depending on your activities this cache directory can become between **%{cache_average_min}** and **%{cache_average_max} GB** in size. If the `default cache path <http://qooxdoo.org/documentation/general/snippets#finding_your_system-wide_tmp_directory>`__ does not suite you, you can change it in your configuration.
sdk_install_troubleshoot
Expand Up @@ -5,7 +5,7 @@ The Event Layer

The class `qx.event.Manager <http://demo.qooxdoo.org/%{version}/apiviewer/#qx.event.Manager>`_ provides a per-document wrapper for cross-browser DOM event handling. The implementation of the event layer is inside the `qx.event <http://demo.qooxdoo.org/%{version}/apiviewer/#qx.event>`_ namespace.

The following features work in all :ref:`supported browsers <pages/requirements#client>`:
The following features work in all :ref:`supported browsers <pages/website/requirements#client>`:

* Canceling events: ``stopPropagation()``
* Skipping the browser's default behavior: ``preventDefault()``
Expand Down

0 comments on commit bb23e0b

Please sign in to comment.