Permalink
Browse files

Preparing docs for 2.0.1 release

  • Loading branch information...
1 parent 0b79d81 commit 4dc3c8dce4c4b5284766c5db3288c90ca5730aae @csadilek csadilek committed Jun 22, 2012
Showing with 582 additions and 216 deletions.
  1. +1 −1 quickstart/src/main/docbook/en/chapter-1-Errai_Maven_Archetype.xml
  2. +1 −1 quickstart/src/main/docbook/en/chapter-2-Errai_CDI_Maven_Archetype.xml
  3. +1 −1 quickstart/src/main/docbook/en/chapter-3-Errai_JAX_RS_Maven_Archetype.xml
  4. +2 −2 quickstart/src/main/docbook/en/chapter-4-Errai_Kitchen_Sink_Maven_Archetype.xml
  5. +5 −0 reference/src/main/docbook/en/Author_Group.xml
  6. +5 −10 reference/src/main/docbook/en/Common_Content/Conventions.xml
  7. +9 −14 reference/src/main/docbook/en/Common_Content/Feedback.xml
  8. +3 −7 reference/src/main/docbook/en/Common_Content/Legal_Notice.xml
  9. +21 −22 reference/src/main/docbook/en/Reference_Guide.xml
  10. +36 −0 reference/src/main/docbook/en/chapter-10-Troubleshooting_FAQ.xml
  11. +2 −2 reference/src/main/docbook/en/{chapter-10-Upgrade_Guide.xml → chapter-11-Upgrade_Guide.xml}
  12. 0 reference/src/main/docbook/en/{chapter-11-Downloads.xml → chapter-12-Downloads.xml}
  13. 0 reference/src/main/docbook/en/{chapter-12-Sources.xml → chapter-13-Sources.xml}
  14. 0 ...rence/src/main/docbook/en/{chapter-13-Reporting_problems.xml → chapter-14-Reporting_problems.xml}
  15. 0 reference/src/main/docbook/en/{chapter-14-Errai_License.xml → chapter-15-Errai_License.xml}
  16. +1 −1 reference/src/main/docbook/en/chapter-2-Messaging.xml
  17. +13 −0 reference/src/main/docbook/en/chapter-3-Dependency_Injection.xml
  18. +246 −92 reference/src/main/docbook/en/chapter-4-Marshalling.xml
  19. +3 −3 reference/src/main/docbook/en/chapter-5-Remote_Procedure_Calls_RPC_.xml
  20. +35 −16 reference/src/main/docbook/en/chapter-6-Errai_CDI.xml
  21. +3 −1 reference/src/main/docbook/en/chapter-7-Errai_JAX_RS.xml
  22. +195 −43 reference/src/main/docbook/en/chapter-8-Configuration.xml
