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 2017/01/09 22:40:26 UTC
[06/22] isis git commit: ISIS-1557: updates
_rgcfg_configuring_core.adoc, each sentence to its own line.
ISIS-1557: updates _rgcfg_configuring_core.adoc, each sentence to its own line.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/ac2907df
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/ac2907df
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/ac2907df
Branch: refs/heads/master
Commit: ac2907dfe80a3a118bc096c35dece291d25dc6ce
Parents: 6b1dd2f
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Wed Dec 21 12:19:48 2016 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Wed Dec 21 12:19:48 2016 +0000
----------------------------------------------------------------------
.../guides/_rgcfg_configuring-core.adoc | 54 +++++++++++---------
1 file changed, 29 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/ac2907df/adocs/documentation/src/main/asciidoc/guides/_rgcfg_configuring-core.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcfg_configuring-core.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcfg_configuring-core.adoc
index bdc1a3d..e4f894e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcfg_configuring-core.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcfg_configuring-core.adoc
@@ -299,7 +299,8 @@ Since this almost certainly constitutes a bug in application code, by default th
(`false`)
|whether recognized exceptions should also be logged. +
-Generally a recognized exception is one that is expected (for example a uniqueness constraint violated in the database) and which does not represent an error condition. This property logs the exception anyway, useful for debugging.
+Generally a recognized exception is one that is expected (for example a uniqueness constraint violated in the database) and which does not represent an error condition.
+This property logs the exception anyway, useful for debugging.
| `isis.services.` +
@@ -309,7 +310,8 @@ Generally a recognized exception is one that is expected (for example a uniquene
(`false`)
|whether to disable the default recognizers registered by `ExceptionRecognizerCompositeForJdoObjectStore`. +
-This implementation provides a default set of recognizers to convert RDBMS constraints into user-friendly messages. In the (probably remote) chance that this functionality isn't required, they can be disabled through this flag.
+This implementation provides a default set of recognizers to convert RDBMS constraints into user-friendly messages.
+In the (probably remote) chance that this functionality isn't required, they can be disabled through this flag.
|`isis.services.` +
@@ -318,7 +320,9 @@ This implementation provides a default set of recognizers to convert RDBMS const
(`false`)
|(Whether the framework should support `inject...()` as a prefix for injecting domain services into other domain objects.
+
-By default this is disabled. The default prior to `1.13.0` was enabled. If the setting is left as disabled then this may reduce application start-up times.
+By default this is disabled.
+The default prior to `1.13.0` was enabled.
+If the setting is left as disabled then this may reduce application start-up times.
|`isis.services.` +
@@ -327,7 +331,8 @@ By default this is disabled. The default prior to `1.13.0` was enabled. If the
(`true`)
|Whether the framework should support `set...()` as a prefix for injecting domain services into other domain objects.
+
-By default this is enabled (no change in `1.13.0`). If the setting is changed to disabled then this may reduce application start-up times.
+By default this is enabled (no change in `1.13.0`).
+If the setting is changed to disabled then this may reduce application start-up times.
@@ -426,7 +431,8 @@ See xref:rgcfg.adoc#_rgcfg_configuring-core_filterVisibility[section below] for
|`FQCN`
|This property is now ignored. +
+
-To customize the programming model, use `facets.exclude` and `facets.include`. See xref:ugbtb.adoc#_ugbtb_programming-model_finetuning[finetuning the programming model] for more details.
+To customize the programming model, use `facets.exclude` and `facets.include`.
+See xref:ugbtb.adoc#_ugbtb_programming-model_finetuning[finetuning the programming model] for more details.
@@ -446,13 +452,12 @@ See xref:ugbtb.adoc#_ugbtb_programming-model_finetuning[finetuning the programmi
(`false`)
|Whether deprecated facets should be ignored or honoured. +
+
-By default all deprecated facets are honoured; they remain part of the metamodel. If instead this property is set to
-`true` then the facets are simply not loaded into the metamodel and their semantics will be excluded. +
+By default all deprecated facets are honoured; they remain part of the metamodel.
+If instead this property is set to `true` then the facets are simply not loaded into the metamodel and their semantics will be excluded. +
+
-In most cases this should reduce the start-up times for the application. However, be aware that this could also
-substantially alter the semantics of your application. To be safe, we recommend that you first run your application
-using `isis.reflector.validator.allowDeprecated` set to `false`; if any deprecated annotations etc. are in use, then
-the app will fail-fast and refuse to start.
+In most cases this should reduce the start-up times for the application.
+However, be aware that this could also substantially alter the semantics of your application.
+To be safe, we recommend that you first run your application using `isis.reflector.validator.allowDeprecated` set to `false`; if any deprecated annotations etc. are in use, then the app will fail-fast and refuse to start.
|`isis.reflector.facets.` +
@@ -481,7 +486,8 @@ See xref:ugbtb.adoc#_ugbtb_programming-model_custom-validator[Custom Validator]
`allowDeprecated`
|`true`,`false` +
(`true`)
-| Whether deprecated annotations or naming conventions are tolerated or not. If not, then a metamodel validation error will be triggered, meaning the app won't boot (fail-fast). +
+| Whether deprecated annotations or naming conventions are tolerated or not.
+If not, then a metamodel validation error will be triggered, meaning the app won't boot (fail-fast). +
+
See also `isis.reflector.facets.ignoreDeprecated`.
@@ -515,7 +521,8 @@ The framework provides the `isis.reflector.facet.filterVisibility` configuration
* Action invocations: +
-If an action returns a collection that includes the object, then the object will be excluded from the list when rendered. If it returns a single object and the user does not have access to that object, then the action will seemingly return `null`
+If an action returns a collection that includes the object, then the object will be excluded from the list when rendered.
+If it returns a single object and the user does not have access to that object, then the action will seemingly return `null`
* Collections: +
@@ -529,7 +536,8 @@ If an parent object has a (scalar) reference some other object to which the user
If an object is returned in a list of choices or within an auto-complete list, and the user does not have access, then it is excluded from the rendered list.
-The original motivation for this feature was to transparently support such features as multi-tenancy (as per the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module). That is, if an entity is logically "owned" by a user, then the multi-tenancy support can be arranged to prevent some other user from viewing that object.
+The original motivation for this feature was to transparently support such features as multi-tenancy (as per the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module).
+That is, if an entity is logically "owned" by a user, then the multi-tenancy support can be arranged to prevent some other user from viewing that object.
By default this configuration property is enabled. To disable the visibility filtering, set the appropriate configuration property to `false`:
@@ -538,18 +546,14 @@ By default this configuration property is enabled. To disable the visibility fi
isis.reflector.facet.filterVisibility=false
----
-Filtering is supported by the xref:ugvw.adoc#[Wicket viewer] and the xref:ugvro.adoc#[Restful Objects viewer], and also
-by the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] domain service (provided the wrapper's execution
-mode is __not__ "skip rules").
+Filtering is supported by the xref:ugvw.adoc#[Wicket viewer] and the xref:ugvro.adoc#[Restful Objects viewer], and also by the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] domain service (provided the wrapper's execution mode is __not__ "skip rules").
[NOTE]
====
-In order for the framework to perform this filtering of collections, be aware that the framework takes a _copy_ of the
-original collection, filters on the collection, and returns that filtered collection rather than the original.
+In order for the framework to perform this filtering of collections, be aware that the framework takes a _copy_ of the original collection, filters on the collection, and returns that filtered collection rather than the original.
-There are no major side-effects from this algorithm, other than the fact that the referenced objects will (most likely)
-need to be resolved in order to determine if they are visible. This could conceivably have a performance impact in
-some cases.
+There are no major side-effects from this algorithm, other than the fact that the referenced objects will (most likely) need to be resolved in order to determine if they are visible.
+This could conceivably have a performance impact in some cases.
====
@@ -572,8 +576,7 @@ We recommend enabling this feature; it will help drive out the underlying busine
[[_rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition]]
=== `propertyLayout.labelPosition`
-If you want a consistent look-n-feel throughout the app, eg all property labels to the top, then it'd be rather
-frustrating to have to annotate every property.
+If you want a consistent look-n-feel throughout the app, eg all property labels to the top, then it'd be rather frustrating to have to annotate every property.
Instead, a default can be specified in `isis.properties`:
@@ -589,4 +592,5 @@ or
isis.viewers.propertyLayout.labelPosition=LEFT
----
-If these are not present then Apache Isis will render according to internal defaults. At the time of writing, this means labels are to the left for all datatypes except multiline strings.
+If these are not present then Apache Isis will render according to internal defaults.
+At the time of writing, this means labels are to the left for all datatypes except multiline strings.