documentation on the UI aspects of creating a new module

[GoogleCodeExporter]

Can you please write some documentation that covers all the UI aspects of 
adding a new module?

Say for example a student wants to add fish data. Say they create a fish icon 
(but what is he best place to do that also?) and they want to have the UI 
updated for the fish data source, a fish icon, and a fish domain. Which file 
and with what code do they update? I remember there being something about 
setting up a variable like "isBird", but I don't have the full trace. 

This is the sort of documentation we lack and need. And we need to connect it 
to documentation of any of the required server side bits that we may or may not 
have already documented.

Original issue reported on code.google.com by apse...@gmail.com on 9 Dec 2012 at 11:03

[GoogleCodeExporter]

Reclassifying as a task.

Original comment by ewpat...@gmail.com on 10 Dec 2012 at 12:15

• Added labels: Type-Task
• Removed labels: Type-Defect

[GoogleCodeExporter]

I consider inline commenting to be part of the documentation work that needs to 
be completed for comprehension of the UI aspects.

I reviewed some of Chen's inline comments, he pointed out parts that you had 
added that you would need to comment on. This includes calling 
DataTypeModule.registerVisibilityFunction and 
DataTypeModule.registerIconLocator and the callbacks that are implemented. This 
includes commenting of "    var birdIcon = 
$("input[value='birds']+img").attr("src");
" , this is primarily all between line 10 and 33 in the speciesHierarchy.js 
file, although feel free overlook the whole file for specific things you added. 
This commenting also applies to the characteristics facet js files, naturally.

Original comment by apse...@gmail.com on 12 Dec 2012 at 3:19