Development

Changeset 6993

You must first sign up to be able to contribute.

Changeset 6993

Show
Ignore:
Timestamp:
01/08/08 04:35:08 (8 months ago)
Author:
davedash
Message:

ddAccessibleFormPlugin: updated the documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • plugins/ddAccessibleFormPlugin/README

    r6979 r6993  
    11== Introduction == 
    22 
    3 This is based on the [http://alistapart.com/articles/prettyaccessibleforms prettier accessible forms] article from a List apart. 
     3This plugin allows you to make  
     4[http://alistapart.com/articles/prettyaccessibleforms prettier accessible forms]. 
    45 
    5 You need to symlink things to work 
     6Very simply it provides a helper with a function, `accessible_form_tag()`  
     7which acts just like `form_tag()` but adds a stylesheet and some javascript.   
     8The result is nicely structured forms using semantic markup. 
     9 
     10== Installation == 
     11 
     12This plugin is only available via svn.  If you would like to make this a pear  
     13package please contact the maintainer (Dave Dash). 
     14 
     15{{{ 
     16cd plugins/ 
     17svn co http://svn.symfony-forge.com/plugins/ddAccessibleFormPlugin ddAccessibleFormPlugin 
     18}}} 
     19 
     20Then create the proper symlink: 
    621 
    722{{{ 
     
    924ln -s ../plugins/ddAccessibleFormPlugin/web ddAccessibleFormPlugin 
    1025}}} 
     26 
     27== jQuery == 
     28 
     29The `cmxform.js` forces `label` tags to use the `inline-box` display style.   
     30It 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 
     34It's not recommended to mix multiple libraries.  If you use YUI, moo tools or  
     35prototype, it might be wise to create an alternate `cmxform.js` for your  
     36platform.  If you create such a package please let the maintainer (Dave Dash) 
     37know and he'll gladly include it in this plugin. 
     38 
     39== Maintenance/Authors == 
     40 
     41This plugin is currently maintained by Dave Dash @  
     42[http://spindrop.us/ spindrop.us].  If you'd like to contribute please contact 
     43him with patches. 
     44 
     45== Changelog == 
     46 
     472008-01-07  Updated README 
     48 
     49== Todo == 
     50 
     51* Impliment in YUI 
     52* Impliment in moo tools 
     53* Impliment in Prototype 
     54* Create PEAR package