cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aadamc...@apache.org
Subject svn commit: r1555530 - in /cayenne/main/trunk/docs/docbook: getting-started-rop/src/docbkx/ getting-started-rop/src/images/ getting-started/src/docbkx/ getting-started/src/images/ upgrade-guide/src/docbkx/ upgrade-guide/src/images/
Date Sun, 05 Jan 2014 15:58:22 GMT
Author: aadamchik
Date: Sun Jan  5 15:58:22 2014
New Revision: 1555530

URL: http://svn.apache.org/r1555530
Log:
replacing confluence-style waring blocks with 'note' docbook sections

Removed:
    cayenne/main/trunk/docs/docbook/getting-started-rop/src/images/warning.gif
    cayenne/main/trunk/docs/docbook/getting-started/src/images/warning.gif
    cayenne/main/trunk/docs/docbook/upgrade-guide/src/images/
Modified:
    cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/authentification.xml
    cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/web-service.xml
    cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/java-classes.xml
    cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-context.xml
    cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-relational-mapping.xml
    cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/starting-project.xml
    cayenne/main/trunk/docs/docbook/upgrade-guide/src/docbkx/new-features.xml

Modified: cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/authentification.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/authentification.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/authentification.xml (original)
+++ cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/authentification.xml Sun
Jan  5 15:58:22 2014
@@ -48,24 +48,14 @@
     </section>
     <section xml:id="configuring-jetty">
         <title>Configuring Jetty for BASIC Authentication</title>
-        <informaltable class="noteMacro" border="1">
-            <col width="4%"/>
-            <col width="96%"/>
-            <tbody>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1">These instructions are specific to
Jetty 6. Other
-                        containers (and versions of Jetty) will have different mechansims
to achieve
-                        the same thing.</td>
-                </tr>
-            </tbody>
-        </informaltable>
+        
+        <para>
+            <note>
+                <para>These instructions are specific to Jetty 6. Other
+                    containers (and versions of Jetty) will have different mechansims to
achieve
+                    the same thing.</para>
+            </note>
+        </para>
         <para>Open pom.xml in the server project and configure a "userRealm" for the
Jetty
             plugin:</para>
         <programlisting>&lt;plugin&gt;

Modified: cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/web-service.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/web-service.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/web-service.xml (original)
+++ cayenne/main/trunk/docs/docbook/getting-started-rop/src/docbkx/web-service.xml Sun Jan
 5 15:58:22 2014
@@ -52,27 +52,15 @@
             &lt;/releases&gt;
         &lt;/repository&gt;
     &lt;/repositories&gt;
-&lt;/project&gt;</programlisting>
-        <informaltable class="noteMacro" border="1">
-            <col width="4%"/>
-            <col width="96%"/>
-            <tbody>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1"><emphasis role="bold">Maven Optimization
-                            Hint</emphasis> On a real project both server and client
modules will
-                        likely share a common parent pom.xml where common repository delcaration
can
-                        be placed, with child pom's "inheriting" it from parent. This would
reduce
-                        build code duplication.</td>
-                </tr>
-            </tbody>
-        </informaltable>
+    &lt;/project&gt;</programlisting>
+        
+        <note>
+            <para><emphasis role="bold">Maven Optimization
+                Hint</emphasis> On a real project both server and client modules will
+                likely share a common parent pom.xml where common repository delcaration
can
+                be placed, with child pom's "inheriting" it from parent. This would reduce
+                build code duplication.</para>
+        </note>
     </section>
     <section xml:id="client-classes-on-server">
         <title>Client Classes on the Server</title>
@@ -102,27 +90,14 @@
         &lt;servlet-name>cayenne-project&lt;/servlet-name>
         &lt;url-pattern>/cayenne-service&lt;/url-pattern>
     &lt;/servlet-mapping>
-&lt;/web-app></programlisting>
-        <informaltable class="noteMacro" border="1">
-            <col width="4%"/>
-            <col width="96%"/>
-            <tbody>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1"><emphasis role="bold">Extending
Server Behavior via
-                            Callbacks</emphasis> While no custom Java code is required
on the
-                        server, just a service declaration, it is possible to customizing
-                        server-side behavior via callbacks and listeners (not shown in the
-                        tutorial).</td>
-                </tr>
-            </tbody>
-        </informaltable>
+    &lt;/web-app></programlisting>
+        <note>
+            <para><emphasis role="bold">Extending Server Behavior via
+                Callbacks</emphasis> While no custom Java code is required on the
+                server, just a service declaration, it is possible to customizing
+                server-side behavior via callbacks and listeners (not shown in the
+                tutorial).</para>
+        </note>
     </section>
     <section xml:id="running-rop-server">
         <title>Running ROP Server</title>

