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/isis.git
The following commit(s) were added to refs/heads/master by this push:
new 6914ecb9a6 ISIS-3272: updates config pages
6914ecb9a6 is described below
commit 6914ecb9a68a7529873f684949f3db5eb130580a
Author: Dan Haywood <[email protected]>
AuthorDate: Fri Nov 4 12:18:33 2022 +0000
ISIS-3272: updates config pages
(sh preview.sh -BC does the trick)
---
core/config/generateConfigDocs.groovy | 6 ++
.../adoc/modules/config/pages/sections/_nav.adoc | 1 +
.../config/pages/sections/causeway.applib.adoc | 2 +-
.../pages/sections/causeway.viewer.common.adoc | 102 ++++++++++++++++++
.../pages/sections/causeway.viewer.wicket.adoc | 115 +++------------------
5 files changed, 124 insertions(+), 102 deletions(-)
diff --git a/core/config/generateConfigDocs.groovy
b/core/config/generateConfigDocs.groovy
index 411b120ef5..7af192c1a8 100644
--- a/core/config/generateConfigDocs.groovy
+++ b/core/config/generateConfigDocs.groovy
@@ -145,6 +145,12 @@ groups+= new PropertyGroup() {{
searchOrder = 501
}}
+groups+= new PropertyGroup() {{
+ prefix = "causeway.viewer.common"
+ name = "Common Config for Viewers"
+ searchOrder = 501
+}}
+
groups+= new PropertyGroup() {{
prefix = "causeway.viewer.restfulobjects"
name = "Restful Objects Viewer"
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/_nav.adoc
b/core/config/src/main/adoc/modules/config/pages/sections/_nav.adoc
index d76382bba1..9b1db05517 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/_nav.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/_nav.adoc
@@ -9,6 +9,7 @@
** xref:refguide:config:sections/causeway.security.shiro.adoc[Shiro Security
Implementation]
** xref:refguide:config:sections/causeway.security.keycloak.adoc[Keycloak
Security Implementation]
** xref:refguide:config:sections/causeway.security.spring.adoc[Spring Security
Implementation]
+** xref:refguide:config:sections/causeway.viewer.common.adoc[Common Config for
Viewers]
** xref:refguide:config:sections/causeway.viewer.restfulobjects.adoc[Restful
Objects Viewer]
** xref:refguide:config:sections/causeway.viewer.wicket.adoc[Wicket Viewer]
** xref:refguide:config:sections/datanucleus.adoc[DataNucleus Configuration]
diff --git
a/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc
b/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc
index 15732f32c0..77deded309 100644
---
a/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc
+++
b/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc
@@ -122,7 +122,7 @@ domain-event.post-for-default
Up to five different events can be fired during an interaction, with the
event's phase determining which (hide, disable, validate, executing and
executed). Subscribers can influence the behaviour at each of these phases.
-The algorithm for determining whether (and what type of) an event is actually
sent depends on the value of the ``Action#domainEvent()`` for the action in
question:
+The algorithm for determining whether (and what type of) an event is actually
sent depends on the value of the ``Action#domainEvent()`` for the action in
question
* If set to some subtype of ActionDomainEvent.Noop, then _no_ event is sent.
* If set to some subtype of ActionDomainEvent.Default, then an event is sent
_if and only if_ this configuration setting is set.
diff --git
a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.common.adoc
b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.common.adoc
new file mode 100644
index 0000000000..5f4b9ac4ab
--- /dev/null
+++
b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.common.adoc
@@ -0,0 +1,102 @@
+= Common Config for Viewers
+:page-role: -toc -narrow
+
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
+
+include::../section-hooks/causeway.viewer.common~pre.adoc[]
+
+[cols="3a,2a,5a", options="header"]
+|===
+|Property
+|Default
+|Description
+|
+[[causeway.viewer.common.application.about]]
+causeway.viewer.common.application. +
+about
+
+|
+| Label used on the about page.
+
+
+|
+[[causeway.viewer.common.application.brand-logo-header]]
+causeway.viewer.common.application. +
+brand-logo-header
+
+|
+| Either the location of the image file (relative to the class-path resource
root), or an absolute URL.
+
+This is rendered on the header panel. An image with a size of 160x40 works
well. If not specified, the application.name is used instead.
+
+
+|
+[[causeway.viewer.common.application.brand-logo-signin]]
+causeway.viewer.common.application. +
+brand-logo-signin
+
+|
+| Either the location of the image file (relative to the class-path resource
root), or an absolute URL.
+
+This is rendered on the sign-in page. An image with a size of 400x40 works
well. If not specified, the name is used instead.
+
+
+|
+[[causeway.viewer.common.application.favicon-url]]
+causeway.viewer.common.application. +
+favicon-url
+
+|
+| Specifies the URL to use of the favIcon.
+
+This is expected to be a local resource.
+
+
+|
+[[causeway.viewer.common.application.menubars-layout-file]]
+causeway.viewer.common.application. +
+menubars-layout-file
+
+| menubars.layout.xml
+| Specifies the file name containing the menubars.
+
+This is expected to be a local resource.
+
+
+|
+[[causeway.viewer.common.application.name]]
+causeway.viewer.common.application. +
+name
+
+| Apache Causeway ™
+| Identifies the application on the sign-in page (unless a sign-in image is
configured) and on top-left in the header (unless a header image is configured).
+
+
+|
+[[causeway.viewer.common.application.version]]
+causeway.viewer.common.application. +
+version
+
+|
+| The version of the application, eg 1.0, 1.1, etc.
+
+If present, then this will be shown in the footer on every page as well as on
the about page.
+
+
+|
+[[causeway.viewer.common.credit]]
+causeway.viewer.common.credit
+
+|
+| List of organisations or individuals to give credit to, shown as links and
icons in the footer. A maximum of 3 credits can be specified.
+
+IntelliJ unfortunately does not provide IDE completion for lists of classes;
YMMV.
+
+NOTE: For further discussion, see for example
https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects[this
stackoverflow question] and
https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo[this
wiki page].
+
+
+
+|===
+
+include::../section-hooks/causeway.viewer.common~post.adoc[]
diff --git
a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc
b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc
index 99cc315c25..749c6aba81 100644
---
a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc
+++
b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc
@@ -32,101 +32,6 @@ CausewayWicketApplication
There is usually very little reason to change this from its default.
-|
-[[causeway.viewer.wicket.application.about]]
-causeway.viewer.wicket.application. +
-about
-
-|
-| Label used on the about page.
-
-
-|
-[[causeway.viewer.wicket.application.brand-logo-header]]
-causeway.viewer.wicket.application. +
-brand-logo-header
-
-|
-| Either the location of the image file (relative to the class-path resource
root), or an absolute URL.
-
-This is rendered on the header panel. An image with a size of 160x40 works
well. If not specified, the application.name is used instead.
-
-
-|
-[[causeway.viewer.wicket.application.brand-logo-signin]]
-causeway.viewer.wicket.application. +
-brand-logo-signin
-
-|
-| Either the location of the image file (relative to the class-path resource
root), or an absolute URL.
-
-This is rendered on the sign-in page. An image with a size of 400x40 works
well. If not specified, the name is used instead.
-
-
-|
-[[causeway.viewer.wicket.application.css]]
-causeway.viewer.wicket.application. +
-css
-
-|
-| URL of file to read any custom CSS, relative to ``static`` package on the
class path.
-
-A typical value is ``css``. This will result in this file being read from the
``static/css`` directory (because static resources such as CSS are mounted by
Spring by default under ``static`` package).
-
-
-|
-[[causeway.viewer.wicket.application.favicon-url]]
-causeway.viewer.wicket.application. +
-favicon-url
-
-|
-| Specifies the URL to use of the favIcon.
-
-This is expected to be a local resource.
-
-
-|
-[[causeway.viewer.wicket.application.js]]
-causeway.viewer.wicket.application. +
-js
-
-|
-| URL of file to read any custom JavaScript, relative to ``static`` package on
the class path.
-
-A typical value is ``js``. This will result in this file being read from the
``static/js`` directory (because static resources such as CSS are mounted by
Spring by default under ``static`` package).
-
-
-|
-[[causeway.viewer.wicket.application.menubars-layout-xml]]
-causeway.viewer.wicket.application. +
-menubars-layout-xml
-
-| menubars.layout.xml
-| Specifies the file name containing the menubars.
-
-This is expected to be a local resource.
-
-
-|
-[[causeway.viewer.wicket.application.name]]
-causeway.viewer.wicket.application. +
-name
-
-| Apache Causeway ™
-| Identifies the application on the sign-in page (unless a sign-in image is
configured) and on top-left in the header (unless a header image is configured).
-
-
-|
-[[causeway.viewer.wicket.application.version]]
-causeway.viewer.wicket.application. +
-version
-
-|
-| The version of the application, eg 1.0, 1.1, etc.
-
-If present, then this will be shown in the footer on every page as well as on
the about page.
-
-
|
[[causeway.viewer.wicket.base-path]]
causeway.viewer.wicket.base-path
@@ -206,15 +111,13 @@ The default behaviour is to honour the original
destination requested.
|
-[[causeway.viewer.wicket.credit]]
-causeway.viewer.wicket.credit
+[[causeway.viewer.wicket.css]]
+causeway.viewer.wicket.css
|
-| List of organisations or individuals to give credit to, shown as links and
icons in the footer. A maximum of 3 credits can be specified.
-
-IntelliJ unfortunately does not provide IDE completion for lists of classes;
YMMV.
+| URL of file to read any custom CSS, relative to ``static`` package on the
class path.
-NOTE: For further discussion, see for example
https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects[this
stackoverflow question] and
https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo[this
wiki page].
+A typical value is ``css``. This will result in this file being read from the
``static/css`` directory (because static resources such as CSS are mounted by
Spring by default under ``static`` package).
|
@@ -275,6 +178,16 @@ dialog-mode-for-menu
This can be overridden on a case-by-case basis using
``ActionLayout#promptStyle()``.
+|
+[[causeway.viewer.wicket.js]]
+causeway.viewer.wicket.js
+
+|
+| URL of file to read any custom JavaScript, relative to ``static`` package on
the class path.
+
+A typical value is ``js``. This will result in this file being read from the
``static/js`` directory (because static resources such as CSS are mounted by
Spring by default under ``static`` package).
+
+
|
[[causeway.viewer.wicket.live-reload-url]]
causeway.viewer.wicket. +
