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/02/16 19:23:17 UTC
[isis] 04/07: ISIS-2062: updates docs for config properties.
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 76d180bcfdd0ed95c75e13696696729a8fbf5829
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Feb 13 09:50:12 2020 +0000
ISIS-2062: updates docs for config properties.
---
.../btb/pages/hints-and-tips/are-you-sure.adoc | 2 +-
.../how-to-implement-a-spellchecker.adoc | 4 ++--
.../fun/pages/building-blocks/identifiers/oid.adoc | 2 +-
.../main/adoc/modules/applib-ant/pages/Column.adoc | 11 ++++++-----
.../classes/contributee/HasTransactionId.adoc | 2 +-
.../generated/isis.viewer.restfulobjects.adoc | 22 +++++++++++-----------
6 files changed, 22 insertions(+), 21 deletions(-)
diff --git a/api/adoc/userguide/modules/btb/pages/hints-and-tips/are-you-sure.adoc b/api/adoc/userguide/modules/btb/pages/hints-and-tips/are-you-sure.adoc
index 07765e3..fd16a5f 100644
--- a/api/adoc/userguide/modules/btb/pages/hints-and-tips/are-you-sure.adoc
+++ b/api/adoc/userguide/modules/btb/pages/hints-and-tips/are-you-sure.adoc
@@ -9,7 +9,7 @@ In such a case it's probably a good idea for the UI to require that the end-user
== Using action semantics
-One way to meet this requirement is using the framework's built-in xref:refguide:applib-ant:Action.adoc#semantics[`@Action#semantics``] attribute:
+One way to meet this requirement is using the framework's built-in xref:refguide:applib-ant:Action.adoc#semantics[`@Action#semantics`] attribute:
[source,java]
----
diff --git a/api/adoc/userguide/modules/btb/pages/hints-and-tips/how-to-implement-a-spellchecker.adoc b/api/adoc/userguide/modules/btb/pages/hints-and-tips/how-to-implement-a-spellchecker.adoc
index 3868828..83d16b4 100644
--- a/api/adoc/userguide/modules/btb/pages/hints-and-tips/how-to-implement-a-spellchecker.adoc
+++ b/api/adoc/userguide/modules/btb/pages/hints-and-tips/how-to-implement-a-spellchecker.adoc
@@ -14,9 +14,9 @@ One way to implement is to use the xref:refguide:applib-svc:core-domain-api/Even
* Set up a xref:refguide:applib-cm:classes/domainevent.adoc[domain event] xref:refguide:applib-cm:classes/super.adoc#AbstractSubscriber[subscriber] that can veto the changes.
-* if the change is made through an action, you can use xref:refguide:applib-ant:Action.adoc#domainEvent[`@Action#domainEvent``].
+* if the change is made through an action, you can use xref:refguide:applib-ant:Action.adoc#domainEvent[`@Action#domainEvent`].
-if if the change is made through an edit, you can use xref:refguide:applib-ant:Property.adoc#domainEvent[`@Property#domainEvent``].
+if if the change is made through an edit, you can use xref:refguide:applib-ant:Property.adoc#domainEvent[`@Property#domainEvent`].
You'll need some way to know which fields should be spell checked. Two ways spring to mind:
diff --git a/api/adoc/userguide/modules/fun/pages/building-blocks/identifiers/oid.adoc b/api/adoc/userguide/modules/fun/pages/building-blocks/identifiers/oid.adoc
index c6b07c4..b2479cd 100644
--- a/api/adoc/userguide/modules/fun/pages/building-blocks/identifiers/oid.adoc
+++ b/api/adoc/userguide/modules/fun/pages/building-blocks/identifiers/oid.adoc
@@ -33,7 +33,7 @@ When the PDF is scanned by the mail room, the barcode could be read to attach th
* and of course both the xref:vro:ROOT:about.adoc[RestfulObjects viewer] and xref:vw:ROOT:about.adoc[Wicket viewer] use the oid tuple to look up, render and allow the user to interact with domain objects.
Although the exact content of an OID should be considered opaque by domain objects, it is possible for domain objects to obtain OIDs.
-These are represented as ``Bookmark``s, obtained from the xref:refguide:applib-svc:integration-api/BookmarkService.adoc[``BookmarkService``].
+These are represented as ``Bookmark``s, obtained from the xref:refguide:applib-svc:integration-api/BookmarkService.adoc[``BookmarkService`].
Deep links meanwhile can be obtained from the xref:refguide:applib-svc:presentation-layer-api/DeepLinkService.adoc[``DeepLinkService`].
OIDs can also be converted into XML format, useful for integration scenarios.
diff --git a/api/applib/src/main/adoc/modules/applib-ant/pages/Column.adoc b/api/applib/src/main/adoc/modules/applib-ant/pages/Column.adoc
index 2187da8..5e1addb 100644
--- a/api/applib/src/main/adoc/modules/applib-ant/pages/Column.adoc
+++ b/api/applib/src/main/adoc/modules/applib-ant/pages/Column.adoc
@@ -30,16 +30,16 @@ public class Customer {
public void setMiddleInitial(String middleInitial) { /* ... */ }
----
-Isis also provides xref:refguide:applib-ant:Property.adoc#optionality[`@Property#optionality``] attribute. If both are specified, Apache Isis will check when it initializes for any contradictions, and will fail-fast with an appropriate error message in the log if there are.
+Isis also provides xref:refguide:applib-ant:Property.adoc#optionality[`@Property#optionality`] attribute. If both are specified, Apache Isis will check when it initializes for any contradictions, and will fail-fast with an appropriate error message in the log if there are.
-You should also be aware that in the lack of either the `@Column#allowsNull()` or the `@Property#optionality()` attributes, that the JDO and Apache Isis defaults differ. Apache Isis rule is straight-forward: properties are assumed to be required. JDO on the other hand specifies that only primitive types are mandatory; everything else is assumed to be optional. Therefore a lack of either annotation can also trigger the fail-fast validation check.
+You should also be aware that in the lack of either the `@Column#allowsNull` or the `@Property#optionality` attributes, that the JDO and Apache Isis defaults differ. Apache Isis rule is straight-forward: properties are assumed to be required. JDO on the other hand specifies that only primitive types are mandatory; everything else is assumed to be optional. Therefore a lack of either annotation can also trigger the fail-fast validation check.
-In the vast majority of cases you should be fine just to add the `@Column#allowsNull()` attribute to the getter. But see the documentation for xref:refguide:applib-ant:Property.adoc#optionality[`@Property#optionality``] attribute for discussion on one or two minor edge cases.
+In the vast majority of cases you should be fine just to add the `@Column#allowsNull` attribute to the getter. But see the documentation for xref:refguide:applib-ant:Property.adoc#optionality[`@Property#optionality`] attribute for discussion on one or two minor edge cases.
== Length for ``String``s
-The `length()` attribute is used to specify the length of `java.lang.String` property types as they map to `varchar(n)` columns.
+The `length` attribute is used to specify the length of `java.lang.String` property types as they map to `varchar(n)` columns.
For example:
@@ -57,7 +57,8 @@ public class Customer {
public void setLastName(String lastName) { /* ... */ }
----
-Isis also provides xref:refguide:applib-ant:Property.adoc#maxLength[`@Property#maxLength``] attribute. If both are specified, Apache Isis will check when it initializes for any contradictions, and will fail-fast with an appropriate error message in the log if there are.
+Apache Isis also provides xref:refguide:applib-ant:Property.adoc#maxLength[`@Property#maxLength`] attribute.
+If both are specified, Apache Isis will check when it initializes for any contradictions, and will fail-fast with an appropriate error message in the log if there are.
diff --git a/api/applib/src/main/adoc/modules/applib-cm/pages/classes/contributee/HasTransactionId.adoc b/api/applib/src/main/adoc/modules/applib-cm/pages/classes/contributee/HasTransactionId.adoc
index b34c3b7..1515a98 100644
--- a/api/applib/src/main/adoc/modules/applib-cm/pages/classes/contributee/HasTransactionId.adoc
+++ b/api/applib/src/main/adoc/modules/applib-cm/pages/classes/contributee/HasTransactionId.adoc
@@ -5,7 +5,7 @@
The `HasTransactionId` interface is a mix-in for any domain objects that reference a transaction id, such as
-auditing entries or commands, or for xref:refguide:applib-svc:application-layer-api/InteractionContext.adoc[``Interaction``]s persisted as published events.
+auditing entries or commands, or for xref:refguide:applib-svc:application-layer-api/InteractionContext.adoc[``Interaction`]s persisted as published events.
[NOTE]
====
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 f27eded3..652b465 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,6 +1,6 @@
| isis.viewer.restfulobjects. +
base-uri
-|
+|
| If left unset (the default), then the RO viewer will use the ``UriInfo`` (injected using ``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.
@@ -10,7 +10,7 @@ If set, eg ``com/``, then this value will be used instead.
| isis.viewer.restfulobjects. +
honor-ui-hints
-|
+|
| Whether to enable the ``x-ro-follow-links`` support, to minimize round trips.
The RO viewer provides the capability for the client to set the optional ``x-ro-follow-links`` query parameter, as described in section 34.4 of the RO spec v1.0. If used, the resultant representation includes the result of following the associated link, but through a server-side "join", somewhat akin to GraphQL.
@@ -20,7 +20,7 @@ By default this functionality is disabled, this configuration property enables t
| isis.viewer.restfulobjects. +
object-property-values-only
-|
+|
| When rendering domain objects, if set the representation returned is stripped back to a minimal set, excluding links to actions and collections and with a simplified representation of an object's properties.
This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
@@ -28,20 +28,20 @@ This is disabled by default. If enabled, then the representations returned are n
| isis.viewer.restfulobjects. +
strict-accept-checking
-|
+|
| If set, then any unrecognised ``Accept`` headers will result in an HTTP _Not Acceptable_ response code (406).
| isis.viewer.restfulobjects. +
suppress-described-by-links
-|
+|
| If set, then the representations returned will omit any links to the formal domain-type representations.
| isis.viewer.restfulobjects. +
suppress-member-disabled- +
reason
-|
+|
| If set, then - should there be an interaction with an action, property or collection that is disabled - then this will prevent the ``disabledReason`` reason from being added to the returned representation.
This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
@@ -49,7 +49,7 @@ This is disabled by default. If enabled, then the representations returned are n
| isis.viewer.restfulobjects. +
suppress-member-extensions
-|
+|
| If set, then the ``x-isis-format`` key (under ``extensions``) for properties will be suppressed.
This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
@@ -57,7 +57,7 @@ This is disabled by default. If enabled, then the representations returned are n
| isis.viewer.restfulobjects. +
suppress-member-id
-|
+|
| If set, then the ``id`` key for all members will be suppressed.
This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
@@ -65,15 +65,15 @@ This is disabled by default. If enabled, then the representations returned are n
| isis.viewer.restfulobjects. +
suppress-member-links
-|
-| If set, then the detail link (in other words ``]``) for all members will be suppressed.
+|
+| If set, then the detail link (in other words `]``) for all members will be suppressed.
This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.
| isis.viewer.restfulobjects. +
suppress-update-link
-|
+|
| If set, then the update link (in other words `` ]`` to perform a bulk update of an object) will be suppressed.
This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0.