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/03/08 05:35:11 UTC
[2/4] isis git commit: ISIS-1594: fixes anchors for extension point's
conventions
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_EventBusService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_EventBusService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_EventBusService.adoc
index e8b6763..3d325f7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_EventBusService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_EventBusService.adoc
@@ -24,7 +24,7 @@ Two implementations are available, using either link:https://code.google.com/p/g
-[[_rgsvc_api_EventBusService_api-and-implementation]]
+[[__rgsvc_api_EventBusService_api-and-implementation]]
== API & Implementation
The API defined by `EventBusService` is:
@@ -52,7 +52,7 @@ Isis provides a default implementation of the service, `o.a.i.objectstore.jdo.da
== Registering Subscribers
-The `register()` method should be called in the xref:rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] lifecycle method. It is valid and probably the least confusing to readers to also "unregister" in the xref:rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] lifecycle method (though as noted xref:rgsvc.adoc#_rgsvc_api_EventBusService_api-and-implementation[above], unregistering is actually a no-op).
+The `register()` method should be called in the xref:rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] lifecycle method. It is valid and probably the least confusing to readers to also "unregister" in the xref:rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] lifecycle method (though as noted xref:rgsvc.adoc#__rgsvc_api_EventBusService_api-and-implementation[above], unregistering is actually a no-op).
For example:
@@ -149,7 +149,7 @@ public class LibraryMember {
...
}
----
-<1> `LibraryMemberLeaveEvent` is a subclass of `o.a.i.applib.eventbus.ActionDomainEvent`. The topic of subclassing is discussed in more detail xref:rgsvc.adoc#_rgsvc_api_EventBusService_event-hierarchy[below].
+<1> `LibraryMemberLeaveEvent` is a subclass of `o.a.i.applib.eventbus.ActionDomainEvent`. The topic of subclassing is discussed in more detail xref:rgsvc.adoc#__rgsvc_api_EventBusService_event-hierarchy[below].
Meanwhile, in the `BookRepository` domain service, we subscribe to the event and act upon it. For example:
@@ -173,7 +173,7 @@ This design allows the `libraryMember` module to be decoupled from the `book` mo
-[[_rgsvc_api_EventBusService_event-hierarchy]]
+[[__rgsvc_api_EventBusService_event-hierarchy]]
== Event hierarchy
By creating domain event subtypes we can be more semantically precise and in turn providesmore flexibility for subscribers: they can choose whether to be broadly applicable (by subscribing to a superclass) or to be tightly focussed (by subscribing to a subclass).
@@ -315,7 +315,7 @@ public class ReserveStockSubscriber {
== Implementation SPI
-The implementation of `EventBusService` provided by Apache Isis will by default use link:https://code.google.com/p/guava-libraries/[Guava]'s https://code.google.com/p/guava-libraries/wiki/EventBusExplained[`EventBus`] as the underlying in-memory event bus. Alternatively the link:http://www.axonframework.org/[AxonFramework]'s link:http://www.axonframework.org/docs/2.4/single.html#d5e1489[SimpleEventBus] can be used. Which is used is specified through configuration property (described xref:rgsvc.adoc#_rgsvc_api_EventBusService_Configuration[below]).
+The implementation of `EventBusService` provided by Apache Isis will by default use link:https://code.google.com/p/guava-libraries/[Guava]'s https://code.google.com/p/guava-libraries/wiki/EventBusExplained[`EventBus`] as the underlying in-memory event bus. Alternatively the link:http://www.axonframework.org/[AxonFramework]'s link:http://www.axonframework.org/docs/2.4/single.html#d5e1489[SimpleEventBus] can be used. Which is used is specified through configuration property (described xref:rgsvc.adoc#__rgsvc_api_EventBusService_Configuration[below]).
[NOTE]
.Guava vs Axon, which to use?
@@ -343,7 +343,7 @@ If you do provide your own implementation of this SPI, be aware that your subscr
-[[_rgsvc_api_EventBusService_Configuration]]
+[[__rgsvc_api_EventBusService_Configuration]]
== Configuration
The implementation of `EventBusService` provided by Apache Isis will by default use link:https://code.google.com/p/guava-libraries/[Guava]'s https://code.google.com/p/guava-libraries/wiki/EventBusExplained[`EventBus`] as the underlying in-memory event bus. Alternatively the link:http://www.axonframework.org/[AxonFramework]'s link:http://www.axonframework.org/docs/2.4/single.html#d5e1489[SimpleEventBus] can be used.
@@ -393,7 +393,7 @@ implementation of `EventBusService` service is automatically registered and inje
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_FactoryService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_FactoryService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_FactoryService.adoc
index f490bf4..fc15140 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_FactoryService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_FactoryService.adoc
@@ -67,7 +67,7 @@ implementation of `FactoryService` service is automatically registered and injec
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_GuiceBeanProvider.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_GuiceBeanProvider.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_GuiceBeanProvider.adoc
index 33102de..a004dfd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_GuiceBeanProvider.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_GuiceBeanProvider.adoc
@@ -86,6 +86,6 @@ automatically registered and injected (it is annotated with `@DomainService`) so
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_InteractionContext.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_InteractionContext.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_InteractionContext.adoc
index 7cd7864..a59ce85 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_InteractionContext.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_InteractionContext.adoc
@@ -180,7 +180,7 @@ xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`].
[NOTE]
====
Unlike the similar xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] (discussed
-xref:rgsvc.adoc#_rgsvc_api_InteractionContext_Related-Classes[below]) there is no domain service to different
+xref:rgsvc.adoc#__rgsvc_api_InteractionContext_Related-Classes[below]) there is no domain service to different
implementations of `Interaction` to be used. If this were to be needed, then a custom implementation of
xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`] could always used).
====
@@ -188,7 +188,7 @@ implementations of `Interaction` to be used. If this were to be needed, then a
-[[_rgsvc_api_InteractionContext_Related-Classes]]
+[[__rgsvc_api_InteractionContext_Related-Classes]]
== Related Classes
This service is very similar in nature to xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`], in that the
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_IsisJdoSupport.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_IsisJdoSupport.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_IsisJdoSupport.adoc
index 60461f9..ec94584 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_IsisJdoSupport.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_IsisJdoSupport.adoc
@@ -12,7 +12,7 @@ The following sections discuss the functionality provided by the service, broken
-[[_rgsvc_api_IsisJdoSupport_executing-sql]]
+[[__rgsvc_api_IsisJdoSupport_executing-sql]]
== Executing SQL
You can use the `IsisJdoSupportService` to perform arbitrary SQL SELECTs or UPDATEs:
@@ -50,13 +50,13 @@ The returned value is the number of rows updated.
[TIP]
====
-As an alternative, consider using DataNucleus' link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[type-safe JDO query API], discussed xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport_type-safe-query-api[below].
+As an alternative, consider using DataNucleus' link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[type-safe JDO query API], discussed xref:rgsvc.adoc#__rgsvc_api_IsisJdoSupport_type-safe-query-api[below].
====
-[[_rgsvc_api_IsisJdoSupport_type-safe-jdoql-queries]]
+[[__rgsvc_api_IsisJdoSupport_type-safe-jdoql-queries]]
== Type-safe JDOQL Queries
DataNucleus provides an link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[extension to JDO], so that JDOQL queries can be built up and executed using a set of type-safe classes.
@@ -129,10 +129,10 @@ private static <T> List<T> executeListAndClose(final TypesafeQuery<T> query) {
-[[_rgsvc_api_IsisJdoSupport_fixture-support]]
+[[__rgsvc_api_IsisJdoSupport_fixture-support]]
== Fixture support
-When writing xref:ugtst.adoc#_ugtst_integ-test-support[integration tests] you'll usually need to tear down some/all mutable transactional data before each test. One way to do that is to use the `executeUpdate(...)` method described xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport_executing-sql[above].
+When writing xref:ugtst.adoc#_ugtst_integ-test-support[integration tests] you'll usually need to tear down some/all mutable transactional data before each test. One way to do that is to use the `executeUpdate(...)` method described xref:rgsvc.adoc#__rgsvc_api_IsisJdoSupport_executing-sql[above].
Alternatively, the `deleteAll(...)` method will let your test delete all instances of a class without resorting to SQL:
@@ -173,7 +173,7 @@ is temporarily disabled while this method is performed.
-[[_rgsvc_api_IsisJdoSupport_reloading-entities]]
+[[__rgsvc_api_IsisJdoSupport_reloading-entities]]
== Reloading entities
An http://www.datanucleus.org/products/datanucleus/jdo/orm/relationships.html[(intentional) limitation] of JDO/DataNucleus is that persisting a child entity (in a 1:n bidirectional relationship) does not cause the parent's collection to be updated.
@@ -234,7 +234,7 @@ The `ensureLoaded(...)` method allows a collection of domain objects to be loade
-[[_rgsvc_api_IsisJdoSupport_jdo-persistencemanager]]
+[[__rgsvc_api_IsisJdoSupport_jdo-persistencemanager]]
== JDO `PersistenceManager`
The functionality provided by `IsisJdoSupport` focus only on the most common use cases. If you require more flexibility than this, eg for dynamically constructed queries, then you can use the service to access the underlying JDO `PersistenceManager` API:
@@ -273,4 +273,4 @@ implementation of `IsisJdoSupport` service is automatically registered and injec
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_JaxbService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_JaxbService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_JaxbService.adoc
index 7bfdeb8..755895a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_JaxbService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_JaxbService.adoc
@@ -13,7 +13,7 @@ unmarshalled from XML back into domain objects.
-[[_rgsvc_api_JaxbService_api-and-implementation]]
+[[__rgsvc_api_JaxbService_api-and-implementation]]
== API & Implementation
The API defined by `JaxbService` is:
@@ -64,5 +64,5 @@ 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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_LayoutService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_LayoutService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_LayoutService.adoc
index df5a1bb..d443615 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_LayoutService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_LayoutService.adoc
@@ -7,11 +7,11 @@
The `LayoutService` provides the ability to obtain the XML layout for a single domain object or for all domain
-objects. This functionality is surfaced through the user interface through a related xref:_rgsvc_api_LayoutService_related-mixins-and-menus[mixin and menu action].
+objects. This functionality is surfaced through the user interface through a related xref:__rgsvc_api_LayoutService_related-mixins-and-menus[mixin and menu action].
-[[_rgsvc_api_LayoutService_api-and-implementation]]
+[[__rgsvc_api_LayoutService_api-and-implementation]]
== API & Implementation
The API defined by `LayoutService` is:
@@ -83,7 +83,7 @@ As a developer, you therefore have a choice as to how you provide the metadata r
-[[_rgsvc_api_LayoutService_related-mixins-and-menus]]
+[[__rgsvc_api_LayoutService_related-mixins-and-menus]]
== Related Mixins and Menus
The service's functionality is exposed in the UI through a mixin (per object) and a menu action (for all objects):
@@ -99,7 +99,7 @@ desired.
-[[_rgsvc_api_LayoutService_related-domain-services]]
+[[__rgsvc_api_LayoutService_related-domain-services]]
== Related Domain Services
The xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] is responsible for loading and normalizing layout XML for
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MementoService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MementoService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MementoService.adoc
index 2c43ede..d52c43b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MementoService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MementoService.adoc
@@ -143,4 +143,4 @@ implementation of `MementoService` service is automatically registered and injec
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MessageService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MessageService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MessageService.adoc
index 104100f..2acc924 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MessageService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MessageService.adoc
@@ -72,7 +72,7 @@ implementation of `MessageService` service is automatically registered and injec
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MetamodelService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MetamodelService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MetamodelService.adoc
index 69e9ebb..f1d5b8c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MetamodelService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_MetamodelService.adoc
@@ -58,7 +58,7 @@ implementation of `MetamodelService` service is automatically registered and inj
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_QueryResultsCache.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_QueryResultsCache.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_QueryResultsCache.adoc
index c537a32..27c30ee 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_QueryResultsCache.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_QueryResultsCache.adoc
@@ -117,7 +117,7 @@ implementation of `QueryResultsCache` service is automatically registered and in
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_RepositoryService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_RepositoryService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_RepositoryService.adoc
index 437c1c0..64d5a11 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_RepositoryService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_RepositoryService.adoc
@@ -261,7 +261,7 @@ implementation of `RepositoryService` service is automatically registered and in
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_Scratchpad.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_Scratchpad.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_Scratchpad.adoc
index 56773b9..4d170b3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_Scratchpad.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_Scratchpad.adoc
@@ -115,7 +115,7 @@ 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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_ServiceRegistry.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_ServiceRegistry.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_ServiceRegistry.adoc
index e7ccf5c..7916878 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_ServiceRegistry.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_ServiceRegistry.adoc
@@ -70,6 +70,6 @@ implementation of `ServiceRegistry` service is automatically registered and inje
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SessionManagementService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SessionManagementService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SessionManagementService.adoc
index b0dd287..8d263eb 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SessionManagementService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SessionManagementService.adoc
@@ -53,4 +53,4 @@ implementation of `SessionManagementService` service is automatically registered
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SudoService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SudoService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SudoService.adoc
index 8a67b14..0020008 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SudoService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SudoService.adoc
@@ -37,7 +37,7 @@ The current user/role reported by the internal xref:rgfis.adoc#_rgfis_spi_Authen
[IMPORTANT]
====
Note however that this the "effective user" does not propagate through to the xref:ugsec.adoc#[Shiro security mechanism], which will continue to be evaluated according to the permissions of the current user.
-See the xref:rgsvc.adoc#_rgsvc_api_SudoService_ACCESS-ALL-ROLE[`ACCESS-ALL-ROLE`] below for details of how to circumvent this.
+See the xref:rgsvc.adoc#__rgsvc_api_SudoService_ACCESS-ALL-ROLE[`ACCESS-ALL-ROLE`] below for details of how to circumvent this.
====
@@ -67,7 +67,7 @@ protected void execute(final ExecutionContext ec) {
----
-[[_rgsvc_api_SudoService_ACCESS-ALL-ROLE]]
+[[__rgsvc_api_SudoService_ACCESS-ALL-ROLE]]
=== ACCESS_ALL_ROLE
When `sudo(...)` is called the "effective user" is reported by both xref:rgsvc.adoc#_rgsvc_api_UserService[`UserService`] and by xref:rgfis.adoc#_rgfis_spi_AuthenticationSessionProvider[`AuthenticationSessionProvider`], but does not propagate through to the xref:ugsec.adoc#[Shiro security mechanism].
@@ -134,4 +134,4 @@ implementation of `SudoService` service is automatically registered and injected
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SwaggerService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SwaggerService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SwaggerService.adoc
index 985eff2..c376675 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SwaggerService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_SwaggerService.adoc
@@ -17,7 +17,7 @@ Not all of the REST API exposed by the xref:ugvro.adoc#[Restful Objects viewer]
-[[_rgsvc_api_SwaggerService_api-and-implementation]]
+[[__rgsvc_api_SwaggerService_api-and-implementation]]
== API & Implementation
The API defined by `SwaggerService` is:
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TitleService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TitleService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TitleService.adoc
index 0e76a70..feb1383 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TitleService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TitleService.adoc
@@ -69,6 +69,6 @@ implementation of `TitleService` service is automatically registered and injecte
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TransactionService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TransactionService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TransactionService.adoc
index 960cd79..0eff151 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TransactionService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_TransactionService.adoc
@@ -94,4 +94,4 @@ implementation of `TransactionService` service is automatically registered and i
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc
index 78fbe53..ba5080c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc
@@ -79,7 +79,7 @@ implementation of `UserService` service is automatically registered and injected
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_WrapperFactory.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_WrapperFactory.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_WrapperFactory.adoc
index 9bc22d9..2114742 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_WrapperFactory.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_WrapperFactory.adoc
@@ -159,4 +159,4 @@ implementation of `WrapperFactory` service is automatically registered and injec
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_XmlSnapshotService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_XmlSnapshotService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_XmlSnapshotService.adoc
index 2eca3d1..f29c93b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_XmlSnapshotService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_XmlSnapshotService.adoc
@@ -200,7 +200,7 @@ implementation of `XmlSnapshotService` service is automatically registered and i
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_intro.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_intro.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_intro.adoc
index eda53ac..0df67dc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_intro.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_intro.adoc
@@ -7,7 +7,7 @@
-[[_rgsvc_intro_types-of-domain-services]]
+[[__rgsvc_intro_types-of-domain-services]]
== Types of Domain Service
The domain services also group into various broad categories. Many support functionality of the various layers of the
@@ -32,7 +32,7 @@ service.
-[[_rgsvc_intro_public-api]]
+[[__rgsvc_intro_public-api]]
== Public API vs Internal Services
The vast majority of Apache Isis' domain services are defined in Apache Isis' applib (`o.a.i.core:isis-core-applib`
@@ -48,7 +48,7 @@ are documented in the xref:rgfis.adoc#[Framework Internal Services] guide.
-[[_rgsvc_intro_using-the-services]]
+[[__rgsvc_intro_using-the-services]]
== Using the services
Apache Isis includes an extensive number of domain services for your domain objects to use; simply define the service
@@ -89,7 +89,7 @@ xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s ``in
-[[_rgsvc_intro_overriding-the-services]]
+[[__rgsvc_intro_overriding-the-services]]
== Overriding the services
The framework provides default implementations for many of the domain services. This is convenient, but sometimes you
@@ -159,7 +159,7 @@ The above code could be improved by caching the delegateLocaleProvider once loca
-[[_rgsvc_intro_commands-and-events]]
+[[__rgsvc_intro_commands-and-events]]
== Command and Events
A good number of the domain services manage the execution of action invocations/property edits, along with the state
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_ClassDiscoveryService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_ClassDiscoveryService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_ClassDiscoveryService.adoc
index 852ca9a..7727dc8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_ClassDiscoveryService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_ClassDiscoveryService.adoc
@@ -77,6 +77,6 @@ implementation of `ClassDiscoveryService2` service is automatically registered a
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_EmailNotificationService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_EmailNotificationService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_EmailNotificationService.adoc
index e096749..bab1247 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_EmailNotificationService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_EmailNotificationService.adoc
@@ -70,7 +70,7 @@ implementation of `EmailNotificationService` service is automatically registered
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridLoaderService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridLoaderService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridLoaderService.adoc
index f3fc782..5c0e1a6 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridLoaderService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_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.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.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).
@@ -45,7 +45,7 @@ Assuming that the `configuration-and-annotation` services installer is configure
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridService.adoc
index 91ff854..c9415df 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridService.adoc
@@ -34,9 +34,9 @@ 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.
+<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).
+<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).
<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.
@@ -59,7 +59,7 @@ Assuming that the `configuration-and-annotation` services installer is configure
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).
+in the xref: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`.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridSystemService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridSystemService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridSystemService.adoc
index 7538d8f..325fa2b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridSystemService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_GridSystemService.adoc
@@ -67,7 +67,7 @@ Assuming that the `configuration-and-annotation` services installer is configure
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
== Related Services
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_HintStore.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_HintStore.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_HintStore.adoc
index 1ea64e4..62c56d5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_HintStore.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_HintStore.adoc
@@ -54,11 +54,11 @@ implementation of `HintStore` service is automatically registered and injected (
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).
+in the xref: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.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/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_LocaleProvider.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_LocaleProvider.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_LocaleProvider.adoc
index 1e61213..45789fc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_LocaleProvider.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_LocaleProvider.adoc
@@ -56,7 +56,7 @@ automatically registered and injected (it is annotated with `@DomainService`) so
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_RoutingService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_RoutingService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_RoutingService.adoc
index 643630d..7bc2527 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_RoutingService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_RoutingService.adoc
@@ -59,7 +59,7 @@ if a `null` or `void` was provided. It uses the xref:rgsvc.adoc#_rgsvc_api_Home
There can be multiple implementations of `RoutingService` registered. These are checked in turn (chain of responsibility
pattern), ordered according to xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`]
-(as explained in the xref:rgsvc.adoc#_rgsvc_intro_overriding-the-services[introduction] to this guide).
+(as explained in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
The route from the first service that returns `true` from its `canRoute(...)` method will be used.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationService.adoc
index 7cf4788..2fa6757 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationService.adoc
@@ -68,12 +68,12 @@ If the menu items are not required then these can be suppressed either using sec
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
-[[_rgsvc_api_LayoutService_related-mixins-and-menus]]
+[[__rgsvc_api_LayoutService_related-mixins-and-menus]]
== Related Menus
The `TranslationServicePoMenu` menu exposes the `TranslationServicePo` service's `toPot()` method so that all
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationsResolver.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationsResolver.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationsResolver.adoc
index 23acfab..bcb03cb 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationsResolver.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_TranslationsResolver.adoc
@@ -52,7 +52,7 @@ automatically registered and injected (it is annotated with `@DomainService`) so
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_UrlEncodingService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_UrlEncodingService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_UrlEncodingService.adoc
index 662e24f..87feec9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_UrlEncodingService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_UrlEncodingService.adoc
@@ -55,5 +55,5 @@ cases register an alternative implementation of this service.
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).
+in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_tg_stop-scaffolding-start-coding.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_tg_stop-scaffolding-start-coding.adoc b/adocs/documentation/src/main/asciidoc/guides/_tg_stop-scaffolding-start-coding.adoc
index 9fb343d..c98ca9b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_tg_stop-scaffolding-start-coding.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_tg_stop-scaffolding-start-coding.adoc
@@ -668,7 +668,7 @@ Isis has great support for writing xref:ugtst.adoc#_ugtst_integ-test-support[int
The REST API generated by Apache Isis conforms to the Restful Objects specification. Apache Isis 1.8.0 provides experimental support to allow the representations to be customized.
-* as per xref:ugvro.adoc#_ugvro_simplified-representations_configuration-properties[the documentation], configure the Restful Objects viewer to generate a simplified object representation: +
+* as per xref:ugvro.adoc#__ugvro_simplified-representations_configuration-properties[the documentation], configure the Restful Objects viewer to generate a simplified object representation: +
+
[source,ini]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_decoupling_mixins.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_decoupling_mixins.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_decoupling_mixins.adoc
index 68c673b..a8652dd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_decoupling_mixins.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_decoupling_mixins.adoc
@@ -229,7 +229,7 @@ method. For example:
DocumentHolder_documents mixin = container.mixin(DocumentHolder_documents.class, customer);
----
-The xref:ugtst.adoc#_ugtst_integ-test-support_bootstrapping_IntegrationTestAbstract[`IntegrationTestAbstract`] and
+The xref:ugtst.adoc#__ugtst_integ-test-support_bootstrapping_IntegrationTestAbstract[`IntegrationTestAbstract`] and
xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`] classes both provide a `mixin(...)` convenience
method.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_externalized-configuration.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_externalized-configuration.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_externalized-configuration.adoc
index 17c71ae..a68fb01 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_externalized-configuration.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_externalized-configuration.adoc
@@ -43,7 +43,7 @@ Each of these frameworks has its own way of externalizing its configuration.
-[[_ugbtb_deployment_externalized-configuration_Isis]]
+[[__ugbtb_deployment_externalized-configuration_Isis]]
== Apache Isis' Config
To tell Apache Isis to load configuration from an external directory, specify the `isis.config.dir` context parameter.
@@ -88,7 +88,7 @@ Note that running the app using Apache Isis' `org.apache.isis.WebServer` bootstr
-[[_ugbtb_deployment_externalized-configuration_Shiro]]
+[[__ugbtb_deployment_externalized-configuration_Shiro]]
== Shiro Config
If using Apache Isis' xref:ugsec.adoc#_ugsec_configuring-isis-to-use-shiro[Shiro integration] for authentication and/or authorization, note that it reads from the `shiro.ini` configuration file. By default this also resides in `WEB-INF`.
@@ -112,7 +112,7 @@ Note that Shiro is more flexible than Apache Isis; it will read its configuratio
-[[_ugbtb_deployment_externalized-configuration_Log4j]]
+[[__ugbtb_deployment_externalized-configuration_Log4j]]
== Log4j Config
By default Apache Isis configures log4j to read the `logging.properties` file in the `WEB-INF` directory. This can be overridden by setting the `log4j.properties` system property to the URL of the log4j properties file.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_jvm-flags.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_jvm-flags.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_jvm-flags.adoc
index e36a1f8..801daa4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_jvm-flags.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_deployment_jvm-flags.adoc
@@ -48,5 +48,5 @@ There are also a whole bunch of GC-related flags, that you might want to explore
## Configuring in Tomcat
-If using Tomcat, update the `CATALINA_OPTS` variable. (This variable is also updated if xref:ugbtb.adoc#_ugbtb_deployment_externalized-configuration_Log4j[configuring logging to run externally]).
+If using Tomcat, update the `CATALINA_OPTS` variable. (This variable is also updated if xref:ugbtb.adoc#__ugbtb_deployment_externalized-configuration_Log4j[configuring logging to run externally]).
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_i18n.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_i18n.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_i18n.adoc
index 6f12a75..abb4f62 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_i18n.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_i18n.adoc
@@ -14,7 +14,7 @@ The xref:ugvw.adoc#[Wicket viewer] (that is, its labels and messages) is also in
Isis does not translate the values of your domain objects, though. So, if you have a domain concept such as `Country` whose name is intended to be localized according to the current user, you will need to model this yourself.
-[[_ugbtb_i18n_implementation-approach]]
+[[__ugbtb_i18n_implementation-approach]]
== Implementation Approach
Most Java frameworks tackle i18n by using Java's own `ResourceBundle` API. However, there are some serious drawbacks in this approach, including:
@@ -50,7 +50,7 @@ In Apache Isis' implementation, if the translation is missing from the `.po` fil
-[[_ugbtb_i18n_translation-service]]
+[[__ugbtb_i18n_translation-service]]
== `TranslationService`
The cornerstone of Apache Isis' support for i18n is the `TranslationService` service. This is defined in the applib with the following API:
@@ -102,7 +102,7 @@ When running in write mode the original text is returned to the caller untransla
-[[_ugbtb_i18n_imperative-messages]]
+[[__ugbtb_i18n_imperative-messages]]
== Imperative messages
The `TranslationService` is used internally by Apache Isis when building up the metamodel; the name and description of every class, property, collection, action and action parameter is automatically translated. Thus the simple act of bootstrapping Apache Isis will cause most of the messages requiring translation (that is: those for the Apache Isis metamodel) to be captured by the `TranslationService`.
@@ -220,7 +220,7 @@ public interface TranslatableException {
-[[_ugbtb_i18n_wicket-viewer]]
+[[__ugbtb_i18n_wicket-viewer]]
== Wicket Viewer
The xref:ugvw.adoc#[Wicket viewer] (its labels and messages) is also internationalized using
@@ -474,7 +474,7 @@ msgstr "Username"
-[[_ugbtb_i18n_integration-testing]]
+[[__ugbtb_i18n_integration-testing]]
== Integration Testing
So much for the API; but as noted, it is also necessary to ensure that the required translations are recorded (by the `TranslationService`) into the `.pot` file.
@@ -558,7 +558,7 @@ public Integer getQuantity() { ... }
-[[_ugbtb_i18n_configuration]]
+[[__ugbtb_i18n_configuration]]
== Configuration
There are several different aspects of the translation service that can be configured.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_jaxb.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_jaxb.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_jaxb.adoc
index 5527e4f..16d15ae 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_jaxb.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_jaxb.adoc
@@ -59,20 +59,20 @@ public class ToDoItemV1_1 implements Dto { // <5>
protected List<ToDoItem> similarItems = Lists.newArrayList();
}
----
-<1> package name encodes major version; see discussion on xref:ugbtb.adoc#_ugbtb_view-models_jaxb_versioning[versioning]
+<1> package name encodes major version; see discussion on xref:ugbtb.adoc#__ugbtb_view-models_jaxb_versioning[versioning]
<2> identifies this class as a view model and defines the root element for JAXB serialization
<3> all properties in the class must be listed; (they can be ignored using `@XmlTransient`)
<4> demonstrating use of UI events for a subscriber to provide the DTO's title; see xref:rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`].
-<5> class name encodes (major and) minor version; see discussion on xref:ugbtb.adoc#_ugbtb_view-models_jaxb_versioning[versioning]
-<6> again, see discussion on xref:ugbtb.adoc#_ugbtb_view-models_jaxb_versioning[versioning]
-<7> again, see discussion on xref:ugbtb.adoc#_ugbtb_view-models_jaxb_versioning[versioning]
+<5> class name encodes (major and) minor version; see discussion on xref:ugbtb.adoc#__ugbtb_view-models_jaxb_versioning[versioning]
+<6> again, see discussion on xref:ugbtb.adoc#__ugbtb_view-models_jaxb_versioning[versioning]
+<7> again, see discussion on xref:ugbtb.adoc#__ugbtb_view-models_jaxb_versioning[versioning]
<8> simple scalar properties
-<9> reference to a persistent entity; discussed xref:ugbtb.adoc#_ugbtb_view-models_jaxb_referencing-domain-entities[below]
-<10> reference to a collection of persistent entities; again discussed xref:ugbtb.adoc#_ugbtb_view-models_jaxb_referencing-domain-entities[below]
+<9> reference to a persistent entity; discussed xref:ugbtb.adoc#__ugbtb_view-models_jaxb_referencing-domain-entities[below]
+<10> reference to a collection of persistent entities; again discussed xref:ugbtb.adoc#__ugbtb_view-models_jaxb_referencing-domain-entities[below]
-[[_ugbtb_view-models_jaxb_referencing-domain-entities]]
+[[__ugbtb_view-models_jaxb_referencing-domain-entities]]
== Referencing Domain Entities
It's quite common for view models to be "backed by" (be projections of) some underlying domain entity.
@@ -142,7 +142,7 @@ If the URL does exceed limits, then provide a custom implementation of xref:rgsv
-[[_ugbtb_view-models_jaxb_versioning]]
+[[__ugbtb_view-models_jaxb_versioning]]
== Versioning
The whole point of using DTOs (in Apache Isis, at least) is to define a formal contact between two inter-operating but independent applications.
@@ -186,7 +186,7 @@ Although there is no requirement for the namespace URI to correspond to a physic
This usually means including a company domain name within the string.
As noted above, this package will contain multiple DTO classes all with the same namespace; these represent a set of minor versions of the DTO, each subsequent one intended to be backwardly compatible with the previous.
-Since these DTO classes will all be in the same package (as per the xref:ugbtb.adoc#_ugbtb_view-models_jaxb_using-packages-to-version[advice above]), the class should therefore include the minor version name:
+Since these DTO classes will all be in the same package (as per the xref:ugbtb.adoc#__ugbtb_view-models_jaxb_using-packages-to-version[advice above]), the class should therefore include the minor version name:
[source,java]
----
@@ -243,10 +243,10 @@ Alternatively, you might also consider simply editing the source file, ie renami
We also _don't_ recommend using inheritance (ie `ToDoItemV1_2` should not inherit from `ToDoItemV1_1`; this creates unnecessary complexity downstream if generating XSDs and DTOs for the downstream consumer.
-[[_ugbtb_view-models_jaxb_generating-xsds-and-dtos]]
+[[__ugbtb_view-models_jaxb_generating-xsds-and-dtos]]
== Generating XSDs and DTOs
-In the section xref:ugbtb.adoc#_ugbtb_view-models_jaxb_referencing-domain-entities[above] it was explained how a view model DTO can transparent reference any "backing" entities; these references are converted to internal object identifiers.
+In the section xref:ugbtb.adoc#__ugbtb_view-models_jaxb_referencing-domain-entities[above] it was explained how a view model DTO can transparent reference any "backing" entities; these references are converted to internal object identifiers.
However, if the consumer of the XML is another Java process (eg running within an Apache Camel route), then you might be tempted/expect to be able to use the same DTO within that Java process.
After a little thought though you'll realize that (duh!) of course you cannot; the consumer runs in a different process space, and will not have references to those containing entities.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_use-cases.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_use-cases.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_use-cases.adoc
index ce36efa..2da1e5d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_use-cases.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_view-models_use-cases.adoc
@@ -9,7 +9,7 @@ When developing an Apache Isis application you will most likely start off with t
`Customer`, `Order`, `Product`, and so on. For some applications this may well suffice. However, if the application
needs to integrate with other systems, or if the application needs to support reasonably complex business processes, then you may need to look beyond just domain entities. This section explores these use cases.
-[[_ugbtb_view-models_use-cases_externally-managed-entities]]
+[[__ugbtb_view-models_use-cases_externally-managed-entities]]
== Externally-managed entities
Sometimes the entities that make up your application are persisted not in the local JDO/DataNucleus database
@@ -37,7 +37,7 @@ desirable in any case).
====
-[[_ugbtb_view-models_use-cases_in-memory-entities]]
+[[__ugbtb_view-models_use-cases_in-memory-entities]]
== In-memory entities
As a variation on the above, sometimes there are domain objects that are, conceptually at least entities, but whose
@@ -47,7 +47,7 @@ A simple example might be read-only configuration data that is read from a confi
definitions) but thereafter is presented in the UI just like any other entity.
-[[_ugbtb_view-models_use-cases_application-layer-view-models]]
+[[__ugbtb_view-models_use-cases_application-layer-view-models]]
== Application-layer view models
Domain entities (whether locally persisted using JDO/DataNucleus or managed externally) are the bread-and-butter of Apache Isis applications: the focus after all, should be on the business domain concepts and ensuring that they are
@@ -90,12 +90,12 @@ what the use cases are that those domain entities are trying to support. You ce
domain layer that could support every conceivable use case before starting to think about view models.
Instead, you should iterate. Identify the use case/story/end-user objective that you will deliver value to the
-business. Then build out the minimum domain entities to support that use case (refining the xref:ugfun.adoc#_ugfun_core-concepts_philosophy_domain-driven-design_ubiquitous-language[ubiquitous language] as you
+business. Then build out the minimum domain entities to support that use case (refining the xref:ugfun.adoc#__ugfun_core-concepts_philosophy_domain-driven-design_ubiquitous-language[ubiquitous language] as you
go). Then, identify if there any view models that could be introduced which would simplify the end-user interactions
with the system (perhaps automating several related use cases together).
****
-[[_ugbtb_view-models_use-cases_dtos]]
+[[__ugbtb_view-models_use-cases_dtos]]
== DTOs
DTOs (data transfer objects) are simple classes that (according to link:https://en.wikipedia.org/wiki/Data_transfer_object[wikipedia]) "carry data between processes".
@@ -113,7 +113,7 @@ easily changed by the producer.
To support this use case, a view model can be defined such that it can act as a DTO. This is done by annotating the
class using JAXB annotations; this allows the consumer to obtain the DTO in XML format along with a corresponding
XSD schema describing the structure of that XML. A discussion of how that might be done using an ESB such as
-link:http://camel.apache.org[Apache Camel(TM)] follows xref:ugbtb.adoc#_ugbtb_view-models_use-cases_dtos_consumers[below].
+link:http://camel.apache.org[Apache Camel(TM)] follows xref:ugbtb.adoc#__ugbtb_view-models_use-cases_dtos_consumers[below].
In case it's not obvious, these DTOs are still usable as "regular" view models; they will render in the xref:ugvw.adoc#[Wicket viewer] just like any other. In fact (as the xref:ugbtb.adoc#_ugbtb_view-models_programming-model[programming model] section below makes clear), these JAXB-annotated view models are in many regards the most powerful of all the alternative ways of writing view models.
@@ -123,7 +123,7 @@ The view model simply needs to implement the xref:rgcms.adoc#_rgcms_classes_mixi
framework has xref:rgcms.adoc#_rgcms_classes_mixins_Dto[mixins] that contribute the download actions to the view model.
-[[_ugbtb_view-models_use-cases_dtos_consumers]]
+[[__ugbtb_view-models_use-cases_dtos_consumers]]
=== DTO Consumers
The actual consumers of DTOs will generally obtain the XML of the view models either by requesting the XML directly,
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugbtb_web-xml.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_web-xml.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_web-xml.adoc
index ef9fcb5..05a698b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_web-xml.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_web-xml.adoc
@@ -40,7 +40,7 @@ The following sections detail these various listeners, filters and servlets in m
-[[_ugbtb_web-xml_servlet-context-listeners]]
+[[__ugbtb_web-xml_servlet-context-listeners]]
== Servlet Context Listeners
Servlet context listeners are used to perform initialization on application startup. Both Shiro (if configured as the security mechanism) and RestEasy (for the Restful Objects viewer) require their own context listener. In addition, if the Wicket viewer is _not_ being used, then additional Apache Isis-specific listener is required for bootstrapping of the Apache Isis framework itself.
@@ -120,7 +120,7 @@ There are two relevant context parameters:
-[[_ugbtb_web-xml_servlets]]
+[[__ugbtb_web-xml_servlets]]
== Servlets
Servlets process HTTP requests and return corresponding responses.
@@ -213,7 +213,7 @@ Its mapping is:
-[[_ugbtb_web-xml_filters]]
+[[__ugbtb_web-xml_filters]]
== Filters
The order in which filters appear in `web.xml` matters: first to last they define a pipeline. This is shown in the
@@ -473,7 +473,7 @@ This filter should be mapped to the `servlet-name` for the RestEasy `HttpServlet
-[[_ugbtb_web-xml_context-parameters]]
+[[__ugbtb_web-xml_context-parameters]]
== Configuration Files
However Apache Isis is bootstrapped (using the `IsisWicketApplication` or using `IsisWebAppBootstrapper`), it will
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_building-blocks.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_building-blocks.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_building-blocks.adoc
index 6bd4d2e..caa445c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_building-blocks.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_building-blocks.adoc
@@ -6,7 +6,7 @@
In this section we run through the main building blocks that make up an Apache Isis application.
-[[_ugfun_core-concepts_building-blocks_metamodel]]
+[[__ugfun_core-concepts_building-blocks_metamodel]]
== A MetaModel
At its core, Apache Isis is a metamodel that is built at runtime from the domain classes (eg `Customer.java`), along
@@ -40,7 +40,7 @@ sources.
====
-[[_ugfun_core-concepts_building-blocks_types-of-domain-objects]]
+[[__ugfun_core-concepts_building-blocks_types-of-domain-objects]]
== Type of Domain Objects
Most domain objects that the end-user interacts with are *domain entities*, such as `Customer`, `Order`, `Product` and
@@ -120,7 +120,7 @@ stateless. If a domain service does hold state (eg the `Scratchpad` service not
-[[_ugfun_core-concepts_building-blocks_objects-members]]
+[[__ugfun_core-concepts_building-blocks_objects-members]]
== Object Members
Every domain object in Apache Isis consists of (at most) three types of members:
@@ -234,7 +234,7 @@ For further discussion on view models, see xref:ugbtb.adoc#_ugbtb_view-models[th
-[[_ugfun_core-concepts_building-blocks_domain-services]]
+[[__ugfun_core-concepts_building-blocks_domain-services]]
== Domain Services
Domain services consist of a set of logically grouped actions, and as such follow the same conventions as for entities. However, a service cannot have (persisted) properties, nor can it have (persisted) collections.
@@ -259,7 +259,7 @@ In Apache Isis these are all implemented as domain services. Indeed, it is quit
-[[_ugfun_core-concepts_building-blocks_mixins-and-contributions]]
+[[__ugfun_core-concepts_building-blocks_mixins-and-contributions]]
== Mixins & Contributions
NOTE: TODO
@@ -270,7 +270,7 @@ xref:ugbtb.adoc#_ugbtb_decoupling_mixins[this topic on mixin]s.
-[[_ugfun_core-concepts_building-blocks_domain-events]]
+[[__ugfun_core-concepts_building-blocks_domain-events]]
== Domain Events
NOTE: TODO; see xref:rgcms.adoc#_rgcms_classes_domainevent[domain event] classes.
@@ -284,10 +284,10 @@ NOTE: TODO; see xref:rgcms.adoc#_rgcms_classes_uievent[UI event] classes.
-[[_ugfun_core-concepts_building-blocks_oid]]
+[[__ugfun_core-concepts_building-blocks_oid]]
== OIDs
-As well as defining a xref:ugfun.adoc#_ugfun_core-concepts_building-blocks_metamodel[metamodel] of the structure (domain
+As well as defining a xref:ugfun.adoc#__ugfun_core-concepts_building-blocks_metamodel[metamodel] of the structure (domain
classes) of its domain objects, Apache Isis also manages the runtime instances of said domain objects.
When a domain entity is recreated from the database, the framework keeps track of its identity through an "OID": an
@@ -330,7 +330,7 @@ xref:rgcms.adoc#_rgcms_schema-common[common schema] XSD defines the `oidDto` com
-[[_ugfun_core-concepts_building-blocks_value-objects]]
+[[__ugfun_core-concepts_building-blocks_value-objects]]
== Value Objects (Primitives)
NOTE: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_domain-driven-design.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_domain-driven-design.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_domain-driven-design.adoc
index a2b2a36..274bde2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_domain-driven-design.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_domain-driven-design.adoc
@@ -16,7 +16,7 @@ There are two central ideas at the heart of domain-driven design.
Let's look at each in turn.
-[[_ugfun_core-concepts_philosophy_domain-driven-design_ubiquitous-language]]
+[[__ugfun_core-concepts_philosophy_domain-driven-design_ubiquitous-language]]
== Ubiquitous Language
It's no secret that the IT industry is plagued by project failures. Too often systems take longer than intended to implement, and when finally implemented, they don't address the real requirements anyway.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_faqs_i18n-label-in-wicket-viewer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_faqs_i18n-label-in-wicket-viewer.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_faqs_i18n-label-in-wicket-viewer.adoc
index a6e0aab..baa035a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_faqs_i18n-label-in-wicket-viewer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_faqs_i18n-label-in-wicket-viewer.adoc
@@ -14,7 +14,7 @@ From link:http://isis.markmail.org/thread/ctppmtcbsf4iskzi[this thread] on the A
The above FAQ was raised against `1.10.0`. As of `1.11.0` (due to link:https://issues.apache.org/jira/browse/ISIS-1093[ISIS-1093]) it _is_ now possible to internationalize both the Wicket viewer's labels as well as the regular translations of the domain object metadata using the `.po` translation files as
supported by the xref:rgsvc.adoc#_rgsvc_spi_TranslationService[`TranslationService`].
-Full details of the ``msgId``s that must be added to the `translations.po` file can be found in xref:guides/ugbtb.adoc#_ugbtb_i18n_wicket-viewer[i18n] section of the xref:ugbtb.adoc#[beyond the basics] guide.
+Full details of the ``msgId``s that must be added to the `translations.po` file can be found in xref:guides/ugbtb.adoc#__ugbtb_i18n_wicket-viewer[i18n] section of the xref:ugbtb.adoc#[beyond the basics] guide.
In prior releases (`1.10.0` and earlier) it was necessary to use link:https://ci.apache.org/projects/wicket/guide/6.x/guide/i18n.html#i18n_3[ Wicket's internationalization support], namely resource bundles. This is still supported (as a fallback):
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_getting-started_simpleapp-archetype.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_getting-started_simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_getting-started_simpleapp-archetype.adoc
index 22ce033..c1924e3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_getting-started_simpleapp-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_getting-started_simpleapp-archetype.adoc
@@ -236,7 +236,7 @@ To log in, use `sven/pass`.
Once you are familiar with the generated app, you'll want to start modifying it. There is plenty of guidance on this site; check out the 'programming model how-tos' section on the main link:../documentation.html[documentation] page first).
-If you use IntelliJ IDEA or Eclipse, do also install the xref:dg.adoc#_dg_ide_intellij_live-templates[live templates (for IntelliJ)] / xref:dg.adoc#_dg_ide_eclipse_editor-templates[editor templates (for Eclipse)]; these will help you follow the Apache Isis naming conventions.
+If you use IntelliJ IDEA or Eclipse, do also install the xref:dg.adoc#__dg_ide_intellij_live-templates[live templates (for IntelliJ)] / xref:dg.adoc#__dg_ide_eclipse_editor-templates[editor templates (for Eclipse)]; these will help you follow the Apache Isis naming conventions.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_actions.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_actions.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_actions.adoc
index 814ea37..b32f75f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_actions.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_actions.adoc
@@ -22,7 +22,7 @@ If the state change is simple, for example just being able to correct an invalid
But if the state change is more complex, then most likely an action should be used instead.
-[[_ugfun_how-tos_class-structure_actions_defining-actions]]
+[[__ugfun_how-tos_class-structure_actions_defining-actions]]
== Defining actions
Broadly speaking, actions are all the `public` methods that are not getters or setters which represent properties or collections.
@@ -55,7 +55,7 @@ The (non-ASF) Isis addons' http://github.com/isisaddons/isis-metamodel-paraname8
====
-[[_ugfun_how-tos_class-structure_actions_reference-parameter-types]]
+[[__ugfun_how-tos_class-structure_actions_reference-parameter-types]]
== (Reference) Parameter types
Parameter types can be value types or reference types.
@@ -93,7 +93,7 @@ It is also required to return a Collection of that type.
Note that it is also valid to define "choices" and "autoComplete" for value types (such as `quantity`, above); it just isn't as common to do so.
-[[_ugfun_how-tos_class-structure_actions_reference-parameter-types_removing-boilerplate]]
+[[__ugfun_how-tos_class-structure_actions_reference-parameter-types_removing-boilerplate]]
=== Removing boilerplate
To save having to define an `autoCompleteNXxx(...)` method everywhere that a reference to a particular type (such as `Product`) appears as an action parameter, it is also possible to use the `@DomainObject` annotation on `Product` itself:
@@ -138,7 +138,7 @@ public class PaymentMethodType ... {
<1> only a small (ie "bounded") number of instances available, meaning that the framework should render all in a drop-down.
-[[_ugfun_how-tos_class-structure_actions_collection-parameter-types]]
+[[__ugfun_how-tos_class-structure_actions_collection-parameter-types]]
== Collection Parameter types
Action parameters can also be collections of values (for example `List<String>`), or can be collections of references (such as `List<Customer>`).
@@ -160,13 +160,13 @@ public List<Product> autoComplete0AddToBasket(@MinLength(3) String searchTerm) {
}
----
-As the example suggests, any collection parameter type must provide a way to select items, either by way of a "choices" or "autoComplete" supporting method or alternatively defined globally using xref:rgant.adoc#_rgant_DomainObject[`@DomainObject`] on the referenced type (described xref:ugfun.adoc#_ugfun_how-tos_class-structure_actions_reference-parameter-types_removing-boilerplate[above]).
+As the example suggests, any collection parameter type must provide a way to select items, either by way of a "choices" or "autoComplete" supporting method or alternatively defined globally using xref:rgant.adoc#_rgant_DomainObject[`@DomainObject`] on the referenced type (described xref:ugfun.adoc#__ugfun_how-tos_class-structure_actions_reference-parameter-types_removing-boilerplate[above]).
-[[_ugfun_how-tos_class-structure_actions_optional-parameters]]
+[[__ugfun_how-tos_class-structure_actions_optional-parameters]]
== Optional Parameters
-Whereas the xref:ugfun.adoc#_ugfun_how-tos_class-structure_properties_optional-properties[optionality of properties] is defined using xref:rgant.adoc#_rgant_Column_allowsNull[`@javax.jdo.annotations.Column#allowsNull()`], that JDO annotation cannot be applied to parameter types.
+Whereas the xref:ugfun.adoc#__ugfun_how-tos_class-structure_properties_optional-properties[optionality of properties] is defined using xref:rgant.adoc#_rgant_Column_allowsNull[`@javax.jdo.annotations.Column#allowsNull()`], that JDO annotation cannot be applied to parameter types.
Instead, either the xref:rgant.adoc#_rgant_Nullable[`@Nullable`] annotation or the xref:rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`] annotation/attribute is used.
For example:
@@ -192,10 +192,10 @@ public Order invoice(
See also xref:ugfun.adoc#_ugfun_how-tos_class-structure_properties-vs-parameters[properties vs parameters].
-[[_ugfun_how-tos_class-structure_actions_string-parameters]]
+[[__ugfun_how-tos_class-structure_actions_string-parameters]]
== ``String`` Parameters (Length)
-Whereas the xref:ugfun.adoc#_ugfun_how-tos_class-structure_properties_mapping-strings[length of string properties] is defined using xref:rgant.adoc#_rgant_Column_length[`@javax.jdo.annotations.Column#length()`], that JDO annotation cannot be applied to parameter types.
+Whereas the xref:ugfun.adoc#__ugfun_how-tos_class-structure_properties_mapping-strings[length of string properties] is defined using xref:rgant.adoc#_rgant_Column_length[`@javax.jdo.annotations.Column#length()`], that JDO annotation cannot be applied to parameter types.
Instead, the xref:rgant.adoc#_rgant_Parameter_maxLength[`@Parameter#maxLength()`] annotation/attribute is used.
For example:
@@ -233,10 +233,10 @@ This is important, because it allows JDO/DataNucleus to keep track that this ins
See also xref:ugfun.adoc#_ugfun_how-tos_class-structure_properties-vs-parameters[properties vs parameters].
-[[_ugfun_how-tos_class-structure_actions_bigdecimal-parameters]]
+[[__ugfun_how-tos_class-structure_actions_bigdecimal-parameters]]
== ``BigDecimal``s (Precision)
-Whereas the xref:ugfun.adoc#_ugfun_how-tos_class-structure_properties_mapping-bigdecimals[precision of BigDecimal properties] is defined using xref:rgant.adoc#_rgant_Column_scale[`@javax.jdo.annotations.Column#scale()`], that JDO annotation cannot be applied to parameter types.
+Whereas the xref:ugfun.adoc#__ugfun_how-tos_class-structure_properties_mapping-bigdecimals[precision of BigDecimal properties] is defined using xref:rgant.adoc#_rgant_Column_scale[`@javax.jdo.annotations.Column#scale()`], that JDO annotation cannot be applied to parameter types.
Instead, the xref:rgant.adoc#_rgant_Digits_fraction[`@javax.validation.constraints.Digits#fraction()`] annotation/attribute is used.
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_class-definition.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_class-definition.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_class-definition.adoc
index 8ae3073..6bdc20b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_class-definition.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_class-definition.adoc
@@ -33,7 +33,7 @@ Within the module there may be various subpackages, but its the module defines t
In the same way that the Java module act as a namespace for domain objects, it's good practice to map domain entities to their own (database) schemas.
-[[_ugfun_how-tos_class-structure_class-definition_entities]]
+[[__ugfun_how-tos_class-structure_class-definition_entities]]
== Entities
Entities are persistent domain objects.
@@ -113,7 +113,7 @@ However, there is no need to provide such a no-arg constructor; it is added by t
<11> The `ObjectContracts` utility class also provides assistance for `toString()`, useful when debugging in an IDE.
-[[_ugfun_how-tos_class-structure_class-definition_domain-services]]
+[[__ugfun_how-tos_class-structure_class-definition_domain-services]]
== Domain Services
Domain services are generally singletons that are automatically injected into other domain services.
@@ -164,7 +164,7 @@ The framework can inject into not just other domain services but will also autom
There is further discussion of service injection xref:ugfun.adoc#_ugfun_how-tos_class-structure_inject-services[below].
-[[_ugfun_how-tos_class-structure_class-definition_view-models]]
+[[__ugfun_how-tos_class-structure_class-definition_view-models]]
== View Models
xref:ugbtb.adoc#_ugbtb_view-models[View model]s are similar to entities in that (unlike domain services) there can be many instances of any given type; but they differ from entities in that they are not persisted into a database.
http://git-wip-us.apache.org/repos/asf/isis/blob/b8cf9adb/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_collections.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_collections.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_collections.adoc
index 76ee75f..b1b69ec 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_collections.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_how-tos_class-structure_collections.adoc
@@ -8,7 +8,7 @@
A collection is an instance variable of a domain object, of a collection type that holds references to other domain objects.
For example, a `Customer` may have a collection of ``Order``s).
-It's ok for a xref:ugfun.adoc#_ugfun_how-tos_class-structure_class-definition_entities[domain entity] to reference another domain entity, and for a xref:ugfun.adoc#_ugfun_how-tos_class-structure_class-definition_view-models[view model] to reference both view model and domain entities.
+It's ok for a xref:ugfun.adoc#__ugfun_how-tos_class-structure_class-definition_entities[domain entity] to reference another domain entity, and for a xref:ugfun.adoc#__ugfun_how-tos_class-structure_class-definition_view-models[view model] to reference both view model and domain entities.
However, it isn't valid for a domain entity to hold a persisted reference to view model (DataNucleus will not know how to persist that view model).
Formally speaking, a collection is simply a regular JavaBean getter, returning a collection type (subtype of `java.util.Collection`).