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/04/20 08:12:23 UTC
[14/58] [abbrv] isis git commit: ISIS-1521: fixes xref links between
guides
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout.adoc
index e8ed93a..ef22d3c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout.adoc
@@ -18,28 +18,28 @@ The table below summarizes the annotation's attributes.
| Description
-|xref:rgant.adoc#_rgant-ActionLayout_bookmarking[`bookmarking()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_bookmarking[`bookmarking()`]
|`AS_ROOT`, `NEVER` +
(`NEVER`)
-|indicates if an action (with safe xref:rgant.adoc#_rgant-Action_semantics[action semantics]) is automatically bookmarked.
+|indicates if an action (with safe xref:../rgant/rgant.adoc#_rgant-Action_semantics[action semantics]) is automatically bookmarked.
-|xref:rgant.adoc#_rgant-ActionLayout_contributedAs[`contributedAs()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_contributedAs[`contributedAs()`]
|`AS_BOTH`, `AS_ACTION`, `AS_ASSOCIATION`, `AS_NEITHER` +
(`AS_BOTH`)
|for a domain service action that can be contributed, whether to contribute as an action or as an association (ie a property or collection). +
-For a domain service action to be contributed, the domain services must have a xref:rgant.adoc#_rgant-DomainService_nature[nature] nature of either `VIEW` or `VIEW_CONTRIBUTIONS_ONLY`, and the action must have xref:rgant.adoc#_rgant-Action_semantics[safe action semantics], and takes a single argument, namely the contributee domain object.
+For a domain service action to be contributed, the domain services must have a xref:../rgant/rgant.adoc#_rgant-DomainService_nature[nature] nature of either `VIEW` or `VIEW_CONTRIBUTIONS_ONLY`, and the action must have xref:../rgant/rgant.adoc#_rgant-Action_semantics[safe action semantics], and takes a single argument, namely the contributee domain object.
-|xref:rgant.adoc#_rgant-ActionLayout_cssClass[`cssClass()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[`cssClass()`]
|Any string valid as a CSS class
-|an additional CSS class around the HTML that represents for the action, to allow targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`]. +
+|an additional CSS class around the HTML that represents for the action, to allow targetted styling in xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`]. +
Supported by the xref:ugvw.adoc#[Wicket viewer] but currently ignored by the xref:ugvro.adoc#[RestfulObjects viewer].
-|xref:rgant.adoc#_rgant-ActionLayout_cssClassFa[`cssClassFa()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClassFa[`cssClassFa()`]
|Any valid link:http://fortawesome.github.io/Font-Awesome/[Font awesome] icon name
|specify a font awesome icon for the action's menu link or icon. +
@@ -50,26 +50,26 @@ Supported by the xref:ugvw.adoc#[Wicket viewer] but currently ignored by the xre
|Positioning of the icon on the button/menu item.
-|xref:rgant.adoc#_rgant-ActionLayout_describedAs[`describedAs()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[`describedAs()`]
|String.
|provides a short description of the action, eg for rendering as a 'tool tip'.
-|xref:rgant.adoc#_rgant-ActionLayout_hidden[`hidden()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_hidden[`hidden()`]
|`EVERYWHERE`, `NOWHERE` +
(`NOWHERE`)
|indicates where (in the UI) the action should be hidden from the user.
-|xref:rgant.adoc#_rgant-ActionLayout_named[`named()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[`named()`]
|String.
|to override the name inferred from the action's name in code. +
A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.
-|xref:rgant.adoc#_rgant-ActionLayout_position[`position()`]
+|xref:../rgant/rgant.adoc#_rgant-ActionLayout_position[`position()`]
|`BELOW`, `RIGHT`, `PANEL`, `PANEL_DROPDOWN` (`BELOW`)
-|for actions associated (using xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder#named()`]) with properties, the positioning of the action's button with respect to the property
+|for actions associated (using xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder#named()`]) with properties, the positioning of the action's button with respect to the property
|===
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
index aa1c159..643f24e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
@@ -6,7 +6,7 @@
-The `bookmarking()` attribute indicates if an action (with safe xref:rgant.adoc#_rgant-Action_semantics[action semantics]) is automatically bookmarked. This attribute is also supported for xref:rgant.adoc#_rgant-DomainObjectLayout_bookmarking[domain objects].
+The `bookmarking()` attribute indicates if an action (with safe xref:../rgant/rgant.adoc#_rgant-Action_semantics[action semantics]) is automatically bookmarked. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_bookmarking[domain objects].
@@ -45,7 +45,7 @@ indicates that the `notYetComplete()` action is bookmarkable.
[NOTE]
====
-The enum value `AS_CHILD` has no meaning for actions; it relates only to bookmarked xref:rgant.adoc#_rgant-DomainObject_bookmarking[domain object]s.
+The enum value `AS_CHILD` has no meaning for actions; it relates only to bookmarked xref:../rgant/rgant.adoc#_rgant-DomainObject_bookmarking[domain object]s.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_contributedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_contributedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_contributedAs.adoc
index 0f4c22e..cd1f9dc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_contributedAs.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_contributedAs.adoc
@@ -10,7 +10,7 @@ For a domain service action that _can_ be contributed, the `contributedAs()` att
The distinction between property or collection is automatic: if the action returns a `java.util.Collection` (or subtype) then the action is contributed as a collection; otherwise it is contributed as a property.
-For a domain service action to be contributed, the domain services must have a xref:rgant.adoc#_rgant-DomainService_nature[nature] nature of either `VIEW` or `VIEW_CONTRIBUTIONS_ONLY`, and the action must have xref:rgant.adoc#_rgant-Action_semantics[safe action semantics], and takes a single argument, namely the contributee domain object.
+For a domain service action to be contributed, the domain services must have a xref:../rgant/rgant.adoc#_rgant-DomainService_nature[nature] nature of either `VIEW` or `VIEW_CONTRIBUTIONS_ONLY`, and the action must have xref:../rgant/rgant.adoc#_rgant-Action_semantics[safe action semantics], and takes a single argument, namely the contributee domain object.
For example:
@@ -43,7 +43,7 @@ public class OrderContributions {
}
----
-In such cases, though, it would probably make more sense to annotate the action as either xref:rgant.adoc#_rgant-Action_hidden[hidden] or indeed xref:rgant.adoc#_rgant-Programmatic[`@Programmatic`].
+In such cases, though, it would probably make more sense to annotate the action as either xref:../rgant/rgant.adoc#_rgant-Action_hidden[hidden] or indeed xref:../rgant/rgant.adoc#_rgant-Programmatic[`@Programmatic`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClass.adoc
index 9acba07..56b6d84 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClass.adoc
@@ -6,9 +6,9 @@
-The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the action. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
+The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the action. xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
-This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
+This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
For example:
@@ -24,7 +24,7 @@ public class ToDoItem {
[NOTE]
====
-The similar xref:rgant.adoc#_rgant-ActionLayout_cssClassFa[`@ActionLayout#cssClassFa()`] annotation attribute is also used as a hint
+The similar xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClassFa[`@ActionLayout#cssClassFa()`] annotation attribute is also used as a hint
to apply CSS, specifically to add http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icons] on action menu items or buttons.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClassFa.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClassFa.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClassFa.adoc
index 40a609c..2b642cd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClassFa.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_cssClassFa.adoc
@@ -7,7 +7,7 @@
The `cssClassFa()` attribute is used to specify the name of a link:http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icon] name, to be rendered on the action's representation as a button or menu item. The related `cssClassFaPosition()` attribute specifies the positioning of the icon, to the left or the right of the text.
-These attributes can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClassFa[domain objects] and to xref:rgant.adoc#_rgant-ViewModelLayout_cssClassFa[view models] to specify the object's icon.
+These attributes can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassFa[domain objects] and to xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClassFa[view models] to specify the object's icon.
For example:
@@ -54,6 +54,6 @@ can be used instead, eg:
[NOTE]
====
-The similar xref:rgant.adoc#_rgant-ActionLayout_cssClass[`@ActionLayout#cssClass()`] annotation attribute is also used as a hint to apply CSS, but for wrapping the representation of an object or object member so that it can be styled in an application-specific way.
+The similar xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[`@ActionLayout#cssClass()`] annotation attribute is also used as a hint to apply CSS, but for wrapping the representation of an object or object member so that it can be styled in an application-specific way.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_describedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_describedAs.adoc
index d1fa462..7818a0d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_describedAs.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_describedAs.adoc
@@ -8,7 +8,7 @@
The `describedAs()` attribute is used to provide a short description of the action to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'.
-This attribute can also be specified for xref:rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:rgant.adoc#_rgant-ParameterLayout_describedAs[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:rgant.adoc#_rgant-ViewModelLayout_describedAs[view models].
+This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_describedAs[view models].
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_hidden.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_hidden.adoc
index d901a64..a1ad7d4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_hidden.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_hidden.adoc
@@ -5,11 +5,11 @@
:_imagesdir: images/
-The `hidden()` attribute indicates where (in the UI) the action should be hidden from the user. This attribute can also be applied to xref:rgant.adoc#_rgant-PropertyLayout_hidden[properties] and xref:rgant.adoc#_rgant-CollectionLayout_hidden[collections].
+The `hidden()` attribute indicates where (in the UI) the action should be hidden from the user. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-PropertyLayout_hidden[properties] and xref:../rgant/rgant.adoc#_rgant-CollectionLayout_hidden[collections].
[TIP]
====
-It is also possible to use xref:rgant.adoc#_rgant-Action_hidden[`@Action#hidden()`] to hide an action at the domain layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user.
+It is also possible to use xref:../rgant/rgant.adoc#_rgant-Action_hidden[`@Action#hidden()`] to hide an action at the domain layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user.
====
For example:
@@ -50,7 +50,7 @@ can be used instead, eg:
[NOTE]
====
-For actions of domain services the visibility is dependent upon its xref:rgant.adoc#_rgant-DomainService_nature[`@DomainService#nature()`] and also on whether it is contributed (as per xref:rgant.adoc#_rgant-ActionLayout_contributedAs[`@ActionLayout#contributedAs()`]).
+For actions of domain services the visibility is dependent upon its xref:../rgant/rgant.adoc#_rgant-DomainService_nature[`@DomainService#nature()`] and also on whether it is contributed (as per xref:../rgant/rgant.adoc#_rgant-ActionLayout_contributedAs[`@ActionLayout#contributedAs()`]).
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
index c18ba6b..d50b1f8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `named()` attribute explicitly specifies the action's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:rgant.adoc#_rgant-CollectionLayout_named[collections], xref:rgant.adoc#_rgant-PropertyLayout_named[properties], xref:rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:rgant.adoc#_rgant-DomainServiceLayout_named[domain services].
+The `named()` attribute explicitly specifies the action's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[domain services].
[TIP]
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_position.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_position.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_position.adoc
index 27d3f68..89cba44 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_position.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_position.adoc
@@ -8,7 +8,7 @@
-The `position()` attribute pertains only to actions that have been associated with properties using xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder#named()`]. For these actions, it specifies the positioning of the action's button with respect to the field representing the object property.
+The `position()` attribute pertains only to actions that have been associated with properties using xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder#named()`]. For these actions, it specifies the positioning of the action's button with respect to the field representing the object property.
The attribute can take one of four values: `BELOW`, `RIGHT`, `PANEL` or `PANEL_DROPDOWN`.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_command.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_command.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_command.adoc
index 759d684..16ab6ce 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_command.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_command.adoc
@@ -9,13 +9,13 @@ The `@Action(command=...)` attribute (and the related `@Action(commandPersistenc
The annotation works with (and is influenced by the behaviour of) a number of domain services:
-* xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`]
-* xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`]
-* xref:rgsvc.adoc#_rgsvc_spi_BackgroundService[`BackgroundService`] and
-* xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`]
+* xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`]
+* xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`]
+* xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundService[`BackgroundService`] and
+* xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`]
-Each action invocation is reified by the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service into a `Command` object, capturing details of the target object, the action, the parameter arguments, the user, a timestamp and so on.
+Each action invocation is reified by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service into a `Command` object, capturing details of the target object, the action, the parameter arguments, the user, a timestamp and so on.
If an appropriate `CommandService` is configured (for example using (non-ASF) http://github.com/isisaddons/isis-module-command[Isis addons' command] module), then the `Command` itself is persisted.
@@ -28,9 +28,9 @@ If background ``Command``s are used, then an external scheduler, using xref:ugbt
-The `command()` attribute determines whether the action invocation should be reified into a `Command` object (by the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service).
+The `command()` attribute determines whether the action invocation should be reified into a `Command` object (by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service).
-The default is `AS_CONFIGURED`, meaning that the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.command.actions` is used to determine the whether the action is reified:
+The default is `AS_CONFIGURED`, meaning that the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.command.actions` is used to determine the whether the action is reified:
* `all` +
+
@@ -48,7 +48,7 @@ If there is no configuration property in `isis.properties` then all actions are
[NOTE]
====
-Note: `Command` reification does not necessarily imply that `Command` objects will be persisted; that depends on whether there is a xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] configured that will persist said ``Command``s.
+Note: `Command` reification does not necessarily imply that `Command` objects will be persisted; that depends on whether there is a xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] configured that will persist said ``Command``s.
====
This default can be overridden on an action-by-action basis; if `command()` is set to `ENABLED` then the action is reified irrespective of the configured value; if set to `DISABLED` then the action is NOT reified irrespective of the configured value.
@@ -86,7 +86,7 @@ public class Order {
}
----
-will suppress the persistence of the `Command` object _unless_ a child background `Command` has been created in the body of the action by way of the xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`].
+will suppress the persistence of the `Command` object _unless_ a child background `Command` has been created in the body of the action by way of the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`].
On the other hand:
@@ -112,7 +112,7 @@ will prevent the parent `Command` object from being persisted, _even if_ a child
For persisted commands, the `commandExecuteIn()` attribute determines whether the `Command` should be executed in the foreground (the default) or executed in the background.
-Background execution means that the command is not executed immediately, but is available for a configured xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`] to execute, eg by way of an in-memory scheduler such as Quartz. See xref:ugbtb.adoc#_ugbtb_headless-access_BackgroundCommandExecution[here] for further information on this topic.
+Background execution means that the command is not executed immediately, but is available for a configured xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`] to execute, eg by way of an in-memory scheduler such as Quartz. See xref:ugbtb.adoc#_ugbtb_headless-access_BackgroundCommandExecution[here] for further information on this topic.
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
index b5bef05..af488f5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
@@ -13,7 +13,7 @@ Whenever a domain object (or list of domain objects) is to be rendered, the fram
* pre-execute phase: before the invocation of the action
* post-execute: after the invocation of the action
-Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] using either link:https://github.com/google/guava[Guava] or link:http://www.axonframework.org/[Axon Framework] annotations and can influence each of these phases.
+Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] using either link:https://github.com/google/guava[Guava] or link:http://www.axonframework.org/[Axon Framework] annotations and can influence each of these phases.
By default the event raised is `ActionDomainEvent.Default`. For example:
@@ -29,8 +29,8 @@ public class ToDoItem {
The `domainEvent()` attribute allows a custom subclass to be emitted allowing more precise subscriptions (to those
subclasses) to be defined instead. This attribute is also supported for
-xref:rgant.adoc#_rgant-Collection_domainEvent[collections] and
-xref:rgant.adoc#_rgant-Property_domainEvent[properties].
+xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[collections] and
+xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
For example:
@@ -60,7 +60,7 @@ rather than through the constructor. This substantially reduces the boilerplate
== Subscribers
-Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API.
+Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API.
Subscribers can be either coarse-grained (if they subscribe to the top-level event type):
@@ -155,8 +155,8 @@ then no event will be posted.
== Raising events programmatically
-Normally events are only raised for interactions through the UI. However, events can be raised programmatically either by calling the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or by emulating the UI by
-wrapping the target object using the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] domain service.
+Normally events are only raised for interactions through the UI. However, events can be raised programmatically either by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or by emulating the UI by
+wrapping the target object using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] domain service.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_hidden.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_hidden.adoc
index 84c53df..1646495 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_hidden.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_hidden.adoc
@@ -7,11 +7,11 @@
-Actions can be hidden at the domain-level, indicating that they are not visible to the end-user. This attribute can also be applied to xref:rgant.adoc#_rgant-Property_hidden[properties] and xref:rgant.adoc#_rgant-Collection_hidden[collections].
+Actions can be hidden at the domain-level, indicating that they are not visible to the end-user. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-Property_hidden[properties] and xref:../rgant/rgant.adoc#_rgant-Collection_hidden[collections].
[TIP]
====
-It is also possible to use xref:rgant.adoc#_rgant-ActionLayout_hidden[`@ActionLayout#hidden()`] or xref:ugvw.adoc#_ugvw_layout_file-based[file-based layouts] such that the action can be hidden at the view layer.
+It is also possible to use xref:../rgant/rgant.adoc#_rgant-ActionLayout_hidden[`@ActionLayout#hidden()`] or xref:../ugvw/ugvw.adoc#_ugvw_layout_file-based[file-based layouts] such that the action can be hidden at the view layer.
Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user.
====
@@ -43,7 +43,7 @@ The other values of the `Where` enum have no meaning for a collection.
[NOTE]
====
-For actions of domain services the visibility is dependent upon its xref:rgant.adoc#_rgant-DomainService_nature[`@DomainService#nature()`] and also on whether it is contributed (as per xref:rgant.adoc#_rgant-ActionLayout_contributedAs[`@ActionLayout#contributedAs()`]).
+For actions of domain services the visibility is dependent upon its xref:../rgant/rgant.adoc#_rgant-DomainService_nature[`@DomainService#nature()`] and also on whether it is contributed (as per xref:../rgant/rgant.adoc#_rgant-ActionLayout_contributedAs[`@ActionLayout#contributedAs()`]).
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
index d5abc01..3c10f3c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
@@ -8,15 +8,15 @@
The `publishing()` attribute determines whether and how an action invocation is published via the registered
-implementation of a xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]) or
-xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]. This attribute is also
-supported for xref:rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects
-are published as events, and for xref:rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`], where it controls
+implementation of a xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]) or
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]. This attribute is also
+supported for xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects
+are published as events, and for xref:../rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`], where it controls
whether property edits are published as events.
A common use case is to notify external "downstream" systems of changes in the state of the Isis application.
The default value for the attribute is `AS_CONFIGURED`, meaning that the
-xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.actions` is used to determine
+xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.actions` is used to determine
the whether the action is published:
* `all` +
@@ -62,8 +62,8 @@ this should avoid the necessity to query back for additional information.
[WARNING]
====
-Be aware that this attribute is only honoured by the (deprecated) xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`], so should itself be considered as deprecated. It
-is ignored by the replacement xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`],
+Be aware that this attribute is only honoured by the (deprecated) xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`], so should itself be considered as deprecated. It
+is ignored by the replacement xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`],
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_restrictTo.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_restrictTo.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_restrictTo.adoc
index f07ca6f..6b3728f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_restrictTo.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_restrictTo.adoc
@@ -7,7 +7,7 @@
-By default actions are available irrespective of the xref:rgcfg.adoc#_rgcfg_deployment-types[deployment mode]. The `restrictTo()` attribute specifies whether the action should instead be restricted to only available in prototyping mode.
+By default actions are available irrespective of the xref:../rgcfg/rgcfg.adoc#_rgcfg_deployment-types[deployment mode]. The `restrictTo()` attribute specifies whether the action should instead be restricted to only available in prototyping mode.
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_semantics.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_semantics.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_semantics.adoc
index 78e8ecf..e3f3a13 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_semantics.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_semantics.adoc
@@ -66,7 +66,7 @@ public class Customer {
}
----
-Actions that are safe and request-cacheable automatically use the xref:rgsvc.adoc#_rgsvc_api_QueryResultsCache[`QueryResultsCache`] service to cache the result of the method. Note though that the results of this caching will only be apparent if the action is invoked from another method using the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] service.
+Actions that are safe and request-cacheable automatically use the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_QueryResultsCache[`QueryResultsCache`] service to cache the result of the method. Note though that the results of this caching will only be apparent if the action is invoked from another method using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] service.
Continuing the example above, imagine code that loops over a set of ``Order``s where each `Order` has an associated `Customer`. We want to check the credit rating of each `Customer` (a potentially expensive operation) but we don't want to do it more than once per `Customer`. Invoking through the `WrapperFactory` will allow us to accomplish this by exploiting the semantics of `checkCredit()` action:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_typeOf.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_typeOf.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_typeOf.adoc
index 22b6e58..ddc093d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_typeOf.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_typeOf.adoc
@@ -6,7 +6,7 @@
-The `typeOf()` attribute specifies the expected type of an element returned by the action (returning a collection), when for whatever reason the type cannot be inferred from the generic type, or to provide a hint about the actual run-time (as opposed to compile-time) type. This attribute can also be specified for xref:rgant.adoc#_rgant-Collection_typeOf[collections].
+The `typeOf()` attribute specifies the expected type of an element returned by the action (returning a collection), when for whatever reason the type cannot be inferred from the generic type, or to provide a hint about the actual run-time (as opposed to compile-time) type. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-Collection_typeOf[collections].
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection.adoc
index 569928b..6b508ce 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection.adoc
@@ -18,13 +18,13 @@ The table below summarizes the annotation's attributes.
| Description
-|xref:rgant.adoc#_rgant-Collection_domainEvent[`domainEvent()`]
+|xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[`domainEvent()`]
|subtype of `CollectionDomainEvent` +
(`CollectionDomainEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to broadcast the collection's business rule checking (hide, disable, validate) and its modification (before and after).
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to broadcast the collection's business rule checking (hide, disable, validate) and its modification (before and after).
-|xref:rgant.adoc#_rgant-Collection_editing[`editing()`]
+|xref:../rgant/rgant.adoc#_rgant-Collection_editing[`editing()`]
|`ENABLED`, `DISABLED`, `AS_CONFIGURED` +
(`AS_CONFIGURED`)
|whether a collection can be added to or removed from within the UI
@@ -35,13 +35,13 @@ The table below summarizes the annotation's attributes.
|if `editing()` is `DISABLED`, provides a reason as to why.
-|xref:rgant.adoc#_rgant-Collection_hidden[`hidden()`]
+|xref:../rgant/rgant.adoc#_rgant-Collection_hidden[`hidden()`]
|`EVERYWHERE`, `OBJECT_FORMS`, `NOWHERE` +
(`NOWHERE`)
|indicates where (in the UI) the collection should be hidden from the user.
-|xref:rgant.adoc#_rgant-Collection_notPersisted[`notPersisted()`]
+|xref:../rgant/rgant.adoc#_rgant-Collection_notPersisted[`notPersisted()`]
|`true`, `false` +
(`false`)
|whether to exclude from snapshots. +
@@ -53,7 +53,7 @@ Collection must also be annotated with `@javax.jdo.annotations.NotPersistent` in
-|xref:rgant.adoc#_rgant-Collection_typeOf[`typeOf()`]
+|xref:../rgant/rgant.adoc#_rgant-Collection_typeOf[`typeOf()`]
|
|hints as to the run-time type of the objects within that collection (as a fallback)
@@ -88,7 +88,7 @@ public class ToDoItem {
[TIP]
====
-The annotation is one of a handful (others including xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:rgant.adoc#_rgant-Property[`@Property`] and xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`]) that can also be applied to the field, rather than the getter method. This is specifically
+The annotation is one of a handful (others including xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:../rgant/rgant.adoc#_rgant-Property[`@Property`] and xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`]) that can also be applied to the field, rather than the getter method. This is specifically
so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout.adoc
index 071ed02..88a0f52 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout.adoc
@@ -19,12 +19,12 @@ The table below summarizes the annotation's attributes.
| Description
-|xref:rgant.adoc#_rgant-CollectionLayout_cssClass[`cssClass()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_cssClass[`cssClass()`]
|Any string valid as a CSS class
-|the css class that a collection should have, to allow more targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`]
+|the css class that a collection should have, to allow more targetted styling in xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`]
-|xref:rgant.adoc#_rgant-CollectionLayout_defaultView[`defaultView()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_defaultView[`defaultView()`]
|`table`, `excel`, `calendar`, `map`, ...
|Which view is selected by default, if multiple views are available.
@@ -32,18 +32,18 @@ See (non-ASF) link:http://isisaddons.org[Isis Addons] for further views.
-|xref:rgant.adoc#_rgant-CollectionLayout_describedAs[`describedAs()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[`describedAs()`]
|String.
|description of this collection, eg to be rendered in a tooltip.
-|xref:rgant.adoc#_rgant-CollectionLayout_hidden[`hidden()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_hidden[`hidden()`]
|`EVERYWHERE`, `OBJECT_FORMS`, `NOWHERE` +
(`NOWHERE`)
|indicates where (in the UI) the collection should be hidden from the user.
-|xref:rgant.adoc#_rgant-CollectionLayout_named[named()]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[named()]
|String.
|to override the name inferred from the collection's name in code. +
@@ -55,18 +55,18 @@ A typical use case is if the desired name is a reserved Java keyword, such as `d
|whether to HTML escape the name of this property.
-|xref:rgant.adoc#_rgant-CollectionLayout_paged[`paged()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_paged[`paged()`]
|Positive integer
|the page size for instances of this class when rendered within a table.
-|xref:rgant.adoc#_rgant-CollectionLayout_render[`render()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_render[`render()`]
|`EAGERLY`, `LAZILY` +
(`LAZILY`)
|whether the collection should be (eagerly) rendered open or (lazily) rendered closed
-|xref:rgant.adoc#_rgant-CollectionLayout_sortedBy[`sortedBy()`]
+|xref:../rgant/rgant.adoc#_rgant-CollectionLayout_sortedBy[`sortedBy()`]
|Subclass of `java.util.Comparator` for element type
|indicates that the elements in the `java.util.SortedSet` collection should be sorted according to a specified `Comparator` rather than their natural sort order.
@@ -105,7 +105,7 @@ As an alternative to using the `@CollectionLayout` annotation, a xref:ugvw.adoc#
[TIP]
====
-The annotation is one of a handful (others including xref:rgant.adoc#_rgant-Collection[`@Collection`], xref:rgant.adoc#_rgant-Property[`@Property`] and xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`]) that can also be applied to the field, rather than the getter method. This is specifically
+The annotation is one of a handful (others including xref:../rgant/rgant.adoc#_rgant-Collection[`@Collection`], xref:../rgant/rgant.adoc#_rgant-Property[`@Property`] and xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`]) that can also be applied to the field, rather than the getter method. This is specifically
so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
index 479aea4..d5834c4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
@@ -5,9 +5,9 @@
:_imagesdir: images/
-The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the collection. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
+The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the collection. xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
-This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-ActionLayout_cssClass[actions], xref:rgant.adoc#_rgant-PropertyLayout_cssClass[properties] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
+This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[actions], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[properties] and xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_defaultView.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_defaultView.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_defaultView.adoc
index 65ff625..9955a3b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_defaultView.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_defaultView.adoc
@@ -38,6 +38,6 @@ can be used instead, eg:
[NOTE]
====
-This attribute takes precedence over any value for the xref:rgant.adoc#_rgant-CollectionLayout_render[`@CollectionLayout#render()`] attribute. For example, if the
+This attribute takes precedence over any value for the xref:../rgant/rgant.adoc#_rgant-CollectionLayout_render[`@CollectionLayout#render()`] attribute. For example, if the
`defaultView` attribute is defined to "table", then the table will be show even if `render` is set to `LAZILY`.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_describedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_describedAs.adoc
index 0b20afa..7695b9b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_describedAs.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_describedAs.adoc
@@ -7,7 +7,7 @@
The `describedAs()` attribute is used to provide a short description of the collection to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'.
-The `describedAs()` attribute can also be specified for xref:rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:rgant.adoc#_rgant-ParameterLayout_describedAs[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:rgant.adoc#_rgant-ViewModelLayout_describedAs[view models].
+The `describedAs()` attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[domain objects] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_describedAs[view models].
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_hidden.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_hidden.adoc
index 4973e8a..5156638 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_hidden.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_hidden.adoc
@@ -5,12 +5,12 @@
:_imagesdir: images/
-The `hidden()` attribute indicates where (in the UI) the collection should be hidden from the user. This attribute can also be applied to xref:rgant.adoc#_rgant-ActionLayout_hidden[actions] and xref:rgant.adoc#_rgant-PropertyLayout_hidden[properties].
+The `hidden()` attribute indicates where (in the UI) the collection should be hidden from the user. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-ActionLayout_hidden[actions] and xref:../rgant/rgant.adoc#_rgant-PropertyLayout_hidden[properties].
[TIP]
====
-It is also possible to use xref:rgant.adoc#_rgant-Collection_hidden[`@Collection#hidden()`] to hide an action at the domain layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user.
+It is also possible to use xref:../rgant/rgant.adoc#_rgant-Collection_hidden[`@Collection#hidden()`] to hide an action at the domain layer. Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user.
====
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
index a75e210..d58a60c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
@@ -6,7 +6,7 @@
-The `named()` attribute explicitly specifies the collection's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:rgant.adoc#_rgant-ActionLayout_named[actions], xref:rgant.adoc#_rgant-PropertyLayout_named[properties], xref:rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:rgant.adoc#_rgant-DomainServiceLayout_named[domain services].
+The `named()` attribute explicitly specifies the collection's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[actions], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[domain services].
[TIP]
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_paged.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_paged.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_paged.adoc
index 4b0abed..f3d7569 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_paged.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_paged.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `paged()` attribute specifies the number of rows to display in a (parented) collection. This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_paged[domain objects] and xref:rgant.adoc#_rgant-ViewModelLayout_paged[view models].
+The `paged()` attribute specifies the number of rows to display in a (parented) collection. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_paged[domain objects] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_paged[view models].
[WARNING]
@@ -27,7 +27,7 @@ public class Order {
----
-It is also possible to specify a global default for the page size of standalone collections, using the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.viewer.paged.parented`.
+It is also possible to specify a global default for the page size of standalone collections, using the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.viewer.paged.parented`.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_render.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_render.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_render.adoc
index 7462a18..eaeeda2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_render.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_render.adoc
@@ -35,8 +35,8 @@ can be used instead, eg:
[NOTE]
====
-Note that xref:ugfun.adoc#_ugfun_how-tos_contributed-members[contributed collections] (which, under the covers are just action invocations against a domain service) are always rendered eagerly.
+Note that xref:../ugfun/ugfun.adoc#_ugfun_how-tos_contributed-members[contributed collections] (which, under the covers are just action invocations against a domain service) are always rendered eagerly.
-Also, if a xref:rgant.adoc#_rgant-CollectionLayout_defaultView[`@CollectionLayout#defaultView()`] attribute has been specified then that will take precedence over the value of the `render()` attribute.
+Also, if a xref:../rgant/rgant.adoc#_rgant-CollectionLayout_defaultView[`@CollectionLayout#defaultView()`] attribute has been specified then that will take precedence over the value of the `render()` attribute.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
index 51b2aee..254fa62 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
@@ -13,14 +13,14 @@ Whenever a domain object (or list of domain objects) is to be rendered, the fram
* pre-execute phase: before the modification of the collection
* post-execute: after the modification of the collection
-Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] using either link:https://github.com/google/guava[Guava] or link:http://www.axonframework.org/[Axon Framework] annotations and can influence each of these phases.
+Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] using either link:https://github.com/google/guava[Guava] or link:http://www.axonframework.org/[Axon Framework] annotations and can influence each of these phases.
[WARNING]
====
The xref:ugvw.adoc#[Wicket viewer] does _not_ currently support the modification of collections; they are rendered read-only. However, domain events are still relevant to determine if such collections should be hidden.
-The workaround is to create add/remove actions and use xref:rgant.adoc#_rgant-MemberOrder[UI hints] to render them close to the collection.
+The workaround is to create add/remove actions and use xref:../rgant/rgant.adoc#_rgant-MemberOrder[UI hints] to render them close to the collection.
====
By default the event raised is `CollectionDomainEvent.Default`. For example:
@@ -36,8 +36,8 @@ public class ToDoItem {
The `domainEvent()` attribute allows a custom subclass to be emitted allowing more precise subscriptions (to those
subclasses) to be defined instead. This attribute is also supported for
-xref:rgant.adoc#_rgant-Action_domainEvent[actions] and
-xref:rgant.adoc#_rgant-Property_domainEvent[properties].
+xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[actions] and
+xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
For example:
@@ -73,7 +73,7 @@ rather than through the constructor. This substantially reduces the boilerplate
== Subscribers
-Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API.
+Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API.
Subscribers can be either coarse-grained (if they subscribe to the top-level event type):
@@ -166,8 +166,8 @@ then no event will be posted.
== Raising events programmatically
-Normally events are only raised for interactions through the UI. However, events can be raised programmatically either by calling the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or by emulating the UI by
-wrapping the target object using the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] domain service.
+Normally events are only raised for interactions through the UI. However, events can be raised programmatically either by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or by emulating the UI by
+wrapping the target object using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] domain service.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_editing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_editing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_editing.adoc
index ed63939..3310952 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_editing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_editing.adoc
@@ -6,7 +6,7 @@
-The `editing()` annotation indicates whether a collection can be added to or removed from within the UI. This attribute can also be specified for xref:rgant.adoc#_rgant-Property_editing[properties], and can also be specified for the xref:rgant.adoc#_rgant-DomainObject_editing[domain object]
+The `editing()` annotation indicates whether a collection can be added to or removed from within the UI. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-Property_editing[properties], and can also be specified for the xref:../rgant/rgant.adoc#_rgant-DomainObject_editing[domain object]
The related `editingDisabledReason()` attribute specifies the a hard-coded reason why the collection cannot be modified directly.
@@ -14,18 +14,18 @@ The related `editingDisabledReason()` attribute specifies the a hard-coded reaso
====
The xref:ugvw.adoc#[Wicket viewer] does *not* currently support the modification of collections; they are rendered read-only.
-The workaround is to create add/remove actions and use xref:rgant.adoc#_rgant-MemberOrder[UI hints] to render them close to the collection.
+The workaround is to create add/remove actions and use xref:../rgant/rgant.adoc#_rgant-MemberOrder[UI hints] to render them close to the collection.
====
Whether a collection is enabled or disabled depends upon these factors:
-* whether the domain object has been configured as immutable through the xref:rgant.adoc#_rgant-DomainObject_editing[`@DomainObject#editing()`] attribute
+* whether the domain object has been configured as immutable through the xref:../rgant/rgant.adoc#_rgant-DomainObject_editing[`@DomainObject#editing()`] attribute
-* else (that is, if the domain object's editability is specified as being `AS_CONFIGURED`), then the value of the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing`. If set to `false`, then the object's collections (and properties) are *not* editable
+* else (that is, if the domain object's editability is specified as being `AS_CONFIGURED`), then the value of the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing`. If set to `false`, then the object's collections (and properties) are *not* editable
* else, then the value of the `@Collection(editing=...)` attribute itself.
-* else, the result of invoking any supporting xref:rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`] supporting methods
+* else, the result of invoking any supporting xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`] supporting methods
Thus, to make a collection read-only even if the object would otherwise be editable, use:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_hidden.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_hidden.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_hidden.adoc
index e2feb1a..63da074 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_hidden.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_hidden.adoc
@@ -5,11 +5,11 @@
:_imagesdir: images/
-Collections can be hidden at the domain-level, indicating that they are not visible to the end-user. This attribute can also be applied to xref:rgant.adoc#_rgant-Action_hidden[actions] and xref:rgant.adoc#_rgant-Property_hidden[properties].
+Collections can be hidden at the domain-level, indicating that they are not visible to the end-user. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-Action_hidden[actions] and xref:../rgant/rgant.adoc#_rgant-Property_hidden[properties].
[TIP]
====
-It is also possible to use xref:rgant.adoc#_rgant-CollectionLayout_hidden[`@CollectionLayout#hidden()`] or using xref:ugvw.adoc#_ugvw_layout_file-based[file-based layout] such that the collection can be hidden at the view layer.
+It is also possible to use xref:../rgant/rgant.adoc#_rgant-CollectionLayout_hidden[`@CollectionLayout#hidden()`] or using xref:ugvw.adoc#_ugvw_layout_file-based[file-based layout] such that the collection can be hidden at the view layer.
Both options are provided with a view that in the future the view-layer semantics may be under the control of (expert) users, whereas domain-layer semantics should never be overridden or modified by the user.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
index cd33b91..0f6c19c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
@@ -6,7 +6,7 @@
-The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`]. This attribute is also supported for xref:rgant.adoc#_rgant-Property_notPersisted[properties].
+The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`]. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Property_notPersisted[properties].
[WARNING]
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_typeOf.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_typeOf.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_typeOf.adoc
index cea1e14..00efb05 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_typeOf.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_typeOf.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `typeOf()` attribute specifies the expected type of an element contained within a collection when for whatever reason the type cannot be inferred from the generic type, or to provide a hint about the actual run-time (as opposed to compile-time) type. This attribute can also be specified for xref:rgant.adoc#_rgant-Action_typeOf[actions].
+The `typeOf()` attribute specifies the expected type of an element contained within a collection when for whatever reason the type cannot be inferred from the generic type, or to provide a hint about the actual run-time (as opposed to compile-time) type. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-Action_typeOf[actions].
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Column.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Column.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Column.adoc
index a4a2f33..08451f0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Column.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Column.adoc
@@ -34,11 +34,11 @@ public class Customer {
public void setMiddleInitial(String middleInitial) { ... }
----
-Isis also provides xref:rgant.adoc#_rgant-Property_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:../rgant/rgant.adoc#_rgant-Property_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.
-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:rgant.adoc#_rgant-Property_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:../rgant/rgant.adoc#_rgant-Property_optionality[`@Property#optionality()`] attribute for discussion on one or two minor edge cases.
@@ -62,7 +62,7 @@ public class Customer {
public void setLastName(String lastName) { ... }
----
-Isis also provides xref:rgant.adoc#_rgant-Property_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.
+Isis also provides xref:../rgant/rgant.adoc#_rgant-Property_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.
@@ -81,7 +81,7 @@ public class Customer {
public void setTotalOrdersToDate(BigDecimal totalOrdersToDate) { ... }
----
-For ``BigDecimal``s it is also possible to specify the xref:rgant.adoc#_rgant-Digits[`@Digits`] annotation, whose form is `@Digits(integer, fraction)`. There is a subtle difference here: while `@Column#scale()` corresponds to `@Digits#fraction()`, the value of `@Column#length()` (ie the precision) is actually the _sum_ of the `@Digits`' `integer()` and `fraction()` parts.
+For ``BigDecimal``s it is also possible to specify the xref:../rgant/rgant.adoc#_rgant-Digits[`@Digits`] annotation, whose form is `@Digits(integer, fraction)`. There is a subtle difference here: while `@Column#scale()` corresponds to `@Digits#fraction()`, the value of `@Column#length()` (ie the precision) is actually the _sum_ of the `@Digits`' `integer()` and `fraction()` parts.
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.
@@ -116,7 +116,7 @@ public class PartyRelationship {
== Mapping ``Blob``s and ``Clob``s
-Isis provides custom value types for xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`]s and xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]s. These value types have multiple internal fields, meaning that they corresponding to multiple columns in the database. Mapping this correctly requires using `@Column` within JDO's `@Persistent` annotation.
+Isis provides custom value types for xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`]s and xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]s. These value types have multiple internal fields, meaning that they corresponding to multiple columns in the database. Mapping this correctly requires using `@Column` within JDO's `@Persistent` annotation.
For example, here's how to map a `Blob` (taken from (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]):
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Digits.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Digits.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Digits.adoc
index af51285..16a8a42 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Digits.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Digits.adoc
@@ -28,7 +28,7 @@ public void setCost(final BigDecimal cost) {
:null;
}
----
-<1> the xref:rgant.adoc#_rgant-Column[`@Column#scale()`] attribute must be ...
+<1> the xref:../rgant/rgant.adoc#_rgant-Column[`@Column#scale()`] attribute must be ...
<2> ... consistent with `@Digits#fraction()`
<3> the correct idiom when setting a new value is to normalized to the correct scale
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
index efa54a3..6f7716d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
@@ -21,12 +21,12 @@ This value is used internally to generate a string representation of an objects
This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
- (see xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`])
+ (see xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`])
** and thus in the "table-of-two-halves" pattern, as per (non-ASF) http://github.com/isisaddons/isis-module-poly[Isis addons' poly] module
-* in the serialization of `OidDto` in the xref:rgcms.adoc#_rgcms_schema-cmd[command] and xref:rgcms.adoc#_rgcms_schema-ixn[interaction] schemas
+* in the serialization of `OidDto` in the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[command] and xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[interaction] schemas
* in the URLs of the xref:ugvro.adoc#[RestfulObjects viewer]
* in the URLs of the xref:ugvw.adoc#[Wicket viewer] (in general and in particular if xref:ugvw.adoc#_ugvw_features_hints-and-copy-url[copying URLs])
-* in XML snapshots generated by the xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`]
+* in XML snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`]
@@ -49,9 +49,9 @@ has an object type of `custmgmt.Customer`.
The rules of precedence for determining a domain object's object type are:
-1. xref:rgant.adoc#_rgant_Discriminator[`@Discriminator`]
+1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`]
2. `@DomainObject#objectType`
-3. xref:rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`], if at least the `schema` attribute is defined. +
+3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`], if at least the `schema` attribute is defined. +
+
If both `schema` and `table` are defined, then the value is "`schema.table`".
If only `schema` is defined, then the value is "`schema.className`".
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
index 584471f..acd363ac 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
@@ -19,15 +19,15 @@ The table below summarizes the annotation's attributes.
| Description
-|xref:rgant.adoc#_rgant-DomainObject_auditing[`auditing()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_auditing[`auditing()`]
|`AS_CONFIGURED`, `ENABLED`, `DISABLED` +
(`AS_CONFIGURED`)
|indicates whether each of the changed properties of an object should be submitted to the registered
-xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`] (deprecated) or (its replacement)
-xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`] (deprecated) or (its replacement)
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]
-|xref:rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`autoCompleteRepository()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`autoCompleteRepository()`]
|Domain service class
|nominate a method on a domain service to be used for looking up instances of the domain object
@@ -38,56 +38,56 @@ xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]
|override the method name to use on the auto-complete repository
-|xref:rgant.adoc#_rgant-DomainObject_bounded[`bounded()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_bounded[`bounded()`]
|`true`, `false` +
(`false`)
|Whether the number of instances of this domain class is relatively small (a "bounded" set), such that instances could be selected from a drop-down list box or similar.
-|xref:rgant.adoc#_rgant-DomainObject_createdLifecycleEvent[`created-` +
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_createdLifecycleEvent[`created-` +
`LifecycleEvent()`]
|subtype of `ObjectCreatedEvent` +
(`ObjectCreatedEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is created
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is created
-|xref:rgant.adoc#_rgant-DomainObject_editing[`editing()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_editing[`editing()`]
|`AS_CONFIGURED`, `ENABLED`, `DISABLED` +
(`AS_CONFIGURED`)
|whether the object's properties and collections can be edited or not (ie whether the instance should be considered to be immutable)
-|xref:rgant.adoc#_rgant-DomainObject_mixinMethod[`mixinMethod()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_mixinMethod[`mixinMethod()`]
|Method name within the mixin
|How to recognize the "reserved" method name, meaning that the mixin's own name will be inferred from the mixin type.
Typical examples are "exec", "execute", "invoke", "apply" and so on.
The default "reserved" method name is `$$`.
-|xref:rgant.adoc#_rgant-DomainObject_nature[`nature()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_nature[`nature()`]
|`NOT_SPECIFIED`, `JDO_ENTITY`, `EXTERNAL_ENTITY`, `INMEMORY_ENTITY`, `MIXIN`, `VIEW_MODEL` (`NOT_SPECIFIED`)
|whether the domain object logically is an entity (part of the domain layer) or is a view model (part of the application layer); or is a mixin. If an entity, indicates how its persistence is managed.
-|xref:rgant.adoc#_rgant-DomainObject_objectType[`objectType()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_objectType[`objectType()`]
|(none, which implies fully qualified class name)
|specify an alias for the domain class used to uniquely identify the object both within the Apache Isis runtime and externally
-|xref:rgant.adoc#_rgant-DomainObject_persistedLifecycleEvent[`persisted-` +
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_persistedLifecycleEvent[`persisted-` +
`LifecycleEvent()`]
|subtype of `ObjectPersistedEvent` +
(`ObjectPersistedEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance has just been persisted
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance has just been persisted
-|xref:rgant.adoc#_rgant-DomainObject_persistingLifecycleEvent[`persisting-` +
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_persistingLifecycleEvent[`persisting-` +
`LifecycleEvent()`]
|subtype of `ObjectPersistingEvent` +
(`ObjectPersistingEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is about to be persisted
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is about to be persisted
-|xref:rgant.adoc#_rgant-DomainObject_publishing[`publishing()`]
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[`publishing()`]
|`AS_CONFIGURED`, `ENABLED`, `DISABLED` +
(`AS_CONFIGURED`)
-|whether changes to the object should be published to the registered xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
+|whether changes to the object should be published to the registered xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
|`publishing-` +
@@ -95,23 +95,23 @@ The default "reserved" method name is `$$`.
|subtype of `PublishingPayloadFactory-` `ForObject` (none)
|specifies that a custom implementation of `PublishingPayloadFactoryForObject` be used to create the (payload of the) published event representing the change to the object
-|xref:rgant.adoc#_rgant-DomainObject_removingLifecycleEvent[`removing-` +
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_removingLifecycleEvent[`removing-` +
`LifecycleEvent()`]
|subtype of `ObjectRemovingEvent` +
(`ObjectRemovingEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is about to be deleted
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is about to be deleted
-|xref:rgant.adoc#_rgant-DomainObject_updatedLifecycleEvent[`updated-` +
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_updatedLifecycleEvent[`updated-` +
`LifecycleEvent()`]
|subtype of `ObjectUpdatedEvent` +
(`ObjectUpdatedEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance has just been updated
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance has just been updated
-|xref:rgant.adoc#_rgant-DomainObject_updatingLifecycleEvent[`updating-` +
+|xref:../rgant/rgant.adoc#_rgant-DomainObject_updatingLifecycleEvent[`updating-` +
`LifecycleEvent()`]
|subtype of `ObjectUpdatingEvent` +
(`ObjectUpdatingEvent.Default`)
-|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is about to be updated
+|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] whenever an instance is about to be updated
|===