You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/03/19 19:00:26 UTC
[isis] 04/08: ISIS-2450: updates config docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch release-2.0.0-M5-RC1
in repository https://gitbox.apache.org/repos/asf/isis.git
commit d42f493c3b7456e15d75b2da9d21cf21e6219ae0
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Mar 19 06:54:05 2021 +0000
ISIS-2450: updates config docs
---
.../modules/config/pages/sections/datanucleus.adoc | 16 +++---
.../config/pages/sections/isis.viewer.wicket.adoc | 61 +++++++++-------------
2 files changed, 35 insertions(+), 42 deletions(-)
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc b/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc
index dbb9d3e..10faca9 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc
@@ -18,19 +18,21 @@ datanucleus.cache.level2.mode
|
| The mode of operation of the L2 cache, deciding which entities are cached.
-The default (UNSPECIFIED) is the same as DISABLE_SELECTIVE. NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete. @see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] @see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#cache_level2[DataNucleus Cache docs].
+The default (UNSPECIFIED) is the same as DISABLE_SELECTIVE.
+
+For more details, see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] and the https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#cache_level2[DataNucleus Cache docs].
|
[[datanucleus.cache.level2.type]]
datanucleus.cache.level2.type
-|
+| soft
| Name of the type of Level 2 Cache to use.
Can be used to interface with external caching products. Use "none" to turn off L2 caching; other values include "soft", "weak", "javax.cache".
-NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete. @see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] @see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#cache_level2[DataNucleus Cache docs].
+For more details, see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] and the https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#cache_level2[DataNucleus Cache docs].
|
@@ -45,12 +47,12 @@ datanucleus.identifier.case
[[datanucleus.manage-relationships]]
datanucleus.manage-relationships
-|
+| true
| Whether DataNucleus will try to manage bidirectional relations, correcting the input objects so that all relations are consistent.
This process runs when flush()/commit() is called. You can set it to false if you always set both sides of a relation when persisting/updating.
-NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete. @see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs]
+For more details, see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs].
|
@@ -59,12 +61,12 @@ datanucleus. +
persistence-by-reachability-at- +
commit
-|
+| true
| Whether to run the "persistence-by-reachability" algorithm at commit time.
This means that objects that were reachable at a call to makePersistent() but that are no longer persistent will be removed from persistence. For performance improvements, consider turning this off.
-NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete. @see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs]
+For more details, see https://www.datanucleus.org/products/accessplatform_5_2/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs].
|
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc b/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc
index 7eb5066..3cc4dcf 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc
@@ -15,7 +15,7 @@ include::../section-hooks/isis.viewer.wicket~pre.adoc[]
[[isis.viewer.wicket.ajax-debug-mode]]
isis.viewer.wicket.ajax-debug-mode
-|
+|
| Whether the Ajax debug should be shown, by default this is disabled.
@@ -36,7 +36,7 @@ There is usually very little reason to change this from its default.
isis.viewer.wicket.application. +
about
-|
+|
| Label used on the about page.
@@ -45,7 +45,7 @@ about
isis.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.
@@ -56,7 +56,7 @@ This is rendered on the header panel. An image with a size of 160x40 works well.
isis.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 application name is used instead.
@@ -66,27 +66,18 @@ This is rendered on the sign-in page. An image with a size of 400x40 works well.
[[isis.viewer.wicket.application.css]]
isis.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).
|
-[[isis.viewer.wicket.application.favicon-content-type]]
-isis.viewer.wicket.application. +
-favicon-content-type
-
-|
-| Specifies the content type of the favIcon, if any.
-
-
-|
[[isis.viewer.wicket.application.favicon-url]]
isis.viewer.wicket.application. +
favicon-url
-|
+|
| Specifies the URL to use of the favIcon.
This is expected to be a local resource.
@@ -96,7 +87,7 @@ This is expected to be a local resource.
[[isis.viewer.wicket.application.js]]
isis.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).
@@ -127,7 +118,7 @@ name
isis.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.
@@ -194,7 +185,7 @@ max-parent-chain-length
isis.viewer.wicket. +
clear-original-destination
-|
+|
| If the end user uses a deep link to access the Wicket viewer, but is not authenticated, then this configuration property determines whether to continue through to that original destination once authenticated, or simply to go to the home page.
The default behaviour is to honour the original destination requested.
@@ -204,7 +195,7 @@ The default behaviour is to honour the original destination requested.
[[isis.viewer.wicket.credit]]
isis.viewer.wicket.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.
@@ -260,7 +251,7 @@ Each Date scalar panel will use ``#getDatePattern()`` or ``#getDateTimePattern()
isis.viewer.wicket. +
development-utilities.enable
-|
+|
| Determines whether debug bar and other stuff influenced by ``DebugSettings#isDevelopmentUtilitiesEnabled()`` is enabled or not.
By default, depends on the mode (prototyping = enabled, server = disabled). This property acts as an override.
@@ -270,7 +261,7 @@ By default, depends on the mode (prototyping = enabled, server = disabled). This
[[isis.viewer.wicket.dialog-mode]]
isis.viewer.wicket.dialog-mode
-|
+|
| Whether the dialog mode rendered when invoking actions on domain objects should be to use the sidebar (the default) or to use a modal dialog.
This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle()``.
@@ -281,7 +272,7 @@ This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle(
isis.viewer.wicket. +
dialog-mode-for-menu
-|
+|
| Whether the dialog mode rendered when invoking actions on domain services (that is, menus) should be to use a modal dialog (the default) or to use the sidebar panel.
This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle()``.
@@ -291,7 +282,7 @@ This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle(
[[isis.viewer.wicket.live-reload-url]]
isis.viewer.wicket.live-reload-url
-|
+|
| If specified, then is rendered on each page to enable live reload.
Configuring live reload also requires an appropriate plugin to the web browser (eg see http://livereload.com/[livereload.com] and a mechanism to trigger changes, eg by watching ``xml`` files.
@@ -303,7 +294,7 @@ isis.viewer.wicket. +
max-title-length-in-parented- +
tables
-|
+|
| null
@@ -313,7 +304,7 @@ isis.viewer.wicket. +
max-title-length-in-standalone- +
tables
-|
+|
| null
@@ -354,7 +345,7 @@ This behaviour is enabled by default, but can be disabled using this flag.
[[isis.viewer.wicket.prompt-style]]
isis.viewer.wicket.prompt-style
-|
+|
| Whether to use a modal dialog for property edits and for actions associated with properties.
This can be overridden on a case-by-case basis using ``@PropertyLayout#promptStyle`` and ``@ActionLayout#promptStyle``.
@@ -367,7 +358,7 @@ This behaviour is disabled by default; the viewer will use an inline prompt in t
isis.viewer.wicket. +
redirect-even-if-same-object
-|
+|
| Whether to redirect to a new page, even if the object being shown (after an action invocation or a property edit) is the same as the previous page.
This behaviour is disabled by default; the viewer will update the existing page if it can, making for a smoother user experience. If enabled then this reinstates the pre-1.15.0 behaviour of redirecting in all cases.
@@ -387,7 +378,7 @@ cookie-key
isis.viewer.wicket.remember-me. +
encryption-key
-|
+|
| If the "remember me" feature is available, optionally specifies an encryption key (a complex string acting as salt to the encryption algorithm) for computing the encrypted credentials.
If not set, then (in production mode) the Wicket viewer will compute a random key each time it is started. This will mean that any credentials stored between sessions will become invalid.
@@ -402,7 +393,7 @@ In prototype mode this setting is effectively ignored, because the same key will
isis.viewer.wicket.remember-me. +
suppress
-|
+|
| Whether the sign-in page should have a "remember me" link (the default), or if it should be suppressed.
If "remember me" is available and checked, then the viewer will allow users to login based on encrypted credentials stored in a cookie. An encryption key can optionally be specified.
@@ -446,7 +437,7 @@ By default this is enabled, in other words Wicket tags are stripped. Please be a
isis.viewer.wicket. +
suppress-password-reset
-|
+|
| Whether to suppress the password reset link on the sign-in page.
Although this is disabled by default (in other words the 'reset password' link is not suppressed), note that in addition the application must provide an implementation of the ``UserRegistrationService`` as well as a configured ``EmailNotificationService`` (same conditions as for the ``#isSuppressSignUp()`` sign-up link).
@@ -457,7 +448,7 @@ Although this is disabled by default (in other words the 'reset password' link i
isis.viewer.wicket. +
suppress-sign-up
-|
+|
| Whether to suppress the sign-up link on the sign-in page.
Although this is disabled by default (in other words the sign-up link is not suppressed), note that in addition the application must provide an implementation of the ``UserRegistrationService`` as well as a configured ``EmailNotificationService`` (same conditions as for the ``#isSuppressPasswordReset()`` password reset link).
@@ -467,7 +458,7 @@ Although this is disabled by default (in other words the sign-up link is not sup
[[isis.viewer.wicket.themes.enabled]]
isis.viewer.wicket.themes.enabled
-|
+|
| A comma separated list of enabled theme names, as defined by https://bootswatch.com.
@@ -496,7 +487,7 @@ IsisWicketThemeSupportDefault
isis.viewer.wicket.themes. +
show-chooser
-|
+|
| Whether the theme chooser widget should be available in the footer.
@@ -526,7 +517,7 @@ This behaviour is enabled by default.
[[isis.viewer.wicket.welcome.text]]
isis.viewer.wicket.welcome.text
-|
+|
| Text to be displayed on the application’s home page, used as a fallback if welcome.file is not specified. If a @HomePage action exists, then that will take precedence.
@@ -535,7 +526,7 @@ isis.viewer.wicket.welcome.text
isis.viewer.wicket. +
wicket-source-plugin
-|
+|
| Whether the Wicket source plugin should be enabled; if so, the markup includes links to the Wicket source.
This behaviour is disabled by default. Please be aware that enabloing it can substantially impact performance.