Modified: cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/java-classes.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/java-classes.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/java-classes.xml (original)
+++ cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/java-classes.xml Sun Jan  5
15:58:22 2014
@@ -84,26 +84,15 @@
             in "org.example.cayenne.persistent" package - those will never be overwritten
by the
             class generator.</para>
         <para>
-            <informaltable border="1">
-                <col width="4%"/>
-                <col width="96%"/>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1"><emphasis role="bold">Class Generation
-                            Hint</emphasis> Often you'd start by generating classes
from the
-                        Modeler, but at the later stages of the project the generation is
usually
-                        automated either via Ant cgen task or Maven cgen mojo. All three
methods are
-                        interchangeable, however Ant and Maven methods would ensure that
you never
-                        forget to regenerate classes on mapping changes, as they are integrated
into
-                        the build cycle.</td>
-                </tr>
-            </informaltable>
+            <note>
+                <para><emphasis role="bold">Class Generation
+                    Hint</emphasis> Often you'd start by generating classes from the
+                    Modeler, but at the later stages of the project the generation is usually
+                    automated either via Ant cgen task or Maven cgen mojo. All three methods
are
+                    interchangeable, however Ant and Maven methods would ensure that you
never
+                    forget to regenerate classes on mapping changes, as they are integrated
into
+                    the build cycle.</para>
+            </note>
         </para>
         
     </section>

Modified: cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-context.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-context.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-context.xml (original)
+++ cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-context.xml Sun Jan
 5 15:58:22 2014
@@ -83,24 +83,10 @@ INFO: loading user name and password.
 INFO: Created connection pool: jdbc:derby:memory:testdb;create=true
     Driver class: org.apache.derby.jdbc.EmbeddedDriver
     Min. connections in the pool: 1
-    Max. connections in the pool: 1</programlisting><informaltable
-                border="1">
-                <col width="4%"/>
-                <col width="96%"/>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1"><emphasis role="bold">How to
Configure Cayenne
-                            Logging</emphasis> You can tweak more or less detailed
output by
-                        following the instructions in the logging chapter.</td>
-                </tr>
-            </informaltable>Nothing much happened here, but we've been able to create
a working
-            Cayenne stack. In the following chapters we'll use the ObjectContext for more
-            interesting things.</para>
+    Max. connections in the pool: 1</programlisting>
+            
+            <note><para><emphasis role="bold">How to Configure Cayenne
Logging.</emphasis>  Follow the instructions in
+                    the logging chapter to tweak verbosity of the logging output.</para></note>
+           </para>
     </section>
 </chapter>

Modified: cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-relational-mapping.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-relational-mapping.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-relational-mapping.xml
(original)
+++ cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/object-relational-mapping.xml
Sun Jan  5 15:58:22 2014
@@ -28,24 +28,11 @@
     </inlinemediaobject>
     </para>
     <para>
-        <informaltable border="1">
-            <col width="4%"/>
-            <col width="96%"/>
-            <tr>
-                <td rowspan="1" colspan="1" valign="top">
-                    <mediaobject>
-                        <imageobject>
-                            <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                        </imageobject>
-                    </mediaobject>
-                </td>
-                <td rowspan="1" colspan="1">Very often you'd have an existing database
already, and
-                    it can be quickly imported in Cayenne via "Tools &gt; Reengineer
Database
-                    Schema". This will save you lots of time compared to manual mapping.
However
-                    understanding how to create the mapping by hand is important, so we are
showing
-                    the "manual" approach below.</td>
-            </tr>
-        </informaltable>
+        <note><para>Very often you'd have an existing database already, and
+            it can be quickly imported in Cayenne via "Tools &gt; Reengineer Database
+            Schema". This will save you lots of time compared to manual mapping. However
+            understanding how to create the mapping by hand is important, so we are showing
+            the "manual" approach below.</para></note>
     </para>
     <section xml:id="mapping-db-tables-and-columns">
         <title>Mapping Database Tables and Columns</title>
@@ -67,23 +54,12 @@
         <para>Similarly add NAME VARCHAR(200) and DATE_OF_BIRTH DATE attributes. After
