WidgetTemplate

Page history last edited by Scott González 1 mo ago

 

type: widget || utility

release: 0.0

status: in planning || in development || complete

documentation: url || N/A

demo: url || N/A

 


 

1 - Description:

 

(High level description of purpose, where and when to use, how it solves a particular user or developer issue, links to existing plug-ins and UI guidelines, screenshots of best practice examples, diagrams -- anything that helps to clearly describe the item in plain English.)

 


 

2 - Visual Design:

 

(Initial wireframe mockup, followed by more detailed designs of the various configurations, options and states.)

 


 

 

3 - Functional Specifications/Requirements:

 

(Detailed description of how the script will be structured: defaults, options, architecture, extensibility, etc.)

 


 

4 - Markup & Style:

 

     4.1 Initial markup examples

 

     (Pre-enhanced HTML markup structure that will be transformed into the final widget. There may be multiple possible HTML markup options per widget: for example, for a slider, radiobuttons, inputs or selects could all be used. )

 

     4.2 Recommended transformed HTML markup

 

     (The HTML markup structure and classes that will be used by the scripts in the enhanced version) 

 

     4.3 Accessibility recommendation

 

    (Detailed recommendations for ARIA, HTML markup, CSS and javascript that will contribute to universal access and full section 508 accessibility for screen readers, mobile devices and any other devices) 

 

     4.4 CSS & Theme

 

    (Description of the CSS classes to be used for all states, how custom theming and Themeroller support will work.) 

 


 

5 - Latest version of plugin:

 

(Link to the latest version in the jQuery UI trunk here)

 


 

6 - Open issues being discussed

 

(Use this area to place things that we're hashing out like features and options we're not sure we should include, questions about how this fits into UI and relates to other widgets and utilities, known problems, whether features should be broken across multiple releases, etc.)

 


 

 

 

 

Comments (1)

profile picture

Todd Parker said

at 11:26 am on Nov 18, 2008

I've simplified the template structure and added notes for each section to help people fill this out correctly. The user stories and external links sections were not being filled out so I'm recommending that we simply use the Description as the place to document where and why something should be used so there aren't as many sections in this template. We can add more structure later if it seems necessary. Feel free to edit, Im hoping to make a bunch of placeholder pages today.

You don't have permission to comment on this page.