Skip to content

Latest commit

 

History

History
60 lines (33 loc) · 5.04 KB

README.md

File metadata and controls

60 lines (33 loc) · 5.04 KB

Extensible

This project is no longer under active development. The code remains available for historical purposes only.


About

Extensible actually contains a bunch of different components, but the primary product currently is Calendar Pro, a drop-in calendar solution styled after (the old) Google Calendar. It supports multiple views, drag-and-drop editing, calendar color-coding, localizability and is built to be easily extendable.

Calendar Pro screenshot

Ext Version Support

Extensible only supports Ext JS versions 3.x and 4.x. Ext 5 and above are not supported.

Extensible works with both Ext 3 and Ext 4. Unfortunately since Ext 4 is not backwards-compatible it means that Extensible must be managed in two separate branches in order to maintain support for both versions of Ext. The default master branch is now only compatible with Ext 4, and all Extensible releases from 1.5 forward will be for Ext 4. The Extensible 1.x branch (less than 1.5) will remain as the Ext 3 compatible line of code.

Since Sencha Inc. officially no longer supports Ext version 3.x (they support 4.2 and above only as of early 2016) Extensible also no longer officially supports Ext 3, and so Extensible itself will only be supported for versions 1.5 and greater.

Configuration

As of Extensible 1.0.2 and 1.5.1 you can easily customize the framework paths for the examples (e.g., if you want to run a different version of Ext, or host it locally), or switch between running the pre-built versions of Extensible or using the Ext.Loader to dynamically load the individual Extensible classes (extremely useful if you have to step into Extensible code). For complete details on all options, see the source comments included in Extensible-config.js.

Building from Source

"Compiling" the Code

If you clone or fork the repository to use the most up-to-date code, you'll probably want to be able to rebuild the project yourself. Build scripts for both Mac/Unix (build.sh) and Windows (build.bat) are included in the /build folder, as well as a version of JSBuilder and a .jsb2 project file for Extensible. You must have a current version of Java installed for JSBuilder to work.

By default, each build script uses the script file's location to reference other files relatively, so they should work as expected without modification. When you execute a build script (e.g., sh build.sh on the Mac/Unix command line, or just build on the Windows command line) it will build everything (minus docs) into a /deploy folder and also copy the -all and -all-debug files into the main /lib folder so that the examples will always have the latest code as well.

Generating Docs

The jar file for the Ext-doc utility is also included. If you'd like to generate docs as part of your build, simply pass -d as a command line arg to the build script (e.g., sh build.sh -d or build -d) and the current documentation will also be created under /docs.

Deployment

For use in your own application, you'll simply include the built framework files, just like any other typical Ext application dependencies. This could be your own custom-built files, if you've made any changes to the Extensible source. For example:

<!-- Load the Ext and Extensible CSS -->
<link rel="stylesheet" type="text/css" href="path/to/extjs/resources/css/ext-all.css" />
<link rel="stylesheet" type="text/css" href="path/to/extensible/resources/css/extensible-all.css" />

<!-- Load the Ext and Extensible deployment files -->
<script type="text/javascript" src="path/to/extjs/ext-all[-debug].js"></script>
<script type="text/javascript" src="path/to/extensible-all[-debug].js"></script>

<!-- Include your app and any other app-specific files -->
<script type="text/javascript" src="MyApp.js"></script>

Upgrading from Extensible 1.x to 1.5+

Nothing about the Extensible API changed between 1.x and 1.5 except the naming/namespacing and organization of classes. No new functionality was introduced that was not directly relevant to supporting Ext 4.0. Because of this upgrading should not be difficult, but since almost every single class was renamed and/or reorganized (to be more consistent with Ext 4 and also to provide support for dynamic loading), you may find it initially tedious to get existing application code back up and running under Extensible 1.5+.

To ease this transition there is a compatibility file in the /lib folder called extensible-1.0-compat.js that provides all of the necessary class aliases to get Extensible 1.x code working under 1.5+. Simply include it right after your existing extensible-all[-debug].js reference. You should eventually update your own code with the new class names so that you can remove the compatibility file, but it will not hurt anything to run with it as needed.

License

Extensible is available for free under the terms of GPL v3.