[isis] 08/19: ISIS-2717: updates config pages

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch ISIS-2717
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 77ccaa543f67ff4715acb2b0b19f6cf2119eed9d
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Jun 6 16:13:56 2021 +0100

    ISIS-2717: updates config pages
---
 .../sections/isis.core.meta-model.validator.adoc   |   5 +-
 .../config/pages/sections/isis.extensions.adoc     | 112 +++++++++++++++++++++
 .../config/pages/sections/isis.testing.adoc        |  72 +++++++++++++
 .../config/pages/sections/isis.viewer.wicket.adoc  |  64 ++++++++++++
 4 files changed, 251 insertions(+), 2 deletions(-)

diff --git a/core/config/src/main/adoc/modules/config/pages/sections/isis.core.meta-model.validator.adoc b/core/config/src/main/adoc/modules/config/pages/sections/isis.core.meta-model.validator.adoc
index d813cfe..16fdeb9 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/isis.core.meta-model.validator.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/isis.core.meta-model.validator.adoc
@@ -33,15 +33,16 @@ If not allowed, then metamodel validation errors will be flagged.
 
 Note that this settings has no effect if the programming model has been configured to ignore deprecated features (because in this case the programming model facets simply won't be included in the introspection process.
 
+
 |
 [[isis.core.meta-model.validator.explicit-logical-type-names]]
 isis.core.meta-model.validator. +
 explicit-logical-type-names
 
 | 
-| Whether to ensure that the object type of all objects must be specified explicitly, using either ``DomainObject#logicalTypeName()`` or ``DomainService#logicalTypeName()``.
+| Whether to ensure that the logical-type-name of all objects must be specified explicitly, using either ``DomainObject#logicalTypeName()`` or ``DomainService#logicalTypeName()``.
 
-It is _highly advisable_ to leave this set as enabled (the default). These object types should also (of course) be unique - that can be checked by setting the ``#isEnsureUniqueObjectTypes()`` config property.
+It is _highly advisable_ to leave this set as enabled (the default). These logical-type-names should also (of course) be unique - among non-abstract types.
 
 
 |
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/isis.extensions.adoc b/core/config/src/main/adoc/modules/config/pages/sections/isis.extensions.adoc
index c8d5222..d0627d6 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/isis.extensions.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/isis.extensions.adoc
@@ -178,6 +178,118 @@ exposed-headers
 For more information, check the usage of the ``headers`` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter].
 
 
