Changeset 9830

Timestamp:

08/09/07 18:45:38 (3 years ago)

Author:

rcmatthews

Message:

 

Location:

documents/trunk/documentation/src

Files:

• app-dev/build-app.xml (modified) (3 diffs)
• enterprise/running.xml (modified) (2 diffs)
• nof-application-development-manual.xml (modified) (4 diffs)
• reference/reflector-properties.xml (modified) (1 diff)
• reference/run-parameters.xml (modified) (1 diff)

documents/trunk/documentation/src/app-dev/build-app.xml

@@ -118 +118 @@
   <chmod file="${build.dir}/run.sh" perm="ugo+x"/>
 
-  <mkdir dir="dist" />
+  <mkdir dir="${dist.dir}" />
   <zip destfile="dist/no-application.zip" >
     <zipfileset dir="${build.dir}" prefix="no-application" />
@@ -130 +130 @@
 Buildfile: build.xml
 
+compile:
 dist:
      [copy] Copying 45 files to /home/rcm/workspace/project/build/lib
@@ -136 +137 @@
 BUILD SUCCESSFUL
 Total time: 6 seconds</command-listing>
+
+  <para>After this has completed the <path>build</path> directory will look
+  like the following, and the <path>dist</path> directory will contain a
+  zipped file of the same contents.</para>
+
+  <command-listing>build/
+   classes/
+   config/
+   images/
+   lib/
+   web/
+   lcp.bat
+   run.bat
+   run.sh</command-listing>
+
+  <heading>Creating a web-app</heading>
+
+  <para>From the same set of project files we can create a <ital>war</ital>
+  file for running Naked Objects on a web server such as Tomcat. Running Ant
+  again with the <em>web-app</em> target will create war file in the
+  <path>dist</path> directory. It is important to note that we do not need to
+  provide and additional files or configurations to create the war.</para>
+
+  <command-listing>$ ant web-app
+Buildfile: build.xml
+
+compile:
+web-app:
+    [mkdir] Created dir: /home/rcm/no-development/release-trial/office-workspace/build/war
+    [unwar] Expanding: /home/rcm/tmp/release/developer/lib/nos-web-app-3.0M4D2-SNAPSHOT.war into /home/rcm/no-development/release-trial/office-workspace/build/war
+      [war] Building war: /home/rcm/no-development/release-trial/office-workspace/dist/example.war
+BUILD SUCCESSFUL
+Total time: 5 seconds</command-listing>
 </section>

documents/trunk/documentation/src/enterprise/running.xml

@@ -2 +2 @@
 <!DOCTYPE section SYSTEM "../documentation.dtd">
 <section>
-  <title>Enterprise Naked Objects</title>
+  <title>Running enterprise Naked Objects</title>
 
   <heading>Basic server</heading>
@@ -46 +46 @@
   to access the URL http://<ital>server</ital>/ to access the logon
   page.</para>
+
+  <heading>Running the server and web server together</heading>
+
+  <command-listing>$ run.sh --type server --connection xstream --viewer html --persistor xml
+2007-08-09 12:37:13.671::INFO:  Logging to STDERR via org.mortbay.log.StdErrLog
+2007-08-09 12:37:13.801::INFO:  jetty-6.0.2
+2007-08-09 12:37:13.954::INFO:  Started SocketConnector @ 0.0.0.0:8080
+</command-listing>
+
+  <para>By specifying a connection and the html view the server can be access
+  by both web browsers and remote clients.</para>
 </section>

documents/trunk/documentation/src/nof-application-development-manual.xml

@@ -100 +100 @@
     <title>Enterprise Systems</title>
 
+    <include file="enterprise/running.xml" />
+
     <include file="enterprise/hibernate.xml" />
+
+    <include file="enterprise/security.xml" />
+
+    <include file="enterprise/internationalization.xml" />
 
     <!--
@@ -128 +134 @@
 
   <section numbered="on">
-    <title>wReference</title>
+    <title>Reference</title>
 
     <include file="reference/recognised-types.xml" />
@@ -148 +154 @@
     <include file="reference/helper-classes.xml" />
 
+    <include file="reference/internationalization.xml" />
+
     <include file="reference/ant-template.xml" />
 
@@ -162 +170 @@
     <include file="reference/viewer-properties.xml" />
 
-    <include file="reference/security.xml" />
-
     <include file="reference/other-properties.xml" />
 

documents/trunk/documentation/src/reference/reflector-properties.xml

@@ -36 +36 @@
   <para>This setting can be overriden for a specific field using the <see
   label="@mask"><code>@Mask</code> annotation</see>.</para>
+
+  <heading>Reflector peers or decorators</heading>
+
+  <para>The reflector peers property specifies a list of
+  <class>ReflectionPeerFactoryInstaller</class> objects that should be
+  installed and registered with the reflector. These peers decorate the
+  reflector allowing it change the behaviour of the reflector. This allows us
+  to add internationalization, help look up, authorisation and other features.
+  Although transaction management is also achieved by decorating the reflector
+  this is done automatically and does not need to be specified using this
+  property. The following example adds a single decorator that provide
+  internationalization via resource files.</para>
+
+  <property-listing>nakedobjects.reflector.peers=resource-i18n</property-listing>
 </section>

documents/trunk/documentation/src/reference/run-parameters.xml

@@ -2 +2 @@
 <!DOCTYPE section SYSTEM "../documentation.dtd">
 <section>
-  <title>Running Naked Objects - command line parameters</title>
+  <title>Command line parameters</title>
 
   <para>The framework's bootstrapper takes care or loading up the Naked