| 1 |
== Introduction == |
|---|
| 2 |
|
|---|
| 3 |
This plugin allows you to make |
|---|
| 4 |
[http://alistapart.com/articles/prettyaccessibleforms prettier accessible forms]. |
|---|
| 5 |
|
|---|
| 6 |
Very simply it provides a helper with a function, `accessible_form_tag()` |
|---|
| 7 |
which acts just like `form_tag()` but adds a stylesheet and some javascript. |
|---|
| 8 |
The result is nicely structured forms using semantic markup. |
|---|
| 9 |
|
|---|
| 10 |
== Installation == |
|---|
| 11 |
|
|---|
| 12 |
This plugin is only available via svn. If you would like to make this a pear |
|---|
| 13 |
package please contact the maintainer (Dave Dash). |
|---|
| 14 |
|
|---|
| 15 |
{{{ |
|---|
| 16 |
cd plugins/ |
|---|
| 17 |
svn co http://svn.symfony-forge.com/plugins/ddAccessibleFormPlugin ddAccessibleFormPlugin |
|---|
| 18 |
}}} |
|---|
| 19 |
|
|---|
| 20 |
Then create the proper symlink: |
|---|
| 21 |
|
|---|
| 22 |
{{{ |
|---|
| 23 |
cd web/ |
|---|
| 24 |
ln -s ../plugins/ddAccessibleFormPlugin/web ddAccessibleFormPlugin |
|---|
| 25 |
}}} |
|---|
| 26 |
|
|---|
| 27 |
== Javascript == |
|---|
| 28 |
|
|---|
| 29 |
The `cmxform.js` forces `label` tags to use the `inline-box` display style. |
|---|
| 30 |
It currently depends on the `jquery` javascript library. A copy of |
|---|
| 31 |
`jquery.js` is bundled and will be used unless overridden by the |
|---|
| 32 |
`SF_JQUERY_WEB_DIR` setting. |
|---|
| 33 |
|
|---|
| 34 |
Alternately you may use the Yahoo User Interface library. For this to work, |
|---|
| 35 |
set `SF_JS_LIB` to `yui` and set `SF_YUI_WEB_DIR` to the proper location. |
|---|
| 36 |
If you are using hosted YUI, you can have a setting like so in your |
|---|
| 37 |
`settings.yml`: |
|---|
| 38 |
|
|---|
| 39 |
{{{ |
|---|
| 40 |
yui_web_dir: http://yui.yahooapis.com/2.4.1/build/ |
|---|
| 41 |
}}} |
|---|
| 42 |
|
|---|
| 43 |
It's not recommended to mix multiple libraries. If you use dojo, moo tools or |
|---|
| 44 |
prototype, it might be wise to create an alternate `cmxform.js` for your |
|---|
| 45 |
platform. If you create such a package please let the maintainer (Dave Dash) |
|---|
| 46 |
know and he'll gladly include it in this plugin. |
|---|
| 47 |
|
|---|
| 48 |
== Maintenance/Authors == |
|---|
| 49 |
|
|---|
| 50 |
This plugin is currently maintained by Dave Dash @ |
|---|
| 51 |
[http://spindrop.us/ spindrop.us]. If you'd like to contribute please contact |
|---|
| 52 |
him with patches. |
|---|
| 53 |
|
|---|
| 54 |
== Changelog == |
|---|
| 55 |
|
|---|
| 56 |
2008-01-07 Updated README |
|---|
| 57 |
2008-01-21 Added YUI support, cleaned up jQuery code. |
|---|
| 58 |
|
|---|
| 59 |
== Todo == |
|---|
| 60 |
|
|---|
| 61 |
* Impliment in moo tools |
|---|
| 62 |
* Impliment in Prototype |
|---|
| 63 |
* Create PEAR package |
|---|
| 64 |
* Impliment in dojo |
|---|