[kepler-dev] kepler actor documentation

[Matt Jones]

I updated the EML200DataSource documentation this morning to try to show 
what I thought would be a good level of granularity for the actor 
documentation.  It now displays in Kepler if you run 'ant generateDoc' 
before you run 'ant run-dev'.   However, for some reason the Parameter 
documentation does not display -- it just says "No description".  Any 
idea of how to fix this? The 'trigger' and 'output' ports inherited from 
the superclass also show up as 'No port description', but I think you 
already knew about that issue.

Nandita's HTML version of the actor docs shows all of the documentation, 
including the Parameter docs. However, it ignores the HTML formatting 
that I embedded.  It seems it would be nice to be able to deal with that 
because we need a way to provide some formatting in longer documentation 
sections.  The html tags are probably being escaped in the XML output 
and so probably are not being recognized by the XSLT processor.  Nandita 
-- what do you think?

Jing -- can you review the EML200DataSource documentation for content to 
be sure I didn't make any mistakes -- I pretty much rewrote it all. Thanks.

Matt

Dan Higgins wrote:
> Matt,
>    You may be interested in just seeing the list of actors currently in 
> Kepler that were created at NCEAS under SEEK. [May be incomplete.]
> 
> Dan
> 
> 
> ------------------------------------------------------------------------
> 
> Actors created by NCEAS
> 
> -- Dan Higgins --
> AddGrids
> CVHull2Raster
> GARPSummary
> GISHullActorJ
> GridRescaler
> GridReset
> MergeGrids
> MessageDigestTest 
> MetadataSource
> ZipFiles
> Rescaler
> KeplerImageReader
> ClimateChangeFileProcessor
> ClimateFileProcessor
> AscToRaw
> URLToLocalFile
> IJMacro
> ImageJActor
> ShowLocations
> RExpression
> --- 
> 
> -- Chad --
> GarpPrediction
> GARPPresampleLayers
> GARPAlgorithm
> GDALFormatTranslator
> GDALWarpandProjection 
> FilesystemCacheGet
> FilesystemCachePut
> ---
> 
> --Matt/Jing--
> EML2Dataset
> EcogridWriter
> RBoxPlot
> SummaryStatistics
> ---

-- 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Matt Jones                                   Ph: 907-789-0496
jones at nceas.ucsb.edu                    SIP #: 1-747-626-7082
National Center for Ecological Analysis and Synthesis (NCEAS)
UC Santa Barbara     http://www.nceas.ucsb.edu/ecoinformatics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~