Skip to content
Browse files

Small documentation changes.

  • Loading branch information...
1 parent 00bef01 commit b66980d0eb8ae69181b7231304a83ef7414e4e3c @bwolff committed Nov 19, 2012
View
3 src/docs/guide/advancedTopics.gdoc
@@ -6,13 +6,14 @@ application name would be 'foo' and the entry point name 'hello', the URL would
Sometimes it may be desired to reach the entry point under the base URL or a different URL. This can
easily be achieved by using the [Grails URL Mappings|http://grails.org/doc/latest/guide/theWebLayer.html#urlmappings].
-To map the entry point to the base URL, the following needs to be configured in the @UrlMappings.groovy@
+To map the entry point to the base URL, the following needs to be configured in the @grails-app/conf/UrlMappings.groovy@
file:
{code}
class UrlMappings {
static mappings = {
+ // Other mapping configurations
"/"(uri: "/hello")
}
View
2 src/docs/guide/configuration.gdoc
@@ -1,4 +1,4 @@
-The RWT application goes into a special configuration block in the @Config.groovy@ file.
+The RWT configuration goes into a special block in the @grails-app/conf/Config.groovy@ file.
{code}
rwt {
View
1 src/docs/guide/configuration/loggingConfiguration.gdoc
@@ -4,6 +4,7 @@ the [log4j section|http://grails.org/doc/latest/guide/conf.html#logging] in your
{code}
log4j = {
+ // Other logging configurations
debug 'grails.app.conf.RwtPluginBootStrap'
debug 'grails.plugins.rwt'
View
5 src/docs/guide/gettingStarted.gdoc
@@ -12,8 +12,9 @@ URLs with the actual name of your example application.
h3. Example Code
-There is an example project available on GitHub that can be used as a kickstart. It contains the
-example code shown in this guide and is properly configured to get started immediately.
+There is an example project [available on GitHub|http://github.com/bwolff/grails-rwt-example] that
+can be used as a kickstart. It contains the example code shown in this guide and is properly
+configured to get started immediately.
{code}
git clone https://github.com/bwolff/grails-rwt-example
View
2 src/docs/guide/gettingStarted/configureEntryPoint.gdoc
@@ -1,6 +1,6 @@
The only thing that is missing now is the configuration of our new RWT entry point. This is done
in an own [configuration|http://grails.org/doc/latest/guide/conf.html#config] block in the
-@Config.groovy@ file.
+@grails-app/conf/Config.groovy@ file.
{code}
// RWT configuration
View
4 src/docs/guide/gettingStarted/createEntryPoint.gdoc
@@ -36,6 +36,8 @@ class HelloEntryPointService implements IEntryPoint { // "The service needs to i
@Override
int createUI() {
+ log.info("Creating RWT UI ...") // "Implicit logger object"
+
Display display = new Display()
Shell shell = new Shell(display)
shell.setSize(500, 400)
@@ -71,7 +73,7 @@ class HelloEntryPointService implements IEntryPoint { // "The service needs to i
{code}
According to the Grails conventions, a Spring bean called @helloEntryPointService@ will be registered
-automatically on application start. The next step is to configure our newly create entry point.
+automatically on application start. The next step is to configure our newly created entry point.
{note}
The given code snippet is just a very simple example to demonstrate the usage. You should develop
View
4 src/docs/guide/gettingStarted/installation.gdoc
@@ -1,10 +1,12 @@
The plugin is installed using the default [Grails plugin installation mechanism|http://grails.org/doc/latest/guide/conf.html#pluginDependencies].
-Simply add/modify the following lines to the plugin dependency section in the @BuildConfig.groovy@ file:
+Simply add/modify the following lines to the plugin dependency section in the @grails-app/conf/BuildConfig.groovy@ file:
{code}
grails.project.dependency.resolution = {
plugins {
+ // Other plugin dependencies
+
compile ':rwt:0.1'
}
}
View
15 src/docs/guide/introduction.gdoc
@@ -2,12 +2,12 @@ This plugin integrates the [RAP Widget Toolkit (RWT)|http://wiki.eclipse.org/Wid
web-based Ajax/JavaScript widget library similar to [SWT|http://www.eclipse.org/swt/] - into your Grails
application.
-RWT is the UI part of the [Rich Ajax Platform (RAP)|http://www.eclipse.org/rap] - the web-ported
-[Eclipse RCP|http://wiki.eclipse.org/index.php/Rich_Client_Platform] application platform. RWT is
-provided in
+RWT is the web UI part of the [Remote Application Platform (RAP)|http://www.eclipse.org/rap] - an
+application framework based on the [Eclipse platform|http://wiki.eclipse.org/Platform].
+RWT is provided in
[standalone|http://eclipse.org/rap/developers-guide/devguide.php?topic=advanced/rwt-standalone.html]
-mode by this plugin, without the full RAP workbench or OSGi. It also enables you to use the
-[JFace API|http://wiki.eclipse.org/JFace] for building your user interfaces.
+mode by this plugin, without the full RAP workbench or OSGi. Besides the SWT API, you can use the
+[JFace API|http://wiki.eclipse.org/JFace] to build your user interfaces.
RWT enables you to create highly interactive, desktop-like Ajax interfaces by only writing
Java/Groovy code. In contrast to the popular [Google Web Toolkit|http://developers.google.com/web-toolkit/] ([Grails plugin|http://grails.org/plugin/gwt]),
@@ -22,9 +22,10 @@ For more information please refer to the documentation of the particular technol
The following pages will provide you with the necessary information to get started with Grails and
RWT. Have fun!
-h3. RWT Version
+h3. Grails & RWT Version
-The current version of this plugin comes with [RWT 2.0 M3|http://www.eclipse.org/rap/noteworthy/2.0/?build=M3].
+The plugin requires at least [Grails 2.0|http://grails.org/Download] to be used. The current version
+of this plugin ships with [RWT 2.0 M3|http://www.eclipse.org/rap/noteworthy/2.0/?build=M3].
h3. License
View
2 src/docs/guide/introduction/knownIssues.gdoc
@@ -2,6 +2,8 @@ This section sums up a few issues that will be tackled/resolved in upcoming vers
* *Theming & Branding*
** Support the RWT custom CSS and theming options.
+* *Configuration*
+** Allow to configure more aspects of RWT. Allow simple addition of resources etc.
* *Use Maven for the RWT dependencies*
** Unfortunately there is no maven repository available that can server the required RWT dependency jar files. Currently, the required jars are bundled with the plugin. This is no ideal, as it doesn't allow to switch the RWT version. This situation can be improved if the jar files will become available in a public Maven repository.

0 comments on commit b66980d

Please sign in to comment.
Something went wrong with that request. Please try again.