+|
+[[isis.extensions.secman.delegated-users.auto-create-policy]]
+isis.extensions.secman. +
+delegated-users.auto-create-policy
+
+| 
+| Whether delegated users should be autocreated as locked (the default) or unlocked.
+
+BE AWARE THAT if any users are auto-created as unlocked, then the set of roles that they are given should be highly restricted !!!
+
+
+|
+[[isis.extensions.secman.permissions-evaluation-policy]]
+isis.extensions.secman. +
+permissions-evaluation-policy
+
+| 
+| If there are conflicting (allow vs veto) permissions at the same scope, then this policy determines whether to prefer to allow the permission or to veto it.
+
+This is only used if a ``PermissionsEvaluationService`` has not been declared explicitly.
+
+
+|
+[[isis.extensions.secman.seed.admin.namespace-permissions.additional]]
+isis.extensions.secman.seed.admin. +
+namespace-permissions.additional
+
+| 
+| An (optional) additional set of namespaces that the admin role is granted.
+
+These are in addition to the main namespaces granted.
+
+@see NamespacePermissions#getSticky()
+
+
+|
+[[isis.extensions.secman.seed.admin.namespace-permissions.sticky]]
+isis.extensions.secman.seed.admin. +
+namespace-permissions.sticky
+
+| 
+| The set of namespaces to which the admin role is granted.
+
+These namespaces are intended to be sufficient to allow users with this admin role to be able to administer the security module itself, for example to manage users and roles. The security user is not necessarily able to use the main business logic within the domain application itself, though.
+
+These roles cannot be removed via user interface
+
+WARNING: normally these should not be overridden. Instead, specify additional namespaces using ``NamespacePermissions#getAdditional()``.
+
+@see NamespacePermissions#getAdditional()
+
+
+|
+[[isis.extensions.secman.seed.admin.password]]
+isis.extensions.secman.seed.admin. +
+password
+
+| 
+| The corresponding password for admin user. @see #getUserName()
+
+
+|
+[[isis.extensions.secman.seed.admin.role-name]]
+isis.extensions.secman.seed.admin. +
+role-name
+
+| 
+| The name of security admin role.
+
+Users with this role (in particular, the default admin user are granted access to a set of namespaces (``NamespacePermissions#getSticky()`` and ``NamespacePermissions#getAdditional()``) which are intended to be sufficient to allow users with this admin role to be able to administer the security module itself, for example to manage users and roles.
+
+@see Admin#getUserName() @see NamespacePermissions#getSticky() @see NamespacePermissions#getAdditional()
+
+
+|
+[[isis.extensions.secman.seed.admin.user-name]]
+isis.extensions.secman.seed.admin. +
+user-name
+
+| 
+| The name of the security super user.
+
+This user is automatically made a member of the admin role, from which it is granted permissions to administer other users.
+
+The password for this user is set in ``Admin#getPassword()``.
+
+@see #getPassword() @see #getRoleName()
+
+
+|
+[[isis.extensions.secman.seed.regular-user.role-name]]
+isis.extensions.secman.seed. +
+regular-user.role-name
+
+| 
+| The role name for regular users of the application, granting them access to basic security features.
+
+The exact set of permissions is hard-wired in the ``IsisExtSecmanRegularUserRoleAndPermissions`` fixture.
+
+
+|
+[[isis.extensions.secman.user-registration.initial-role-names]]
+isis.extensions.secman. +
+user-registration. +
+initial-role-names
+
+| 
+| The set of roles that users registering with the app are granted automatically.
+
+If using the wicket viewer, also requires isis.viewer.wicket.suppress-signup to be set ``false``, along with any other of its other prereqs.
+
+
 
 |===
 
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/isis.testing.adoc b/core/config/src/main/adoc/modules/config/pages/sections/isis.testing.adoc
index c910945..74735da 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/isis.testing.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/isis.testing.adoc
@@ -12,6 +12,78 @@ include::../section-hooks/isis.testing~pre.adoc[]
 |Default
 |Description
 |
+[[isis.testing.fixtures.fixture-scripts-specification.context-class]]
+isis.testing.fixtures. +
+fixture-scripts-specification. +
+context-class
+
+| 
+| Specifies the base package from which to search for fixture scripts.
+
+Either this or packagePrefix must be specified. This property is used by preference.
+
+@see #getPackagePrefix()
+
+
+|
+[[isis.testing.fixtures.fixture-scripts-specification.multiple-execution-strategy]]
+isis.testing.fixtures. +
+fixture-scripts-specification. +
+multiple-execution-strategy
+
+| 
+| Indicates whether, if a fixture script (or more precisely any other fixture scripts of the same class) is encountered more than once in a graph of dependencies, it should be executed again or skipped.
+
+The default is to fixture scripts are executed only once per class.
+
+Note that this policy can be overridden on a fixture-by-fixture basis if the fixture implements ``FixtureScriptWithExecutionStrategy``.
+
+
+|
+[[isis.testing.fixtures.fixture-scripts-specification.non-persisted-objects-strategy]]
+isis.testing.fixtures. +
+fixture-scripts-specification. +
+non-persisted-objects-strategy
+
+| 
+| Indicates whether objects that are returned as a fixture result should be automatically persisted if required (the default) or not.
+
+
+|
+[[isis.testing.fixtures.fixture-scripts-specification.package-prefix]]
+isis.testing.fixtures. +
+fixture-scripts-specification. +
+package-prefix
+
+| 
+| Specifies the base package from which to search for fixture scripts.
+
+Either this or ``#getContextClass()`` must be specified; ``#getContextClass()`` is used by preference.
+
+@see #getContextClass()
+
+
+|
+[[isis.testing.fixtures.fixture-scripts-specification.recreate]]
+isis.testing.fixtures. +
+fixture-scripts-specification. +
+recreate
+
+| 
+| null
+
+
+|
+[[isis.testing.fixtures.fixture-scripts-specification.run-script-default]]
+isis.testing.fixtures. +
+fixture-scripts-specification. +
+run-script-default
+
+| 
+| null
+
+
+|
 [[isis.testing.fixtures.initial-script]]
 isis.testing.fixtures. +
 initial-script
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc b/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc
index 3e26053..1200d2d 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/isis.viewer.wicket.adoc
@@ -328,6 +328,70 @@ If truncated, then the remainder of the title will be replaced with ellipses (..
 
 
 |
+[[isis.viewer.wicket.message-popups.error-delay]]
+isis.viewer.wicket.message-popups. +
+error-delay
+
+|  0ms
+| How long the error popup should display before disappearing.
+
+A value of 0 (the default) means do not disappear automatically.
+
+
+|
+[[isis.viewer.wicket.message-popups.info-delay]]
+isis.viewer.wicket.message-popups. +
+info-delay
+
+|  3500ms
+| How long the info popup should display before disappearing.
+
+A value of 0 means do not disappear automatically.
+
+
+|
+[[isis.viewer.wicket.message-popups.offset]]
+isis.viewer.wicket.message-popups. +
+offset
+
+|  100
+| How far in from the edge the popup should display
+
+
+|
+[[isis.viewer.wicket.message-popups.placement.horizontal]]
+isis.viewer.wicket.message-popups. +
+placement.horizontal
+
+| 
+| Whether to display popups aligned ot the left or right of the page.
+
+The default is to show them aligned to the right
+
+
+|
+[[isis.viewer.wicket.message-popups.placement.vertical]]
+isis.viewer.wicket.message-popups. +
+placement.vertical
+
+| 
+| Whether to display popups at the top or the bottom of the page.
+
+The default is to show them at the top.
+
+
+|
+[[isis.viewer.wicket.message-popups.warning-delay]]
+isis.viewer.wicket.message-popups. +
+warning-delay
+
+|  0ms
+| How long the warning popup should display before disappearing.
+
+A value of 0 (the default) means do not disappear automatically.
+
+
+|
 [[isis.viewer.wicket.prevent-double-click-for-form-submit]]
 isis.viewer.wicket. +
 prevent-double-click-for-form- +