[ome-devel] Documentation Effort to coincide with 2.6 Release

Tom Macura tm289 at cam.ac.uk
Thu Jul 13 20:27:22 BST 2006


Hi,

As Ilya wrote to y'all, the 2.6.0 release is hopefully coming out soon.

I think it's a great time to add descriptions of some of OME's newer  
features and to update descriptions of past released features.

I have made a list of areas i want to address (enclosed below). If  
you think other areas need addressing, please let me know. I have  
volunteered myself to work on the documentation slowly as a non- 
priority for the next couple of weeks.

We are also going to be adding links from the OME WebUI header to a  
specific web-page that gives further info.  e.g so where you see

Analysis
-----------
FindSpots

it will be FindSpots (?) with the ? linking to the FindSpots guide.

Please give feedback. If there are other OME features that you think  
are important but not sufficiently described please let me know and  
maybe I'll have enough time to write about them.

Tom

------------

Expand OME Command-line utility online documentation to discuss the  
following topics

	admin
		  configure
		  uninstall
		
	data
		chown
		delete
		
	annotate [detailed info about spreadsheet syntax]
		wizards [PDI/CGC]
		spreadsheet
		
	scripting OME.
		Make the obvious point that OME commands can be combined into  
scripts --
		that all commands can have all inputs specified on the command line
		reference HOWTO about using image importers
	
Expand Getting Started
	- add section introducing spreadsheet imports for mass annotations
	(Intro of concepts, screenshots, link to command-line)
	
	- reference Walk-through about executing an Analysis Chain
	- reference HOWTO about mass image import

Write HOWTO about how to do a mass import of images into OME in a  
structured way.

Do we want to say something about guest access? Maybe in the getting  
started section
where we talk about login


More information about the ome-devel mailing list