@@ -12,7 +12,7 @@
<programlisting>mvn archetype:generate \
-DarchetypeGroupId=org.jboss.errai.archetypes \
-DarchetypeArtifactId=bus-quickstart \
--DarchetypeVersion=2.0.0.Final \
+-DarchetypeVersion=2.0.1.Final \
-DarchetypeRepository=https://repository.jboss.org/nexus/content/groups/public/</programlisting>
</informalexample>
<para>When invoking the archetype build you will be asked to provide the maven groupId, artifactId and package name your GWT application should use:</para>
@@ -13,7 +13,7 @@
<programlisting>mvn archetype:generate \
-DarchetypeGroupId=org.jboss.errai.archetypes \
-DarchetypeArtifactId=cdi-quickstart \
--DarchetypeVersion=2.0.0.Final \
+-DarchetypeVersion=2.0.1.Final \
-DarchetypeRepository=https://repository.jboss.org/nexus/content/groups/public/</programlisting>
</informalexample>
<para>Customize the build properties according to your needs.</para>
@@ -8,7 +8,7 @@
<programlisting>mvn archetype:generate \
-DarchetypeGroupId=org.jboss.errai.archetypes \
-DarchetypeArtifactId=jaxrs-quickstart \
--DarchetypeVersion=2.0.0.Final \
+-DarchetypeVersion=2.0.1.Final \
-DarchetypeRepository=https://repository.jboss.org/nexus/content/groups/public/</programlisting>
</informalexample>
<para>Customize the build properties according to your needs.</para>
@@ -16,8 +16,8 @@
<informalexample>
<programlisting>mvn archetype:generate \
-DarchetypeGroupId=org.jboss.errai.archetypes \
--DarchetypeArtifactId=kitchensink-quickstart \
--DarchetypeVersion=2.0.0.Final \
+-DarchetypeArtifactId=jboss-errai-kitchensink-archetype \
+-DarchetypeVersion=2.0.1.Final \
-DarchetypeRepository=https://repository.jboss.org/nexus/content/groups/public/</programlisting>
</informalexample>
<para>Customize the build properties according to your needs.</para>
@@ -11,6 +11,11 @@
<email>cbrock@redhat.com</email>
</author>
<author>
+ <firstname>Jonathan</firstname>
+ <surname>Fuerth</surname>
+ <email>fuerth@fuerth.ca</email>
+ </author>
+ <author>
<firstname>Christian</firstname>
<surname>Sadilek</surname>
<email>csadilek@redhat.com</email>
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding='utf-8' ?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2011 JBoss, by Red Hat, Inc
~
@@ -13,13 +13,8 @@
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
- -->
-
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<section>
- <title>Document Conventions</title>
- <para>
+ --><section>
+ <title>Document Conventions</title>
+ <para>
</para>
-</section>
-
+</section>
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding='utf-8' ?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2011 JBoss, by Red Hat, Inc
~
@@ -13,17 +13,12 @@
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
- -->
-
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<section>
- <title>Feedback</title>
- <indexterm>
- <primary></primary>
- <secondary></secondary>
- </indexterm>
- <para>
+ --><section>
+ <title>Feedback</title>
+ <indexterm significance="normal">
+ <primary/>
+ <secondary/>
+ </indexterm>
+ <para>
</para>
-</section>
-
+</section>
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding='utf-8' ?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2011 JBoss, by Red Hat, Inc
~
@@ -13,12 +13,8 @@
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
- -->
-
-<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<legalnotice>
- <para>
+ --><legalnotice>
+ <para>
Copyright 2011 JBoss, a divison Red Hat, Inc
Licensed under the Apache License, Version 2.0 (the "License");
@@ -1,24 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-1-Introduction.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-2-Messaging.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="chapter-3-Dependency_Injection.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-4-Marshalling.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="chapter-5-Remote_Procedure_Calls_RPC_.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-6-Errai_CDI.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-7-Errai_JAX_RS.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-8-Configuration.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="chapter-9-Debugging_Errai_Applications.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-10-Upgrade_Guide.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-11-Downloads.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-12-Sources.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="chapter-13-Reporting_problems.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-14-Errai_License.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/>
-</book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-1-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-2-Messaging.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-3-Dependency_Injection.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-4-Marshalling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-5-Remote_Procedure_Calls_RPC_.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-6-Errai_CDI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-7-Errai_JAX_RS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-8-Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-9-Debugging_Errai_Applications.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-10-Troubleshooting_FAQ.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-11-Upgrade_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-12-Downloads.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-13-Sources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-14-Reporting_problems.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="chapter-15-Errai_License.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="sid-32473113">
+ <title>Troubleshooting &amp; FAQ</title>
+ <para>This section explains the cause of and solution to some common problems that people encounter when building applications with Errai.</para>
+ <para>Of course, when lots of people trip over the same problem, it's probably because there is a deficiency in the framework! A FAQ list like this is just a band-aid solution. If you have suggestions for permanent fixes to these problems, please get in touch with us: file an issue in our issue tracker, chat with us on IRC, or post a suggestion on our forum.</para>
+ <para>But for now, on to the FAQ:</para>
+ <section id="sid-32473113_Troubleshooting%26FAQ-WhydoesitseemthatErraican%27tseemyclassatcompiletime%3F">
+ <title>Why does it seem that Errai can't see my class at compile time?</title>
+ <para>Possible symptoms:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ uncaught exception: java.lang.RuntimeException: No proxy provider found for type:
+ <emphasis role="italics">my.fully.qualified.ServiceName</emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ <emphasis role="strong">Answer:</emphasis>
+ Make sure the
+ <xref linkend="sid-5931354"/>
+ file is actually making it into your runtime classpath.
+ </para>
+ <para>One common cause of this problem is a &lt;resources&gt; section in pom.xml that includes src/main/java (to expose .java sources to the GWT compiler) that does not also include src/main/resources as a resource path. You must include both explicitly:</para>
+ <informalexample>
+ <programlisting language="xml">&lt;resources&gt;
+ &lt;resource&gt;
+ &lt;directory&gt;src/main/java&lt;/directory&gt;
+ &lt;/resource&gt;
+ &lt;resource&gt;
+ &lt;directory&gt;src/main/resources&lt;/directory&gt;
+ &lt;/resource&gt;
+&lt;/resources&gt;</programlisting>
+ </informalexample>
+ </section>
+</chapter>
@@ -7,7 +7,7 @@
.
</para>
<section id="sid-21758204">
- <title>Upgrading from 1.x to 2.0</title>
+ <title>Upgrading from 1.* to 2.0</title>
<para>
The first issues that will arise after replacing the jars or after changing the version numbers in the
<code>pom.xml</code>
@@ -95,7 +95,7 @@
</itemizedlist>
</section>
<section id="sid-24838246">
- <title>Upgrading from 2.0.Beta to 2.0.CR1 (or Final)</title>
+ <title>Upgrading from 2.0.Beta to 2.0.*.Final</title>
<para>The following is a list of manual steps that have to be carried out when upgrading from a 2.0.Beta version to 2.0.CR1 or 2.0.Final:</para>
<itemizedlist>
<listitem>
@@ -132,7 +132,7 @@ public class HelloWorldService implements MessageCallback {
private RequestDispatcher dispatcher;
@Inject
- public HelloWorldService(RequestDispatcher disaptcher) {
+ public HelloWorldService(RequestDispatcher dispatcher) {
dispatcher = dispatcher;
}
@@ -9,6 +9,19 @@
specification for in-client component wiring.
</para>
<para>Dependency injection (DI) allows for cleaner and more modular code, by permitting the implementation of decoupled and type-safe components. By using DI, components do not need to be aware of the implementation of provided services. Instead, they merely declare a contract with the container, which in turn provides instances of the services that component depends on.</para>
+ <note>
+ <title>Classpath Scanning and ErraiApp.properties</title>
+ <para>
+ Errai only scans the contents of classpath locations (JARs and directories) that have
+ <link linkend="sid-5931354">
+ a file called
+ <code>ErraiApp.properties</code>
+ </link>
+ at their root. If dependency injection is not working for you, double-check that you have an
+ <code>ErraiApp.properties</code>
+ in every JAR and directory that contains classes Errai should know about.
+ </para>
+ </note>
<para>A simple example:</para>
<informalexample>
<programlisting language="java">public class MyLittleClass {
Oops, something went wrong. Retry.

0 comments on commit 4dc3c8d

Please sign in to comment.