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 2015/12/03 19:15:53 UTC
[15/15] isis-site git commit: ISIS-1243: breaking up the user and ref
guides
ISIS-1243: breaking up the user and ref guides
Project: http://git-wip-us.apache.org/repos/asf/isis-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis-site/commit/5d1d8c79
Tree: http://git-wip-us.apache.org/repos/asf/isis-site/tree/5d1d8c79
Diff: http://git-wip-us.apache.org/repos/asf/isis-site/diff/5d1d8c79
Branch: refs/heads/asf-site
Commit: 5d1d8c790ef7ede0f92b3a5e11230204400335d6
Parents: 9862c26
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Thu Dec 3 18:02:30 2015 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Thu Dec 3 18:02:30 2015 +0000
----------------------------------------------------------------------
content/common-use-cases.html | 4 +-
content/documentation.html | 73 +-
content/guides/cg.html | 186 +-
content/guides/rg.html | 26896 +------------------------
content/guides/rgant.html | 12265 +++++++++++
content/guides/rgcfg.html | 2394 +++
content/guides/rgcms.html | 5877 ++++++
content/guides/rgsvc.html | 8568 ++++++++
content/guides/simpleapp-archetype.html | 2 +-
content/guides/tg.html | 136 +-
content/guides/ug.html | 15611 +-------------
content/guides/ugbtb.html | 5070 +++++
content/guides/ugfun.html | 6730 +++++++
content/guides/ugsec.html | 2212 ++
content/guides/ugtst.html | 3607 ++++
content/guides/ugvro.html | 1386 ++
content/guides/ugvw.html | 3410 ++++
content/how-isis-works.html | 2 +-
content/migration-notes.html | 38 +-
content/powered-by.html | 6 +-
content/release-notes.html | 2 +-
21 files changed, 51817 insertions(+), 42658 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis-site/blob/5d1d8c79/content/common-use-cases.html
----------------------------------------------------------------------
diff --git a/content/common-use-cases.html b/content/common-use-cases.html
index b69b7d4..c9765bb 100644
--- a/content/common-use-cases.html
+++ b/content/common-use-cases.html
@@ -546,7 +546,7 @@ table.CodeRay td.code>pre{padding:0}
<p>One of the original motivations for Apache Isis itself was to be able automatically generate a user interface for a domain object model.</p>
</div>
<div class="paragraph">
-<p>Apache Isis' has a pluggable architecture allowing different user interface technologies. The principal implementation (as configured by the <a href="./simple-archetype.html">simple archetype</a>) is the <a href="guides/ug.html#_ug_wicket-viewer">Wicket viewer</a>. This provides an appealing default user interface, with the ability to customize the user interface by writing new <a href="http://wicket.apache.org">Apache Wicket</a> components. Some third-party components can be found in the (non-ASF) <a href="http://isisaddons.org">Isis Addons</a> (non-ASF) project, integrating the Wicket viewer with <a href="https://github.com/isisaddons/isis-wicket-gmap3">google maps</a>, <a href="https://github.com/isisaddons/isis-wicket-fullcalendar2">a full calendar</a> and a <a href="https://github.com/isisaddons/isis-wicket-excel">export to Excel</a> component.</p>
+<p>Apache Isis' has a pluggable architecture allowing different user interface technologies. The principal implementation (as configured by the <a href="./simple-archetype.html">simple archetype</a>) is the <a href="guides/ugvw.html#">Wicket viewer</a>. This provides an appealing default user interface, with the ability to customize the user interface by writing new <a href="http://wicket.apache.org">Apache Wicket</a> components. Some third-party components can be found in the (non-ASF) <a href="http://isisaddons.org">Isis Addons</a> (non-ASF) project, integrating the Wicket viewer with <a href="https://github.com/isisaddons/isis-wicket-gmap3">google maps</a>, <a href="https://github.com/isisaddons/isis-wicket-fullcalendar2">a full calendar</a> and a <a href="https://github.com/isisaddons/isis-wicket-excel">export to Excel</a> component.</p>
</div>
<div class="paragraph">
<p>Deploying on Apache Isis means that the framework also manages object persistence. Again this is pluggable, but the principal implementation is the JDO/DataNucleus objectstore. Because JDO supports both SQL and NoSQL databases, you can then deploy on a variety of platforms, including the <a href="https://developers.google.com/appengine/">Google App Engine (GAE)</a> and <a href="http://neo4j.com/">Neo4J</a>.</p>
@@ -560,7 +560,7 @@ table.CodeRay td.code>pre{padding:0}
<p>REST (Representation State Transfer) is an architectural style for building highly scalable distributed systems, using the same principles as the World Wide Web. Many commercial web APIs (twitter, facebook, Amazon) are implemented as either pure REST APIs or some approximation therein.</p>
</div>
<div class="paragraph">
-<p>The <a href="http://restfulobjects.org">Restful Objects specification</a> defines a means by a domain object model can be exposed as RESTful resources using JSON representations over HTTP. Apache Isis' <a href="guides/ug.html#_ug_restfulobjects_viewer">RestfulObjects viewer</a> is an implementation of that spec, making any Apache Isis domain object automatically available via REST.</p>
+<p>The <a href="http://restfulobjects.org">Restful Objects specification</a> defines a means by a domain object model can be exposed as RESTful resources using JSON representations over HTTP. Apache Isis' <a href="guides/ugvro.html#">RestfulObjects viewer</a> is an implementation of that spec, making any Apache Isis domain object automatically available via REST.</p>
</div>
<div class="paragraph">
<p>There are two main use cases for deploying Apache Isis as a RESTful web service are:</p>
http://git-wip-us.apache.org/repos/asf/isis-site/blob/5d1d8c79/content/documentation.html
----------------------------------------------------------------------
diff --git a/content/documentation.html b/content/documentation.html
index 2577b09..f77656e 100644
--- a/content/documentation.html
+++ b/content/documentation.html
@@ -615,75 +615,58 @@ table.CodeRay td.code>pre{padding:0}
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><strong>Users' Guide:</strong></p>
-</div>
-<div class="paragraph">
-<p>Core concepts, how tos and more advanced techniques, using and customizing the Wicket viewer & the Restful Objects viewer, security, testing</p>
-</div>
-<div class="paragraph">
-<p><a class="button guide" href="./guides/ug.html" role="button" target="_blank">Users' Guide »</a></p>
-</div>
-<div class="paragraph">
-<p>including:</p>
+<p><strong>User Guides:</strong></p>
</div>
<div class="ulist">
<ul>
<li>
-<p><strong><a href="./guides/ug.html#_ug_getting-started_simpleapp-archetype">Getting Started</a></strong> (SimpleApp Archetype)</p>
+<p><strong><a href="./guides/ugfun.html" target="_blank">Fundamentals</a></strong></p>
</li>
<li>
-<p><a href="./guides/ug.html#_ug_how-tos">How-tos</a></p>
+<p><a href="./guides/ugvw.html" target="_blank">Wicket Viewer</a></p>
</li>
<li>
-<p><a href="./guides/ug.html#_ug_wicket-viewer">Customizing the Wicket Viewer</a></p>
+<p><a href="./guides/ugvro.html" target="_blank">Restful Objects Viewer</a></p>
</li>
<li>
-<p><a href="./guides/ug.html#_ug_testing">Testing</a></p>
+<p><a href="./guides/ugsec.html" target="_blank">Security</a></p>
</li>
<li>
-<p><a href="./guides/ug.html#_ug_extending">Extending</a></p>
+<p><strong><a href="./guides/ugtst.html" target="_blank">Testing</a></strong></p>
+</li>
+<li>
+<p><a href="./guides/ugbtb.html" target="_blank">Beyond the Basics</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><strong>Reference Guide:</strong></p>
-</div>
-<div class="paragraph">
-<p>Programming model (annotations, methods), domain services (API and SPI), utility classes, UI layout, runtime configuration properties</p>
-</div>
-<div class="paragraph">
-<p><a class="button guide" href="./guides/rg.html" role="button" target="_blank">Reference Guide »</a></p>
-</div>
-<div class="paragraph">
-<p>including:</p>
+<p><strong>Reference Guides:</strong></p>
</div>
<div class="ulist">
<ul>
<li>
-<p><a href="./guides/rg.html#_rg_annotations">Annotations</a></p>
-</li>
-<li>
-<p><strong><a href="./guides/rg.html#_rg_methods">Methods</a></strong></p>
+<p><strong><a href="./guides/rgant.html" target="_blank">Annotations</a></strong></p>
</li>
<li>
-<p><strong><a href="./guides/rg.html#_rg_services-api">Domain Services API</a></strong></p>
+<p><strong><a href="./guides/rgsvc.html" target="_blank">Domain Services</a></strong></p>
</li>
<li>
-<p><a href="./guides/rg.html#_rg_services-spi">Domain Services SPI</a></p>
+<p><a href="./guides/rgcfg.html" target="_blank">Configuration Properties</a></p>
</li>
<li>
-<p><a href="./guides/rg.html#_rg_runtime">Configuration Properties</a></p>
+<p><a href="./guides/rgcms.html" target="_blank">Classes, Methods and Schema</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p><strong>Contributors' Guide</strong></p>
</div>
-<div class="paragraph">
-<p>IDE setup, build the framework, writing docs, how to contribute patches (pull requests); for committers: publishing docs, applying patches, release process.</p>
-</div>
-<div class="paragraph">
-<p><a class="button guide" href="./guides/cg.html" role="button" target="_blank">Contributors' Guide »</a></p>
+<div class="ulist">
+<ul>
+<li>
+<p><strong><a href="./guides/cg.html" target="_blank">Contributors Guide</a></strong></p>
+</li>
+</ul>
</div>
<div class="paragraph">
<p>including:</p>
@@ -694,15 +677,9 @@ table.CodeRay td.code>pre{padding:0}
<p>Setting up <a href="./guides/cg.html#_cg_ide_intellij">IntelliJ</a> or <a href="./guides/cg.html#_cg_ide_eclipse">Eclipse</a></p>
</li>
<li>
-<p><a href="./guides/cg.html#_cg_ide-templates"><strong>IDE templates</strong></a> (IntelliJ and Eclipse)</p>
-</li>
-<li>
<p><a href="./guides/cg.html#_cg_contributing">Contributing patches</a> (pull requests)</p>
</li>
<li>
-<p><a href="./guides/cg.html#_cg_isis-maven-plugin">Isis Maven plugin</a></p>
-</li>
-<li>
<p><a href="./guides/cg.html#_cg_committers_cutting-a-release">Cutting a release</a> ; <a href="./guides/cg.html#_cg_committers_verifying-releases">Verifying a release</a></p>
</li>
</ul>
@@ -781,6 +758,16 @@ table.CodeRay td.code>pre{padding:0}
<p><a href="migration-notes.html">Migration Notes</a></p>
</li>
</ul>
+</div>
+<div class="paragraph">
+<p><strong>Get involved!</strong></p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Our <a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=87"><strong>Kanban board</strong></a> maps out the JIRA issues we are looking to tackle in the next few releases</p>
+</li>
+</ul>
</div></div></td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/isis-site/blob/5d1d8c79/content/guides/cg.html
----------------------------------------------------------------------
diff --git a/content/guides/cg.html b/content/guides/cg.html
index 983cebd..85e2955 100644
--- a/content/guides/cg.html
+++ b/content/guides/cg.html
@@ -527,7 +527,9 @@ table.CodeRay td.code>pre{padding:0}
<div class="ulist">
<ul>
<li>
-<p>programmers who want to just use Apache Isis to build applications, and want help setting up their development environment or to build their code from the command line (eg to execute within a continuous integration server such as Jenkins)</p>
+<p>programmers who want to just use Apache Isis to build applications, and want help setting up their development
+environment or to build their code from the command line (eg to execute within a continuous integration server such
+as Jenkins)</p>
</li>
<li>
<p>programmers who want to contribute back patches (bug fixes, new features) either to the codebase or the framework’s documentation</p>
@@ -537,8 +539,58 @@ table.CodeRay td.code>pre{padding:0}
</li>
</ul>
</div>
+<div class="sect2">
+<h3 id="_other_guides">1.1. Other Guides</h3>
+<div class="paragraph">
+<p>Apache Isis documentation is broken out into a number of user and reference guides.</p>
+</div>
<div class="paragraph">
-<p>This contributors' guide is <em>not</em> intended as a reference manual; for that see the <strong><a href="rg.html#_rg">Reference Guide</a></strong>. This guide also doesn’t describe how to actually build an Apache Isis application; for that see the <strong><a href="ug.html#_ug">Users' Guide</a></strong>.</p>
+<p>The user guides available are:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="ugfun.html">Fundamentals</a></p>
+</li>
+<li>
+<p><a href="ugvw.html">Wicket viewer</a></p>
+</li>
+<li>
+<p><a href="ugvro.html">Restful Objects viewer</a></p>
+</li>
+<li>
+<p><a href="ugsec.html">Security</a></p>
+</li>
+<li>
+<p><a href="ugtst.html">Testing</a></p>
+</li>
+<li>
+<p><a href="ugbtb.html">Beyond the Basics</a></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>The reference guides are:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="rgant.html">Annotations</a></p>
+</li>
+<li>
+<p><a href="rgsvc.html">Domain Services</a></p>
+</li>
+<li>
+<p><a href="rgcfg.html">Configuration Properties</a></p>
+</li>
+<li>
+<p><a href="rg.html">Classes, Methods and Schema</a></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>In addition, there is (this) <a href="#_cg">Contributors' Guide</a> describing development practices for contributors and committers alike.</p>
+</div>
</div>
</div>
</div>
@@ -1485,7 +1537,7 @@ non-commercial free license (though note this comes with some usage conditions).
<p>DataNucleus' enhancer uses the domain object model’s own classpath to reference DataNucleus JARs. So, even though your domain objects are unlikely to depend on DataNucleus, these references must still be present.</p>
</div>
<div class="paragraph">
-<p>See the earlier section on <a href="ug.html#_ug_getting-started_datanucleus-enhancer">DataNucleus enhancer</a> for details of the contents of the <code>pom.xml</code>. Chances are it is already set up from running the <a href="ug.html#_ug_getting-started_simpleapp-archetype">SimpleApp archetype</a>.</p>
+<p>See the earlier section on <a href="ug.html#_ugfun_getting-started_datanucleus-enhancer">DataNucleus enhancer</a> for details of the contents of the <code>pom.xml</code>. Chances are it is already set up from running the <a href="ug.html#_ugfun_getting-started_simpleapp-archetype">SimpleApp archetype</a>.</p>
</div>
<div class="paragraph">
<p>Then, tell DataNucleus to use the project classpath:</p>
@@ -1647,7 +1699,7 @@ your code.</p>
so that it can emit additional bytecode (eg for the getter and setter). See <a href="#_cg_ide_intellij_other-settings-compiler">here</a> for details of setting up in IntelliJ (Eclipse has very similar support).</p>
</div>
<div class="paragraph">
-<p>Apache Isis supports <a href="https://projectlombok.org/">Project Lombok</a>, in that the annotations that would normally be placed on the getter (namely <a href="rg.html#_rg_annotations_manpage-Property"><code>Property</code></a>, <a href="rg.html#_rg_annotations_manpage-PropertyLayout"><code>@PropertyLayout</code></a>, <a href="rg.html#_rg_annotations_manpage-Collection"><code>@Collection</code></a>, <a href="rg.html#_rg_annotations_manpage-CollectionLayout"><code>@CollectionLayout</code></a> and <a href="rg.html#_rg_annotations_manpage-MemberOrder"><code>@MemberOrder</code></a>) can be placed on the field instead.</p>
+<p>Apache Isis supports <a href="https://projectlombok.org/">Project Lombok</a>, in that the annotations that would normally be placed on the getter (namely <a href="rgant.html#_rgant-Property"><code>Property</code></a>, <a href="rgant.html#_rgant-PropertyLayout"><code>@PropertyLayout</code></a>, <a href="rgant.html#_rgant-Collection"><code>@Collection</code></a>, <a href="rgant.html#_rgant-CollectionLayout"><code>@CollectionLayout</code></a> and <a href="rgant.html#_rgant-MemberOrder"><code>@MemberOrder</code></a>) can be placed on the field instead.</p>
</div>
<div class="paragraph">
<p>There are plugins for Lombok for maven; it’s just a matter of adding the required dependency. To compile the code
@@ -1657,7 +1709,7 @@ Lombok plugin appropriate to that IDE. See the <a href="https://projectlombok.o
<div class="sect3">
<h4 id="_future_thoughts">2.3.1. Future thoughts</h4>
<div class="paragraph">
-<p>In the future we might extend/fork Lombok so that it understands Isis' own annotations (ie <a href="rg.html#_rg_annotations_manpage-Property"><code>@Property</code></a> and <a href="rg.html#_rg_annotations_manpage-Collection"><code>@Collection</code></a>)
+<p>In the future we might extend/fork Lombok so that it understands Isis' own annotations (ie <a href="rgant.html#_rgant-Property"><code>@Property</code></a> and <a href="rgant.html#_rgant-Collection"><code>@Collection</code></a>)
rather than Lombok’s own <code>@Getter</code> and `@Setter.</p>
</div>
<div class="paragraph">
@@ -1923,10 +1975,10 @@ TODO
<li>
<p><code>xsd</code><br></p>
<div class="paragraph">
-<p>Uses the <a href="rg.html#_rg_services-api_manpage-JaxbService"><code>JaxbService</code></a> to generate XSD schemas from any JAXB-annotated view models/DTOs.<br></p>
+<p>Uses the <a href="rgsvc.html#_rgsvc-api_JaxbService"><code>JaxbService</code></a> to generate XSD schemas from any JAXB-annotated view models/DTOs.<br></p>
</div>
<div class="paragraph">
-<p>This is instead of and preferable to using the JAXB <a href="https://jaxb.java.net/2.2.4/docs/schemagen.html">schemagen</a> tool, because it uses the framework’s support (via <a href="rg.html#_rg_annotations_manpage-XmlJavaValueType"><code>@XmlJavaValueType</code></a>) to translate any references to domain objects into <code>OidDto</code>s (as defined by the Apache Isis <a href="rg.html#_rg_schema-common">common schema</a>).</p>
+<p>This is instead of and preferable to using the JAXB <a href="https://jaxb.java.net/2.2.4/docs/schemagen.html">schemagen</a> tool, because it uses the framework’s support (via <a href="rgant.html#_rgant-XmlJavaValueType"><code>@XmlJavaValueType</code></a>) to translate any references to domain objects into <code>OidDto</code>s (as defined by the Apache Isis <a href="rgcms.html#_rgcms_schema-common">common schema</a>).</p>
</div>
</li>
</ul>
@@ -1935,17 +1987,17 @@ TODO
<p>The <code>validate</code> goal is by default bound to the <code>test</code> phase of your application’s <code>dom</code> sub-module, whereas the <code>xsd</code> goal defaults to the <code>generate-resources</code> phase of a completely separate <code>canonical</code> submodule. An example can be found in the (non-ASF) <a href="http://github.com/isisaddons/isis-app-todoapp">Isis addons' todoapp</a> example app.</p>
</div>
<div class="paragraph">
-<p>Both goals require an <a href="rg.html#_rg_classes_AppManifest-bootstrapping"><code>AppManifest</code></a> to point the plugin at, so that
+<p>Both goals require an <a href="rgcms.html#_rgcms_classes_AppManifest-bootstrapping"><code>AppManifest</code></a> to point the plugin at, so that
it knows how to bootstrap an Isis runtime. This is discussed below, followed by sections on configuring the two goals.</p>
</div>
<div class="sect2">
<h3 id="__code_appmanifest_code">5.1. <code>AppManifest</code></h3>
<div class="paragraph">
-<p>As noted in the introduction, both goals require an <a href="rg.html#_rg_classes_AppManifest-bootstrapping"><code>AppManifest</code></a>
+<p>As noted in the introduction, both goals require an <a href="rgcms.html#_rgcms_classes_AppManifest-bootstrapping"><code>AppManifest</code></a>
to point the plugin at, so that it knows how to bootstrap an Isis runtime.</p>
</div>
<div class="paragraph">
-<p>This can be extremely minimal. For example, the <a href="ug.html#_ug_getting-started_simpleapp-archetype">SimpleApp</a>'s
+<p>This can be extremely minimal. For example, the <a href="ug.html#_ugfun_getting-started_simpleapp-archetype">SimpleApp</a>'s
manifest is:</p>
</div>
<div class="listingblock">
@@ -2130,7 +2182,7 @@ different configuration; see the final section for differences.</p>
<div class="sect3">
<h4 id="_example_of_failure">5.2.3. Example of failure</h4>
<div class="paragraph">
-<p>In the <a href="ug.html#_ug_getting-started_simpleapp-archetype">SimpleApp</a> application the <code>SimpleObject</code> defines an <code>updateName</code> action. This has a supporting method:</p>
+<p>In the <a href="ug.html#_ugfun_getting-started_simpleapp-archetype">SimpleApp</a> application the <code>SimpleObject</code> defines an <code>updateName</code> action. This has a supporting method:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -2181,7 +2233,7 @@ different configuration; see the final section for differences.</p>
<div class="sect3">
<h4 id="_custom_validation_rules">5.2.4. Custom validation rules</h4>
<div class="paragraph">
-<p>It is also possible to customize the validation, explained <a href="ug.html#_ug_extending_programming-model_custom-validator">here</a>. For example, you could enforce project-specific conventions by implementing a custom <code>MetaModelValidator</code>, and registering using a configuration property.</p>
+<p>It is also possible to customize the validation, explained <a href="ugbtb.html#_ugbtb_programming-model_custom-validator">here</a>. For example, you could enforce project-specific conventions by implementing a custom <code>MetaModelValidator</code>, and registering using a configuration property.</p>
</div>
<div class="paragraph">
<p>To support this using <code>AppManifest`s, override its `getConfigurationProperties()</code> method:</p>
@@ -2286,14 +2338,14 @@ different configuration; see the final section for differences.</p>
<div class="sect2">
<h3 id="_cg_isis-maven-plugin_xsd">5.3. <code>xsd</code> goal (<code>1.11.0-SNAPSHOT</code>)</h3>
<div class="paragraph">
-<p>The <code>xsd</code> goal of the <code>isis-maven-plugin</code> uses the <a href="rg.html#_rg_services-api_manpage-JaxbService"><code>JaxbService</code></a> to
-generate XSD schemas from any JAXB-annotated <a href="ug.html#_ug_more-advanced_view-models">view model/DTOs</a>.</p>
+<p>The <code>xsd</code> goal of the <code>isis-maven-plugin</code> uses the <a href="rgsvc.html#_rgsvc-api_JaxbService"><code>JaxbService</code></a> to
+generate XSD schemas from any JAXB-annotated <a href="ugbtb.html#_ugbtb_more-advanced_view-models">view model/DTOs</a>.</p>
</div>
<div class="paragraph">
<p>This is instead of and preferable to using the JAXB <a href="https://jaxb.java.net/2.2.4/docs/schemagen.html">schemagen</a>
tool, because it uses the framework’s support (via
-<a href="rg.html#_rg_annotations_manpage-XmlJavaValueType"><code>@XmlJavaValueType</code></a>) to translate any references to domain
-objects into <code>OidDto</code>s (as defined by the Apache Isis <a href="rg.html#_rg_schema-common">common schema</a>).</p>
+<a href="rgant.html#_rgant-XmlJavaValueType"><code>@XmlJavaValueType</code></a>) to translate any references to domain
+objects into <code>OidDto</code>s (as defined by the Apache Isis <a href="rgcms.html#_rgcms_schema-common">common schema</a>).</p>
</div>
<div class="paragraph">
<p>The <code>xsd</code> goal defines the following properties:</p>
@@ -2304,7 +2356,7 @@ objects into <code>OidDto</code>s (as defined by the Apache Isis <a href="rg.htm
<p><code>appManifest</code> - fully qualified class name for the app manifest used to bootstrap the application (see discussion above)</p>
</li>
<li>
-<p><code>jaxbClasses</code> - a list of <a href="rg.html#_ug_more-advanced_view-models_jaxb">JAXB-annotated view model</a> classes;</p>
+<p><code>jaxbClasses</code> - a list of <a href="rg.html#_ugbtb_more-advanced_view-models_jaxb">JAXB-annotated view model</a> classes;</p>
</li>
<li>
<p><code>output</code> - (optional) subdirectory under the <code>target</code> directory to generate the XSDs<br></p>
@@ -2315,7 +2367,7 @@ objects into <code>OidDto</code>s (as defined by the Apache Isis <a href="rg.htm
<li>
<p><code>separate</code> - (optional) whether to create separate directories for each JAXB-class.<br></p>
<div class="paragraph">
-<p>Defaults to <code>false</code>. Most DTO classes will reference one another or the <a href="rg.html#_rg_schema-common">common schema</a>. Normally it’s fine to merge all these XSDs together. This property, if set, results in each a separate directory for each generation of its XSD or XSDs.</p>
+<p>Defaults to <code>false</code>. Most DTO classes will reference one another or the <a href="rgcms.html#_rgcms_schema-common">common schema</a>. Normally it’s fine to merge all these XSDs together. This property, if set, results in each a separate directory for each generation of its XSD or XSDs.</p>
</div>
</li>
</ul>
@@ -2639,7 +2691,7 @@ is for use in a standalone context, eg in a Java subscriber on an event bus.</p>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
-<td>catalog file indicates the location of the referenced <a href="_rg_schema-common">common schema</a> XSDs.</td>
+<td>catalog file indicates the location of the referenced <a href="_rgcms_schema-common">common schema</a> XSDs.</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
@@ -2654,7 +2706,7 @@ packaged as any other code</td>
</div>
<div class="paragraph">
<p>The referenced <code>catalog.xml</code> file instructs the <code>xjc</code> plugin how to resolve referenced schema locations. Only a
-reference for the Apache Isis <a href="_rg_schema-common">common schema</a> is likely to be needed:</p>
+reference for the Apache Isis <a href="_rgcms_schema-common">common schema</a> is likely to be needed:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -7268,10 +7320,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_annotations[Annotations]</pre></p>
+<p><pre>xref:rgant.adoc#_rgant[Annotations]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_annotations">Annotations</a></p>
+<p><a href="rgant.html#_rgant">Annotations</a></p>
</div></div></td>
</tr>
<tr>
@@ -7296,10 +7348,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_object-layout_dynamic_[Dynamic object layout</pre>]</p>
+<p><pre>xref:ug.adoc#_ugfun_object-layout_dynamic_[Dynamic object layout</pre>]</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_object-layout_dynamic">Dynamic object layout</a></p>
+<p><a href="ug.html#_ugfun_object-layout_dynamic">Dynamic object layout</a></p>
</div></div></td>
</tr>
<tr>
@@ -7324,28 +7376,28 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS]</pre></p>
+<p><pre>xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_runtime_application-specific_application-css">Application-specific CSS</a></p>
+<p><a href="rgcfg.html#_rgcfg_application-specific_application-css">Application-specific CSS</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgcfg</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_runtime_configuring-core[configuration properties</pre>]</p>
+<p><pre>xref:rgcfg.adoc#_rgcfg_configuring-core[configuration properties</pre>]</p>
</div>
<div class="paragraph">
<p>a hyperlink to the reference guide’s catalogue of the Apache Isis configuration properties.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_runtime_configuring-core">configuration properties</a></p>
+<p><a href="rgcfg.html#_rgcfg_configuring-core">configuration properties</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgcs</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_classes_super_manpage-xxx[`xxx`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_classes_super_xxx[`xxx`]</pre></p>
</div>
<div class="paragraph">
<p>a hyperlink to the "man page" for a superclass, where:</p>
@@ -7361,16 +7413,16 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_classes_super_manpage-AbstractService[`AbstractService`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_classes_super_AbstractService[`AbstractService`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_classes_super_manpage-AbstractService"><code>AbstractService</code></a></p>
+<p><a href="rgcms.html#_rgcms_classes_super_AbstractService"><code>AbstractService</code></a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgcu</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_classes_utility_manpage-xxx[`xxx`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_classes_utility_xxx[`xxx`]</pre></p>
</div>
<div class="paragraph">
<p>a hyperlink to the "man page" for a utility class, where:</p>
@@ -7386,16 +7438,16 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_classes_utility_manpage-TitleBuffer[`TitleBuffer`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_classes_utility_TitleBuffer[`TitleBuffer`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_classes_utility_manpage-TitleBuffer"><code>TitleBuffer</code></a></p>
+<p><a href="rgcms.html#_rgcms_classes_utility_TitleBuffer"><code>TitleBuffer</code></a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgcv</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_classes_value-types_manpage-xxx[`xxx`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_classes_value-types_xxx[`xxx`]</pre></p>
</div>
<div class="paragraph">
<p>a hyperlink to the "man page" for an applib value class, where:</p>
@@ -7411,16 +7463,16 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_classes_value-types_manpage-Blob[`Blob`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_classes_value-types_manpage-Blob"><code>Blob</code></a></p>
+<p><a href="rgcms.html#_rgcms_classes_value-types_Blob"><code>Blob</code></a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgmp</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_methods_prefixes_manpage-xxx[`xxx...()`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_methods_prefixes_xxx[`xxx...()`]</pre></p>
</div>
<div class="paragraph">
<p>a hyperlink to the "man page" for a prefixed method, where:</p>
@@ -7436,10 +7488,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_methods_prefixes_manpage-disable[`disable...()`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_methods_prefixes_manpage-disable"><code>disable…​()</code></a></p>
+<p><a href="rgcms.html#_rgcms_methods_prefixes_disable"><code>disable…​()</code></a></p>
</div></div></td>
</tr>
<tr>
@@ -7461,16 +7513,16 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_methods_reserved_manpage-title[`title()`]</pre></p>
+<p><pre>xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_methods_reserved_manpage-title"><code>title()</code></a></p>
+<p><a href="rgcms.html#_rgcms_methods_reserved_title"><code>title()</code></a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgna</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_annotations_manpage-xxx[`@xxx`</pre>]</p>
+<p><pre>xref:rgant.adoc#_rgant-xxx[`@xxx`</pre>]</p>
</div>
<div class="paragraph">
<p>a hyperlink to the "man page" for an annotation, where:</p>
@@ -7486,16 +7538,16 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_annotations_manpage-Action[`@Action`]</pre></p>
+<p><pre>xref:rgant.adoc#_rgant-Action[`@Action`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_annotations_manpage-Action"><code>@Action</code></a></p>
+<p><a href="rgant.html#_rgant-Action"><code>@Action</code></a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adrgnt</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_annotations_manpage-xxx_ttt[`@xxx#ttt()`</pre>]</p>
+<p><pre>xref:rgant.adoc#_rgant-xxx_ttt[`@xxx#ttt()`</pre>]</p>
</div>
<div class="paragraph">
<p>a hyperlink to the "man page" for the specific attribute (field) of an annotation, where:</p>
@@ -7514,10 +7566,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_annotations_manpage-Action_semantics[`@Action#semantics()`]</pre></p>
+<p><pre>xref:rgant.adoc#_rgant-Action_semantics[`@Action#semantics()`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_annotations_manpage-Action_semantics"><code>@Action#semantics()</code></a></p>
+<p><a href="rgant.html#_rgant-Action_semantics"><code>@Action#semantics()</code></a></p>
</div></div></td>
</tr>
<tr>
@@ -7539,10 +7591,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_services-api_manpage-DomainObjectContainer[`DomainObjectContainer`]</pre></p>
+<p><pre>xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer[`DomainObjectContainer`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_services-api_manpage-DomainObjectContainer"><code>DomainObjectContainer</code></a></p>
+<p><a href="rgsvc.html#_rgsvc-api_DomainObjectContainer"><code>DomainObjectContainer</code></a></p>
</div></div></td>
</tr>
<tr>
@@ -7564,10 +7616,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:rg.adoc#_rg_services-spi_manpage-ContentMappingService[`ContentMappingService`]</pre></p>
+<p><pre>xref:rgsvc.adoc#_rgsvc-spi_ContentMappingService[`ContentMappingService`]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="rg.html#_rg_services-spi_manpage-ContentMappingService"><code>ContentMappingService</code></a></p>
+<p><a href="rgsvc.html#_rgsvc-spi_ContentMappingService"><code>ContentMappingService</code></a></p>
</div></div></td>
</tr>
</tbody>
@@ -7626,10 +7678,10 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:ug.adoc#_ug_core-concepts[Core concepts]</pre></p>
+<p><pre>xref:ug.adoc#_ugfun_core-concepts[Core concepts]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="ug.html#_ug_core-concepts">Core concepts</a></p>
+<p><a href="ug.html#_ugfun_core-concepts">Core concepts</a></p>
</div></div></td>
</tr>
<tr>
@@ -7682,46 +7734,46 @@ WIP - cool new feature
<p>for example:</p>
</div>
<div class="paragraph">
-<p><pre>xref:ug.adoc#_ug_core-concepts_philosophy_naked-objects-pattern[Naked objects pattern]</pre></p>
+<p><pre>xref:ug.adoc#_ugfun_core-concepts_philosophy_naked-objects-pattern[Naked objects pattern]</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="ug.html#_ug_core-concepts_philosophy_naked-objects-pattern">Naked objects pattern</a></p>
+<p><a href="ug.html#_ugfun_core-concepts_philosophy_naked-objects-pattern">Naked objects pattern</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adugsimpleapp</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype]</pre></p>
+<p><pre>xref:ug.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype]</pre></p>
</div>
<div class="paragraph">
<p>A hyperlink to the <code>simpleapp</code> archetype in the "getting started" chapter.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="ug.html#_ug_getting-started_simpleapp-archetype">SimpleApp archetype</a></p>
+<p><a href="ug.html#_ugfun_getting-started_simpleapp-archetype">SimpleApp archetype</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adugvro</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:ug.adoc#_ug_restfulobjects-viewer[RestfulObjects viewer]</pre></p>
+<p><pre>xref:ugvro.adoc#[RestfulObjects viewer]</pre></p>
</div>
<div class="paragraph">
<p>A hyperlink to the Restful Objects viewer chapter.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="ug.html#_ug_restfulobjects-viewer">RestfulObjects viewer</a></p>
+<p><a href="ugvro.html">RestfulObjects viewer</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>adugvw</code></p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><pre>xref:ug.adoc#_ug_wicket-viewer[Wicket viewer]</pre></p>
+<p><pre>xref:ugvw.adoc#[Wicket viewer]</pre></p>
</div>
<div class="paragraph">
<p>A hyperlink to the Wicket viewer chapter.</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><a href="ug.html#_ug_wicket-viewer">Wicket viewer</a></p>
+<p><a href="ugvw.html">Wicket viewer</a></p>
</div></div></td>
</tr>
</tbody>
@@ -8235,13 +8287,13 @@ xxx<br>
<p>For example:</p>
</div>
<div class="paragraph">
-<p><pre>= anchor:[_ug_i18n] Internationalization</pre></p>
+<p><pre>= anchor:[_ugfun_i18n] Internationalization</pre></p>
</div>
<div class="paragraph">
<p>An alternative (more commonly used in our documentation) is to use the <code>[[…​]]</code> directly above the heading:</p>
</div>
<div class="paragraph">
-<p><pre>[[_ug_i18n]]
+<p><pre>[[_ugfun_i18n]]
= Internationalization</pre></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div></div></td>
@@ -8295,7 +8347,11 @@ xxx<br>
<div id="toc" class="toc2">
<div class="fallback-toc">
<ul class="sectlevel1">
-<li><a href="#_cg">1. Contributors' Guide</a></li>
+<li><a href="#_cg">1. Contributors' Guide</a>
+<ul class="sectlevel2">
+<li><a href="#_other_guides">1.1. Other Guides</a></li>
+</ul>
+</li>
<li><a href="#_cg_ide">2. Using an IDE</a>
<ul class="sectlevel2">
<li><a href="#_cg_ide_intellij">2.1. Developing using IntelliJ IDEA</a>