niclas 2004/03/14 03:12:45 Modified: merlin/platform/xdocs/starting/tutorial internal.xml merlin/platform/xdocs/starting/tutorial/config block.xml configurable.xml defaults.xml index.xml navigation.xml override.xml merlin/platform/xdocs/starting/tutorial/context casting.xml entries.xml standard.xml Log: Applied patches recommended by Daniel Frey. Revision Changes Path 1.5 +6 -6 avalon/merlin/platform/xdocs/starting/tutorial/internal.xml Index: internal.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/internal.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- internal.xml 25 Jan 2004 13:28:50 -0000 1.4 +++ internal.xml 14 Mar 2004 11:12:45 -0000 1.5 @@ -57,8 +57,8 @@ <subsection name="Targetted debugging using -config"> <p> - We can also override the logging priority for the component using the - a target override directive. + We can also override the logging priority for the component using + a target override directive. </p> <p><i>${basedir}\conf\config.xml</i></p> <source><![CDATA[ @@ -122,8 +122,8 @@ <p> As the compoent has been declared in the block.xml file, the default deployment policy is to deploy it on startup. In this example the - component is a transient component with. The logging message details - the lifestyle and policy re. activation on startup. + component is a transient component. The logging message details + the lifestyle and policy during activation on startup. </p> <source><![CDATA[ @@ -175,14 +175,14 @@ <p> When merlin is launched in execute mode (using the -execute command - line parameter, Merlin automatically initiates container decomissioning + line parameter), Merlin automatically initiates container decomissioning once deployment is complete. If the -execute parameter is absent, Merlin will continue until a ^C interup is encountered. </p> <p> Decommissioning of a component involves stopping the compoent if it - implements the Startable interface, foloowed by component disposal. + implements the Startable interface, followed by component disposal. </p> <source><![CDATA[ 1.4 +13 -8 avalon/merlin/platform/xdocs/starting/tutorial/config/block.xml Index: block.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/config/block.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- block.xml 25 Jan 2004 13:28:50 -0000 1.3 +++ block.xml 14 Mar 2004 11:12:45 -0000 1.4 @@ -27,10 +27,11 @@ </header> <body> <section name="Using Merlin"> - <subsection name="Declaring a configuration in the Component Directive"> + <subsection name="Declaring a Configuration in the Component Directive"> <p> - We can modify the configuration behaviour by including a configuration - within the block.xml deployment directive. + We can overwrite the default configuration behaviour by + including a configuration within the block.xml deployment + directive. </p> <p> Resources supporting this tutorial are contained in the @@ -51,6 +52,7 @@ Build and run the tutorial again. </p> <source> +$ maven $ merlin -execute target\classes </source> <p> @@ -63,15 +65,18 @@ [INFO ] (hello): configuration stage [INFO ] (hello): initialization stage [INFO ] (hello): source: explicit configuration within block - </source> +</source> </subsection> - <subsection name="Using Defaults"> + <subsection name="Using Target Overrides"> <p> - The <a href="defaults.html">next tutorial</a> shows how - Merlin provides support for the packaging of default - configurations with a component. + The <a href="override.html">next tutorial</a> shows how + you can modify configurations via declaration of a set + configuration override targets. This is usefull when + you have a packaged deployment scenario and you want to + override/suppliment the configuration with different + information (such as host name, username, passwords, etc.). </p> </subsection> 1.5 +4 -4 avalon/merlin/platform/xdocs/starting/tutorial/config/configurable.xml Index: configurable.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/config/configurable.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- configurable.xml 25 Jan 2004 13:28:50 -0000 1.4 +++ configurable.xml 14 Mar 2004 11:12:45 -0000 1.5 @@ -26,7 +26,7 @@ </header> <body> <section name="Using Merlin"> - <subsection name="Adding configuration support to the component"> + <subsection name="Adding Configuration Support to the Component"> <p> To be supplied with a configuration, our component must implement the Avalon Framework Configurable interface. The following code @@ -81,9 +81,9 @@ <subsection name="Declaring a Configuration"> <p> - A number of different approaches to controlling the configuration - that is supplied to a component are presented in the <a href="block.html">next - turorial</a>. + A number of different approaches to controlling the + configuration that is supplied to a component are presented in + the <a href="defaults.html">next tutorial</a>. </p> </subsection> 1.4 +10 -12 avalon/merlin/platform/xdocs/starting/tutorial/config/defaults.xml Index: defaults.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/config/defaults.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- defaults.xml 25 Jan 2004 13:28:50 -0000 1.3 +++ defaults.xml 14 Mar 2004 11:12:45 -0000 1.4 @@ -26,7 +26,7 @@ </header> <body> <section name="Using Merlin"> - <subsection name="Creating a default configuration"> + <subsection name="Creating a Default Configuration"> <p> Merlin provides support for the association of a default with a component type. This is achieved by including a @@ -49,29 +49,27 @@ Build and run the tutorial again. </p> <source> +$ maven $ merlin -execute target\classes - </source> +</source> <p> - In the logging output we see that the configuration - supplied to the component has been overrided by the + In the logging output we see that the default configuration + supplied to the component has been generated by the information we supplied inside the xconfig resource. </p> <source> [INFO ] (tutorial.hello): configuration stage [INFO ] (tutorial.hello): initialization stage [INFO ] (tutorial.hello): source: packaged default - </source> +</source> </subsection> - <subsection name="Using Target Overrides"> + <subsection name="Using Block Overrides"> <p> - The <a href="override.html">next tutorial</a> shows how - you can modify configurations via declaration of a set - configuration override targets. This is usefull when - you have a packaged deployment scenario and you want to - override/suppliment the configuration with different - information (such as host name, username, passwords, etc.). + The <a href="block.html">next tutorial</a> shows how Merlin + provides support for the packaging of configurations within + the block.xml deployment directive with a component. </p> </subsection> 1.4 +7 -7 avalon/merlin/platform/xdocs/starting/tutorial/config/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/config/index.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- index.xml 25 Jan 2004 13:28:50 -0000 1.3 +++ index.xml 14 Mar 2004 11:12:45 -0000 1.4 @@ -38,18 +38,18 @@ </td> </tr> <tr> - <td><a href="block.html">Declaring</a></td> - <td> - This tutorial covers the declaration of a configuration - as part of the <component> tag within a block directive. - </td> - </tr> - <tr> <td><a href="defaults.html">Defaults</a></td> <td> Tutorial covering the creation of a default configuration and association of the default with a particular component type. + </td> + </tr> + <tr> + <td><a href="block.html">Declaring</a></td> + <td> + This tutorial covers the declaration of a configuration + as part of the <component> tag within a block directive. </td> </tr> <tr> 1.9 +2 -2 avalon/merlin/platform/xdocs/starting/tutorial/config/navigation.xml Index: navigation.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/config/navigation.xml,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- navigation.xml 2 Mar 2004 00:00:17 -0000 1.8 +++ navigation.xml 14 Mar 2004 11:12:45 -0000 1.9 @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version="1.0" encoding="UTF-8"?> <!-- Copyright 2004 Apache Software Foundation @@ -40,8 +40,8 @@ <item name="Behind the Scenes" href="/starting/tutorial/internal.html"/> <item name="Configurations" href="/starting/tutorial/config/index.html"> <item name="Using" href="/starting/tutorial/config/configurable.html"/> - <item name="Declaring" href="/starting/tutorial/config/block.html"/> <item name="Defaults" href="/starting/tutorial/config/defaults.html"/> + <item name="Declaring" href="/starting/tutorial/config/block.html"/> <item name="Overriding" href="/starting/tutorial/config/override.html"/> </item> <item name="Contextualization" href="/starting/tutorial/context/index.html"/> 1.7 +5 -3 avalon/merlin/platform/xdocs/starting/tutorial/config/override.xml Index: override.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/config/override.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- override.xml 14 Mar 2004 06:00:41 -0000 1.6 +++ override.xml 14 Mar 2004 11:12:45 -0000 1.7 @@ -26,11 +26,11 @@ </header> <body> <section name="Using Merlin"> - <subsection name="Using configuration overrides"> + <subsection name="Using Configuration Overrides"> <p> The Merlin command line tool allows the specification of a set of overriding configuration targets. Each target in the - <targets> set contains a a configuration that may be + <targets> set contains a configuration that may be applied to a named component. This allows modification of a configuration without modification of a packaged block.xml file. @@ -41,6 +41,7 @@ </p> </subsection> <subsection name="Target Override Format"> + <p><i>config.xml</i></p> <source><![CDATA[ <targets> <target path="/tutorial/hello"> @@ -58,8 +59,9 @@ in the tutorials/configuration package). </p> <source> +$ maven $ merlin -execute target\classes -config conf\config.xml - </source> +</source> <p> Executing Merlin demonstrates that the configuration supplied to the hello component reflects the configuration element contained 1.4 +8 -8 avalon/merlin/platform/xdocs/starting/tutorial/context/casting.xml Index: casting.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/context/casting.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- casting.xml 25 Jan 2004 13:28:50 -0000 1.3 +++ casting.xml 14 Mar 2004 11:12:45 -0000 1.4 @@ -26,7 +26,7 @@ </header> <body> <section name="Using Merlin"> - <subsection name="Casting Context to a custom Interface"> + <subsection name="Casting Context to a Custom Interface"> <p> This tutorial describes how Merlin provides support for the safe casting of a supplied context instance to @@ -40,10 +40,10 @@ <subsection name="Requirements"> <p> While the context interface provides the mechanisms to - access any object type, it is sometimes convinient to + access any object type, it is sometimes convenient to declare a domain specific interface and context implementation. This enables client code to take advantage - of convinience accessors, resulting in code less cluttered + of convenience accessors, resulting in code less cluttered with casting and context entry key references. </p> <p> @@ -216,7 +216,7 @@ } </source> </subsection> - <subsection name="Declaring the context interface"> + <subsection name="Declaring the Context Interface"> <p> To be supplied with a domain specific context to which the component can safely cast, we need to declare this @@ -235,7 +235,7 @@ Secondly, we need to provide corresponding meta-data to Merlin describing the implementation class that it can use to construct the context instance. The following changes to the block.xml - description include the "class" attribute on the context directive. + description include the class attribute on the context directive. The class attribute tells Merlin to use the named class as the context implementation. </p> @@ -247,14 +247,14 @@ </container> ]]></source> </subsection> - <subsection name="Executing the example"> + <subsection name="Executing the Example"> <p> Build and run the tutorial. </p> <source> -$ ant jar +$ maven $ merlin build\classes - </source> +</source> <p> In the logging output we see the standard context values accessed via the domain specific context interface. 1.7 +4 -4 avalon/merlin/platform/xdocs/starting/tutorial/context/entries.xml Index: entries.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/context/entries.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- entries.xml 25 Jan 2004 13:28:50 -0000 1.6 +++ entries.xml 14 Mar 2004 11:12:45 -0000 1.7 @@ -39,7 +39,7 @@ </p> </subsection> - <subsection name="Creating a non-Component Object"> + <subsection name="Creating a Non-Component Object"> <p> To demonstrate Merlin's support for the supply of non-component objects to a component, we need to create an @@ -116,7 +116,7 @@ The following source demonstrates the implementation of the contextualization stage, access and casting of a context entry to the NumberCruncher class, and the - the invocation of on operation on that class. + the invocation of an operation on that class. </p> <source> @@ -200,14 +200,14 @@ <source> $ maven $ merlin -execute target\classes - </source> +</source> <p> In the logging output we see that Merlin has created and supplied the NumberCruncher instance to the component. </p> <source> [INFO ] (tutorial.hello): result: 10.5 - </source> +</source> </subsection> <subsection name="Context Casting"> 1.6 +2 -2 avalon/merlin/platform/xdocs/starting/tutorial/context/standard.xml Index: standard.xml =================================================================== RCS file: /home/cvs/avalon/merlin/platform/xdocs/starting/tutorial/context/standard.xml,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- standard.xml 25 Jan 2004 13:28:50 -0000 1.5 +++ standard.xml 14 Mar 2004 11:12:45 -0000 1.6 @@ -70,7 +70,7 @@ </table> </subsection> - <subsection name="Adding context support to the component"> + <subsection name="Adding Context Support to the Component"> <p> In order to receive a runtime context we need to update the HelloComponent source so that it implements the Avalon @@ -154,7 +154,7 @@ </source> </subsection> - <subsection name="Custom entries"> + <subsection name="Custom Entries"> <p> The <a href="entries.html">next tutorial</a> shows how
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]