that repeat
             this procedure for PAINTING and GALLERY entities to match DB schema shown above.</para>
         <para>
-            <informaltable border="1">
-                <col width="4%"/>
-                <col width="96%"/>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1">Don't forget to save your project periodically
to
-                        avoid losing your work. You will also have to refresh the project
in Eclipse
-                        after every CayenneModeler save, as Eclipse is by default unaware
of any
-                        changes made in the Modeler.</td>
-                </tr>
-            </informaltable>
+            <note>
+                <para>Don't forget to save your project periodically to
+                    avoid losing your work. You will also have to refresh the project in
Eclipse
+                    after every CayenneModeler save, as Eclipse is by default unaware of
any
+                    changes made in the Modeler.</para>
+            </note>
         </para>
     </section>
     <section xml:id="mapping-db-relationships">

Modified: cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/starting-project.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/starting-project.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/starting-project.xml (original)
+++ cayenne/main/trunk/docs/docbook/getting-started/src/docbkx/starting-project.xml Sun Jan
 5 15:58:22 2014
@@ -56,22 +56,9 @@
             get access to the CayenneModeler tool. 
         </para>
         <para>
-            <informaltable border="1">
-                <col width="4%"/>
-                <col width="96%"/>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1">If you are really into Maven, you can
start
-                        CayenneModeler from Maven if you wish. We'll do it in a more traditional
way
-                        here.</td>
-                </tr>
-            </informaltable>
+            <note><para>If you are really into Maven, you can start
+                CayenneModeler from Maven too. We'll do it in a more traditional way
+                here.</para></note>
         </para>
         <para> Download the latest release. Unpack the distribution somewhere in the
file system and
             start CayenneModeler, following platform-specific instructions. On most platforms
it is
@@ -108,23 +95,11 @@
                 </listitem>
             </itemizedlist></para>
         <para>
-            <informaltable border="1">
-                <col width="4%"/>
-                <col width="96%"/>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata fileref="images/warning.gif" depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1">We are creating an in-memory database
here. So when
-                        you stop your application, all the data will be lost. In most real-life
-                        cases you'll be connecting to a database that actually persists its
data on
-                        disk, but an in-memory DB will do for the simple tutorial.</td>
-                </tr>
-            </informaltable>
+            <note><para>We are creating an in-memory database here. So when
+                you stop your application, all the data will be lost. In most real-life
+                cases you'll be connecting to a database that actually persists its data
on
+                disk, but an in-memory DB will do for the simple tutorial.</para>
+            </note>
         </para>
         <para>Also you will need to change "Schema Update Strategy". Select
             "org.apache.cayenne.access.dbsync.CreateIfNoSchemaStrategy" from the dropdown,
so that

Modified: cayenne/main/trunk/docs/docbook/upgrade-guide/src/docbkx/new-features.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/upgrade-guide/src/docbkx/new-features.xml?rev=1555530&r1=1555529&r2=1555530&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/upgrade-guide/src/docbkx/new-features.xml (original)
+++ cayenne/main/trunk/docs/docbook/upgrade-guide/src/docbkx/new-features.xml Sun Jan  5 15:58:22
2014
@@ -46,27 +46,11 @@
     </section>
     <section xml:id="cayenne-configuration">
         <title>Cayenne Configuration</title>
-        <informaltable class="noteMacro" border="1">
-            <col width="4%"/>
-            <col width="96%"/>
-            <tbody>
-                <tr>
-                    <td rowspan="1" colspan="1" valign="top">
-                        <mediaobject>
-                            <imageobject>
-                                <imagedata
-                                    fileref="images/warning.gif"
-                                    depth="16" width="16"/>
-                            </imageobject>
-                        </mediaobject>
-                    </td>
-                    <td rowspan="1" colspan="1">The new DI-based bootstrap and configuration
-                        approach is not API-compatible with earlier versions of Cayenne.
Make sure
-                        you read the UPGRADE.txt file for instructions how to upgrade the
existing
-                        projects.</td>
-                </tr>
-            </tbody>
-        </informaltable>
+        
+        <note><para>The new DI-based bootstrap and configuration
+            approach is not API-compatible with earlier versions of Cayenne. Make sure
+            you read the UPGRADE.txt file for instructions how to upgrade the existing
+            projects.</para></note>
         <section>
             <title>Dependency Injection Container</title>
             <para>Cayenne 3.1 runtime stack is built around the ideas of Dependency
Injection (DI),



Mime
View raw message