Author: rdonkin Date: Wed Jun 8 13:24:39 2005 New Revision: 189633 URL: http://svn.apache.org/viewcvs?rev=189633&view=rev Log: Fixes for documentation. Thanks to Simon Kitching.
Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/faq.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/binding.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/derived.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/examples.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/integration.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/output.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/tutorial.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/writing.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/index.xml jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/navigation.xml Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/faq.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/faq.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/faq.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/faq.xml Wed Jun 8 13:24:39 2005 @@ -179,10 +179,7 @@ </a> </dt> <dd> - At the moment, <code>BeanWriter</code> is the only way to output the xml. - This writes the xml (as characters) to standard java io streams. - Work will begin on a SAX-based writer (which will generate SAX events) - very soon. + Betwixt can output xml as streaming text or as SAX events. </dd> </dl> <dl> @@ -227,9 +224,8 @@ beanWriter.setWriteIDs(false); </source> and then Betwixt will no longer automatically add <code>ID</code> attributes. - Once this property is set (to false), BeanWroter will throw a - <code>CyclicReferenceException</code> when any cyclic references which are - encountered in the bean graph. + Once this property is set (to false), when a cycle reference is encountered + in the bean graph, a <code>CyclicReferenceException</code> will be thrown. </dd> </dl> @@ -274,9 +270,8 @@ </dt> <dd> Betwixt uses <a href='http://jakarta.apache.org/commons/digester/index.html'>Digester</a> for bean - reading. There are problems integrating the last release with custom digester rules. - The CVS HEAD version of betwixt now supports this and so users who need to do this should - upgrade. + reading. With care and knowledge of the way that Betwixt reads beans, + extra rules can be used to add custom functionality. </dd> <dt> <a name="bean-read-failure"> Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/binding.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/binding.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/binding.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/binding.xml Wed Jun 8 13:24:39 2005 @@ -50,7 +50,7 @@ <p> <strong>Note</strong> that the attribute and element names given in a .betwixt file (as usual) - override the name mapping settings on the <code>XMLIntrotrospector</code>. + override the name mapping settings on the <code>XMLIntrospector</code>. </p> <subsection name="Using A Custom Type Name To Element Name Mapping"> @@ -305,7 +305,7 @@ <subsection name="Caching and the XMLRegistry"> <p> - Introspection is slow and so caching the results improves preformance. Though the writers + Introspection is slow and so caching the results improves performance. Though the writers and readers can - by nature - only be used safely in a single thread, a single <code>XMLIntrospector</code> instance can be safely shared amongst multiple threads. Sharing a single instance will improve performance by sharing it's <code>XMLBeanInfo</code> cache. Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/derived.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/derived.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/derived.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/derived.xml Wed Jun 8 13:24:39 2005 @@ -26,7 +26,7 @@ <section name='Derived Beans'> <subsection name='What Is A Derived Bean?'> <p> -A derived bean is one which runtime class differs from the mapped property type +A derived bean is one whose runtime class differs from the mapped property type (as determined during introspection). </p> </subsection> Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/examples.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/examples.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/examples.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/examples.xml Wed Jun 8 13:24:39 2005 @@ -32,7 +32,7 @@ xml and back again. A round trip, no less! </p> <p> - In order to run these simple examples, the classpath needs to contain Betwixt and all it's + In order to run these simple examples, the classpath needs to contain Betwixt and all its <a href='../dependencies'>dependencies</a>. Note that any <a href='http://java.sun.com/xml/jaxp/index.html'>JAXP (1.1 or later)</a> compliant parser can be used to replace xerces and xml-apis. JUnit is not required to run betwixt (but is needed Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/integration.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/integration.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/integration.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/integration.xml Wed Jun 8 13:24:39 2005 @@ -24,7 +24,7 @@ <body> - <section name='Cocooon'> + <section name='Cocoon'> <p> <a href='http://cocoon.apache.org/'>Cocoon</a> is a web development framework (and more) built around component pipelines and XML. A transformer is available for Cocoon which Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/output.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/output.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/output.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/output.xml Wed Jun 8 13:24:39 2005 @@ -18,14 +18,14 @@ <document> <properties> - <title>Outputing Results</title> + <title>Outputting Results</title> <author email="[EMAIL PROTECTED]">Robert Burrell Donkin</author> </properties> <body> -<section name='Outputing Results (Of Bean Writing)'> +<section name='Outputting Results (Of Bean Writing)'> <p> -Betwixt is flexible when it comes to outputing the results of bean writing. +Betwixt is flexible when it comes to outputting the results of bean writing. The abstract <code>AbstractBeanWriter</code> class provides a basic framework with an implementation API inspired by <a href='http://www.saxproject.org/'>SAX</a>. Betwixt ships with writers that support SAX and textual streams @@ -34,7 +34,7 @@ </section> <section name='Pushing Results to a Textual Stream'> <p> -<code>BeanWriter</code> push results to a textual stream. This can be used +<code>BeanWriter</code> pushes results to a textual stream. This can be used to efficiently push content through a socket or just to create a simple String. Note that only document fragments are created so you may need to append any prologs before writing the bean. @@ -121,7 +121,7 @@ </section> <section name='Pushing Results to SAX'> <p> -<code>SAXBeanWriter</code> push results to a SAX content handler. +<code>SAXBeanWriter</code> pushes events to a SAX content handler. This allows Betwixt to efficiently participate as a content generator in SAX-based pipelines such as <a href='http://cocoon.apache.org/'>cocoon</a>. </p> Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/tutorial.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/tutorial.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/tutorial.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/tutorial.xml Wed Jun 8 13:24:39 2005 @@ -44,7 +44,7 @@ object model</a> for RSS 0.91. This was originally created for <a href='http://jakarta.apache.org/commons/digester/index.html'>Digester</a> -by Craig R. McClanahan and Ted Husted with a few ammendments for this tutorial. +by Craig R. McClanahan and Ted Husted with a few amendments for this tutorial. There are only four main objects in the model: </p> <ul> Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/writing.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/writing.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/writing.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/guide/writing.xml Wed Jun 8 13:24:39 2005 @@ -31,10 +31,10 @@ For more details see <a href='http://jakarta.apache.org/commons/beanutils/index.html'>BeanUtils</a>. </p> <p> -Betwixt now supports the (correct) writing of objects implementating DynaBean. Rather than using standard +Betwixt now supports the (correct) writing of objects implementing DynaBean. Rather than using standard introspection for these objects, <code>Betwixt</code> now interrogates the DynaClass. Using .betwixt files -with DynaBeans is not yet supported and special behaviour of DynaBeans can be overridden by specifying a -.betwixt file. +with DynaBeans is not yet supported. The special behaviour of DynaBean classes will be overridden when a +.betwixt file is present. </p> </subsection> <subsection name='Writing Entity Beans'> @@ -42,7 +42,7 @@ Entity beans are a kind of Enterprise Java Bean. For more details see the <a href='http://java.sun.com/j2ee/'>J2EE</a> specification. They are a common way to persist data. When dealing with an entity bean, you usually deal with the remote interface rather than the -concrete implementation. There is no gaurantee that the class presented by the container will be +concrete implementation. There is no guarantee that the class presented by the container will be the class your created to provide the bean's functionality. Indeed, <code>Proxy</code> implementations are one common way in which the remote interfaces are implemented. Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/index.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/index.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/index.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/index.xml Wed Jun 8 13:24:39 2005 @@ -132,7 +132,7 @@ </p> <p> You can get the nightly builds from - <a href="http://jakarta.apache.org/builds/jakarta-commons/nightly/commons-betwixt/">here</a> + <a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-betwixt/">here</a> </p> </section> Modified: jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/navigation.xml URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/navigation.xml?rev=189633&r1=189632&r2=189633&view=diff ============================================================================== --- jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/navigation.xml (original) +++ jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/xdocs/navigation.xml Wed Jun 8 13:24:39 2005 @@ -38,15 +38,15 @@ <item name="Community" href="/community.html"/> <item name="Powered By" href="/powered.html"/> <item name="Tasks" href="/tasks.html"/> - <item name="SVN" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/betwixt/trunk/"/> - <!--item name="Javadoc (CVS latest)" href="apidocs/index.html"/--> + <item name="View SVN" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/betwixt/trunk/"/> + <item name="SVN" href="http://svn.apache.org/repos/asf/jakarta/commons/proper/betwixt/"/> </menu> <menu name="User guide"> <item name="Getting Started" href="/guide/start.html"/> <item name="Binding Beans" href="/guide/binding.html"/> <item name="Derived Bindings" href="/guide/derived.html"/> <item name="Writing Beans(Advanced)" href="/guide/writing.html"/> - <item name="Outputing The Results" href="/guide/output.html"/> + <item name="Outputting The Results" href="/guide/output.html"/> <item name="Reading Beans(Advanced)" href="/guide/reading.html"/> <item name="Integrating" href="/guide/integration.html"/> <item name="Examples" href="/guide/examples.html"/> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]