UX Registration manual.

This topic assumes that you have already registered as an UX Repository author here: http://extjs-ux.org/register.

1. Login

First you need to login to your UX Repository author account here: http://extjs-ux.org/login

2. Register ux

Now that you are logged in, you can Register your UX here: http://extjs-ux.org/uxregister.

When you register your UX:

1. You are "reserving a name" for your UX. The name can be anything you like, but generally you should follow some kind of logical naming convention. How you name the extension dictates how the extension will be filed in the UX Repository Documentation system. For example, Ext.ux.grid.Filters would be filed under: Ext/ux/grid/Filters.js If you wanted to provide an extension for a panel, you might name your file as Ext.ux.panel.PanelExtensionName (will be filed under Ext/ux/panel/PanelExtensionName.js)
2. Now that the extension is registered, the UX Repository documentation system will check your author directory for the registered extension name. If the system finds a *.js file in the appropriate location then the system will copy that ux into the main ux/trunk folder and use JSDoc to add any documentation to the UX Repository API Docs. The system updates the ux/trunk folder and the docs on an hourly basis.

3. It is author's responsibility to properly place the extension file in the correct location and document the code. If the file is incorrectly located it will not be copied to main trunk. If the source code does not follow JSDoc conventions, it will be improperly documented or will not be included in the API Docs at all.

3. Checkout your home directory

Use your svn client (for Windows users a good choice is TortoiseSVN, for Linux Subclipse plugin for Eclipse) to check out your entire author's home directory to a local directory using the credentials you entered during registration.

a) Create an empty directory. Right click within that directory and do SVN Checkout.

b) Specify the url you want to check out from

4. Upload ux

Upload your extension. The system won't be able to copy the extension into the main ux/trunk or add documentation until you upload your files.

Author's directories are located here:

http://extjs-ux.org/repo /authors/ux - main trunk for all authors

Each author has a home directory organized this way:

/authorName/tags
/authorName/branches
/authorName/trunk
/authorName/trunk/Ext
/authorName/trunk/Ext/ux - the author's ux trunk, any registered ux's will be copied from this folder to main trunk

Author's directory is automatically created like this:

a) Since you already checked out a local working copy of your svn folder you'll want to create the appropriate files and directories in your local working copy. For example, if you registered an UX as Ext.ux.event.Broadcast (note does not end with .js) you would create a folder event within the ux directory and add the following file:

/authorName/trunk/Ext/ux/ event/ Broadcast.js

b) Use your svn client to upload (commit) your files back to the repository. Keep in mind the UX Repository updates the Docs and the main ux/trunk hourly, so it may be up to an hour before you see your changes implemented.

5. Creating demos

You may organize your home directory any way you want. Since your svn directory is http-browsable, you can include html demos, gzipped packages, images - etc. in your home directory if you wish.

You may use the following links to have access to the ExtJS files (for appropriate Ext versions):

http://extjs-ux.org/ext21
http://extjs-ux.org/ext22
http://extjs-ux.org/ext221
http://extjs-ux.org/ext3rc1
http://extjs-ux.org/ext3rc1.1

It can looks like:

<link rel="stylesheet" type="text/css" href="/ext21/resources/css/ext-all.css" />
<script type="text/javascript" src="/ext21/adapter/ext/ext-base.js"></script>
<script type="text/javascript" src="/ext21/ext-all.js"></script>

If you are uploading html files they require some special handling to function within the repository. To do this you'll need to set the svn:mime-type to text/html. (Details in next item)

6. Setting mime-type

Here are some screenshots to guide you through setting the mime-type using Tortoise:

1.) Right click on the file you want to alter properties for. Go to TortoiseSVN -> Properties to bring up this window.

2.) Select the property name and set the property value. Then click "ok".

3.) The file should now have the properties set: