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/17 14:04:58 UTC
[isis] branch master updated (11277d9 -> e57b222)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git.
from 11277d9 ISIS-2158: improving terminology: 'bookmarkable' -> 'identifiable'
new 71b2d2d ISIS-2062: uses pandoc to convert generated docs from html to adoc
new 078a92d ISIS-2062: adds back in scripts/ci/build-site.sh
new f9bc0ea ISIS-2062: fixes bad link in demo app.
new 748a4de ISIS-2062: regen cfg prop docs through pandoc
new e57b222 ISIS-2062: cleans up the generated .adoc with some regex before hand
The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
build-site.sh | 2 +-
.../config/examples/generated/isis.applib.adoc | 204 ++++++++++++++++-----
.../isis.core.meta-model.introspector.adoc | 24 ++-
.../generated/isis.core.meta-model.validator.adoc | 3 +-
.../generated/isis.core.runtime-services.adoc | 9 +-
.../examples/generated/isis.core.runtime.adoc | 3 +-
.../isis.persistence.jdo-datanucleus.impl.adoc | 135 ++++++++++----
.../examples/generated/isis.security.shiro.adoc | 6 +-
.../generated/isis.viewer.restfulobjects.adoc | 9 +-
.../examples/generated/isis.viewer.wicket.adoc | 111 +++++++----
.../config/examples/generated/resteasy.adoc | 10 +
.../dom/types/primitive/PrimitivesDemo.adoc | 2 +-
scripts/ci/{build-site.sh => _build-site.sh} | 0
scripts/ci/build-site.sh | 52 +-----
scripts/generateConfigDocs.groovy | 23 ++-
15 files changed, 391 insertions(+), 202 deletions(-)
copy scripts/ci/{build-site.sh => _build-site.sh} (100%)
[isis] 02/05: ISIS-2062: adds back in scripts/ci/build-site.sh
Posted by da...@apache.org.
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 078a92d845df10973846e43ddb5e1b05533e4244
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 17 14:23:05 2020 +0100
ISIS-2062: adds back in scripts/ci/build-site.sh
---
scripts/ci/build-site.sh | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/scripts/ci/build-site.sh b/scripts/ci/build-site.sh
new file mode 100644
index 0000000..0cffba2
--- /dev/null
+++ b/scripts/ci/build-site.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+export SKIP_EXAMPLES=true
+export SKIP_CONFIGS=true
+export SKIP_STALE_EXAMPLE_CHECK=true
+
+sh scripts/ci/_build-site.sh $*
[isis] 05/05: ISIS-2062: cleans up the generated .adoc with some
regex before hand
Posted by da...@apache.org.
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 e57b222cd1e5eba3b53523cea2c5f61787e7da88
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 17 14:56:12 2020 +0100
ISIS-2062: cleans up the generated .adoc with some regex before hand
---
.../config/examples/generated/isis.applib.adoc | 134 ++++++++++-----------
.../isis.core.meta-model.introspector.adoc | 8 +-
.../examples/generated/isis.core.runtime.adoc | 2 +-
.../isis.persistence.jdo-datanucleus.impl.adoc | 2 +-
.../generated/isis.viewer.restfulobjects.adoc | 2 +-
.../examples/generated/isis.viewer.wicket.adoc | 8 +-
.../config/examples/generated/resteasy.adoc | 2 +-
scripts/generateConfigDocs.groovy | 2 +
8 files changed, 81 insertions(+), 79 deletions(-)
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
index 29c73b7..64201e0 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
@@ -23,7 +23,7 @@ domain-event.post-for-default
| isis.applib.annotation.action. +
explicit
|
-| Whether or not a public method needs to be annotated with @\{@link org.apache.isis.applib.annotation.Action} in order to be picked up as an action in the metamodel.
+| Whether or not a public method needs to be annotated with @`org.apache.isis.applib.annotation.Action` in order to be picked up as an action in the metamodel.
| isis.applib.annotation.action. +
@@ -53,12 +53,12 @@ domain-object-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the CSS classes that are used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()} @DomainObjectLayout(cssClassEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent() @DomainObjectLayout(cssClassEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Default CssClassUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -67,12 +67,12 @@ domain-object-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the icon that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent()} @DomainObjectLayout(iconEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent() @DomainObjectLayout(iconEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Default IconUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of IconUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -81,14 +81,14 @@ domain-object-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the layout that is used.
If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent()} @DomainObjectLayout(layoutEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent() @DomainObjectLayout(layoutEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Default LayoutUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -102,21 +102,21 @@ domain-object-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the title that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()} @DomainObjectLayout(titleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent() @DomainObjectLayout(titleEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Default TitleUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
| isis.applib.annotation. +
domain-object.auditing
|
-| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to the \{@link org.apache.isis.applib.services.audit.AuditerService}.
+| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to the
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getAuditing() DomainObject#getAuditing()}
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getAuditing() DomainObject#getAuditing()
Note: this applies only to domain entities, not view models.
@@ -126,12 +126,12 @@ domain-object. +
created-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object has been created using \{@link org.apache.isis.applib.services.factory.FactoryService}..
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object has been created using
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Noop ObjectCreatedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectCreatedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -140,7 +140,7 @@ domain-object.editing
|
| The default for whether the properties of domain objects can be edited, or whether instead they can be modified only using actions (or programmatically as a side-effect of actions on other objects).
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getEditing() DomainObject#getEditing()}
+This setting can be overridden on a case-by-case basis using DomainObject#getEditing()
| isis.applib.annotation. +
@@ -148,12 +148,12 @@ domain-object. +
loaded-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ has been loaded from the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ has been loaded from the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#loadedLifecycleEvent() @DomainObject(loadedLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(loadedLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Noop ObjectLoadedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectLoadedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -164,12 +164,12 @@ domain-object. +
persisted-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ has been persisted (for the first time) to the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ has been persisted (for the first time) to the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#persistedLifecycleEvent() @DomainObject(persistedLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(persistedLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Noop ObjectPersistedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectPersistedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -180,12 +180,12 @@ domain-object. +
persisting-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#persistingLifecycleEvent() @DomainObject(persistingLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(persistingLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Noop ObjectPersistingEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectPersistingEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -194,11 +194,11 @@ Note: this applies only to domain entities, not to view models.
| isis.applib.annotation. +
domain-object.publishing
|
-| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the \{@link org.apache.isis.applib.services.publish.PublisherService} for publishing.
+| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the for publishing.
-The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish} method is called only once per transaction, with \{@link PublishedObjects} collecting details of all changed domain objects.
+The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish method is called only once per transaction, with collecting details of all changed domain objects.
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getPublishing() DomainObject#getPublishing()}.
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getPublishing() DomainObject#getPublishing().
| isis.applib.annotation. +
@@ -206,12 +206,12 @@ domain-object. +
removing-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#removingLifecycleEvent() @DomainObject(removingLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(removingLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Noop ObjectRemovingEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectRemovingEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -224,12 +224,12 @@ domain-object. +
updated-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ has been updated in the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ has been updated in the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#updatedLifecycleEvent() @DomainObject(updatedLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(updatedLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Noop ObjectUpdatedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectUpdatedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -240,12 +240,12 @@ domain-object. +
updating-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ is about to be updated in the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ is about to be updated in the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#updatingLifecycleEvent() @DomainObject(updatingLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(updatingLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Noop ObjectUpdatingEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectUpdatingEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -284,12 +284,12 @@ view-model-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the CSS classes that are used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent()} @ViewModelLayout(cssClassEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent() @ViewModelLayout(cssClassEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Default CssClassUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -298,12 +298,12 @@ view-model-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the icon that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent()} @ViewModelLayout(iconEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent() @ViewModelLayout(iconEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Default IconUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of IconUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -312,14 +312,14 @@ view-model-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the layout that is used.
If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent()} @ViewModelLayout(layoutEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent() @ViewModelLayout(layoutEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Default LayoutUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -328,12 +328,12 @@ view-model-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used.
+| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the title that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent()} @ViewModelLayout(titleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent() @ViewModelLayout(titleEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Default TitleUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent.
+* If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
index 5482034..9534929 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
@@ -4,7 +4,7 @@ lock-after-full-introspection
| true
| If true, then no new specifications will be allowed to be loaded once introspection has been complete.
-Only applies if the introspector is configured to perform full introspection up-front (either because of \{@link IntrospectionMode#FULL} or \{@link IntrospectionMode#LAZY_UNLESS_PRODUCTION} when in production); otherwise is ignored.
+Only applies if the introspector is configured to perform full introspection up-front (either because of or \{@link IntrospectionMode#LAZY_UNLESS_PRODUCTION when in production); otherwise is ignored.
| isis.core.meta-model. +
@@ -12,7 +12,7 @@ introspector.mode
|
| Whether all known types should be fully introspected as part of the bootstrapping, or should only be partially introspected initially.
-Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless \{@link #isValidateIncrementally()} is disabled.
+Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless `#isValidateIncrementally()` is disabled.
| isis.core.meta-model. +
@@ -27,8 +27,8 @@ validate-incrementally
| true
| If true, then metamodel validation is performed after any new specification has been loaded (after the initial bootstrapping).
-This does _not_ apply if the introspector is configured to perform full introspection up-front AND when the metamodel is \{@link Core.MetaModel.Introspector#isLockAfterFullIntrospection() locked} after initial bootstrapping (because in that case the lock check will simply prevent any new specs from being loaded). But it will apply otherwise.
+This does _not_ apply if the introspector is configured to perform full introspection up-front AND when the metamodel is locked after initial bootstrapping (because in that case the lock check will simply prevent any new specs from being loaded). But it will apply otherwise.
-In particular, this setting _can_ still apply even if the \{@link Core.MetaModel.Introspector#getMode() introspection mode} is set to \{@link IntrospectionMode#FULL full}, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the \{@link org.apache.isis.applib.services.wrapper.WrapperFactory} - this will cause introspection of that new type to be performed.
+In particular, this setting _can_ still apply even if the introspection mode is set to full, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the `org.apache.isis.applib.services.wrapper.WrapperFactory` - this will cause introspection of that new type to be performed.
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 1e42adf..845ccca 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,6 +1,6 @@
| isis.core.runtime.locale
|
-| Set to override \{@link Locale#getDefault()}
+| Set to override `Locale#getDefault()`
| isis.core.runtime.timezone
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
index a06c42e..2ffc3c0 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
@@ -306,6 +306,6 @@ class
JDOPersistenceManagerFactory
| See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - changing this property from its default is used to enable the flyway extension (in combination with \{@link Datanucleus.Schema#isAutoCreateAll()}
+@implNote - changing this property from its default is used to enable the flyway extension (in combination with `Datanucleus.Schema#isAutoCreateAll()`
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 e6ad358..8d4dfa5 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
@@ -1,7 +1,7 @@
| isis.viewer.restfulobjects. +
base-uri
|
-| If left unset (the default), then the RO viewer will use the \{@link javax.ws.rs.core.UriInfo} injected using @link javax.ws.rs.core.Context}) to figure out the base Uri (used to render `href`s).
+| If left unset (the default), then the RO viewer will use the injected using @link javax.ws.rs.core.Context) to figure out the base Uri (used to render `href`s).
This will be correct much of the time, but will almost certainly be wrong if there is a reverse proxy.
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 9dd0777..19f4abd 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
@@ -27,7 +27,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 \{@link Application#name} is used instead.
+| 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.
| isis.viewer.wicket. +
@@ -62,7 +62,7 @@ menubars-layout-xml
| isis.viewer.wicket. +
application.name
| Apache Isis ™
-| Identifies the application on the sign-in page (unless a \{@link Application#brandLogoSignin} 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 image is configured) and on top-left in the header (unless a \{@link Application#brandLogoHeader image is configured).
| isis.viewer.wicket. +
@@ -127,7 +127,7 @@ date-time-pattern
| dd-MM-yyyy HH:mm
| The pattern used for rendering and parsing date/times.
-Each Date scalar panel will use \{@link Wicket#getDatePattern()} or \{@link Wicket#getDateTimePattern()} depending on its date type. In the case of panels with a date time picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
+Each Date scalar panel will use or \{@link Wicket#getDateTimePattern() depending on its date type. In the case of panels with a date time picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
| isis.viewer.wicket. +
@@ -252,7 +252,7 @@ initial
| Flatly
| The initial theme to use.
-Expected to be in the list of \{@link #getEnabled()} themes.
+Expected to be in the list of `#getEnabled()` themes.
| isis.viewer.wicket.themes. +
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc b/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
index c2d5177..615a658 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
@@ -13,7 +13,7 @@ registration
| resteasy.jaxrs.default-path
| /restful
-| Note that this is used rather than `resteasy.servlet.mapping.prefix` because there is _NO_ implementation of \{@link javax.ws.rs.core.Application}, so we rely on it being automatically created.
+| Note that this is used rather than `resteasy.servlet.mapping.prefix` because there is _NO_ implementation of `javax.ws.rs.core.Application`, so we rely on it being automatically created.
| resteasy.resteasy-settings
diff --git a/scripts/generateConfigDocs.groovy b/scripts/generateConfigDocs.groovy
index f21634c..257f59e 100644
--- a/scripts/generateConfigDocs.groovy
+++ b/scripts/generateConfigDocs.groovy
@@ -261,6 +261,8 @@ System.out.println("");
static String toAsciidoc(String str) {
System.out.print(".");
+ str = str.replaceAll( /\{@link[ ]+?(.+?)[ ]+(.+?)[ ]*?}/, '$2')
+ str = str.replaceAll( /\{@link[ ]+?(.+?)[ ]*?}/, '`$1`')
File tf = File.createTempFile("input",".html")
tf.write(str) // write to the file
[isis] 04/05: ISIS-2062: regen cfg prop docs through pandoc
Posted by da...@apache.org.
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 748a4de0331f221726214d003c8912c542ce60df
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 17 14:34:12 2020 +0100
ISIS-2062: regen cfg prop docs through pandoc
---
.../config/examples/generated/isis.applib.adoc | 204 ++++++++++++++++-----
.../isis.core.meta-model.introspector.adoc | 24 ++-
.../generated/isis.core.meta-model.validator.adoc | 3 +-
.../generated/isis.core.runtime-services.adoc | 9 +-
.../examples/generated/isis.core.runtime.adoc | 3 +-
.../isis.persistence.jdo-datanucleus.impl.adoc | 135 ++++++++++----
.../examples/generated/isis.security.shiro.adoc | 6 +-
.../generated/isis.viewer.restfulobjects.adoc | 9 +-
.../examples/generated/isis.viewer.wicket.adoc | 111 +++++++----
.../config/examples/generated/resteasy.adoc | 10 +
10 files changed, 374 insertions(+), 140 deletions(-)
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
index 221706f..29c73b7 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
@@ -23,7 +23,8 @@ domain-event.post-for-default
| isis.applib.annotation.action. +
explicit
|
-| Whether or not a public method needs to be annotated with @{@link org.apache.isis.applib.annotation.Action} in order to be picked up as an action in the metamodel.
+| Whether or not a public method needs to be annotated with @\{@link org.apache.isis.applib.annotation.Action} in order to be picked up as an action in the metamodel.
+
| isis.applib.annotation.action. +
publishing
@@ -52,25 +53,44 @@ domain-object-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()} @DomainObjectLayout(cssClassEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@l [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()} @DomainObjectLayout(cssClassEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Default CssClassUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
domain-object-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent()} @DomainObjectLayout(iconEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link org.apache.i [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent()} @DomainObjectLayout(iconEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Default IconUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
domain-object-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used. +
- If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml</code> use used (where `zzz</code> is the name of the layout). +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent()} @DomainObjectLayout(layoutEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link org. [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used.
+
+If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent()} @DomainObjectLayout(layoutEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Default LayoutUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
domain-object-layout.paged
@@ -82,91 +102,154 @@ domain-object-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()} @DomainObjectLayout(titleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link org.apac [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()} @DomainObjectLayout(titleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Default TitleUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
domain-object.auditing
|
-| The default for whether _domain entities</i> should be audited or not (meaning that any changes are sent through to the {@link org.apache.isis.applib.services.audit.AuditerService}. +
- This setting can be overridden on a case-by-case basis using {@link DomainObject#getAuditing() DomainObject#getAuditing()} +
- Note: this applies only to domain entities, not view models.
+| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to the \{@link org.apache.isis.applib.services.audit.AuditerService}.
+
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getAuditing() DomainObject#getAuditing()}
+
+Note: this applies only to domain entities, not view models.
+
| isis.applib.annotation. +
domain-object. +
created-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object has been created using {@link org.apache.isis.applib.services.factory.FactoryService}.. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Noop ObjectCreatedEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype o [...]
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object has been created using \{@link org.apache.isis.applib.services.factory.FactoryService}..
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Noop ObjectCreatedEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
domain-object.editing
|
-| The default for whether the properties of domain objects can be edited, or whether instead they can be modified only using actions (or programmatically as a side-effect of actions on other objects). +
- This setting can be overridden on a case-by-case basis using {@link DomainObject#getEditing() DomainObject#getEditing()}
+| The default for whether the properties of domain objects can be edited, or whether instead they can be modified only using actions (or programmatically as a side-effect of actions on other objects).
+
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getEditing() DomainObject#getEditing()}
+
| isis.applib.annotation. +
domain-object. +
loaded-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity</i> has been loaded from the persistence store. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#loadedLifecycleEvent() @DomainObject(loadedLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Noop ObjectLoadedEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of [...]
- Note: this applies only to domain entities, not to view models.
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ has been loaded from the persistence store.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#loadedLifecycleEvent() @DomainObject(loadedLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Noop ObjectLoadedEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
+Note: this applies only to domain entities, not to view models.
+
| isis.applib.annotation. +
domain-object. +
persisted-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity</i> has been persisted (for the first time) to the persistence store. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#persistedLifecycleEvent() @DomainObject(persistedLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Noop ObjectPersistedEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some s [...]
- Note: this applies only to domain entities, not to view models.
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ has been persisted (for the first time) to the persistence store.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#persistedLifecycleEvent() @DomainObject(persistedLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Noop ObjectPersistedEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
+Note: this applies only to domain entities, not to view models.
+
| isis.applib.annotation. +
domain-object. +
persisting-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity</i> is about to be persisting (for the first time) to the persistence store. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#persistingLifecycleEvent() @DomainObject(persistingLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Noop ObjectPersistingEvent.Noop}, then _no</i> event is sent. </li> <li> If set to so [...]
- Note: this applies only to domain entities, not to view models.
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#persistingLifecycleEvent() @DomainObject(persistingLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Noop ObjectPersistingEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
+Note: this applies only to domain entities, not to view models.
+
| isis.applib.annotation. +
domain-object.publishing
|
-| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the {@link org.apache.isis.applib.services.publish.PublisherService} for publishing. +
- The service's {@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish} method is called only once per transaction, with {@link PublishedObjects} collecting details of all changed domain objects. +
- This setting can be overridden on a case-by-case basis using {@link DomainObject#getPublishing() DomainObject#getPublishing()}.
+| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the \{@link org.apache.isis.applib.services.publish.PublisherService} for publishing.
+
+The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish} method is called only once per transaction, with \{@link PublishedObjects} collecting details of all changed domain objects.
+
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getPublishing() DomainObject#getPublishing()}.
+
| isis.applib.annotation. +
domain-object. +
removing-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity</i> is about to be removed (that is, deleted) from the persistence store. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#removingLifecycleEvent() @DomainObject(removingLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Noop ObjectRemovingEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subty [...]
- Note: this applies only to domain entities, not to view models. +
- Note: There is no corresponding `removed</code> callback, because (for the JDO persistence store at least) it is not possible to interact with a domain entity once it has been deleted.
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#removingLifecycleEvent() @DomainObject(removingLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Noop ObjectRemovingEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
+Note: this applies only to domain entities, not to view models.
+
+Note: There is no corresponding `removed` callback, because (for the JDO persistence store at least) it is not possible to interact with a domain entity once it has been deleted.
+
| isis.applib.annotation. +
domain-object. +
updated-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity</i> has been updated in the persistence store. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#updatedLifecycleEvent() @DomainObject(updatedLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Noop ObjectUpdatedEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype o [...]
- Note: this applies only to domain entities, not to view models.
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ has been updated in the persistence store.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#updatedLifecycleEvent() @DomainObject(updatedLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Noop ObjectUpdatedEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
+Note: this applies only to domain entities, not to view models.
+
| isis.applib.annotation. +
domain-object. +
updating-lifecycle-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity</i> is about to be updated in the persistence store. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.DomainObject#updatingLifecycleEvent() @DomainObject(updatingLifecycleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Noop ObjectUpdatingEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subty [...]
- Note: this applies only to domain entities, not to view models.
+| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ is about to be updated in the persistence store.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#updatingLifecycleEvent() @DomainObject(updatingLifecycleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Noop ObjectUpdatingEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
+Note: this applies only to domain entities, not to view models.
+
| isis.applib.annotation. +
parameter-layout. +
@@ -201,33 +284,58 @@ view-model-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with {@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent()} @ViewModelLayout(cssClassEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link or [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent()} @ViewModelLayout(cssClassEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Default CssClassUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
view-model-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with {@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent()} @ViewModelLayout(iconEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link org.apache.isis.ap [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent()} @ViewModelLayout(iconEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Default IconUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
view-model-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with {@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used. +
- If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml</code> use used (where `zzz</code> is the name of the layout). +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent()} @ViewModelLayout(layoutEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link org.apache [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used.
+
+If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent()} @ViewModelLayout(layoutEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Default LayoutUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
view-model-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an {@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal {@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with {@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally {@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used. +
- The algorithm for determining whether an event is sent depends on the value of the {@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent()} @ViewModelLayout(titleEvent=...)} for the domain object in question. <ul> <li> If set to some subtype of {@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no</i> event is sent. </li> <li> If set to some subtype of {@link org.apache.isi [...]
+| Influences whether an \{@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used.
+
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent()} @ViewModelLayout(titleEvent=...)} for the domain object in question.
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no_ event is sent.
+* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Default TitleUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
view-model.validation. +
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
index e6cae77..5482034 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
@@ -2,25 +2,33 @@
introspector. +
lock-after-full-introspection
| true
-| If true, then no new specifications will be allowed to be loaded once introspection has been complete. +
- Only applies if the introspector is configured to perform full introspection up-front (either because of {@link IntrospectionMode#FULL} or {@link IntrospectionMode#LAZY_UNLESS_PRODUCTION} when in production); otherwise is ignored.
+| If true, then no new specifications will be allowed to be loaded once introspection has been complete.
+
+Only applies if the introspector is configured to perform full introspection up-front (either because of \{@link IntrospectionMode#FULL} or \{@link IntrospectionMode#LAZY_UNLESS_PRODUCTION} when in production); otherwise is ignored.
+
| isis.core.meta-model. +
introspector.mode
|
-| Whether all known types should be fully introspected as part of the bootstrapping, or should only be partially introspected initially. +
- Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless {@link #isValidateIncrementally()} is disabled.
+| Whether all known types should be fully introspected as part of the bootstrapping, or should only be partially introspected initially.
+
+Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless \{@link #isValidateIncrementally()} is disabled.
+
| isis.core.meta-model. +
introspector.parallelize
| true
-| Whether to perform introspection in parallel.
+| Whether to perform introspection in parallel.
+
| isis.core.meta-model. +
introspector. +
validate-incrementally
| true
-| If true, then metamodel validation is performed after any new specification has been loaded (after the initial bootstrapping). +
- This does _not</i> apply if the introspector is configured to perform full introspection up-front AND when the metamodel is {@link Core.MetaModel.Introspector#isLockAfterFullIntrospection() locked} after initial bootstrapping (because in that case the lock check will simply prevent any new specs from being loaded). But it will apply otherwise. +
-In particular, this setting _can</i> still apply even if the {@link Core.MetaModel.Introspector#getMode() introspection mode} is set to {@link IntrospectionMode#FULL full}, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the {@link org.apache.isis.applib.services.wrapper.WrapperFactory} - this will cause introspection of that new type to be performed.
+| If true, then metamodel validation is performed after any new specification has been loaded (after the initial bootstrapping).
+
+This does _not_ apply if the introspector is configured to perform full introspection up-front AND when the metamodel is \{@link Core.MetaModel.Introspector#isLockAfterFullIntrospection() locked} after initial bootstrapping (because in that case the lock check will simply prevent any new specs from being loaded). But it will apply otherwise.
+
+In particular, this setting _can_ still apply even if the \{@link Core.MetaModel.Introspector#getMode() introspection mode} is set to \{@link IntrospectionMode#FULL full}, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the \{@link org.apache.isis.applib.services.wrapper.WrapperFactory} - this will cause introspection of that new type to be performed.
+
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 c439e64..453ae53 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
@@ -76,7 +76,8 @@ validator.no-params-only
| isis.core.meta-model. +
validator.parallelize
| true
-| Whether to perform metamodel validation in parallel.
+| Whether to perform metamodel validation in parallel.
+
| isis.core.meta-model. +
validator.mixins-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 de5cb4d..2664b46 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
@@ -74,9 +74,12 @@ disable
repository-service. +
disable-auto-flush
|
-| Normally any queries are automatically preceded by flushing pending executions. +
- This key allows this behaviour to be disabled. +
- Originally introduced as part of ISIS-1134 (fixing memory leaks in the objectstore) where it was found that the autoflush behaviour was causing a (now unrepeatable) data integrity error (see <a href="https://issues.apache.org/jira/browse/ISIS-1134?focusedCommentId=14500638&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14500638">ISIS-1134 comment</a>, in the isis-module-security. However, that this could be circumvented by removing the call [...]
+| Normally any queries are automatically preceded by flushing pending executions.
+
+This key allows this behaviour to be disabled.
+
+Originally introduced as part of ISIS-1134 (fixing memory leaks in the objectstore) where it was found that the autoflush behaviour was causing a (now unrepeatable) data integrity error (see https://issues.apache.org/jira/browse/ISIS-1134?focusedCommentId=14500638&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14500638[ISIS-1134 comment], in the isis-module-security. However, that this could be circumvented by removing the call to flush(). We don't want to [...]
+
| isis.core.runtime-services. +
translation.po.mode
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 04456a7..1e42adf 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,6 +1,7 @@
| isis.core.runtime.locale
|
-| Set to override {@link Locale#getDefault()}
+| Set to override \{@link Locale#getDefault()}
+
| isis.core.runtime.timezone
|
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
index 6a29259..a06c42e 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
@@ -30,41 +30,61 @@ PersistenceUnitLoadClasses
jdo-datanucleus.impl. +
datanucleus.cache.level2.mode
|
-| Values of javax.persistence.SharedCacheMode, capitalized
+| Values of javax.persistence.SharedCacheMode, capitalized
+
| isis.persistence. +
jdo-datanucleus.impl. +
datanucleus.cache.level2.type
| none
-| 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. +
- See also Cache docs for JDO, and for JPA @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| 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.
+
+See also Cache docs for JDO, and for JPA
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
datanucleus. +
connection-factory-name
|
-| The JNDI name for a connection factory for transactional connections. +
- For RBDMS, it must be a JNDI name that points to a javax.sql.DataSource object. +
- See also `additional-spring-configuration-metadata.json</tt> (PascalCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| The JNDI name for a connection factory for transactional connections.
+
+For RBDMS, it must be a JNDI name that points to a javax.sql.DataSource object.
+
+See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
datanucleus. +
connection-factory2-name
|
-| The JNDI name for a connection factory for non-transactional connections. +
- For RBDMS, it must be a JNDI name that points to a javax.sql.DataSource object. +
- See also `additional-spring-configuration-metadata.json</tt> (PascalCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| The JNDI name for a connection factory for non-transactional connections.
+
+For RBDMS, it must be a JNDI name that points to a javax.sql.DataSource object.
+
+See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
datanucleus. +
connection-password-decrypter
|
-| Name of a class that implements `org.datanucleus.store.connection.DecryptionProvider</tt> and should only be specified if the password is encrypted in the persistence properties. +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| Name of a class that implements `org.datanucleus.store.connection.DecryptionProvider` and should only be specified if the password is encrypted in the persistence properties.
+
+See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
@@ -79,8 +99,10 @@ class-name
| org.apache.isis.persistence. +
jdo.datanucleus5.datanucleus. +
JDOStateManagerForIsis
-| Enables dependency injection into entities +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing).
+| Enables dependency injection into entities
+
+See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
| isis.persistence. +
jdo-datanucleus.impl. +
@@ -94,9 +116,14 @@ jdo-datanucleus.impl. +
datanucleus. +
persistence-unit-load-classes
| true
-| Used when we have specified the persistence-unit name for a PMF/EMF and where we want the datastore "tables" for all classes of that persistence-unit loading up into the StoreManager. +
- Defaults to true, which is the opposite of DataNucleus' own default. (The reason that DN defaults to false is because some databases are slow so such an operation would slow down the startup process). +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| Used when we have specified the persistence-unit name for a PMF/EMF and where we want the datastore "tables" for all classes of that persistence-unit loading up into the StoreManager.
+
+Defaults to true, which is the opposite of DataNucleus' own default. (The reason that DN defaults to false is because some databases are slow so such an operation would slow down the startup process).
+
+See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
@@ -111,17 +138,26 @@ jdo-datanucleus.impl. +
datanucleus.schema. +
auto-create-all
|
-| Whether DN should automatically create the database schema on bootstrapping. +
- This should be set to `true</tt> when running against an in-memory database, but set to `false</tt> when running against a persistent database (use something like flyway instead to manage schema evolution). +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - this config property isn't used by the core framework, but is used by one the flyway extension.
+| Whether DN should automatically create the database schema on bootstrapping.
+
+This should be set to `true` when running against an in-memory database, but set to `false` when running against a persistent database (use something like flyway instead to manage schema evolution).
+
+See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the core framework, but is used by one the flyway extension.
+
| isis.persistence. +
jdo-datanucleus.impl. +
datanucleus.schema. +
auto-create-database
|
-| Previously we defaulted this property to "true", but that could cause the target database to be modified +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| Previously we defaulted this property to "true", but that could cause the target database to be modified
+
+See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
@@ -142,8 +178,10 @@ jdo-datanucleus.impl. +
datanucleus.schema. +
validate-all
| true
-| +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl. +
@@ -170,9 +208,14 @@ validateTables
jdo-datanucleus.impl. +
datanucleus.transaction-type
|
-| Type of transaction to use. +
- If running under JavaSE the default is RESOURCE_LOCAL, and if running under JavaEE the default is JTA. +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+| Type of transaction to use.
+
+If running under JavaSE the default is RESOURCE_LOCAL, and if running under JavaEE the default is JTA.
+
+See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+
| isis.persistence. +
jdo-datanucleus.impl.javax. +
@@ -212,31 +255,47 @@ jdo-datanucleus.impl.javax. +
jdo.option. +
connection-driver-name
|
-| JDBC driver used by DataNucleus Object store to connect. +
- See also `additional-spring-configuration-metadata.json</tt> (PascalCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
+| JDBC driver used by DataNucleus Object store to connect.
+
+See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
+
| isis.persistence. +
jdo-datanucleus.impl.javax. +
jdo.option. +
connection-password
|
-| Password for the user account used by DataNucleus Object store to connect. +
- See also `additional-spring-configuration-metadata.json</tt> (PascalCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete. It is not necessarily mandatory, some databases accept an empty password.
+| Password for the user account used by DataNucleus Object store to connect.
+
+See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete. It is not necessarily mandatory, some databases accept an empty password.
+
| isis.persistence. +
jdo-datanucleus.impl.javax. +
jdo.option.connection-url
|
-| URL used by DataNucleus Object store to connect. +
- See also `additional-spring-configuration-metadata.json</tt> (PascalCasing instead of kebab-casing). @implNote - some extensions (H2Console, MsqlDbManager) peek at this URL to determine if they should be enabled. Note that it is also mandatory if using JDO Datanucleus.
+| URL used by DataNucleus Object store to connect.
+
+See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
+
+@implNote - some extensions (H2Console, MsqlDbManager) peek at this URL to determine if they should be enabled. Note that it is also mandatory if using JDO Datanucleus.
+
| isis.persistence. +
jdo-datanucleus.impl.javax. +
jdo.option. +
connection-user-name
|
-| User account used by DataNucleus Object store to connect. +
- See also `additional-spring-configuration-metadata.json</tt> (PascalCasing instead of kebab-casing). @implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
+| User account used by DataNucleus Object store to connect.
+
+See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
+
+@implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
+
| isis.persistence. +
jdo-datanucleus.impl.javax. +
@@ -245,6 +304,8 @@ persistence-manager-factory- +
class
| org.datanucleus.api.jdo. +
JDOPersistenceManagerFactory
-| +
- See also `additional-spring-configuration-metadata.json</tt> (camelCasing instead of kebab-casing). @implNote - changing this property from its default is used to enable the flyway extension (in combination with {@link Datanucleus.Schema#isAutoCreateAll()}
+| See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
+
+@implNote - changing this property from its default is used to enable the flyway extension (in combination with \{@link Datanucleus.Schema#isAutoCreateAll()}
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.security.shiro.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.security.shiro.adoc
index 99618ff..248f114 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.security.shiro.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.security.shiro.adoc
@@ -2,6 +2,8 @@
auto-logout-if-already- +
authenticated
|
-| If the Shiro subject is found to be still authenticated, then will be logged out anyway and then re-authenticated. +
- Applies only to the Restful Objects viewer.
+| If the Shiro subject is found to be still authenticated, then will be logged out anyway and then re-authenticated.
+
+Applies only to the Restful Objects viewer.
+
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 8c68489..e6ad358 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
@@ -1,9 +1,12 @@
| isis.viewer.restfulobjects. +
base-uri
|
-| If left unset (the default), then the RO viewer will use the {@link javax.ws.rs.core.UriInfo} injected using @link javax.ws.rs.core.Context}) to figure out the base Uri (used to render `href</code>s). +
- This will be correct much of the time, but will almost certainly be wrong if there is a reverse proxy. +
- If set, eg `https://dev.myapp.com/</code>, then this value will be used instead.
+| If left unset (the default), then the RO viewer will use the \{@link javax.ws.rs.core.UriInfo} injected using @link javax.ws.rs.core.Context}) to figure out the base Uri (used to render `href`s).
+
+This will be correct much of the time, but will almost certainly be wrong if there is a reverse proxy.
+
+If set, eg `https://dev.myapp.com/`, then this value will be used instead.
+
| isis.viewer.restfulobjects. +
gsoc2013.legacy-param-details
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 049224c..9dd0777 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,7 +1,8 @@
| isis.viewer.wicket. +
ajax-debug-mode
|
-| Whether the Ajax debug should be shown.
+| Whether the Ajax debug should be shown.
+
| isis.viewer.wicket.app
| org.apache.isis.viewer. +
@@ -12,23 +13,28 @@ IsisWicketApplication
| isis.viewer.wicket. +
application.about
|
-| Label used on the about page.
+| Label used on the about page.
+
| 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.
+| 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.
+
| 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 {@link Application#name} is used instead.
+| 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 \{@link Application#name} is used instead.
+
| 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 relative to the class-path resource root.
+
| isis.viewer.wicket. +
application. +
@@ -44,7 +50,8 @@ application.favicon-url
| 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 the class-path resource root.
+
| isis.viewer.wicket. +
application. +
@@ -55,12 +62,14 @@ menubars-layout-xml
| isis.viewer.wicket. +
application.name
| Apache Isis ™
-| Identifies the application on the sign-in page (unless a {@link Application#brandLogoSignin} 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 \{@link Application#brandLogoSignin} image is configured) and on top-left in the header (unless a \{@link Application#brandLogoHeader} 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
| /wicket/
@@ -74,12 +83,14 @@ bookmarked-pages.max-size
| isis.viewer.wicket. +
bookmarked-pages.show-chooser
| true
-| Determines whether the bookmarks should be available in the header.
+| Determines whether the bookmarks should be available in the header.
+
| isis.viewer.wicket. +
breadcrumbs.show-chooser
| true
-| Determines whether the breadcrumbs should be available in the footer.
+| Determines whether the breadcrumbs should be available in the footer.
+
| isis.viewer.wicket. +
clear-original-destination
@@ -88,35 +99,44 @@ clear-original-destination
| isis.viewer.wicket.credit
|
-| IntelliJ unfortunately does not provide IDE completion for lists of classes; YMMV. For further discussion, see for example this stackoverflow question: https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects and this wiki page: https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo and
+| IntelliJ unfortunately does not provide IDE completion for lists of classes; YMMV. For further discussion, see for example this stackoverflow question: https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects and this wiki page: https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo and
+
| isis.viewer.wicket. +
date-pattern
| dd-MM-yyyy
-| The pattern used for rendering and parsing dates. +
- Each Date scalar panel will use {#getDatePattern()} or {@linkplain #getDateTimePattern()} depending on its date type. In the case of panels with a date picker, the pattern will be dynamically adjusted so that it can be used by the <a href="https://github.com/Eonasdan/bootstrap-datetimepicker">Bootstrap Datetime Picker</a> component (which uses <a href="http://momentjs.com/docs/#/parsing/string-format/">Moment.js formats</a>, rather than those of regular Java code).
+| The pattern used for rendering and parsing dates.
+
+Each Date scalar panel will use \{#getDatePattern()} or \{@linkplain #getDateTimePattern()} depending on its date type. In the case of panels with a date picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
+
| 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).
+| 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).
+| 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-time-pattern
| dd-MM-yyyy HH:mm
-| The pattern used for rendering and parsing date/times. +
- Each Date scalar panel will use {@link Wicket#getDatePattern()} or {@link Wicket#getDateTimePattern()} depending on its date type. In the case of panels with a date time picker, the pattern will be dynamically adjusted so that it can be used by the <a href="https://github.com/Eonasdan/bootstrap-datetimepicker">Bootstrap Datetime Picker</a> component (which uses <a href="http://momentjs.com/docs/#/parsing/string-format/">Moment.js formats</a>, rather than those of regular Java code).
+| The pattern used for rendering and parsing date/times.
+
+Each Date scalar panel will use \{@link Wicket#getDatePattern()} or \{@link Wicket#getDateTimePattern()} depending on its date type. In the case of panels with a date time picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
+
| isis.viewer.wicket. +
development-utilities.enable
|
-| Determines whether debug bar and other stuff influenced by `org.apache.wicket.settings.DebugSettings#isDevelopmentUtilitiesEnabled()</tt> is enabled or not. +
- By default, depends on the mode (prototyping = enabled, server = disabled). This property acts as an override.
+| Determines whether debug bar and other stuff influenced by `org.apache.wicket.settings.DebugSettings#isDevelopmentUtilitiesEnabled()` is enabled or not.
+
+By default, depends on the mode (prototyping = enabled, server = disabled). This property acts as an override.
+
| isis.viewer.wicket. +
dialog-mode
@@ -154,23 +174,27 @@ max-title-length-in-tables
prevent-double-click-for-form- +
submit
| true
-| Whether to disable a form submit 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 form submit 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. +
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</code> and `@ActionLayout#promptStyle</code>. 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. +
remember-me.cookie-key
@@ -191,7 +215,8 @@ 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
@@ -201,8 +226,10 @@ show-footer
| isis.viewer.wicket. +
strip-wicket-tags
| true
-| Whether Wicket tags should be stripped from the markup. +
- Be aware that if Wicket tags are _not</i> stripped, then this may break CSS rules on some browsers.
+| 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.
+
| isis.viewer.wicket. +
suppress-password-reset
@@ -217,13 +244,16 @@ suppress-sign-up
| isis.viewer.wicket.themes. +
enabled
|
-| A comma separated list of enabled theme names, as defined by https://bootswatch.com.
+| A comma separated list of enabled theme names, as defined by https://bootswatch.com.
+
| isis.viewer.wicket.themes. +
initial
| Flatly
-| The initial theme to use. +
- Expected to be in the list of {@link #getEnabled()} themes.
+| The initial theme to use.
+
+Expected to be in the list of \{@link #getEnabled()} themes.
+
| isis.viewer.wicket.themes. +
provider
@@ -236,28 +266,33 @@ IsisWicketThemeSupportDefault
| isis.viewer.wicket.themes. +
show-chooser
|
-| Whether the theme chooser should be available in the footer.
+| 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.
+| The pattern used for rendering and parsing timestamps.
+
| 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, but can be disabled using this flag.
+
| 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, but can be disabled using this flag.
+
| 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.
+| 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
@@ -272,6 +307,8 @@ max-parent-chain-length
| 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.
+| 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.
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc b/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
index 644481d..c2d5177 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
@@ -6,6 +6,16 @@
|
|
+| resteasy.jaxrs.app. +
+registration
+|
+|
+
+| resteasy.jaxrs.default-path
+| /restful
+| Note that this is used rather than `resteasy.servlet.mapping.prefix` because there is _NO_ implementation of \{@link javax.ws.rs.core.Application}, so we rely on it being automatically created.
+
+
| resteasy.resteasy-settings
|
|
[isis] 03/05: ISIS-2062: fixes bad link in demo app.
Posted by da...@apache.org.
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 f9bc0ea073c34d81bc422e5fe58164d00af2a533
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 17 14:23:24 2020 +0100
ISIS-2062: fixes bad link in demo app.
---
.../demo/src/main/java/demoapp/dom/types/primitive/PrimitivesDemo.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/examples/demo/src/main/java/demoapp/dom/types/primitive/PrimitivesDemo.adoc b/examples/demo/src/main/java/demoapp/dom/types/primitive/PrimitivesDemo.adoc
index 4199d73..c02c0fa 100644
--- a/examples/demo/src/main/java/demoapp/dom/types/primitive/PrimitivesDemo.adoc
+++ b/examples/demo/src/main/java/demoapp/dom/types/primitive/PrimitivesDemo.adoc
@@ -18,4 +18,4 @@ Also note how *null* and *void* are handled regarding action results or properti
----
See the primitives demo
-link:${SOURCES_DEMO}/demoapp/dom/types/primitives[sources].
\ No newline at end of file
+link:${SOURCES_DEMO}/demoapp/dom/types/primitive[sources].
[isis] 01/05: ISIS-2062: uses pandoc to convert generated docs from
html to adoc
Posted by da...@apache.org.
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 71b2d2d9bf309b914a391a3b76d9e2e8216b0acd
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 17 14:22:24 2020 +0100
ISIS-2062: uses pandoc to convert generated docs from html to adoc
---
build-site.sh | 2 +-
scripts/ci/{build-site.sh => _build-site.sh} | 0
scripts/generateConfigDocs.groovy | 21 +++++++++------------
3 files changed, 10 insertions(+), 13 deletions(-)
diff --git a/build-site.sh b/build-site.sh
index ddfe33d..33ee109 100644
--- a/build-site.sh
+++ b/build-site.sh
@@ -1,3 +1,3 @@
#!/bin/bash
export ANTORA_CACHE_DIR=.antora-cache-dir
-sh scripts/ci/build-site.sh $*
+sh scripts/ci/_build-site.sh $*
diff --git a/scripts/ci/build-site.sh b/scripts/ci/_build-site.sh
similarity index 100%
rename from scripts/ci/build-site.sh
rename to scripts/ci/_build-site.sh
diff --git a/scripts/generateConfigDocs.groovy b/scripts/generateConfigDocs.groovy
index b476c94..f21634c 100644
--- a/scripts/generateConfigDocs.groovy
+++ b/scripts/generateConfigDocs.groovy
@@ -255,25 +255,22 @@ for (PropertyGroup group in groups) {
outputFile.write(buf.toString())
}
}
+System.out.println("");
+System.out.println("");
static String toAsciidoc(String str) {
- String lineFeed = " +\n";
+ System.out.print(".");
- // simple html -> asciidoc substitutions
- str = str.replace("<p>", lineFeed);
- str = str.replace("</p>", "");
+ File tf = File.createTempFile("input",".html")
+ tf.write(str) // write to the file
- str = str.replace("<i>", "_");
- str = str.replace("<b>", "*");
- //str = str.replaceAll("<a href=\"(.*)\">(.*?)</a>", "link:$1[$2]");
+ String cmd = "pandoc --wrap=none -f html -t asciidoc " + tf.getCanonicalPath()
+ String adoc = cmd.execute().text
- str = str.replace("<code>", "`");
- str = str.replace("<\\code>", "`");
- str = str.replace("<tt>", "`");
- str = str.replace("<\\tt>", "`");
+ tf.delete()
- return str;
+ return adoc;
}
static String format(String str, int len = 30) {