• If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!

View
 

Worldwide Sprint 2 Documentation

Page history last edited by Micheil 15 years ago

This page covers the documentation topics for Worldwide Sprint 2

 

First task to complete is to go through each plugin's page on pbwiki, and flesh out the specs for them. The documentation pages for each are said to be in fairly good shape, but once we have specs, we can easily write the docs to go with them.

 

Plugins:

For each plugin, we need to go through and check if specs and documentation exists, and how complete it is. Simply mark each with

  • Complete
  • Needs Work
  • Missing

 

If you would like to work on one, put your IRC Nick or Realname into the Owner Column. This will also act as a sort of attribution, which will look cool.

 

Plugin (internally) Specs Documentation Owner
Accordion (docs) Complete Needs Work  
Datepicker (docs) Missing
 
Dialog (docs) Complete Needs Work (Options Missing)  
Draggable (docs) Needs Work (Spec Mismatch) Needs Work (Spec Mismatch)  
Droppable (docs) Complete    
ProgressIndicator (docs) Not Sure (Complete)    
Resizable (docs) Needs Work    
Selectable (docs) Missing    
Slider (docs) Complete    
Sortable (docs) Complete    
Tabs (docs) Complete    

Effects Overview

Same as with Plugins, only with effects.

Effect Specs (N/A ?) Documentation Owner
Blind (docs)   Complete
 
Bounce (docs)   Complete  

Clip (docs)

  Complete  
Drop (docs)   Complete  
Explode (docs)   Complete  
Fold (docs)   Complete  
Highlight (docs)   Complete  
Puff (docs)   Complete  
Pulsate (docs)   Complete
 
Scale (docs)   Complete  
Shake (docs)   Complete  
Size (docs)   Complete  
Slide (docs)   Complete  

Transfer (docs)

  Complete  

 

Comments (3)

Dan Wellman said

at 4:40 am on Apr 18, 2009

I'm wondering if jQuery should be listed as a dependancy? At the moment all widgets and effects list only the core files as dependancies. Perhaps even the widget/effect source file should be listed as well?

Micheil said

at 4:41 am on Apr 18, 2009

That's a good point, I guess it's something we've assumed "Oh, jQuery UI, well, the name, I must need the jQuery thing".

Dan Wellman said

at 9:18 am on Apr 18, 2009

Just thought I'd mention it, I know it's obvious but I think with API docs it is better to include everything :)

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