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 2020/01/21 16:09:34 UTC
[isis] 09/11: ISIS-2264: updates 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/isis.git
commit f65ea49f6e042b5b2eba11b44e820352c5e470df
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Jan 21 14:48:08 2020 +0000
ISIS-2264: updates docs
---
.../config/examples/generated/isis.extensions.adoc | 22 +++-
.../config/examples/generated/isis.legacy.adoc | 6 +-
.../examples/generated/isis.value-types.adoc | 71 +++++++-----
.../examples/generated/isis.viewer.wicket.adoc | 120 ++++++++++++++-------
4 files changed, 149 insertions(+), 70 deletions(-)
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.extensions.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.extensions.adoc
index 5fce987..f987851 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.extensions.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.extensions.adoc
@@ -1,20 +1,34 @@
| isis.extensions.cors. +
allowed-headers
|
-|
+| Which HTTP headers are allowed in a CORS request.
+
+For more information, check the usage of the `cors.allowed.headers` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter].
+
| isis.extensions.cors. +
allowed-methods
|
-|
+| Which HTTP methods are permitted in a CORS request.
+
+For more information, check the usage of the `cors.allowed.methods` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter].
+
| isis.extensions.cors. +
allowed-origins
| *
-|
+| Which origins are allowed to make CORS requests.
+
+The default is the wildcard ("*") but this can be made more restrictive if necessary.
+
+For more information, check the usage of the `cors.allowed.origins` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter].
+
| isis.extensions.cors. +
exposed-headers
| Authorization
-|
+| Which HTTP headers are exposed in a CORS request.
+
+For more information, check the usage of the `cors.exposed.headers` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter].
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.legacy.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.legacy.adoc
index b46ab7d..46833d1 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.legacy.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.legacy.adoc
@@ -1,10 +1,12 @@
| isis.legacy.value-types.money. +
currency
|
-|
+| Configures the default currency code used by `MoneyValueSemanticsProvider`. @deprecated
+
| isis.legacy.value-types. +
percentage.format
|
-|
+| Configures the formats understood by `PercentageValueSemanticsProvider`. @deprecated
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.value-types.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.value-types.adoc
index 023d082..a658185 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.value-types.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.value-types.adoc
@@ -1,110 +1,131 @@
+| isis.value-types.primitives. +
+integer.format
+|
+|
+
| isis.value-types.java-lang. +
byte.format
|
-|
+| Configures the number format understood by `ByteValueSemanticsProviderAbstract`. @deprecated
+
| isis.value-types.java-lang. +
double.format
|
-|
+| Configures the number format understood by `DoubleValueSemanticsProviderAbstract`. @deprecated
+
| isis.value-types.java-lang. +
float.format
|
-|
+| Configures the number format understood by `FloatValueSemanticsProviderAbstract`. @deprecated
+
| isis.value-types.java-lang. +
long.format
|
-|
+| Configures the number format understood by `LongValueSemanticsProviderAbstract`. @deprecated
+
| isis.value-types.java-lang. +
short.format
|
-|
+| Configures the number format understood by `ShortValueSemanticsProviderAbstract`. @deprecated
+
| isis.value-types.java-math. +
big-decimal.format
|
-|
+| Configures the number format understood by `BigDecimalValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-math. +
big-integer.format
|
-|
+| Configures the number format understood by `BigIntegerValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-sql. +
date.format
| medium
-|
+| Configures the formats understood by `JavaSqlDateValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-sql. +
time.format
| short
-|
+| Configures the formats understood by `JavaSqlTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-sql. +
timestamp.format
| short
-|
+| Configures the formats understood by `JavaSqlTimeStampValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-time. +
local-date-time.format
| medium
-|
+| Configures the formats understood by `LocalDateTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-time. +
local-date.format
| medium
-|
+| Configures the formats understood by `LocalDateValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-time. +
local-time.format
| medium
-|
+| Configures the formats understood by `LocalTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-time. +
offset-date-time.format
| medium
-|
+| Configures the formats understood by `OffsetDateTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-time. +
offset-time.format
| medium
-|
+| Configures the formats understood by `OffsetTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-time. +
zoned-date-time.format
| medium
-|
+| Configures the formats understood by `ZonedDateTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.java-util. +
date.format
| medium
-|
+| Configures the formats understood by `JavaUtilDateValueSemanticsProvider`. @deprecated
+
| isis.value-types.joda. +
date-time.format
| medium
-|
+| Configures the formats understood by `JodaDateTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.joda. +
local-date-time.format
| medium
-|
+| Configures the formats understood by `JodaLocalDateTimeValueSemanticsProvider`. @deprecated
+
| isis.value-types.joda. +
local-date.format
| medium
-|
+| Configures the formats understood by `JodaLocalDateValueSemanticsProvider`. @deprecated
+
| isis.value-types.primitives. +
int.format
|
-|
+| Configures the number format understood by `IntValueSemanticsProviderAbstract`. @deprecated
-| isis.value-types.primitives. +
-integer.format
-|
-|
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc
index 3c7853b..756f59d 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc
@@ -36,42 +36,55 @@ application.brand-logo-signin
| isis.viewer.wicket. +
application.css
|
-| URL of file to read any custom CSS, relative to relative to the class-path resource root.
+| URL of file to read any custom CSS, relative to `static` package on the class path.
+
+A typical value is `css/application.css`. This will result in this file being read from the `static.css` package (because static resources such as CSS are mounted by Spring by default under `static` package).
| isis.viewer.wicket. +
application. +
favicon-content-type
|
-|
+| Specifies the content type of the favIcon, if any.
+
| isis.viewer.wicket. +
application.favicon-url
|
-|
+| Specifies the URL to use of the favIcon.
+
+This is expected to be a local resource.
+
| isis.viewer.wicket. +
application.js
|
-| URL of file to read any custom Javascript, relative to the class-path resource root.
+| URL of file to read any custom Javascript, relative to `static` package on the class path.
+
+A typical value is `css/application.js`. This will result in this file being read from the `static.js` package (because static resources such as CSS are mounted by Spring by default under `static` package).
| isis.viewer.wicket. +
application. +
menubars-layout-xml
| menubars.layout.xml
-|
+| Specifies the file name containing the menubars.
+
+This is expected to be a local resource.
+
| isis.viewer.wicket. +
application.name
| Apache Isis ™
-| Identifies the application on the sign-in page (unless a image is configured) and on top-left in the header (unless a \{@link Application#brandLogoHeader image is configured).
+| 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).
| 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.
+| 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.
| isis.viewer.wicket.base-path
@@ -82,19 +95,35 @@ application.version
| isis.viewer.wicket. +
bookmarked-pages.max-size
| 15
-|
+| Specifies the maximum number of bookmarks to show.
+
+These are aged out on an MRU-LRU basis.
+
| isis.viewer.wicket. +
bookmarked-pages.show-chooser
| true
-| Determines whether the bookmarks should be available in the header.
+| Whether the panel providing linsk to previously visited object should be accessible from the top-left of the header.
+
+
+| isis.viewer.wicket. +
+bookmarked-pages. +
+show-drop-down-on-footer
+| true
+| Whether the drop-down list of previously visited objects should be shown in the footer.
| isis.viewer.wicket. +
-breadcrumbs.show-chooser
+breadcrumbs.enabled
| true
-| Determines whether the breadcrumbs should be available in the footer.
+| Whether to enable the 'where am i' feature, in other words the breadcrumbs.
+
+| isis.viewer.wicket. +
+breadcrumbs. +
+max-parent-chain-length
+| 64
+|
| isis.viewer.wicket. +
clear-original-destination
@@ -120,13 +149,17 @@ Each Date scalar panel will use \{#getDatePattern()} or \{@linkplain #getDateTim
| isis.viewer.wicket. +
date-picker.max-date
| 2100-01-01T00:00:00.000Z
-| As per http://eonasdan.github.io/bootstrap-datetimepicker/Options/#maxdate, in ISO format (per https://github.com/moment/moment/issues/1407).
+| Defines the first date available in the date picker.
+
+As per http://eonasdan.github.io/bootstrap-datetimepicker/Options/#maxdate, in ISO format (per https://github.com/moment/moment/issues/1407).
| isis.viewer.wicket. +
date-picker.min-date
| 1900-01-01T00:00:00.000Z
-| As per http://eonasdan.github.io/bootstrap-datetimepicker/Options/#maxdate, in ISO format (per https://github.com/moment/moment/issues/1407).
+| Defines the first date available in the date picker.
+
+As per http://eonasdan.github.io/bootstrap-datetimepicker/Options/#maxdate, in ISO format (per https://github.com/moment/moment/issues/1407).
| isis.viewer.wicket. +
@@ -226,17 +259,28 @@ This behaviour is disabled by default; the viewer will update the existing page
| isis.viewer.wicket. +
remember-me.cookie-key
| isisWicketRememberMe
-|
+| If the "remember me" feature is available, specifies the key to hold the encrypted credentials in the cookie.
+
| 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.
+
+Conversely, if set then (in production mode) then the same salt will be used each time the app is started, meaning that cached credentials can continue to be used across restarts.
+
+In prototype mode this setting is effectively ignored, because the same key will always be provided (either as set, or a fixed literal otherwise).
+
| 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.
+
| isis.viewer.wicket. +
replace-disabled-tag-with- +
@@ -266,14 +310,17 @@ 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 as well as a configured `org.apache.isis.applib.services.userreg.EmailNotificationService (same conditions as for the \{@link #isSuppressSignUp()` sign-up link).
+
| 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), not that in addition the application must provide an implementation of the as well as a configured \{@link org.apache.isis.applib.services.userreg.EmailNotificationService.
+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 as well as a configured `org.apache.isis.applib.services.userreg.EmailNotificationService (same conditions as for the \{@link #isSuppressPasswordReset()` password reset link).
| isis.viewer.wicket.themes. +
@@ -296,31 +343,30 @@ provider
wicket.ui.components.widgets. +
themepicker. +
IsisWicketThemeSupportDefault
-|
+| Specifies an implementation of `org.apache.isis.viewer.wicket.ui.components.widgets.themepicker.IsisWicketThemeSupport`
+
| isis.viewer.wicket.themes. +
show-chooser
|
-| Whether the theme chooser should be available in the footer.
-
-
-| isis.viewer.wicket. +
-timestamp-pattern
-| yyyy-MM-dd HH:mm:ss.SSS
-| The pattern used for rendering and parsing timestamps.
+| Whether the theme chooser widget should be available in the footer.
| isis.viewer.wicket. +
use-indicator-for-form-submit
| true
-| Whether to show an indicator for a form submit button that it has been clicked. This behaviour is enabled by default, but can be disabled using this flag.
+| Whether to show an indicator for a form submit button that it has been clicked.
+
+This behaviour is enabled by default.
| isis.viewer.wicket. +
use-indicator-for-no-arg- +
action
| true
-| Whether to show an indicator for a no-arg action button that it has been clicked. This behaviour is enabled by default, but can be disabled using this flag.
+| Whether to show an indicator for a no-arg action button that it has been clicked.
+
+This behaviour is enabled by default.
| isis.viewer.wicket.welcome. +
@@ -329,21 +375,17 @@ 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.
-| isis.viewer.wicket.where-am-i. +
-enabled
-| true
-|
-
-| isis.viewer.wicket.where-am-i. +
-max-parent-chain-length
-| 64
-|
-
| isis.viewer.wicket. +
wicket-source-plugin
|
| Whether the Wicket source plugin should be enabled; if so, the markup includes links to the Wicket source.
-Be aware that this can substantially impact performance.
+This behaviour is disabled by default. Please be aware that enabloing it can substantially impact performance.
+
+
+| isis.viewer.wicket. +
+timestamp-pattern
+| yyyy-MM-dd HH:mm:ss.SSS
+| @deprecated - seemingly unused