Skip to content

Commit

Permalink
Ext JS 4.2.0 guides.
Browse files Browse the repository at this point in the history
  • Loading branch information
@nene
nene committed Mar 28, 2013
1 parent 0645ccc commit 7e06352
Show file tree
Hide file tree
Showing 54 changed files with 4,110 additions and 1,480 deletions.
2 changes: 1 addition & 1 deletion build
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

guider guides/ --index=guides.json --title="Ext JS 4.1.3 Guides" --link-url=http://docs.sencha.com/ext-js/4-1/
guider guides/ --index=guides.json --title="Ext JS 4.2.0 Guides" --link-url=http://docs.sencha.com/ext-js/4-2/
37 changes: 25 additions & 12 deletions guides.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
"title": "Upgrade Guide",
"description": "Learn what's new in Ext JS 4.0 and how to upgrade your existing applications."
},
{
"name": "upgrade_42",
"title": "Upgrade 4.1 to 4.2",
"description": "Learn what's new in Ext JS 4.2 and how to upgrade your 4.1 applications."
},
{
"name": "upgrade_41",
"title": "Upgrade 4.0 to 4.1",
Expand Down Expand Up @@ -71,6 +76,11 @@
"name": "testing",
"title": "Unit Testing",
"description": "This guide explains how to use Jasmine to unit test your projects."
},
{
"name": "testing_controllers",
"title": "Unit testing MVC Controllers",
"description": "This guide explains how to unit test MVC Controllers with Jasmine."
}
]
},
Expand Down Expand Up @@ -109,73 +119,76 @@
"items": [
{
"name": "command",
"url": "../../../command_guides/command",
"title": "Introduction to Sencha Cmd",
"description": "Introduction to using Sencha Cmd"
},
{
"name": "command_app",
"url": "../../../command_guides/command_app",
"title": "Using Sencha Cmd with Ext JS",
"description": "Using Sencha Cmd to generate and develop Ext JS applications"
},
{
"name": "command_code",
"url": "../../../command_guides/command_code",
"title": "Compiler-Friendly Code Guidelines",
"description": "Recommendations for getting the most from the compiler"
},
{
"name": "command_workspace",
"url": "../../../command_guides/command_workspace",
"title": "Workspaces in Sencha Cmd",
"description": "Using Sencha Cmd to develop large, multi-page, applications"
},
{
"name": "command_packages",
"title": "Sencha Cmd Packages",
"description": "Using Packages in your applications"
},
{
"name": "command_package_authoring",
"title": "Creating Sencha Cmd Packages",
"description": "How to author and distribute packages"
},
{
"name": "command_app_single",
"url": "../../../command_guides/command_app_single",
"title": "Single-Page Ext JS Apps",
"description": "Using Sencha Cmd to develop single-page, Ext JS applications"
},
{
"name": "command_app_multi",
"url": "../../../command_guides/command_app_multi",
"title": "Multi-Page Ext JS Apps",
"description": "Using Sencha Cmd to develop large, multi-page, Ext JS applications"
},
{
"name": "command_theme",
"url": "../../../command_guides/command_theme",
"title": "Building Themes for Ext JS",
"description": "Introduction to themes and the image slicer."
},
{
"name": "command_slice",
"title": "Image Slicing for IE",
"description": "Generate images for legacy browsers so they can dispaly gradients and rounded corners"
},
{
"name": "command_advanced",
"url": "../../../command_guides/command_advanced",
"title": "Advanced Sencha Cmd",
"description": "Advanced uses of Sencha Cmd"
},
{
"name": "command_compiler",
"url": "../../../command_guides/command_compiler",
"title": "Sencha Compiler Reference",
"description": "Using, configuring and getting the most from the compiler"
},
{
"name": "command_ant",
"url": "../../../command_guides/command_ant",
"title": "Ant Integration",
"description": "Describes the Ant Tasks available from Sencha Cmd"
},
{
"name": "command_compiler_meta",
"url": "../../../command_guides/command_compiler_meta",
"title": "Generating Metadata",
"description": "Generation and uses for code metadata"
},
{
"name": "command_reference",
"url": "../../../command_guides/command_reference",
"title": "Sencha Cmd Reference",
"description": "A complete command line reference"
}
Expand Down
2 changes: 1 addition & 1 deletion guides/class_system/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This manual is intended for any developer who wants to create new or extend exis
## I. Overview
______________

Ext JS 4 ships with more than 300 classes. We have a huge community of more than 200,000 developers to date, coming from various programming backgrounds all over the world. At that scale of a framework, we face a big challange of providing a common code architecture that is:
Ext JS 4 ships with more than 300 classes. We have a huge community of more than 200,000 developers to date, coming from various programming backgrounds all over the world. At that scale of a framework, we face a big challenge of providing a common code architecture that is:

- familiar and simple to learn
- fast to develop, easy to debug, painless to deploy
Expand Down
116 changes: 86 additions & 30 deletions guides/command/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,22 @@ Sencha Cmd provides the following capabilities:
load time of your applications.
- Native packaging to convert your Sencha Touch application into a first-class, mobile
application that has access to device functionality and can be distributed in App Stores.
- Distributed package management system for easy integration of packages (such as Ext JS
Themes) created by others or from the Sencha Package Repository.
- Generated build script for applications and packages with "before" and "after" extension
points so you can customize the build process to fit your specific needs.
- Powerful code selection tools for tuning what is included in your application's final
build, determine common code across pages and partition shared code into "packages" - all
using high-level set operations to get builds exactly as you want them.
- Workspace management to assist in sharing code between pages or applications.
- Image extraction to convert CSS3 features (such as border-radius and linear-gradient)
- Workspace management to assist in sharing frameworks, packages and custom code between
applications.
- Image capture to convert CSS3 features (such as border-radius and linear-gradient)
into sprites for legacy browsers.
- Flexible configuration system that enables defaults to be specified for command options
at the application or workspace level or across all workspaces on a machine.
- Robust logging to help you understand the inner workings of commands and facilitate
troubleshooting.
- Integration with Apache Ant.
- Sencha Cmd includes a compatible version of Compass, SASS and Apache Ant.
- Code generation hooks that can be specific to one page or shared by all pages in the
workspace, for example, to check coding conventions or guidelines as new models are
generated).
Expand Down Expand Up @@ -56,8 +61,8 @@ Follow these steps to set up your system and start using Sencha Cmd:
[Java Run-time Environment or JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
It is best to download the most up-to-date version available. The JRE version must be at
least JRE 6.
2. Download and install [Compass](http://compass-style.org/). Compass may have its own
system requirements. Compass is required for several features of Sencha Cmd.
2. To build themes using SASS on Windows, download and install [Ruby](http://ruby-lang.org/).
Ruby is already provided by Mac OS X.
3. Download and install [Sencha Cmd](http://www.sencha.com/products/sencha-cmd).
4. Download the appropriate version of the [Ext JS SDK](http://www.sencha.com/products/extjs/)
or [Sencha Touch SDK](http://www.sencha.com/products/touch/).
Expand All @@ -72,10 +77,41 @@ actual path to the SDK that you extracted to previously (**not the Sencha Cmd di

You should see output that starts like this:

Sencha Cmd v3.0.0
Sencha Cmd v3.1.0
...

If the above message appears and the version number is 3.0.0 or higher you are all set.
If the above message appears and the version number is 3.1.0 or higher you are all set.

## Upgrading Sencha Cmd

New to Sencha Cmd v3.1 is the `sencha upgrade` command. Once you have a version of Sencha
Cmd with the `upgrade` command, you will most likely never need to manually download Sencha
Cmd updates again.

This can be used to check for new updates to Sencha Cmd like so:

sencha upgrade --check

Without the `--check` option, the `sencha upgrade` command will download and install the
latest version if you don't already have it:

sencha upgrade

If you want to check for pre-release (a.k.a. "beta") releases, you can do this:

sencha upgrade --check --beta

To install the latest beta version:

sencha upgrade --beta

Once the installer has completed, you will need to start a new console/terminal in order
to pick up the changes to your PATH environment variable.

Because multiple versions of Sencha Cmd can be installed side-by-side, you can safely try
the Beta channel and then uninstall the beta (or adjust the PATH) to go back to the stable
version. Upgrading your applications using `sencha app upgrade` however, is something you
may need "roll back" if you downgrade to an older Sencha Cmd.

## Command Basics

Expand All @@ -94,37 +130,51 @@ For example, try this:

And you should see this:

Sencha Cmd v3.0.0
Sencha Cmd v3.1.0
...

OPTIONS
Options
* --cwd, -cw - Sets the directory from which commands should execute
* --debug, -d - Sets log level to higher verbosity
* --plain, -p - enables plain logging output (no highlighting)
* --nologo, -n - Suppress the initial Sencha Cmd version display
* --plain, -pl - enables plain logging output (no highlighting)
* --quiet, -q - Sets log level to warnings and errors only
* --sdk-path, -s - sets the path to the target sdk
* --sdk-path, -s - The location of the SDK to use for non-app commands
* --time, -ti - Display the execution time after executing all commands

CATEGORIES
* compile - Compile sources to produce concatenated output and metadata
* generate - Generate code like models and controllers or raw templates
* theme - Builds a set of theme images from a given html page
Categories
* app - Perform various application build processes

COMMANDS
* compass - Wraps execution of compass for sass compilation
* compile - Compile sources to produce concatenated output and metadata
* fs - Utility commands to work with files
* generate - Generates models, controllers, etc. or an entire application
* io - Create, deploy and manage applications on the Sencha.io cloud platform
* iofs - Manage Files stored in the Sencha.io cloud platform
* manifest - Extract class metadata
* package - Manages local and remote packages
* repository - Manage local repository and remote repository connections
* theme - Commands for low-level operations on themes

Commands
* ant - Invoke Ant with helpful properties back to Sencha Cmd
* build - Builds a project from a JSB3 file.
* config - Loads a config file or sets a configuration property
* help - Get help on using Sencha Cmd
* build - Builds a project from a legacy JSB3 file.
* config - Load a properties file or sets a configuration property
* help - Displays help for commands
* js - Executes arbitrary JavaScript file(s)
* upgrade - Upgrades Sencha Cmd
* which - Displays the path to the current version of Sencha Cmd

## Current Directory

In many cases, Sencha Cmd requires you to set a specific current directory. Or it may
just need to know details about the relevant SDK. This can be determined when Sencha Cmd
is run from a generated application folder or, for some few commands, from an extracted
SDK folder.
just need to know details about the relevant SDK. The appropriate SDK can be determined
automatically by Sencha Cmd when it is run from a generated application folder or, for
some few commands, from an extracted SDK folder.

*Important.* For the following commands, Sencha Cmd needs to be run from the root folder
of a generated application. They will fail if not run from such a folder.

* `sencha generate ...` (all commands other than `app` and `workspace`)
* `sencha generate ...` (for commands other than `app`, `package` and `workspace`)
* `sencha app ...`

To generate an application you can run the following command from an extracted SDK folder:
Expand All @@ -142,6 +192,12 @@ use the `-sdk` switch:

sencha -sdk /path/to/sdk compile ...

*Important:* You do not specify the `-sdk` parameter for `sencha app` commands. As noted
above, these command must be run from the application's folder and therefore they will
automatically know the SDK to use. Using `-sdk` on these commands will cause Sencha Cmd
to believe your current directory is the SDK specified which is not the proper current
directory for an application.

## Developing Applications

The starting point for most projects is to generate an application skeleton. This is done
Expand Down Expand Up @@ -183,16 +239,16 @@ batch file` on Windows, follow these steps:
the case, add it to your PATH manually.
- The environment variable `SENCHA_CMD_{version}` is set, with the value being
the absolute path to the installation directory mentioned above. For example, if the
installed version is 3.0.0, a `SENCHA_CMD_3_0_0` must be set. If the output is
installed version is 3.1.0, a `SENCHA_CMD_3_1_0` must be set. If the output is
empty, set the environment variable manually. To check, go to the command prompt (or
Terminal) and run:
- Windows: `echo %SENCHA_CMD_3_0_0%`
- Other - `echo $SENCHA_CMD_3_0_0`
- Windows: `echo %SENCHA_CMD_3_1_0%`
- Other - `echo $SENCHA_CMD_3_1_0`

### Compass is not a recognized command
### Cannot find Ruby

If you see an error related to not recognizing or finding `"compass"` this is likely because
Compass is not installed or is not in your PATH. See the System Requirements above.
If you see an error related to not recognizing or finding `"ruby"` this is likely because
Ruby is not installed or is not in your PATH. See the System Requirements above.

### Wrong Current Directory

Expand Down
Loading

0 comments on commit 7e06352

Please sign in to comment.