Developer Meetings/20121106

From Slicer Wiki
Jump to: navigation, search
Home < Developer Meetings < 20121106

Attendees:

To discuss

  • Organization of LookupTable wiki pages. See below
  • Transform hierarchy are not saved. See #2725

Conclusion

Additional material

Lookup table discussion

Hi Folks, 

My understanding is that we should consolidate the documentation to minimize confusion while presenting the information to the user.

Currently there are the following pages:

1) http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/SlicerApplication/LookupTables
2) http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/SlicerApplication/LookupTables/TractographyColors
3) http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/SlicerApplication/LUTs/TractographyColors

where 3) redirect into 2)


=====
Firstly, we should chose between the following two conventions:

  http://www.slicer.org/slicerWiki/index.php/Documentation/X.Y/SlicerApplication/LookupTables

or 

   http://www.slicer.org/slicerWiki/index.php/Documentation/X.Y/SlicerApplication/LUTs


=====
Secondly, if a module exposes new lookup tables, these ones should probably be documented as subpage(s) of the module. 

For example:

http://www.slicer.org/slicerWiki/index.php/Documentation/X.Y/Modules/TractographyDisplay/LookupTables/Tractography

With this convention a module could document additional lookup tables as sub pages of "Documentation/X.Y/Modules/TractographyDisplay/LookupTables"

======
Thirdly, all lookup tables should be categorized in a LookupTables category allowing to list them.


=====
Fourthly, wiki page code allowing to describe a lookup table should probably be generated based on the description available in the code. We could also think about a mechanism to generate it at runtime and export it in the right format using python.

=====
Last, let me know if you would like to discuss the details over the phone. I would be happy to provide guidance and review code or wiki pages.

Thanks
Jc