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:14 UTC
[05/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/rgsvc/_rgsvc_metadata-api.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api.adoc
index aa2b014..3a3a52e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api.adoc
@@ -20,7 +20,7 @@ The table below summarizes the metadata APIs defined by Apache Isis. It also li
|Notes
-|xref:rgsvc.adoc#_rgsvc_api_ApplicationFeatureRepository[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ApplicationFeatureRepository[`o.a.i.applib.` +
`services.appfeat` +
`ApplicationFeatureRepository`]
|Provides access to string representations of the features (package, class, class members) of the domain classes
@@ -32,7 +32,7 @@ within the metamodel.
-|xref:rgsvc.adoc#_rgsvc_api_LayoutService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_LayoutService[`o.a.i.applib.` +
`services.layout` +
`LayoutService`]
|Provides the ability to download `Xxx.layout.xml` files, in various styles.
@@ -44,7 +44,7 @@ within the metamodel.
-|xref:rgsvc.adoc#_rgsvc_api_MetaModelService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MetaModelService[`o.a.i.applib.` +
`services.metamodel` +
`MetaModelService`]
|Access to certain information from the Apache Isis metamodel.
@@ -54,7 +54,7 @@ within the metamodel.
|Functionality surfaced in the UI through related menu.
-|xref:rgsvc.adoc#_rgsvc_api_ServiceRegistry[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ServiceRegistry[`o.a.i.applib.` +
`services.registry` +
`ServiceRegistry`]
|Methods to access and use other domain services.
@@ -62,19 +62,19 @@ within the metamodel.
``Default`` +
``o.a.i.core`` +
``isis-core-metamodel``
-|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`].
+|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`].
-|xref:rgsvc.adoc#_rgsvc_api_SwaggerService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_SwaggerService[`o.a.i.applib.` +
`services.swagger` +
`SwaggerService`]
|Generates link:http://swagger.io/[Swagger] spec files to describe the public and/or private RESTful APIs exposed by the xref:ugvro.adoc#[RestfulObjects viewer]. These can then be used with the link:http://swagger.io/swagger-ui/[Swagger UI] page to explore the REST API, or used to generate client-side stubs using the link:http://swagger.io/swagger-codegen/[Swagger codegen] tool, eg for use in a custom REST client app.
|`SwaggerServiceDefault` +
``o.a.i.core`` +
``isis-core-metamodel``
-|A `SwaggerServiceMenu` domain service is also provided which enables the swagger spec to be downloaded. Apache Isis' xref:rgmvn.adoc[Maven plugin] also provides a xref:rgmvn.adoc#_rgmvn_swagger[swagger goal] which allows the spec file(s) to be generated at build time (eg so that client-side stubs can then be generated in turn).
+|A `SwaggerServiceMenu` domain service is also provided which enables the swagger spec to be downloaded. Apache Isis' xref:../rgmvn/rgmvn.adoc[Maven plugin] also provides a xref:../rgmvn/rgmvn.adoc#_rgmvn_swagger[swagger goal] which allows the spec file(s) to be generated at build time (eg so that client-side stubs can then be generated in turn).
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
index cf2522f..7362ebe 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
@@ -22,7 +22,7 @@ The table below summarizes the persistence layer APIs defined by Apache Isis. I
|Notes
-|xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`o.a.i.applib.` +
`services.jdosupport` +
`IsisJdoSupport`]
|Lower level access to the JDO Persistence API.
@@ -32,7 +32,7 @@ The table below summarizes the persistence layer APIs defined by Apache Isis. I
|
-|xref:rgsvc.adoc#_rgsvc_api_MetricsService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MetricsService[`o.a.i.applib.` +
`services.metrics` +
`MetricsService`]
|Gathers and provides metrics on the numbers of objects used within a transaction.
@@ -42,7 +42,7 @@ The table below summarizes the persistence layer APIs defined by Apache Isis. I
|
-|xref:rgsvc.adoc#_rgsvc_api_QueryResultsCache[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_QueryResultsCache[`o.a.i.applib.` +
`services.` +
`queryresultscache` +
`QueryResultsCache`]
@@ -54,7 +54,7 @@ The table below summarizes the persistence layer APIs defined by Apache Isis. I
-|xref:rgsvc.adoc#_rgsvc_api_RepositoryService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_RepositoryService[`o.a.i.applib.` +
`services.repository` +
`RepositoryService`]
|Methods to help implement repositories: query for existing objects, persist new or delete existing objects
@@ -62,7 +62,7 @@ The table below summarizes the persistence layer APIs defined by Apache Isis. I
``Default`` +
``o.a.i.core`` +
``isis-core-metamodel``
-|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`].
+|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
index 99bc259..22a389d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
@@ -23,7 +23,7 @@ The table below summarizes the persistence layer SPIs defined by Apache Isis. I
-|xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`o.a.i.applib.` +
`services.audit` +
`AuditerService`]
|Create an audit record for every changed property of every changed object within a transaction.
@@ -35,19 +35,19 @@ also +
|
-|xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`o.a.i.applib.` +
`services.audit` +
`AuditingService3`]
-|(deprecated, replaced by xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]); creates
+|(deprecated, replaced by xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]); creates
an audit record for every changed property of every changed object within a transaction.
|
|
-|xref:rgsvc.adoc#_rgsvc_spi_EventSerializer[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_EventSerializer[`o.a.i.applib.` +
`services.publish` +
`EventSerializer`]
-|(deprecated, not used by replacement xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]) Creates a representation of either an action invocation or a changed object being published through the xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
+|(deprecated, not used by replacement xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]) Creates a representation of either an action invocation or a changed object being published through the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
|`RestfulObjects-` +
`SpecEventSerializer` +
``o.ia.m.publishing`` +
@@ -56,7 +56,7 @@ an audit record for every changed property of every changed object within a tran
-|xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`o.a.i.applib.` +
`services.publish` +
`PublisherService`]
|Publish any action invocations/property edits and changed objects, typically for interchange with an external system in a different bounded context.
@@ -70,10 +70,10 @@ also +
|
-|xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`o.a.i.applib.` +
`services.publish` +
`PublishingService`]
-|(deprecated, replaced by xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]) Publish any action invocations and changed objects, typically for interchange with an external system in a different bounded context.
+|(deprecated, replaced by xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]) Publish any action invocations and changed objects, typically for interchange with an external system in a different bounded context.
|`PublishingService` +
``o.ia.m.publishing`` +
``isis-module-publishing``
@@ -82,7 +82,7 @@ also +
-|xref:rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`o.a.i.applib.` +
`services.userreg` +
`UserRegistrationService`]
|Create a new user account with the configured security mechanism.
@@ -105,7 +105,7 @@ Key:
* `o.a.i.c.r.s` is an abbreviation for `org.apache.isis.core.runtime.services`
-Where an implementation is available (on the classpath) then it is always registered automatically (that is, they are all (with one exception) annotated with xref:rgant.adoc#_rgant-DomainService[`@DomainService`].
+Where an implementation is available (on the classpath) then it is always registered automatically (that is, they are all (with one exception) annotated with xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
index e6ff519..6c0ed69 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
@@ -21,7 +21,7 @@ The table below summarizes the presentation layer SPIs defined by Apache Isis.
|Notes
-|xref:rgsvc.adoc#_rgsvc_spi_ContentMappingService[`o.a.i.applb.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ContentMappingService[`o.a.i.applb.` +
`services.conmap` +
`ContentMappingService`]
|(Attempt to) map the returned data into the representation required by the client's HTTP `Accept` header.
@@ -33,10 +33,10 @@ No default implementation.
-|xref:rgsvc.adoc#_rgsvc_spi_EmailNotificationService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_EmailNotificationService[`o.a.i.applib.` +
`services.userreg` +
`EmailNotificationService`]
-|Notify a user during xref:rgsvc.adoc#_rgsvc_spi_UserRegistrationService[self-registration] of users.
+|Notify a user during xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UserRegistrationService[self-registration] of users.
|`EmailNotificationService-` +
`Default` +
``o.a.i.core`` +
@@ -45,7 +45,7 @@ No default implementation.
a configured `EmailService`
-|xref:rgsvc.adoc#_rgsvc_spi_ErrorReportingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ErrorReportingService[`o.a.i.applib.` +
`services.error` +
`ErrorReportingService`]
|Record details of an error occurring in the system (eg in an external incident recording system such as JIRA), and return a more friendly (jargon-free) message to display to the end user, with optional reference (eg `XXX-1234`).
@@ -53,7 +53,7 @@ a configured `EmailService`
|
-|xref:rgsvc.adoc#_rgsvc_spi_ExceptionRecognizer[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ExceptionRecognizer[`o.a.i.applib.` +
`services.exceprecog` +
`ExceptionRecognizer2`]
|Convert certain exceptions (eg foreign or unique key violation in the database) into a format that can be rendered to the end-user.
@@ -65,7 +65,7 @@ a configured `EmailService`
|Extensible using composite pattern if required
-|xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`o.a.i.applib.` +
`services.grid` +
`GridSystemService`]
|Validates and normalizes the grid layout for a domain class (with respect to a particular grid
@@ -76,7 +76,7 @@ system such as Bootstrap3), also providing a default grid (for those domain clas
|
-|xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`o.a.i.applib.` +
`services.grid` +
`GridLoaderService`]
|Responsible for loading a grid layout for a domain class, eg from a `layout.xml` file.
@@ -86,11 +86,11 @@ system such as Bootstrap3), also providing a default grid (for those domain clas
|
-|xref:rgsvc.adoc#_rgsvc_spi_GridService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`o.a.i.applib.` +
`services.grid` +
`GridService`]
-|A facade on top of both xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] and
-xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`], thus being able to return normalized
+|A facade on top of both xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] and
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`], thus being able to return normalized
grids for any domain class.
|`GridServiceDefault` +
``o.a.i.core`` +
@@ -98,7 +98,7 @@ grids for any domain class.
|
-|xref:rgsvc.adoc#_rgsvc_spi_HintStore[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_HintStore[`o.a.i.applib.` +
`services.hint` +
`HintStore`]
|Stores UI hints on a per-object basis. For example, the viewer remembers which tabs are selected, and for collections which view is selected (eg table or hidden), which page of a table to render, or whether "show all" (rows) is toggled.
@@ -108,29 +108,29 @@ grids for any domain class.
|
-|xref:rgsvc.adoc#_rgsvc_spi_LocaleProvider[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_LocaleProvider[`o.a.i.applib.` +
`services.i18n` +
`LocaleProvider`]
-|Request-scoped service to return the locale of the current user, in support of i18n (ie so that the app's UI, messages and exceptions can be translated to the required locale by the xref:rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`].
+|Request-scoped service to return the locale of the current user, in support of i18n (ie so that the app's UI, messages and exceptions can be translated to the required locale by the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`].
|`LocaleProviderWicket` +
``o.a.i.viewer`` +
``isis-viewer-wicket-impl``
|
-|xref:rgsvc.adoc#_rgsvc_spi_RoutingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_RoutingService[`o.a.i.applib.` +
`services.routing` +
`RoutingService`]
|Return an alternative object than that returned by an action.
|`RoutingServiceDefault` +
``o.a.i.core`` +
``isis-core-applib``
-|The default implementation will return the home page (per xref:rgsvc.adoc#_rgsvc_api_HomePageProviderService[`HomePageProviderService`]) if a void or null is returned. +
+|The default implementation will return the home page (per xref:../rgsvc/rgsvc.adoc#_rgsvc_api_HomePageProviderService[`HomePageProviderService`]) if a void or null is returned. +
Used by the xref:ugvw.adoc#[Wicket viewer] only.
-|xref:rgsvc.adoc#_rgsvc_spi_TableColumnOrderService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TableColumnOrderService[`o.a.i.applib.` +
`services.tablecol` +
`TableColumn-` +
`OrderService`]
@@ -142,10 +142,10 @@ Used by the xref:ugvw.adoc#[Wicket viewer] only.
|
-|xref:rgsvc.adoc#_rgsvc_spi_TranslationService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationService[`o.a.i.applib.` +
`services.i18n` +
`TranslationService`]
-|Translate an app's UI, messages and exceptions for the current user (as per the locale provided by xref:rgsvc.adoc#_rgsvc_spi_LocaleProvider[`LocalProvider`].
+|Translate an app's UI, messages and exceptions for the current user (as per the locale provided by xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_LocaleProvider[`LocalProvider`].
|`TranslationServicePo` +
``o.a.i.core`` +
``isis-core-runtime``
@@ -154,17 +154,17 @@ depends on: +
`TranslationsResolver`, `LocaleProvider`
-|xref:rgsvc.adoc#_rgsvc_spi_TranslationsResolver[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationsResolver[`o.a.i.applib.` +
`services.i18n` +
`TranslationsResolver`]
-|Obtain translations for a particuar phrase and locale, in support of i18n (ie so that the app's UI, messages and exceptions can be translated to the required locale by the xref:rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`]
+|Obtain translations for a particuar phrase and locale, in support of i18n (ie so that the app's UI, messages and exceptions can be translated to the required locale by the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`]
|`TranslationsResolverWicket` +
``o.a.i.viewer`` +
``isis-viewer-wicket-impl``
|
-|xref:rgsvc.adoc#_rgsvc_spi_UrlEncodingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UrlEncodingService[`o.a.i.applib.` +
`services.urlencoding` +
`UrlEncodingService`]
|Converts strings into a form safe for use within a URL. Used to convert view models mementos into usable URL form.
@@ -176,7 +176,7 @@ depends on: +
|
-|xref:rgsvc.adoc#_rgsvc_spi_UserProfileService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UserProfileService[`o.a.i.applib.` +
`services.userprof` +
`UserProfileService`]
|Obtain an alternative (usually enriched/customized) name for the current user, to render in the UI.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditerService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditerService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditerService.adoc
index 37f46fa..e0f435d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditerService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditerService.adoc
@@ -11,7 +11,7 @@ The `AuditerService` auditing service provides a simple mechanism to capture cha
[NOTE]
====
-This service is intended to replace the now-deprecated xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService3`].
+This service is intended to replace the now-deprecated xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService3`].
The difference between the two is that this service recognises that the `transactionId` is now (as of `1.13.0`)
actually a request/interaction Id, and that an additional `sequence
====
@@ -85,7 +85,7 @@ the secondary menu bar.
the user interface (they are all `@Programmatic`).
* `AuditingServiceContributions` which contrbutes collections to the
-xref:rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[ `HasTransactionId`] interface. This will therefore display all
+xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[ `HasTransactionId`] interface. This will therefore display all
audit entries that occurred in a given request/transaction, in other words whenever a command, a published event or
another audit entry is displayed.
@@ -94,7 +94,7 @@ another audit entry is displayed.
== Usage
-The typical way to indicate that an object should be audited is to annotate it with the xref:rgant.adoc#_rgant-DomainObject_auditing[`@DomainObject#auditing()`] annotation.
+The typical way to indicate that an object should be audited is to annotate it with the xref:../rgant/rgant.adoc#_rgant-DomainObject_auditing[`@DomainObject#auditing()`] annotation.
@@ -105,7 +105,7 @@ The (non-ASF) http://github.com/isisaddons/isis-module-audit[Isis addons' audit]
this service (`AuditerService`), and also provides a number of related domain services (`AuditingServiceMenu`,
`AuditingServiceRepository` and `AuditingServiceContributions`).
-Assuming that an `AppManifest` is being used to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
+Assuming that an `AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
then this can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
If menu items or contributions are not required in the UI, these can be suppressed either using security or by
@@ -116,19 +116,19 @@ implementing a xref:ugbtb.adoc#_ugbtb_decoupling_vetoing-visibility[vetoing subs
== Related Services
The auditing service works very well with implementations of
-xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] that persist the ``Interaction.Execution`` objects
-obtained from the xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] service. The interaction
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] that persist the ``Interaction.Execution`` objects
+obtained from the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] service. The interaction
execution captures the _cause_ of an interaction (an action was invoked, a property was edited), while the
`AuditerService` audit entries capture the _effect_ of that interaction in terms of changed state.
[NOTE]
====
-Prior to `1.13.0` the xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] performed a similar role,
+Prior to `1.13.0` the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] performed a similar role,
of capturing the cause. As of `1.13.0`, ``Command``s are now primarily to capture the _intent_ of an action,
not the actual action invocation itself.
====
The `AuditerService` is intended to replace the (now-deprecated)
-xref:rgsvc.adoc#_rgsvc_spi_AuditingService3[`AuditingService3`], as the latter does not support the concept of multiple
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService3[`AuditingService3`], as the latter does not support the concept of multiple
transactions within a single interaction.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditingService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditingService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditingService.adoc
index ddb39de..63ed0f8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditingService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_AuditingService.adoc
@@ -11,7 +11,7 @@ The `AuditingService3` auditing service provides a simple mechanism to capture c
[NOTE]
====
-This service is deprecated, replaced by xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`].
+This service is deprecated, replaced by xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`].
====
@@ -46,7 +46,7 @@ The module also provides:
* `AuditingServiceRepository` service to to search for persisted `AuditEntry``s. None of its actions are visible in the user interface (they are all `@Programmatic`).
-* `AuditingServiceContributions` which contrbutes collections to the xref:rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[ `HasTransactionId`] interface. This will therefore display all audit entries that occurred in a given transaction, in other words whenever a command, a published event or another audit entry is displayed.
+* `AuditingServiceContributions` which contrbutes collections to the xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[ `HasTransactionId`] interface. This will therefore display all audit entries that occurred in a given transaction, in other words whenever a command, a published event or another audit entry is displayed.
@@ -56,7 +56,7 @@ If you just want to debug (writing to stderr), you can instead configure `o.a.i.
== Usage
-The typical way to indicate that an object should be audited is to annotate it with the xref:rgant.adoc#_rgant-DomainObject_auditing[`@DomainObject#auditing()`] annotation.
+The typical way to indicate that an object should be audited is to annotate it with the xref:../rgant/rgant.adoc#_rgant-DomainObject_auditing[`@DomainObject#auditing()`] annotation.
@@ -67,7 +67,7 @@ The (non-ASF) http://github.com/isisaddons/isis-module-audit[Isis addons' audit]
this service (`AuditingService`), and also provides a number of related domain services (`AuditingServiceMenu`,
`AuditingServiceRepository` and `AuditingServiceContributions`).
-Assuming that an `AppManifest` is being used to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
+Assuming that an `AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
then this can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
If menu items or contributions are not required in the UI, these can be suppressed either using security or by
@@ -78,6 +78,6 @@ implementing a xref:ugbtb.adoc#_ugbtb_decoupling_vetoing-visibility[vetoing subs
== Related Services
This service has been deprecated and replaced by the equivalent
-xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`].
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_BackgroundCommandService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_BackgroundCommandService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_BackgroundCommandService.adoc
index 4257ea5..57ae70e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_BackgroundCommandService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_BackgroundCommandService.adoc
@@ -6,11 +6,11 @@
-The `BackgroundCommandService` (SPI) service supports the xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] (API) service, persisting action invocations as commands such that they can subsequently be invoked in the background.
+The `BackgroundCommandService` (SPI) service supports the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] (API) service, persisting action invocations as commands such that they can subsequently be invoked in the background.
-The `BackgroundService` is responsible for capturing a memento representing the action invocation, and then hands off to the xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`] `BackgroundCommandService` to actually persist it.
+The `BackgroundService` is responsible for capturing a memento representing the action invocation, and then hands off to the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`] `BackgroundCommandService` to actually persist it.
-The persisting of commands is only half the story; there needs to be a separate process to read the commands and execute them. The abstract xref:rgsvc.adoc#_rgsvc_api_BackgroundService_BackgroundCommandExecution[`BackgroundCommandExecution`] provides a mechanism to execute such commands. This can be considered an API, albeit "internal" because the implementation relies on internals of the framework.
+The persisting of commands is only half the story; there needs to be a separate process to read the commands and execute them. The abstract xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService_BackgroundCommandExecution[`BackgroundCommandExecution`] provides a mechanism to execute such commands. This can be considered an API, albeit "internal" because the implementation relies on internals of the framework.
@@ -31,7 +31,7 @@ public interface BackgroundCommandService {
}
----
-<1> is a wrapper around a xref:rgsvc.adoc#_rgsvc_api_MementoService[`MementoService`]'s `Memento`, capturing the details of the action invocation to be retained (eg persisted to a database) so that it can be executed at a later time
+<1> is a wrapper around a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MementoService[`MementoService`]'s `Memento`, capturing the details of the action invocation to be retained (eg persisted to a database) so that it can be executed at a later time
<2> reference to the parent `Command` requesting the action be performed as a background command. This allows information such as the initiating user to be obtained.
The API of `ActionInvocationMemento` in turn is:
@@ -85,7 +85,7 @@ The module also provides a concrete subclass of `BackgroundCommandExecution` tha
[TIP]
====
-Details of setting up the Quartz scheduler to actually execute these persisted commands can be found on the xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] page.
+Details of setting up the Quartz scheduler to actually execute these persisted commands can be found on the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] page.
====
@@ -95,9 +95,9 @@ Details of setting up the Quartz scheduler to actually execute these persisted c
Background commands can be created either declaratively or imperatively.
-The declarative approach involves annotating an action using xref:rgant.adoc#_rgant-Action_command[`@Action#command()`] with `@Action#commandExecuteIn=CommandExecuteIn.BACKGROUND`.
+The declarative approach involves annotating an action using xref:../rgant/rgant.adoc#_rgant-Action_command[`@Action#command()`] with `@Action#commandExecuteIn=CommandExecuteIn.BACKGROUND`.
-The imperative approach involves explicitly calling the xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] from within domain object's action.
+The imperative approach involves explicitly calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] from within domain object's action.
@@ -108,9 +108,9 @@ The (non-ASF) http://github.com/isisaddons/isis-module-command[Isis addons' comm
of this service (`BackgroundCommandService`), and also provides a number of related domain services
(`BackgroundCommandServiceJdo`, `BackgroundCommandJdoRepository` and `BackgroundCommandServiceJdoContributions`). This
module also provides service implementations of the
-xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`].
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`].
-Assuming that an `AppManifest` is being used to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
+Assuming that an `AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
then this can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
If contributions are not required in the UI, these can be suppressed either using security or by implementing a
@@ -122,9 +122,9 @@ xref:ugbtb.adoc#_ugbtb_decoupling_vetoing-visibility[vetoing subscriber].
== Related Services
-As discussed above, this service supports the xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] , persisting `Command`s such that they can be executed in the background.
+As discussed above, this service supports the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] , persisting `Command`s such that they can be executed in the background.
-There is also a tie-up with the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] and its supporting xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] domain service. The `CommandContext` service is responsible for providing a parent `Command` with which the background `Command`s can then be associated as children, while the `CommandService` is responsible for persisting those parent `Command`s (analogous to the way in which the `BackgroundCommandService` persists the child background `Command`s). The `BackgroundCommandService` ensures that these background `Command`s are associated with the parent "foreground" `Command`.
+There is also a tie-up with the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] and its supporting xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] domain service. The `CommandContext` service is responsible for providing a parent `Command` with which the background `Command`s can then be associated as children, while the `CommandService` is responsible for persisting those parent `Command`s (analogous to the way in which the `BackgroundCommandService` persists the child background `Command`s). The `BackgroundCommandService` ensures that these background `Command`s are associated with the parent "foreground" `Command`.
What that means is that the implementations of `CommandService` and `BackgroundCommandService` go together, hence both implemented in the (non-ASF) http://github.com/isisaddons/isis-module-command[Isis addons' command] module.).
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ClassDiscoveryService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ClassDiscoveryService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ClassDiscoveryService.adoc
index 087587f..8308765 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ClassDiscoveryService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ClassDiscoveryService.adoc
@@ -8,7 +8,7 @@
The `ClassDiscovery` service is used to automatically discover subclasses of any given type on the classpath. The primary use case is to support "convention-over-configuration" designs that work with a minimum of configuration.
-This service is used by the xref:rgcms.adoc#_rgcms_classes_super_FixtureScripts[`FixtureScripts`] service to automatically locate any xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`] implementations.
+This service is used by the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScripts[`FixtureScripts`] service to automatically locate any xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`] implementations.
@@ -36,7 +36,7 @@ Isis provides an implementation of this service, namely `o.a.i.applib.services.c
[NOTE]
====
-This implementation is also used to discover domain services annotated with xref:rgant.adoc#_rgant-DomainService[`@DomainService`]. Currently this logic uses the implementation directly, so is not pluggable. However, the entire `ServicesInstaller`
+This implementation is also used to discover domain services annotated with xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`]. Currently this logic uses the implementation directly, so is not pluggable. However, the entire `ServicesInstaller`
====
@@ -44,9 +44,9 @@ This implementation is also used to discover domain services annotated with xref
== Usage
The usage will vary depending upon the conventions of the design. As of 1.9.0, the usage of the service has been
-centralized such that the packages to be scanned are located from the xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest`]'s `#getModules()` method.
+centralized such that the packages to be scanned are located from the xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest`]'s `#getModules()` method.
-For example, the xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype]'s app manifest includes:
+For example, the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype]'s app manifest includes:
[source,java]
----
@@ -71,12 +71,12 @@ Other usages of the `ClassDiscoveryService` are likely to work in a similar way,
== Registering the Services
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core
implementation of `ClassDiscoveryService2` service is automatically registered and injected (it is annotated with
`@DomainService`) so no further configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_CommandService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_CommandService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_CommandService.adoc
index 25fc5f8..f211af1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_CommandService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_CommandService.adoc
@@ -6,28 +6,28 @@
-The `CommandService` service supports the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service such
+The `CommandService` service supports the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service such
that `Command` objects (that reify the invocation of an action/edit of a property on a domain object) can be persisted.
As of `1.13.0`, the primary use case for persistent ``Command``s is in support of background commands; they
act as a parent to any background commands that can be persisted either explicitly using the
-xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`], or implicitly by way of the
-xref:rgant.adoc#_rgant-Action_command[`@Action#command()`] annotation.
+xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`], or implicitly by way of the
+xref:../rgant/rgant.adoc#_rgant-Action_command[`@Action#command()`] annotation.
In previous versions of the framework, persistent ``Command``s also supported a number of other use cases:
* they enable profiling of the running application (which actions are invoked then most often, what is their response time)
-* if xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] or
-xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`] (latter deprecated) is configured, they provide
+* if xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] or
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`] (latter deprecated) is configured, they provide
better traceability as the `Command` is also correlated with any published events, again through the unique
`transactionId` GUID
-* if xref:rgsvc.adoc#_rgsvc_spi_AuderService[`AuditerService`] or
-xref:rgsvc.adoc#_rgsvc_spi_AuditService[`AuditingService`] (latter deprecated) is configured, they provide better audit
+* if xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuderService[`AuditerService`] or
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditService[`AuditingService`] (latter deprecated) is configured, they provide better audit
information, since the `Command` (the 'cause' of an action) can be correlated to the audit records (the "effect" of
the action) through the `transactionId` GUID
As of `1.13.0`, these other uses cases are now more fully supported through the
-xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] service and persistent implementations of the
+xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] service and persistent implementations of the
``Interaction`` object, eg as provided by the (non-ASF)
http://github.com/isisaddons/isis-module-publishmq[Isis addons' publishmq] module.
@@ -60,7 +60,7 @@ public interface CommandService {
}
----
<1> Instantiate the appropriate instance of the `Command` (as defined by the
-xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service). Its members will be populated automatically by
+xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service). Its members will be populated automatically by
the framework.
<2> this method (as of `1.13.0`) is *NO LONGER CALLED* and is deprecated: the framework automatically populates the ``Command``'s `timestamp`,
`user` and `transactionId` fields, so there is no need for the service implementation to initialize any of these. In
@@ -84,7 +84,7 @@ The (non-ASF) http://github.com/isisaddons/isis-module-command[Isis addons' comm
== Usage
-The typical way to indicate that an action should be reified into a `Command` is by annotating the action using xref:rgant.adoc#_rgant-Action_command[`@Action#command()`].
+The typical way to indicate that an action should be reified into a `Command` is by annotating the action using xref:../rgant/rgant.adoc#_rgant-Action_command[`@Action#command()`].
@@ -95,9 +95,9 @@ The (non-ASF) http://github.com/isisaddons/isis-module-command[Isis addons' comm
of this service (`CommandService`), and also provides a number of related domain services
(`CommandJdoRepository` and `CommandServiceJdoContributions`). This
module also provides service implementations of the
-xref:rgsvc.adoc#_rgsvc_spi_CommandService[`BackgroundCommandService`].
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`BackgroundCommandService`].
-Assuming that an `AppManifest` is being used to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
+Assuming that an `AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
then this can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
If contributions are not required in the UI, these can be suppressed either using security or by implementing a
@@ -108,14 +108,14 @@ xref:ugbtb.adoc#_ugbtb_decoupling_vetoing-visibility[vetoing subscriber].
== Related Services
-As discussed above, this service supports the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`], providing the ability for `Command` objects to be
-persisted. This is closely related to the xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`]that allows the xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] to schedule commands for background/asynchronous execution.
+As discussed above, this service supports the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`], providing the ability for `Command` objects to be
+persisted. This is closely related to the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`]that allows the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] to schedule commands for background/asynchronous execution.
The implementations of `CommandService` and `BackgroundCommandService` are intended to go together, so that persistent parent `Command`s can be associated with their child background `Command`s.
-The services provided by this module combines very well with the xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`]. The `CommandService` captures the _cause_ of an interaction (an action was invoked, a property was edited), while the `AuditingService3` captures the _effect_ of that interaction in terms of changed state.
+The services provided by this module combines very well with the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`]. The `CommandService` captures the _cause_ of an interaction (an action was invoked, a property was edited), while the `AuditingService3` captures the _effect_ of that interaction in terms of changed state.
-You may also want to configure the xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
+You may also want to configure the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
-All three of these services collaborate implicitly by way of the xref:rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`HasTransactionId`] interface.
+All three of these services collaborate implicitly by way of the xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`HasTransactionId`] interface.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ContentMappingService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ContentMappingService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ContentMappingService.adoc
index 43639cf..bb21807 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ContentMappingService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ContentMappingService.adoc
@@ -7,11 +7,11 @@
The `ContentMappingService` supports the (default implementation of the)
-xref:rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationService`] allowing the
+xref:../rgfis/rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationService`] allowing the
xref:ugvro.adoc#[RestfulObjects viewer] to allow domain objects to be transformed into some other format as specified
by the HTTP `Accept` header.
-See xref:rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationService`] for further discussion.
+See xref:../rgfis/rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationService`] for further discussion.
[NOTE]
@@ -19,7 +19,7 @@ See xref:rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationServ
Unlike most other domain services, the framework (that is, `ContentNegotiationService`) will check _all_ available
implementations of `ContentMappingService` to convert the domain object to the requested media type, rather than merely
the first implementation found; in other words it uses the chain-of-responsibility pattern. Services are checked
-in the ordering defined by xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`]).
+in the ordering defined by xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`]).
The mapped object used will be the first non-`null` result returned by an implementation.
====
@@ -99,4 +99,4 @@ public class ContentMappingServiceForToDoItem implements ContentMappingService {
== Related Services
-This service is a companion to the default implementation of the xref:rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationService`].
\ No newline at end of file
+This service is a companion to the default implementation of the xref:../rgfis/rgfis.adoc#_rgfis_spi_ContentNegotiationService[`ContentNegotiationService`].
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EmailNotificationService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EmailNotificationService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EmailNotificationService.adoc
index 9aaabd5..1bab3a1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EmailNotificationService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EmailNotificationService.adoc
@@ -8,11 +8,11 @@
The `EmailNotificationService` supports the xref:ugvw.adoc#_ugvw_features_user-registration[user registration] (self sign-up) features of the xref:ugvw.adoc#[Wicket viewer] whereby a user can sign-up to access an application by providing a valid email address.
-The Wicket viewer will check whether an implementation of this service (and also the xref:rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`UserRegistrationService`]) is available, and if so will (unless configured not to) expose a sign-up page where the user enters their email address. A verification email is sent using this service; the email includes a link back to the running application. The user then completes the registration process (choosing a user name, password and so on) and the Wicket viewer creates an account for them (using the aforementioned `UserRegistrationService`).
+The Wicket viewer will check whether an implementation of this service (and also the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`UserRegistrationService`]) is available, and if so will (unless configured not to) expose a sign-up page where the user enters their email address. A verification email is sent using this service; the email includes a link back to the running application. The user then completes the registration process (choosing a user name, password and so on) and the Wicket viewer creates an account for them (using the aforementioned `UserRegistrationService`).
The role of this service in all of this is to format and send out emails for the initial registration, or for password resets.
-The default implementation of this service uses the xref:rgsvc.adoc#_rgsvc_api_EmailService[`EmailService`], which must be configured in order for user registration to be enabled.
+The default implementation of this service uses the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EmailService[`EmailService`], which must be configured in order for user registration to be enabled.
== SPI
@@ -64,18 +64,18 @@ To ensure that your alternative implementation takes the place of the default im
== Registering the Service
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' default
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' default
implementation of `EmailNotificationService` service is automatically registered and injected (it is annotated with
`@DomainService`) so no further configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
-As noted elsewhere, the default implementation of this service uses xref:rgsvc.adoc#_rgsvc_api_EmailService[`EmailService`]. This service has no specific configuration properties but does require that the `EmailService` has been configured.
+As noted elsewhere, the default implementation of this service uses xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EmailService[`EmailService`]. This service has no specific configuration properties but does require that the `EmailService` has been configured.
-Conversely, this service is used by (Isis' default implementation of) xref:rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`UserRegistrationService`].
+Conversely, this service is used by (Isis' default implementation of) xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`UserRegistrationService`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ErrorReportingService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ErrorReportingService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ErrorReportingService.adoc
index 1b6b162..90ca1e9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ErrorReportingService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ErrorReportingService.adoc
@@ -34,8 +34,8 @@ public class ErrorDetails {
public List<String> getStackTraceDetailList() { // <4>
}
----
-<1> the main message to be displayed to the end-user. The service is responsible for translating this into the language of the end-user (it can use xref:rgsvc.adoc#_rgsvc_spi_LocaleProvider[`LocaleProvider`] if required).
-<2> whether this message has already been recognized by an xref:rgsvc.adoc#_rgsvc_spi_ExceptionRecognizer[`ExceptionRecognizer`] service. Generally this converts potentially non-recoverable (fatal) exceptions into recoverable exceptions (warnings) as well providing an alternative mechanism for generating user-friendly error messages.
+<1> the main message to be displayed to the end-user. The service is responsible for translating this into the language of the end-user (it can use xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_LocaleProvider[`LocaleProvider`] if required).
+<2> whether this message has already been recognized by an xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ExceptionRecognizer[`ExceptionRecognizer`] service. Generally this converts potentially non-recoverable (fatal) exceptions into recoverable exceptions (warnings) as well providing an alternative mechanism for generating user-friendly error messages.
<3> whether the cause of the exception was due to a lack of privileges. In such cases the UI restricts the information shown to the end-user, to avoid leaking potentially sensitive information
<4> the stack trace of the exception, including the trace of any exceptions in the causal chain. These technical details are hidden from the user and only shown for non-recoverable exceptions.
@@ -100,7 +100,7 @@ image::{_imagesdir}reference-services-spi/ErrorReportingService/kitchensink-exam
== Registering the Services
There is no default implementation of this service. To register your own implementation (and assuming that an
-`AppManifest` is being used to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then just
+`AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then just
ensure that the implementation is on the classpath and the module containing the implementation is returned in
`AppManifest#getModules()`.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EventSerializer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EventSerializer.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EventSerializer.adoc
index e226b6c..ba522cd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EventSerializer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_EventSerializer.adoc
@@ -5,14 +5,14 @@
:_imagesdir: images/
-The `EmailSerializer` service is a supporting service intended for use by (any implementation of) xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]. Its responsibility is to combine the `EventMetadata` and the `EventPayload` into some serialized form (such as JSON, XML or a string) that can then be published.
+The `EmailSerializer` service is a supporting service intended for use by (any implementation of) xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]. Its responsibility is to combine the `EventMetadata` and the `EventPayload` into some serialized form (such as JSON, XML or a string) that can then be published.
[WARNING]
====
-This service is deprecated, replaced with xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`].
+This service is deprecated, replaced with xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`].
====
-See xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`] for further discussion.
+See xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`] for further discussion.
@@ -31,7 +31,7 @@ public interface EventSerializer {
}
----
<1> returns an object for maximum flexibility, which is then handed off to the `PublishingService`.
-<2> standard metadata about the event, such as the user, the xref:rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`transactionId`], date/time etc
+<2> standard metadata about the event, such as the user, the xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`transactionId`], date/time etc
<3> for published actions, will generally be an `EventPayloadForActionInvocation` (or subclass thereof); for published objects, will generally be an `EventPayloadForObjectChanged` (or subclass thereof)
It's important to make sure that the publishing service implementation is able to handle the serialized form. Strings are a good lowest common denominator, but in some cases a type-safe equivalent, such as a w3c DOM `Document` or JSON node might be passed instead.
@@ -66,15 +66,15 @@ There is no default implementation of this service provided by the core Apache I
The (non-ASF) http://github.com/isisaddons/isis-module-publishing[Isis addons' publishing] module provides an
implementation of this service (`RestfulObjectsSpecEventSerializer`) that serializes action invocations and published
objects into a format based on the Restful Objects specification. It also (as you might imagine) provides an
-implementation of the xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
+implementation of the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`].
-Assuming that an `AppManifest` is being used to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
+Assuming that an `AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
then this can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
== Related Services
-This service is intended (though not mandated) to be used by implementations of xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]. The (non-ASF) http://github.com/isisaddons/isis-module-publishing[Isis addons' publishing] module does use it (though the (non-ASF)
+This service is intended (though not mandated) to be used by implementations of xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]. The (non-ASF) http://github.com/isisaddons/isis-module-publishing[Isis addons' publishing] module does use it (though the (non-ASF)
http://github.com/isisaddons/isis-module-publishmq[Isis addons' publishmq] module does not).
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ExceptionRecognizer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ExceptionRecognizer.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ExceptionRecognizer.adoc
index 403a64e..85db100 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ExceptionRecognizer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_ExceptionRecognizer.adoc
@@ -97,7 +97,7 @@ If you want to recognize and handle additional exceptions (for example to captur
== Registering the Services
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then the default
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then the default
implementations provided by the framework (`DomainObjectContainerDefault` and
`ExceptionRecognizerCompositeForJdoObjectStore`) will be registered.
@@ -115,5 +115,5 @@ isis.services=...,\
Prior to 1.9.0, the `ExceptionRecognizerCompositeForJdoObjectStore` also required manual registration.
====
-If the JDO exception recognizers are not required (rather unlikely), then they can be disabled en-masse using the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.ExceptionRecognizerCompositeForJdoObjectStore.disable`.
+If the JDO exception recognizers are not required (rather unlikely), then they can be disabled en-masse using the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.ExceptionRecognizerCompositeForJdoObjectStore.disable`.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_FixtureScriptsSpecificationProvider.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_FixtureScriptsSpecificationProvider.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_FixtureScriptsSpecificationProvider.adoc
index dd9c6c9..1c7f7b4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_FixtureScriptsSpecificationProvider.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_FixtureScriptsSpecificationProvider.adoc
@@ -7,11 +7,11 @@
The `FixtureScriptsSpecificationProvider` configures the
-xref:rgsvc.adoc#_rgsvc_api_FixtureScriptsDefault[`FixtureScriptsDefault`] domain service, providing the
+xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FixtureScriptsDefault[`FixtureScriptsDefault`] domain service, providing the
location to search for fixture scripts and other settings.
The service is only used if the `FixtureScriptsDefault` service is instantiated as a fallback by the framework. If
-the application provides its own subclass of xref:rgcms.adoc#_rgcms_classes_super_FixtureScripts[`FixtureScripts`]
+the application provides its own subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScripts[`FixtureScripts`]
superclass, then this provider service is not used.
[TIP]
@@ -56,7 +56,7 @@ The class is immutable but it has a builder (obtained using `FixturescriptsSpeci
== Implementation
-The xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] has a simple implementation of this service:
+The xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] has a simple implementation of this service:
[source,java]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridLoaderService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridLoaderService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridLoaderService.adoc
index dc413bd..310a40c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridLoaderService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridLoaderService.adoc
@@ -22,9 +22,9 @@ public interface GridLoaderService {
}
----
<1> whether dynamic reloading of layouts is enabled. The default implementation enables reloading for prototyping, disables in production
-<2> support metamodel invalidation/rebuilding of spec, eg as called by this xref:rgcms.adoc#__rgcms_classes_mixins_Object_rebuildMetamodel[Object mixin] action.
+<2> support metamodel invalidation/rebuilding of spec, eg as called by this xref:../rgcms/rgcms.adoc#__rgcms_classes_mixins_Object_rebuildMetamodel[Object mixin] action.
<3> whether any persisted layout metadata (eg a `.layout.xml` file) exists for this domain class.
-<4> returns a new instance of a xref:rgcms.adoc#__rgcms_classes_layout_component[`Grid`] for the specified domain class, eg as loaded from a `layout.xml` file. If none exists, will return null (and the calling xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] will use xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] to obtain a default grid for the domain class).
+<4> returns a new instance of a xref:../rgcms/rgcms.adoc#__rgcms_classes_layout_component[`Grid`] for the specified domain class, eg as loaded from a `layout.xml` file. If none exists, will return null (and the calling xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] will use xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] to obtain a default grid for the domain class).
@@ -39,15 +39,15 @@ For example, the layout for a domain class `com.mycompany.myapp.Customer` would
== Registering the Services
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then the
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then the
default implementation of `GridLoaderService` is automatically registered and injected, and no further
configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
-This service is used by xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`].
+This service is used by xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`GridService`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridService.adoc
index 29eadd8..eb0360a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridService.adoc
@@ -8,9 +8,9 @@
The `GridService` provides the ability to load the XML layout (grid) for a domain class. To do this it delegates:
-* to xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] to load a pre-existing layout for the domain class, if possible
+* to xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] to load a pre-existing layout for the domain class, if possible
-* to xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] to normalize the grid with respect to Apache
+* to xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] to normalize the grid with respect to Apache
Isis' internal metamodel, in other words to ensure that all of the domain objects' properties, collections and actions are associated with regions of the grid.
Once a grid has been loaded for a domain class, this is cached internally by Apache Isis' internal meta model (in the
@@ -34,15 +34,15 @@ public interface GridService {
}
----
<1> whether dynamic reloading of layouts is enabled. The default implementation enables reloading for prototyping, disables in production
-<2> support metamodel invalidation/rebuilding of spec, eg as called by this xref:rgcms.adoc#__rgcms_classes_mixins_Object_rebuildMetamodel[Object mixin] action.
-<3> whether any persisted layout metadata (eg a `.layout.xml` file) exists for this domain class. Just delegates to corresponding method in xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`].
-<4> returns a new instance of a xref:rgcms.adoc#__rgcms_classes_layout_component[`Grid`] for the specified domain class, eg as loaded from a `layout.xml` file. If none exists, will return null (and the calling xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] will use xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] to obtain a default grid for the domain class).
+<2> support metamodel invalidation/rebuilding of spec, eg as called by this xref:../rgcms/rgcms.adoc#__rgcms_classes_mixins_Object_rebuildMetamodel[Object mixin] action.
+<3> whether any persisted layout metadata (eg a `.layout.xml` file) exists for this domain class. Just delegates to corresponding method in xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`].
+<4> returns a new instance of a xref:../rgcms/rgcms.adoc#__rgcms_classes_layout_component[`Grid`] for the specified domain class, eg as loaded from a `layout.xml` file. If none exists, will return null (and the calling xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] will use xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] to obtain a default grid for the domain class).
<5> returns a default grid, eg two columns in ratio 4:8. Used when no existing grid layout exists for a domain class.
-<6> validates and normalizes a grid, modifying the grid so that all of the domain object's members (properties, collections, actions) are bound to regions of the grid. This is done using existing metadata, most notably that of the xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation. Such a grid, if persisted as the layout XML file for the domain class, allows the `@MemberOrder` annotation to be removed from the source code of the domain class (but other annotations must be retained).
-<7> Takes a normalized grid and enriches it with additional metadata (taken from Apache Isis' internal metadata) that can be represented in the layout XML. Such a grid, if persisted as the layout XML file for the domain class, allows all layout annotations (xref:rgant.adoc#_rgant-ActionLayout[`@ActionLayout`], xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] and xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`]) to be removed from the source code of the domain class.
-<8> Takes a normalized grid and strips out removes all members, leaving only the grid structure. Such a grid, if persisted as the layout XML file for the domain class, requires that the xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation is retained in the source code of said class in order to bind members to the regions of the grid.
+<6> validates and normalizes a grid, modifying the grid so that all of the domain object's members (properties, collections, actions) are bound to regions of the grid. This is done using existing metadata, most notably that of the xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation. Such a grid, if persisted as the layout XML file for the domain class, allows the `@MemberOrder` annotation to be removed from the source code of the domain class (but other annotations must be retained).
+<7> Takes a normalized grid and enriches it with additional metadata (taken from Apache Isis' internal metadata) that can be represented in the layout XML. Such a grid, if persisted as the layout XML file for the domain class, allows all layout annotations (xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`], xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] and xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`]) to be removed from the source code of the domain class.
+<8> Takes a normalized grid and strips out removes all members, leaving only the grid structure. Such a grid, if persisted as the layout XML file for the domain class, requires that the xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation is retained in the source code of said class in order to bind members to the regions of the grid.
-The first four methods just delegate to the corresponding methods in xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`], while the last four delegate to the corresponding method in xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`]. The service inspects the ``Grid``'s concrete class to determine which actual `GridSystemService` instance to delegate to.
+The first four methods just delegate to the corresponding methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`], while the last four delegate to the corresponding method in xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`]. The service inspects the ``Grid``'s concrete class to determine which actual `GridSystemService` instance to delegate to.
== Implementation
@@ -53,20 +53,20 @@ The framework provides a default implementation of this service, namely `GridSer
== Registering the Services
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then the
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then the
default implementation of `GridLoaderService` is automatically registered and injected, and no further
configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
That said, there should be little reason to use a different implementation; if behaviour does need to be changed, it would also be possible to replace the implementation of either the `GridLoaderService` or the `GridSystemService`.
== Related Services
-This service calls xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] and xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`].
+This service calls xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] and xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`].
-This service is called by xref:rgsvc.adoc#_rgsvc_api_LayoutService[`LayoutService`], exposed in the UI through `LayoutServiceMenu` (to download the layout XML as a zip file for all domain objects) and the xref:rgcms.adoc#_rgcms_classes_mixins_Object[`downloadLayoutXml()`] mixin (to download the layout XML for a single domain
+This service is called by xref:../rgsvc/rgsvc.adoc#_rgsvc_api_LayoutService[`LayoutService`], exposed in the UI through `LayoutServiceMenu` (to download the layout XML as a zip file for all domain objects) and the xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[`downloadLayoutXml()`] mixin (to download the layout XML for a single domain
object).
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridSystemService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridSystemService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridSystemService.adoc
index a4e09d8..d610cee 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridSystemService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_GridSystemService.adoc
@@ -18,7 +18,7 @@ The framework provides a single such grid implementation, namely for Bootstrap3.
Unlike most other domain services, the framework will check _all_ available implementations of `GridSystemService` to
obtain available grid systems, rather than merely the first implementation found; in other words it uses the
chain-of-responsibility pattern. Services are called in the order defined by
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`]).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`]).
Note though that each concrete implementation must also provide corresponding Wicket viewer components capable of
interpreting the grid layout.
@@ -42,14 +42,14 @@ public interface GridSystemService<G extends Grid> {
}
----
<1> The concrete subclass of `Grid` supported by this implementation. As noted in the introduction, there can be multiple implementations of this service, but there can only be one implementation per concrete subclass. As is normal practice,
-the service with the lowest xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] takes precedence.
+the service with the lowest xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] takes precedence.
<2> the target namespace for this grid system. This is used when generating the XML. The Bootstrap3 grid system provided by the framework returns the value `http://isis.apache.org/applib/layout/grid/bootstrap3`.
<3> the schema location for the XSD. The Bootstrap3 grid system provided by the framework returns the value `http://isis.apache.org/applib/layout/grid/bootstrap3/bootstrap3.xsd`.
<4> a default grid, eg two columns in ratio 4:8. Used when no existing grid layout exists for a domain class.
-<5> Validates and normalizes a grid, modifying the grid so that all of the domain object's members (properties, collections, actions) are bound to regions of the grid. This is done using existing metadata, most notably that of the xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation. Such a grid, if persisted as the layout XML file for the domain class, allows the
+<5> Validates and normalizes a grid, modifying the grid so that all of the domain object's members (properties, collections, actions) are bound to regions of the grid. This is done using existing metadata, most notably that of the xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation. Such a grid, if persisted as the layout XML file for the domain class, allows the
`@MemberOrder` annotation to be removed from the source code of the domain class (but other annotations must be retained).
-<6> Takes a normalized grid and enriches it with additional metadata (taken from Apache Isis' internal metadata) that can be represented in the layout XML. Such a grid, if persisted as the layout XML file for the domain class, allows all layout annotations (xref:rgant.adoc#_rgant-ActionLayout[`@ActionLayout`], xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] and xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`]) to be removed from the source code of the domain class.
-<7> Takes a normalized grid and strips out removes all members, leaving only the grid structure. Such a grid, if persisted as the layout XML file for the domain class, requires that the xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation is retained in the source code of said class in order to bind members to the regions of the grid.
+<6> Takes a normalized grid and enriches it with additional metadata (taken from Apache Isis' internal metadata) that can be represented in the layout XML. Such a grid, if persisted as the layout XML file for the domain class, allows all layout annotations (xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`], xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] and xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`]) to be removed from the source code of the domain class.
+<7> Takes a normalized grid and strips out removes all members, leaving only the grid structure. Such a grid, if persisted as the layout XML file for the domain class, requires that the xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation is retained in the source code of said class in order to bind members to the regions of the grid.
== Implementation
@@ -61,15 +61,15 @@ also provides xref:ugvw.adoc[Wicket viewer] components that are capable of inter
== Registering the Services
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then the
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), then the
Bootstrap3 default implementation of `GridSystemService` is automatically registered and injected, and no further
configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
-This service is used by xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`].
+This service is used by xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`GridService`].
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_HintStore.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_HintStore.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_HintStore.adoc
index c8af9d9..34bfcca 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_HintStore.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_HintStore.adoc
@@ -30,7 +30,7 @@ public interface HintStore {
}
----
<1> obtain a hint (eg which tab to open) for a particular object. Object identity is represented by `Bookmark`, as
-per the xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`], so that alternative implementations can easily serialize this state to a string.
+per the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`], so that alternative implementations can easily serialize this state to a string.
<2> set the state of a hint. (The value of) all hints are represented as strings.
<3> remove a single hint for an object;
<4> remove all hints
@@ -48,17 +48,17 @@ The core framework provides a default implementation of this service (`org.apach
== Registering the Service
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core
implementation of `HintStore` service is automatically registered and injected (it is annotated with
`@DomainService`) so no further configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
-The xref:ugvw.adoc[Wicket viewer] exposes the xref:rgcms.adoc#__rgcms_classes_mixins_Object_clearHints["clear hints"]
+The xref:ugvw.adoc[Wicket viewer] exposes the xref:../rgcms/rgcms.adoc#__rgcms_classes_mixins_Object_clearHints["clear hints"]
mixin action that is for use by end-users of the application to clear any UI hints that have accumulated for a
domain object.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_LocaleProvider.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_LocaleProvider.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_LocaleProvider.adoc
index a0155a1..a31b079 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_LocaleProvider.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_spi_LocaleProvider.adoc
@@ -6,7 +6,7 @@
-The `LocaleProvider` service is one of the services that work together to implement Apache Isis' support for i18n, being used by Isis' default implementation of xref:rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`].
+The `LocaleProvider` service is one of the services that work together to implement Apache Isis' support for i18n, being used by Isis' default implementation of xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`].
The role of the service itself is simply to return the `Locale` of the current user.
@@ -30,7 +30,7 @@ public interface LocaleProvider {
}
----
-This is notionally request-scoped, returning the `Locale` of the current user; _not_ that of the server. (Note that the implementation is not required to actually be xref:rgant.adoc#_rgant-RequestScoped[`@RequestScoped`], however).
+This is notionally request-scoped, returning the `Locale` of the current user; _not_ that of the server. (Note that the implementation is not required to actually be xref:../rgant/rgant.adoc#_rgant-RequestScoped[`@RequestScoped`], however).
@@ -50,20 +50,20 @@ Currently there is no equivalent implementation for the xref:ugvro.adoc#[Restful
== Registering the Services
Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the
-`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), __and__ that the
+`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]), __and__ that the
xref:ugvw.adoc#[Wicket viewer] is being used, then an implementation of `LocaleProvider` is
automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required.
To use an alternative implementation, use
-xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
-in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
+xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained
+in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
-This service works in conjunction with xref:rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`] and xref:rgsvc.adoc#_rgsvc_spi_TranslationsResolver[`TranslationsResolver`] in order to provide i18n support.
+This service works in conjunction with xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`] and xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_TranslationsResolver[`TranslationsResolver`] in order to provide i18n support.