[vtk-developers] vtknew tree and testing / examples

[Sebastien BARRE]

Hi David,

At 27/06/2001 13:41, David Gobbi wrote:

>I'd go halfway on this.  I'd definitely like to see the 'Testing'
>separated out as above, but for the 'Examples' it might be better to
>separate them out according to theme,

Good idea.

>and also specifically pop the
>'Examples' directory at a very low-level to make it very easy to find

Indeed, as you pointed, many "theme examples" may use classes pertaining to 
different packages, so a low-level 'Examples' directory would fit in that 
case, you are right.

>vtk/Examples/Tcl/Applications    # vol.tcl, Decimate.tcl etc
>vtk/Examples/Tcl/Medical         # medical-related examples
>vtk/Examples/Tcl/Volume          # volume rendering

I'd rather see :

>vtk/Examples/Applications/Tcl   # vol.tcl, Decimate.tcl etc
>vtk/Examples/Applications/Python   # vol.tcl, Decimate.tcl etc
>vtk/Examples/Medical/Tcl        # medical-related examples
>vtk/Examples/Medical/Python        # medical-related examples

I think the language separation should be done at the very end. Ideally, 
the very same example coded in both Tcl, C++ and Python is a great learning 
ressource because :
         a) it can show to someone used to a language 'A' how to switch to 
the same feature-set in a language 'B'
         b) it shows to someone used to languages 'A', 'B', ...'C' what is 
very specific to VTK (indeed, the pipeline stuff, etc.).
Hence, I think that in that "theme" case, we should put the language 
folders at the very end of the path.

>etc.
>vtk/Examples/Python/
>vtk/Examples/Java/
>vtk/Examples/Cxx/

This is a bit problematic, because we would end with :

vtk/Examples/Cfd/           (CFD)
vtk/Examples/Cxx/
vtk/Examples/Fem/         (finite element)
vtk/Examples/Financial/
vtk/Examples/Gardening/
vtk/Examples/Java/
vtk/Examples/Medical/
vtk/Examples/Python/

Thus, you see, "languages" mixed with 'theme'. Looks bad to me.

I definitely agree on a "theme" folder :

vtk/Examples/Cfd/           (CFD)
vtk/Examples/Fem/         (finite element)
vtk/Examples/Financial/
vtk/Examples/Medical/

but I would definitely keep these examples that do rely on a single package 
to the package's directory :

vtk/Graphics/Examples/Tcl
vtk/Graphics/Examples/Python
vtk/Graphics/Examples/Cxx

vtk/Graphics/Testing/Tcl
vtk/Graphics/Testing/Python
vtk/Graphics/Testing/Cxx

> > Moreover, this would allow me to write some new Perl scripts to write a new
> > "Links to examples" page, sorted by package :)
>
>Sort by theme!  Sort by theme! ;)

I'm ready to sort on whatever criterion you want :) Just put the files 
where they need to be :)

Ideally, it would have been nice to have a comment at the beginning of each 
examples, something like :

# Short description :
# Keywords :

then I would be sooooooo happy (and the users community would be too). I 
could do very nice examples page :)