type: utility

release: N/A

status: in planning

documentation: N/A

demo: N/A

 

 

---

 

1 - Description:

 

Q: What is a Data library?

A: It is a collection of common functions packaged up for reuse for interacting between the page AJAX, the page elements and servers that send and recieve data.

 

There are a few basic elements to making a simple data library that is functional, easy to learn but powerful to use in features and flexability. (The terms here are used in other libraries and work... if you have suggestions please add them to the comments.)

 

Data: This is simply the variable that holds the data locally if it is not pulled from a server.

 

Model: This is the piece that allows intelligent and extended handling to the data. Is this data a date, numeric, currency? It helps the components to know what kind of data they get... and thus it is easier to add intelligence without redundant coding. (Elegant coding makes everyone happier.)

 

Reader: There will be some standard data readers and if you want or need the interface will be something that will allow you to create a custom reader to deal with content not handled by the standard readers. What type of readers should be standard? XML, JSON and JavaScript Array set.

 

Store: This is the component that will actually be used in an interactive way. This is the ojbect you will use to page, pull new data and push data back to the server as it is saved.

 

 

---

 

2 - Visual Design:

 

none

 

---

 

 

3 - Functional Specifications/Requirements:

 

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

 

Options:

• someNumberOption (number, default: 300)
• details about this option
• more details
• someOtherOption (String or Boolean, default: "bleh")
• details details details

 

Methods:

• method1( requiredArgument, [optionalArgument] )
• description
• detail on arguments, including types and behaviour for optional arguments
• method2()
• description of method with no arguments

Events:

• someEvent
• description of when its triggered
• description of cancellable
• description of what happens when the event is cancelled
• otherEvent
• more description
• etc.

 

---

 

4 - Markup & Style:

 

     4.1 Initial markup examples

 

     no markup necessary

 

     4.2 Recommended transformed HTML markup

 

     no transformed markup

 

     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

 

    none

 

---

 

5 - Latest version of plugin:

 

n/a

 

---

 

6 - Open issues being discussed

 

What type of other things should be handled by such a library in our wish list?

• Perhaps plug-in validation.
• Formatting (to preformat the the data the store shows)
• command to pull unformatted data if formatted one is there

 

The end objective would be to allow both jQuery UI and non-jQuery UI AJAX elements to be built to interact with the data store. This would be certainly something UI can support but third party library authors will be welcome to take just this library and use it in their own jQuery tools.

 

---