Marco Tedone wrote:
First one question:
would it be better to create the documentation on your template or on an
HelloWorld example built using your template?
Good question!
Basically what makes sense is one set of docs the describe the usage of the template. This should be seperate from the template itself. The usage docs would then go through the steps - download, customize, populate, build, etc.
The reason why I'm asking is that it would be nice to have something that uses the component (let's say I created the classic public void printHello() method in the api, and implemented it in the component implementation) but in this case we should add a 'client' to the template. This leads for a second question:
Where is the best place where to build the client? I'm looking at the following url:
http://avalon.apache.org/merlin/starting/tutorial/dependencies/auto.html
You could just add a new component into the impl package that declares a dependency on a service then reference the new component in a block. I guess it depends on how sophisticated you want the demo to be. Perhaps start of with a set of components under impl (and services under the api package), show the demonstration of this, then parhaps under a second stage, add another sub-project at the same level as impl and api that contains some additional components. This would demonstrate that the template is at least adaptive to the content within it.
Anyway - go with whatever you think is best.
BTW, I've been able to develop and succesfully deploy an HelloWorld
service/component and to run the test on it. The only piece I'm missing is
to create a client that looks for the service and uses the printHello()
method.
Just create a component that implements serviceable, add the @avalon.dependency tag referencing the service you want to depend on, the add a <component> declarion in the block to tell merlin to create the component. Merlin will figure out that the dependent is required and will autodeploy it.
Stephen.
Marco
Stephen McConnell wrote:
Absolutely!
Actaully I'm thinking more and more that the template itself is something that could be become an avalon product (formal releases, updates incorporated as maven, merlin and other avalon facilities evolve). In addition to the PDF (which is a good idea), there is the documetation included under the xdocs directory (its currently very minimal).
To generate the current docs you can:
cd template maven avalon:site
The generated html is in target/docs.
Putting all of this together would result in a micro-bootstrap in the avalon/merlin world. About the only thing missing is a nice Merlin iunteractive installer!
Cheers, Stephen.
Cheers,--
Marco
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Stephen J. McConnell mailto:[EMAIL PROTECTED]
|------------------------------------------------| | Magic by Merlin | | Production by Avalon | | | | http://avalon.apache.org/merlin | | http://dpml.net/ | |------------------------------------------------|
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--
Stephen J. McConnell mailto:[EMAIL PROTECTED]
|------------------------------------------------| | Magic by Merlin | | Production by Avalon | | | | http://avalon.apache.org/merlin | | http://dpml.net/ | |------------------------------------------------|
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
