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/20 23:46:16 UTC
[isis] 03/03: ISIS-2267: updates generated 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 f4c64bb2d352a4d5e4bd245ace3c0c28cecd2da9
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jan 20 22:51:35 2020 +0000
ISIS-2267: updates generated docs
---
.../generated/isis.core.meta-model.validator.adoc | 21 ++++---
.../generated/isis.core.runtime-services.adoc | 61 +++++++++++++++-----
.../examples/generated/isis.core.runtime.adoc | 5 +-
.../generated/isis.viewer.restfulobjects.adoc | 52 ++++++++++++-----
.../examples/generated/isis.viewer.wicket.adoc | 65 +++++++++++++++++-----
5 files changed, 152 insertions(+), 52 deletions(-)
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
index fffd6f6..67e14ac 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
@@ -43,42 +43,49 @@ It is _highly advisable_ to leave this set as enabled (the default). These objec
validator.jaxb-view-model. +
date-time-type-adapter
| true
-|
+| If set, then ensures that for all properties of JAXB-style view models where the property's type is a date or time, then that property has been correctly annotated with @`javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter` (so that the property's value can be converted into a serializable form).
+
| isis.core.meta-model. +
validator.jaxb-view-model. +
no-arg-constructor
|
-|
+| If set, then ensures that all JAXB-style view models have a no-arg constructor.
+
| isis.core.meta-model. +
validator.jaxb-view-model. +
not-abstract
| true
-|
+| If set, then ensures that all JAXB-style view models are concrete classes, not abstract.
+
| isis.core.meta-model. +
validator.jaxb-view-model. +
not-inner-class
| true
-|
+| If set, then ensures that all JAXB-style view models are either top-level classes or nested static classes (in other words, checks that they are not anonymous, local nor nested non-static classes).
+
| isis.core.meta-model. +
validator.jaxb-view-model. +
reference-type-adapter
| true
-|
+| If set, then ensures that for all properties of JAXB-style view models where the property's type is an entity, then that entity's type has been correctly annotated with @`javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter` (so that the property's value can be converted into a serializable form).
+
| isis.core.meta-model. +
validator.jdoql.from-clause
| true
-|
+| If set, then ensures that the 'FROM' clause within any JDOQL `@Query`s annotations relates to a known entity type, and moreover that that type is compatible with the type on which the annotation appears: meaning its either a supertype of or the same type as the annotated type.
+
| isis.core.meta-model. +
validator.jdoql. +
variables-clause
| true
-|
+| If set, then ensures that the 'VARIABLES' clause within any JDOQL `@Query`s relates to a known entity type.
+
| isis.core.meta-model. +
validator.no-params-only
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc
index 2664b46..82076b4 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc
@@ -1,74 +1,98 @@
| isis.core.runtime-services. +
application-features.init
|
-|
+| Whether the (or the default implementation of that service, at least) should compute the set of `ApplicationFeature` that describe the metamodel \{@link ApplicationFeaturesInitConfiguration#EAGERLY eagerly, or lazily.
+
| isis.core.runtime-services. +
email.override.bcc
|
-|
+| Intended for testing purposes only, if set then the requested `bcc:` of the email will be ignored, and instead sent to this email address instead.
+
| isis.core.runtime-services. +
email.override.cc
|
-|
+| Intended for testing purposes only, if set then the requested `cc:` of the email will be ignored, and instead sent to this email address instead.
+
| isis.core.runtime-services. +
email.override.to
|
-|
+| Intended for testing purposes only, if set then the requested `to:` of the email will be ignored, and instead sent to this email address instead.
+
| isis.core.runtime-services. +
email.port
| 587
-|
+| The port to use for sending email.
+
| isis.core.runtime-services. +
email.sender.address
|
-|
+| Specifies the email address of the user sending the email.
+
+If the username is not specified, is also used as the username to connect to the SMTP service.
+
+This configuration property is mandatory (for the default implementation of the `org.apache.isis.applib.services.email.EmailService`, at least).
+
| isis.core.runtime-services. +
email.sender.hostname
|
-|
+| Specifies the host running the SMTP service.
+
+If not specified, then the value used depends upon the email implementation. The default implementation will use the `mail.smtp.host` system property.
+
| isis.core.runtime-services. +
email.sender.password
|
-|
+| Specifies the password (corresponding to the username to connect to the SMTP service.
+
+This configuration property is mandatory (for the default implementation of the `org.apache.isis.applib.services.email.EmailService`, at least).
+
| isis.core.runtime-services. +
email.sender.username
|
-|
+| Specifies the username to use to connect to the SMTP service.
+
+If not specified, then the sender's email address will be used instead.
+
| isis.core.runtime-services. +
email. +
socket-connection-timeout
| 2000
-|
+| The maximum number of millseconds to wait to obtain a socket connection before timing out.
+
| isis.core.runtime-services. +
email.socket-timeout
| 2000
-|
+| The maximum number of millseconds to wait to obtain a socket before timing out.
+
| isis.core.runtime-services. +
email.throw-exception-on-fail
| true
-|
+| If an email fails to send, whether to propagate the exception (meaning that potentially the end-user might see the exception), or whether instead to just indicate failure through the return value of the method (\{@link org.apache.isis.applib.services.email.EmailService#send(List, List, List, String, String, DataSource...)) that's being called.
+
| isis.core.runtime-services. +
email.tls.enabled
| true
-|
+| Whether TLS encryption should be started (that is, `STARTTLS`).
+
| isis.core.runtime-services. +
exception-recognizer.jdo. +
disable
|
-|
+| Whether the `org.apache.isis.applib.services.exceprecog.ExceptionRecognizer` implementation for JDO/DataNucleus object store - which attempts to sanitize any exceptions arising from that object store - should be disabled (meaning that exceptions will potentially propagate as more serious to the end user).
+
| isis.core.runtime-services. +
repository-service. +
@@ -84,5 +108,12 @@ Originally introduced as part of ISIS-1134 (fixing memory leaks in the objectsto
| isis.core.runtime-services. +
translation.po.mode
|
-|
+| Specifies the initial mode for obtaining/discovering translations.
+
+There are three modes:
+
+* The default mode of write is appropriate for integration testing or prototyping, meaning that the service records any requests made of it but just returns the string unaltered. This is a good way to discover new strings that require translation.
+* The read mode is appropriate for production; the service looks up translations that have previously been captured.
+* The disabled performs no translation and simply returns the original string unchanged. Unlike the write mode, it does _not_ keep track of translation requests.
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
index 845ccca..7eaf226 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
@@ -1,9 +1,10 @@
| isis.core.runtime.locale
|
-| Set to override `Locale#getDefault()`
+| If set, then overrides the application's `Locale#getDefault()`
| isis.core.runtime.timezone
|
-|
+| If set, then override's the application's timezone.
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc
index 8d4dfa5..9dc2e2f 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc
@@ -9,53 +9,79 @@ If set, eg `https://dev.myapp.com/`, then this value will be used instead.
| isis.viewer.restfulobjects. +
-gsoc2013.legacy-param-details
-|
-|
-
-| isis.viewer.restfulobjects. +
honor-ui-hints
|
-|
+| Whether to enable the `x-ro-follow-links` support, to minimize round trips.
+
+The RO viewer provides the capability for the client to set the optional `x-ro-follow-links` query parameter, as described in section 34.4 of the RO spec v1.0. If used, the resultant representation includes the result of following the associated link, but through a server-side "join", somewhat akin to GraphQL.
+
+By default this functionality is disabled, this configuration property enables the feature. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
| isis.viewer.restfulobjects. +
object-property-values-only
|
-|
+| When rendering domain objects, if set the representation returned is stripped back to a minimal set, excluding links to actions and collections and with a simplified representation of an object's properties.
+
+This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
| isis.viewer.restfulobjects. +
strict-accept-checking
|
-|
+| If set, then any unrecognised `Accept` headers will result in an HTTP _Not Acceptable_ response code (406).
+
| isis.viewer.restfulobjects. +
suppress-described-by-links
|
-|
+| If set, then the representations returned will omit any links to the formal domain-type representations.
+
| isis.viewer.restfulobjects. +
suppress-member-disabled- +
reason
|
-|
+| If set, then - should there be an interaction with an action, property or collection that is disabled - then this will prevent the `disabledReason` reason from being added to the returned representation.
+
+This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
| isis.viewer.restfulobjects. +
suppress-member-extensions
|
-|
+| If set, then the `x-isis-format` key (under `extensions`) for properties will be suppressed.
+
+This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
| isis.viewer.restfulobjects. +
suppress-member-id
|
-|
+| If set, then the `id` key for all members will be suppressed.
+
+This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
| isis.viewer.restfulobjects. +
suppress-member-links
|
-|
+| If set, then the detail link (in other words `links[rel='details' ...]`) for all members will be suppressed.
+
+This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
| isis.viewer.restfulobjects. +
suppress-update-link
|
+| If set, then the update link (in other words `links[rel='update'... ]` to perform a bulk update of an object) will be suppressed.
+
+This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
+
+
+| isis.viewer.restfulobjects. +
+gsoc2013.legacy-param-details
|
+| @deprecated
+
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 19f4abd..3c7853b 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
@@ -1,14 +1,17 @@
| isis.viewer.wicket. +
ajax-debug-mode
|
-| Whether the Ajax debug should be shown.
+| Whether the Ajax debug should be shown, by default this is disabled.
| isis.viewer.wicket.app
| org.apache.isis.viewer. +
wicket.viewer.wicketapp. +
IsisWicketApplication
-|
+| Specifies the subclass of < code>org.apache.isis.viewer.wicket.viewer.wicketapp.IsisWicketApplication that is used to bootstrap Wicket.
+
+There is usually very little reason to change this from its default.
+
| isis.viewer.wicket. +
application.about
@@ -73,7 +76,8 @@ application.version
| isis.viewer.wicket.base-path
| /wicket/
-|
+| The base path at which the Wicket viewer is mounted.
+
| isis.viewer.wicket. +
bookmarked-pages.max-size
@@ -95,7 +99,10 @@ breadcrumbs.show-chooser
| 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.
+
| isis.viewer.wicket.credit
|
@@ -141,17 +148,26 @@ By default, depends on the mode (prototyping = enabled, server = disabled). This
| 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()`.
+
| 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()`.
+
| 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 `Xxx.layout.xml` files.
+
| isis.viewer.wicket. +
max-title-length-in-parented- +
@@ -168,7 +184,10 @@ standalone-tables
| isis.viewer.wicket. +
max-title-length-in-tables
| 12
-|
+| The maximum number of characters to use to render the title of a domain object (alongside the icon) in any table, if not otherwise overridden by either or \{@link #getMaxTitleLengthInStandaloneTables().
+
+If truncated, then the remainder of the title will be replaced with ellipses (...).
+
| isis.viewer.wicket. +
prevent-double-click-for-form- +
@@ -181,19 +200,27 @@ submit
prevent-double-click-for-no- +
arg-action
| true
-| Whether to disable a no-arg action button after it has been clicked, to prevent users causing an error if they do a double click. This behaviour is enabled by default, but can be disabled using this flag.
+| Whether to disable a no-arg action button after it has been clicked, to prevent users causing an error if they do a double click.
+
+This behaviour is enabled by default, but can be disabled using this flag.
| 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`. This behaviour is disabled by default; the viewer will use an inline prompt in these cases, making for a smoother user experience. If enabled then this reinstates the pre-1.15.0 behaviour of using a dialog prompt in all cases.
+| 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`.
+
+This behaviour is disabled by default; the viewer will use an inline prompt in these cases, making for a smoother user experience. If enabled then this reinstates the pre-1.15.0 behaviour of using a dialog prompt in all cases.
| 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.
+| 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.
| isis.viewer.wicket. +
@@ -215,20 +242,25 @@ remember-me.suppress
replace-disabled-tag-with- +
readonly-tag
| true
-| in Firefox and more recent versions of Chrome 54+, cannot copy out of disabled fields; instead we use the readonly attribute (https://www.w3.org/TR/2014/REC-html5-20141028/forms.html#the-readonly-attribute) This behaviour is enabled by default but can be disabled using this flag
+| In Firefox and more recent versions of Chrome 54+, cannot copy out of disabled fields; instead we use the readonly attribute (https://www.w3.org/TR/2014/REC-html5-20141028/forms.html#the-readonly-attribute)
+
+This behaviour is enabled by default but can be disabled using this flag
| isis.viewer.wicket. +
show-footer
| true
-|
+| Whether to show the footer menu bar.
+
+This is enabled by default.
+
| isis.viewer.wicket. +
strip-wicket-tags
| true
| Whether Wicket tags should be stripped from the markup.
-Be aware that if Wicket tags are _not_ stripped, then this may break CSS rules on some browsers.
+By default this is enabled, in other words Wicket tags are stripped. Please be aware that if tags are _not_ stripped, then this may break CSS rules on some browsers.
| isis.viewer.wicket. +
@@ -239,7 +271,10 @@ suppress-password-reset
| 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.
+
| isis.viewer.wicket.themes. +
enabled