You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by da...@apache.org on 2023/03/01 14:55:10 UTC
[causeway] 01/02: CAUSEWAY-3255 : improves docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/causeway.git
commit 34e9f1ff80fc9b5dd4a46f48821a84e9a6488602
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Mar 1 14:52:02 2023 +0000
CAUSEWAY-3255 : improves docs
---
.../conguide/modules/eclipse/pages/about.adoc | 22 ++++++++++++++--------
.../conguide/modules/intellij/pages/about.adoc | 18 +++++++++++-------
.../ROOT/pages/2023/2.0.0-RC1/mignotes.adoc | 8 ++++++--
3 files changed, 31 insertions(+), 17 deletions(-)
diff --git a/antora/components/conguide/modules/eclipse/pages/about.adoc b/antora/components/conguide/modules/eclipse/pages/about.adoc
index 7ae1faea1d..83f554919e 100644
--- a/antora/components/conguide/modules/eclipse/pages/about.adoc
+++ b/antora/components/conguide/modules/eclipse/pages/about.adoc
@@ -16,11 +16,17 @@ Also:
== Prepare for Build
-The project/artifact `causeway-core-privileged` is required to be an _automatic module_
-in the _Java Platform Module System_ (JPMS) sense. (It has unrestricted access to the class-path
-but not the module-path.)
-
-WARNING: As of time of writing, _Eclipse_ does *not* support automatic module name resolution
-for projects that are also *opened* in the IDE. Instead it will resolve such module names
-only from *closed* projects, that previously had been built and installed via _Maven_ to the
-local repository. (Typically `~/.m2/repository`).
+The project/artifact `causeway-core-privileged` is required to be an _automatic module_ in the _Java Platform Module System_ (JPMS) sense.
+(In other words, it has unrestricted access to the class-path but not the module-path.)
+
+However, at the time of writing, _Eclipse_ does *not* support automatic module name resolution for projects that are also *opened* in the IDE.
+Instead it will resolve such module names only from *closed* projects, that previously had been built and installed via _Maven_ to the local repository (typically `~/.m2/repository`).
+
+What this means in practice is that you should:
+
+* build the framework once outside of the IDE, using Maven
+* in the IDE, open the project from the top-level `pom.xml`
+* immediately close the `causeway-core-privileged` module (to force the IDE to resolve from the local repository, as described above).
+
+Although not mandatory, you might also find it worth closing the `causeway-schema` module.
+That's because this module uses a Maven plugin to generate code from XSDs, and sometimes the IDE might overwrite/remove these generated files.
diff --git a/antora/components/conguide/modules/intellij/pages/about.adoc b/antora/components/conguide/modules/intellij/pages/about.adoc
index df42d99130..d36054aa06 100644
--- a/antora/components/conguide/modules/intellij/pages/about.adoc
+++ b/antora/components/conguide/modules/intellij/pages/about.adoc
@@ -10,13 +10,17 @@ Additional configuration of IntelliJ for contributors (and committers).
== Prepare for Build
-The project/artifact `causeway-core-privileged` is required to be an _automatic module_
-in the _Java Platform Module System_ (JPMS) sense. (It has unrestricted access to the class-path
-but not the module-path.)
+The project/artifact `causeway-core-privileged` is required to be an _automatic module_ in the _Java Platform Module System_ (JPMS) sense.
+(In other words, it has unrestricted access to the class-path but not the module-path.)
-WARNING: As of time of writing, _IntelliJ IDEA_ does *not* support automatic module name resolution
-for projects that are also *opened* in the IDE. Instead it will resolve such module names
-only from *ignored* projects, that previously had been built and installed via _Maven_ to the
-local repository. (Typically `~/.m2/repository`).
+However, at the time of writing, _IntelliJ IDEA_ does *not* support automatic module name resolution for projects that are also *opened* in the IDE.
+Instead it will resolve such module names only from *ignored* projects, that previously had been built and installed via _Maven_ to the local repository (typically `~/.m2/repository`).
+What this means in practice is that you should:
+* build the framework once outside of the IDE, using Maven
+* in the IDE, open the project from the top-level `pom.xml`
+* immediately ignore the `causeway-core-privileged` module (to force the IDE to resolve from the local repository, as described above).
+
+Although not mandatory, you might also find it worth ignoring the `causeway-schema` module.
+That's because this module uses a Maven plugin to generate code from XSDs, and sometimes the IDE might overwrite/remove these generated files.
diff --git a/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC1/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC1/mignotes.adoc
index d9ebe96071..14478ae788 100644
--- a/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC1/mignotes.adoc
+++ b/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC1/mignotes.adoc
@@ -33,6 +33,7 @@ To update your app:
xsi:schemaLocation="https://causeway.apache.org/applib/layout/menubars/bootstrap3 https://causeway.apache.org/applib/layout/menubars/bootstrap3/menubars.xsd https://causeway.apache.org/applib/layout/component https://causeway.apache.org/applib/layout/component/component.xsd"
xmlns:mb3="https://causeway.apache.org/applib/layout/menubars/bootstrap3"
xmlns:cpt="https://causeway.apache.org/applib/layout/component"
+ xmlns:lnk="https://causeway.apache.org/applib/layout/links"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</mb3:menuBars>
@@ -47,6 +48,7 @@ To update your app:
xsi:schemaLocation="https://causeway.apache.org/applib/layout/component https://causeway.apache.org/applib/layout/component/component.xsd https://causeway.apache.org/applib/layout/grid/bootstrap3 https://causeway.apache.org/applib/layout/grid/bootstrap3/bootstrap3.xsd"
xmlns:bs3="https://causeway.apache.org/applib/layout/grid/bootstrap3"
xmlns:cpt="https://causeway.apache.org/applib/layout/component"
+ xmlns:lnk="https://causeway.apache.org/applib/layout/links"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</bs3:grid>
@@ -62,9 +64,10 @@ Adjust the locations in your `.layout.xml` files accordingly:
.menubars.layout.xml
----
<mb3:menuBars
- xsi:schemaLocation="http://isis.apache.org/applib/layout/menubars/bootstrap3 https://causeway.apache.org/applib/layout-v1/menubars/bootstrap3/menubars.xsd http://isis.apache.org/applib/layout/component https://causeway.apache.org/applib/layout-v1/component/component.xsd"
+ xsi:schemaLocation="http://isis.apache.org/applib/layout/menubars/bootstrap3 https://causeway.apache.org/applib/layout-v1/menubars/bootstrap3/menubars.xsd http://isis.apache.org/applib/layout/component https://causeway.apache.org/applib/layout-v1/component/component.xsd http://isis.apache.org/applib/layout/links https://causeway.apache.org/applib/layout-v1/links/links.xsd"
xmlns:mb3="http://isis.apache.org/applib/layout/menubars/bootstrap3"
xmlns:cpt="http://isis.apache.org/applib/layout/component"
+ xmlns:lnk="http://isis.apache.org/applib/layout/links"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</mb3:menuBars>
@@ -76,9 +79,10 @@ Adjust the locations in your `.layout.xml` files accordingly:
.Xxx.layout.xml
----
<bs3:grid
- xsi:schemaLocation="http://isis.apache.org/applib/layout/component https://causeway.apache.org/applib/layout-v1/component/component.xsd http://isis.apache.org/applib/layout/grid/bootstrap3 https://causeway.apache.org/applib/layout-v1/grid/bootstrap3/bootstrap3.xsd"
+ xsi:schemaLocation="http://isis.apache.org/applib/layout/component https://causeway.apache.org/applib/layout-v1/component/component.xsd http://isis.apache.org/applib/layout/grid/bootstrap3 https://causeway.apache.org/applib/layout-v1/grid/bootstrap3/bootstrap3.xsd http://isis.apache.org/applib/layout/links https://causeway.apache.org/applib/layout-v1/links/links.xsd"
xmlns:bs3="http://isis.apache.org/applib/layout/grid/bootstrap3"
xmlns:cpt="http://isis.apache.org/applib/layout/component"
+ xmlns:lnk="http://isis.apache.org/applib/layout/links"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</bs3:grid>