This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch 2.0.0 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit f2050cb289c1d07bd450a085f62613ba37676bf0 Author: Dan Haywood <[email protected]> AuthorDate: Wed Jun 5 12:13:14 2024 +0100 updates docs for starter apps were slightly out of date --- .../modules/starters/pages/helloworld-script-jdo.adoc | 4 ++-- .../modules/starters/pages/helloworld-script-jpa.adoc | 4 ++-- starters/adoc/modules/starters/pages/helloworld.adoc | 15 +++++++++------ .../modules/starters/pages/simpleapp-script-jdo.adoc | 4 ++-- .../modules/starters/pages/simpleapp-script-jpa.adoc | 4 ++-- starters/adoc/modules/starters/pages/simpleapp.adoc | 17 +++++++++-------- 6 files changed, 26 insertions(+), 22 deletions(-) diff --git a/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc b/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc index e64fe65954..f8cfb2cabe 100644 --- a/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc +++ b/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc @@ -3,8 +3,8 @@ [source,bash,subs="attributes+"] ---- -curl https://codeload.github.com/apache/causeway-app-helloworld/zip/jdo | jar xv -cd causeway-app-helloworld-jdo +curl https://codeload.github.com/apache/causeway-app-helloworld/zip/v3-jdo | jar xv +cd causeway-app-helloworld-3-jdo mvn clean install mvn spring-boot:run diff --git a/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc b/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc index 044a8f3006..3e427780a2 100644 --- a/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc +++ b/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc @@ -3,8 +3,8 @@ [source,bash,subs="attributes+"] ---- -curl https://codeload.github.com/apache/causeway-app-helloworld/zip/jpa | jar xv -cd causeway-app-helloworld-jpa +curl https://codeload.github.com/apache/causeway-app-helloworld/zip/v3-jpa | jar xv +cd causeway-app-helloworld-3-jpa mvn clean install mvn spring-boot:run diff --git a/starters/adoc/modules/starters/pages/helloworld.adoc b/starters/adoc/modules/starters/pages/helloworld.adoc index b25d1422d5..3034b344d6 100644 --- a/starters/adoc/modules/starters/pages/helloworld.adoc +++ b/starters/adoc/modules/starters/pages/helloworld.adoc @@ -32,11 +32,11 @@ It also creates a minimal application, but provides more structure along with te Apache Causeway is a Java based framework, so in terms of prerequisites, you'll need to install: -* Java 11 JDK (or later) +* Java 21 JDK (or later) + -Apache Causeway itself is compatible with Java 11, and the helloworld app itself is configured for Java 11. +Apache Causeway v3 requires Java 17, and the helloworld app itself is currently configured for Java 21. -* link:http://maven.apache.org[Apache Maven] 3.5+ +* link:http://maven.apache.org[Apache Maven] 3.9.7+ If using JDO as the ORM, you'll also need to run the Datanucleus enhancer (this post-processes the byte code of the entities). The xref:setupguide:ROOT:about.adoc[Setup Guide] explains how to do this for either IntelliJ and Eclipse. @@ -63,6 +63,7 @@ Either way, this should only take a few seconds to download, compile and run. Then browse to link:http://localhost:8080[], and read on. +[#using-the-app] == Using the App When you start the app, you'll be presented with a welcome page from which you can access the webapp using either the generic UI provided by xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] or use Swagger to access the xref:vro:ROOT:about.adoc[REST API (Restful Objects viewer)]: @@ -128,9 +129,11 @@ The above functionality is implemented by this code (in the `HelloWorldObject` e [source,java] ---- -@Action(semantics = SemanticsOf.IDEMPOTENT, - publishing = Publishing.ENABLED, - associateWith = "name") +@Action( semantics = SemanticsOf.IDEMPOTENT, executionPublishing = Publishing.ENABLED ) +@ActionLayout( + associateWith = "name", + describedAs = "Updates the object's name" +) public HelloWorldObject updateName( @Name final String name) { setName(name); diff --git a/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc b/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc index 36da1da658..346506c4a9 100644 --- a/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc +++ b/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc @@ -4,8 +4,8 @@ [source,bash,subs="attributes+"] ---- -curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/jdo | jar xv -cd causeway-app-simpleapp-jdo +curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/v3-jdo | jar xv +cd causeway-app-simpleapp-3-jdo mvn clean install mvn -pl webapp spring-boot:run diff --git a/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc b/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc index fff1a4a96a..0873816ed6 100644 --- a/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc +++ b/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc @@ -4,8 +4,8 @@ [source,bash,subs="attributes+"] ---- -curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/jpa | jar xv -cd causeway-app-simpleapp-jpa +curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/v3-jpa | jar xv +cd causeway-app-simpleapp-3-jpa mvn clean install mvn -pl webapp spring-boot:run diff --git a/starters/adoc/modules/starters/pages/simpleapp.adoc b/starters/adoc/modules/starters/pages/simpleapp.adoc index b149a844b5..9731c22d76 100644 --- a/starters/adoc/modules/starters/pages/simpleapp.adoc +++ b/starters/adoc/modules/starters/pages/simpleapp.adoc @@ -38,11 +38,11 @@ You can use them as a reference once your ideas have solidifid and you need to s Apache Causeway is a Java based framework, so in terms of prerequisites, you'll need to install: -* Java 11 JDK (or later) +* Java 21 JDK (or later) + -Apache Causeway itself is compatible with Java 11, and the simpleapp itself is configured for Java 11. +Apache Causeway v3 requires Java 17, and the simpleapp itself is currently configured for Java 21. -* link:http://maven.apache.org[Apache Maven] 3.5+ +* link:http://maven.apache.org[Apache Maven] 3.9.7+ If using JDO as the ORM, you'll also need to run the Datanucleus enhancer (this post-processes the byte code of the entities). The xref:setupguide:ROOT:about.adoc[Setup Guide] explains how to do this for either IntelliJ and Eclipse. @@ -50,7 +50,6 @@ The xref:setupguide:ROOT:about.adoc[Setup Guide] explains how to do this for eit If using JPA as the ORM, the equivalent process to enhancement is performed at run-time, so there are no special setup considerations. - == Downloading & Running Create a new directory, and `cd` into that directory. @@ -66,8 +65,7 @@ include::simpleapp-script-jdo.adoc[] include::simpleapp-script-jpa.adoc[] - -This should only take a few seconds to download, compile and run. +Either way, this should only take a few seconds to download, compile and run. Then browse to link:http://localhost:8080[], and read on. @@ -217,7 +215,11 @@ The above functionality is implemented by this code (in the `SimpleObject` entit [source,java] ---- -@Action(semantics = IDEMPOTENT) +@Action(semantics = IDEMPOTENT, commandPublishing = Publishing.ENABLED, executionPublishing = Publishing.ENABLED) +@ActionLayout( + associateWith = "name", promptStyle = PromptStyle.INLINE, + describedAs = "Updates the name of this object, certain characters (" + PROHIBITED_CHARACTERS + ") are not allowed." +) public SimpleObject updateName( @Name final String name) { setName(name); @@ -229,7 +231,6 @@ public String default0UpdateName() { ---- - ==== Edit a property The `notes` property is editable, and can be edited in-place.
