Mailing-List: contact jena-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: jena-dev@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of dave.e.reynolds@gmail.com
 designates 74.125.82.43 as permitted sender)
Subject: Re: Example code
From: Dave Reynolds <dave.e.reynolds@gmail.com>
To: jena-dev@incubator.apache.org
In-Reply-To: <4EC94FDA.70406@epimorphics.com>
References: <4EC94FDA.70406@epimorphics.com>
Content-Type: text/plain; charset="UTF-8"
Date: Mon, 21 Nov 2011 08:54:55 +0000
Message-ID: <1321865695.2634.5.camel@dave-desktop>
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit

On Sun, 2011-11-20 at 19:07 +0000, Ian Dickinson wrote: 
> There are various bits of example code referenced from the current 
> documentation. There's more that I would like to add to support some of 
> the new content. What we don't have, at the moment, is a place to put it 
> (Paolo's github notwithstanding [1] :)
> 
> Proposal: create an svn module
> 
>    https://svn.apache.org/repos/asf/incubator/jena/Jena2/Examples/
> 
> (with standard trunk/, tags/, branches/ layout). Use maven for 
> dependencies. For each example, e.g. the Ont API class hierarchy 
> example, create a Java package:
> 
>    org.apache.jena.example.class_hierarchy
> 
> in src/main/java, and put necessary resources (*.rdf, assembler configs, 
> etc), in src/main/resources/example/class_hierarchy
> 
> Optionally, we could group examples together by theme:
> 
>    org.apache.jena.example.ontology.class_hierarchy
> 
> but personally I'm in favour of a flat structure so that users can see 
> all of the examples at one level.
> 
> There should be some level of README documentation about each example in 
> the examples package somewhere.
> 
> Distribution could either be by just letting users check out the code 
> from svn or the git mirror (we could provide detailed instructions on 
> the web site), or we could add an assembly to zip up the contents of the 
> examples module.
> 
> Comments?

Seems like a good plan. I'd be in favour of letting users check it out
to begin with (creating an assembly and zip may set a high expectation
of level of packaging than we want).

Dave