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/05/05 21:51:22 UTC
svn commit: r1677885 [2/4] - in /isis/site/trunk/content: ./
components/objectstores/jdo/ components/security/shiro/
components/viewers/restfulobjects/ components/viewers/wicket/ config/
contributors/ core/ how-tos/ intro/elevator-pitch/ intro/getting-...
Modified: isis/site/trunk/content/contributors/snapshot-process.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/snapshot-process.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/snapshot-process.md (original)
+++ isis/site/trunk/content/contributors/snapshot-process.md Tue May 5 19:51:18 2015
@@ -1,5 +1,6 @@
Title: Snapshot Release Process
+[//]: # (content copied to _user-guide_xxx)
Apache Isis consists of a number of separately releasable modules; see the main [release process](release-process.html) documentation for full details. All the non-core components depend on the `core`, and use the `core`'s parent `pom.xml` as their parent pom.
Modified: isis/site/trunk/content/contributors/upd_sh.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/upd_sh.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/upd_sh.md (original)
+++ isis/site/trunk/content/contributors/upd_sh.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: upd.sh script
+[//]: # (content copied to _user-guide_xxx)
+
The `upd.sh` script automates the downloading of the zip, asc and md5 scripts from the official Apache repository.
To use:
Modified: isis/site/trunk/content/contributors/updating-the-cms-site.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/updating-the-cms-site.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/updating-the-cms-site.md (original)
+++ isis/site/trunk/content/contributors/updating-the-cms-site.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Updating the CMS site
+[//]: # (content copied to _user-guide_xxx)
+
Apache Isis uses the Apache CMS to manage this website.
##About the Apache CMS
Modified: isis/site/trunk/content/contributors/verifying-releases-script.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/verifying-releases-script.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/verifying-releases-script.md (original)
+++ isis/site/trunk/content/contributors/verifying-releases-script.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Verify releases using a script
+[//]: # (content copied to _user-guide_xxx)
+
To save some time in verifying an Isis release we've assembled a script to automate the process. The script is tested on Mac OSX and Linux. Windows users can use Cygwin or [msysgit](http://msysgit.github.io/).
It's **recommended** that you start this process in an empty directory:
Modified: isis/site/trunk/content/contributors/verifying-releases-using-creadur-tools.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/verifying-releases-using-creadur-tools.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/verifying-releases-using-creadur-tools.md (original)
+++ isis/site/trunk/content/contributors/verifying-releases-using-creadur-tools.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Verifying Releases using Creadur Tools
+[//]: # (content copied to _user-guide_xxx)
+
The [Apache Creadur](http://creadur.apache.org) project exists to provide a set of tools to ensure compliance with Apache's licensing standards. The main release auditing tool, [Apache RAT](http://creadur.apache.org/rat), is used in the preparation of the release (as documented [here](release-process.html)). Creadur's remaining tools are to support the verification process.
At the time of writing, these additional tools are quite young and haven't been formally released; so to use them will take a little bit of work. In the future we expect these tools to mature and ease the effort required to verify releases.
Modified: isis/site/trunk/content/contributors/verifying-releases.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/verifying-releases.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/verifying-releases.md (original)
+++ isis/site/trunk/content/contributors/verifying-releases.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Verifying Releases
+[//]: # (content copied to _user-guide_xxx)
+
Whenever a committer announces a vote on a release on the [dev mailing list](../support.html), it is the responsibility of the project's PMC to cast their vote on the release. Anyone else can also vote, but only members of the Apache Isis PMC's vote are binding.
This page provides some guidance on what a voter is expected to verify before casting their vote.
@@ -18,10 +20,10 @@ To verify the source ZIP files, you will
Since the Isis source is mirrored on github.com, you can just use:
-<pre>
-curl http://www.apache.org/dist/isis/KEYS > /tmp/KEYS
-gpg --import /tmp/KEYS
-</pre>
+<pre>
+curl http://www.apache.org/dist/isis/KEYS > /tmp/KEYS
+gpg --import /tmp/KEYS
+</pre>
## Verifying the source release artifacts ##
Modified: isis/site/trunk/content/contributors/versioning-policy.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/versioning-policy.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/versioning-policy.md (original)
+++ isis/site/trunk/content/contributors/versioning-policy.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Versioning Policy
+[//]: # (content copied to _user-guide_xxx)
+
## Semantic Versioning
Starting from v1.0.0, Isis has adopted [semantic versioning](http://semver.org)
Modified: isis/site/trunk/content/core/integtestsupport.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/integtestsupport.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/core/integtestsupport.md (original)
+++ isis/site/trunk/content/core/integtestsupport.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Integration testing Support
+[//]: # (content copied to _user-guide_xxx)
+
> See also Isis' [BDD support](specsupport-and-integtestsupport.html).
The `isis-core-integtestsupport` module provides the ability to bootstrap Isis within a JUnit testing framework, using any object store. This is done using a JUnit rule.
Modified: isis/site/trunk/content/core/runtime.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/runtime.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/core/runtime.md (original)
+++ isis/site/trunk/content/core/runtime.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Core Runtime
+[//]: # (content copied to _user-guide_xxx)
+
{stub
This page is a stub.
}
Modified: isis/site/trunk/content/core/specsupport-and-integtestsupport.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/specsupport-and-integtestsupport.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/core/specsupport-and-integtestsupport.md (original)
+++ isis/site/trunk/content/core/specsupport-and-integtestsupport.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: BDD Specs and Integration testing Support
+[//]: # (content copied to _user-guide_xxx)
+
> This new feature replaces the integration test support provided in 1.2.0. Please note that some small changes to your tests will be required.
## Concepts ##
Modified: isis/site/trunk/content/core/webserver.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/webserver.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/core/webserver.md (original)
+++ isis/site/trunk/content/core/webserver.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Webapp and Webserver Support
+[//]: # (content copied to _user-guide_xxx)
+
{stub
This page is a stub.
}
Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Documentation
+[//]: # (content copied to _user-guide_xxx)
+
<blockquote>
<p>Perfection is finally attained not when there is no longer anything to add but when there is no longer anything to take away.
<p class="author">Antoine de Saint-Exupery</em></br>
Modified: isis/site/trunk/content/download.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/download.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/download.md (original)
+++ isis/site/trunk/content/download.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Downloads
+[//]: # (content copied to _user-guide_xxx)
+
Apache Isis™ software is a framework for rapidly developing domain-driven apps in Java. Write your business logic in entities, domain services and repositories, and the framework dynamically generates a representation of that domain model as a webapp or RESTful API. Use for prototyping or production.
## Getting Started
Modified: isis/site/trunk/content/how-tos/how-to-01-010-How-to-have-a-domain-object-be-a-POJO.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-010-How-to-have-a-domain-object-be-a-POJO.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-010-How-to-have-a-domain-object-be-a-POJO.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-010-How-to-have-a-domain-object-be-a-POJO.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
Pojos vs Inheriting from framework superclasses
-------------------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
{note
A lot of the programming conventions described in these how-tos are encapsulated in the [Eclipse templates](../intro/resources/editor-templates.html). If you use Eclipse, do install these first; they will save a lot of time.
}
Modified: isis/site/trunk/content/how-tos/how-to-01-030-How-to-add-a-property-to-a-domain-entity.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-030-How-to-add-a-property-to-a-domain-entity.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-030-How-to-add-a-property-to-a-domain-entity.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-030-How-to-add-a-property-to-a-domain-entity.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to add a property to a domain entity
----------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
A property is a scalar attribute or field of a domain entity. Its type
can be either a value type (such as an int, Date or String), or a
reference to another entity.
Modified: isis/site/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify a title for a domain entity
------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Apache Isis viewers identify objects through both an [icon](./how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html)
and a title. For example, a `Customer`'s title might be the organization's customer reference, or perhaps (more
informally) their first and last names.
Modified: isis/site/trunk/content/how-tos/how-to-01-050-How-to-add-a-collection-to-a-domain-entity.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-050-How-to-add-a-collection-to-a-domain-entity.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-050-How-to-add-a-collection-to-a-domain-entity.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-050-How-to-add-a-collection-to-a-domain-entity.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to add a collection to a domain entity
------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
A collection is a multi-valued attribute/field of a entity, in other
words a `List` or a `Set`, containing references to other domain
entities. `Map`s are not supported. Collections of value types are not
Modified: isis/site/trunk/content/how-tos/how-to-01-060-How-to-add-an-action-to-a-domain-entity-or-service.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-060-How-to-add-an-action-to-a-domain-entity-or-service.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-060-How-to-add-an-action-to-a-domain-entity-or-service.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-060-How-to-add-an-action-to-a-domain-entity-or-service.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to add an action to a domain entity or service
--------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
An 'action' is a method that we expect the user to be able to invoke on
a domain entity via the user interface, though it may also be invoked
programmatically within the object model. The following conventions are
Modified: isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
title: How to specify the icon for a domain object
+[//]: # (content copied to _user-guide_xxx)
+
Apache Isis viewers identify objects to the end-user through both an icon and a [title](./how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html).
The icon can be either static and fixed - meaning it is based on the object's class - or dynamic and changing - meaning
Modified: isis/site/trunk/content/how-tos/how-to-01-080-How-to-specify-the-order-in-which-properties-or-collections-are-displayed.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-080-How-to-specify-the-order-in-which-properties-or-collections-are-displayed.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-080-How-to-specify-the-order-in-which-properties-or-collections-are-displayed.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-080-How-to-specify-the-order-in-which-properties-or-collections-are-displayed.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify the order in which properties or collections are displayed
-------------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
> This material more-or-less duplicates the information to be found in [here](../components/viewers/wicket/static-layouts.html).
The `@MemberOrder` annotation provides a hint to the viewer as to the
Modified: isis/site/trunk/content/how-tos/how-to-01-090-How-to-specify-the-order-in-which-actions-appear-on-the-menu.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-090-How-to-specify-the-order-in-which-actions-appear-on-the-menu.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-090-How-to-specify-the-order-in-which-actions-appear-on-the-menu.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-090-How-to-specify-the-order-in-which-actions-appear-on-the-menu.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify the order in which actions appear on the menu
------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
> This material more-or-less duplicates the information to be found in [here](../components/viewers/wicket/static-layouts.html).
The `@MemberOrder` annotation provides a hint to the viewer as to the
Modified: isis/site/trunk/content/how-tos/how-to-01-100-How-to-make-a-property-optional.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-100-How-to-make-a-property-optional.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-100-How-to-make-a-property-optional.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-100-How-to-make-a-property-optional.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to make a property optional (when saving an object)
-------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
By default, when a new transient (unsaved) object is presented to the
user, values must be specified for all properties before the object may
be saved.
Modified: isis/site/trunk/content/how-tos/how-to-01-110-How-to-make-an-action-parameter-optional.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-110-How-to-make-an-action-parameter-optional.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-110-How-to-make-an-action-parameter-optional.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-110-How-to-make-an-action-parameter-optional.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to make an action parameter optional
----------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
By default, the framework assumes that when an action method is to be
invoked, all the parameters are mandatory. You may override this
behaviour by marking up one or more of the paramaters with the
Modified: isis/site/trunk/content/how-tos/how-to-01-120-How-to-specify-the-size-of-String-properties.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-120-How-to-specify-the-size-of-String-properties.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-120-How-to-specify-the-size-of-String-properties.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-120-How-to-specify-the-size-of-String-properties.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify the size of String properties
--------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Use:
- the `@MaxLength` to specify the maximum number of characters that
Modified: isis/site/trunk/content/how-tos/how-to-01-130-How-to-specify-the-size-of-String-action-parameters.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-130-How-to-specify-the-size-of-String-action-parameters.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-130-How-to-specify-the-size-of-String-action-parameters.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-130-How-to-specify-the-size-of-String-action-parameters.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify the size of String action parameters
---------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
As for properties (see ?), use:
- the `@MaxLength` to specify the maximum number of characters that
Modified: isis/site/trunk/content/how-tos/how-to-01-140-How-to-specify-names-or-descriptions-for-an-action-parameter.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-140-How-to-specify-names-or-descriptions-for-an-action-parameter.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-140-How-to-specify-names-or-descriptions-for-an-action-parameter.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-140-How-to-specify-names-or-descriptions-for-an-action-parameter.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify names and/or descriptions for an action parameter
----------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Unlike with properties, the framework cannot pick up the names of
parameters that you use within the domain code. By default parameters
will be labelled only with the type of the object required (e.g.
Modified: isis/site/trunk/content/how-tos/how-to-01-150-How-to-inject-services-into-a-domain-entity-or-other-service.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-150-How-to-inject-services-into-a-domain-entity-or-other-service.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-150-How-to-inject-services-into-a-domain-entity-or-other-service.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-150-How-to-inject-services-into-a-domain-entity-or-other-service.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to inject services into a domain entity or other service
------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Apache Isis autowires (automatically injects) domain services into each entity, as well as into the domain services themselves, using either method injection or field injection. The applib `DomainObjectContainer` is also a service, so can be injected in exactly the same manner.
### Method Injection
Modified: isis/site/trunk/content/how-tos/how-to-01-160-How-to-create-or-delete-objects-within-your-code.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-01-160-How-to-create-or-delete-objects-within-your-code.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-01-160-How-to-create-or-delete-objects-within-your-code.md (original)
+++ isis/site/trunk/content/how-tos/how-to-01-160-How-to-create-or-delete-objects-within-your-code.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to create or delete objects within your code
------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
When you create any domain object within your application code, it is
important that the framework is made aware of the existence of this new
object - in order that it may be persisted to the object store, and in
Modified: isis/site/trunk/content/how-tos/how-to-02-010-How-to-hide-a-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-010-How-to-hide-a-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-010-How-to-hide-a-property.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-010-How-to-hide-a-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to hide a property
----------------------
+[//]: # (content copied to _user-guide_xxx)
+
The mechanism for hiding a property is broadly the same as for hiding a
collection <!--(see ?)--> or an action <!--(see ?)-->.
Modified: isis/site/trunk/content/how-tos/how-to-02-020-How-to-hide-a-collection.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-020-How-to-hide-a-collection.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-020-How-to-hide-a-collection.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-020-How-to-hide-a-collection.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to hide a collection
------------------------
+[//]: # (content copied to _user-guide_xxx)
+
The mechanism for hiding a collection is broadly the same as for hiding
a property <!--(see ?)--> or an action <!--(see ?)-->.
Modified: isis/site/trunk/content/how-tos/how-to-02-030-How-to-hide-an-action.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-030-How-to-hide-an-action.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-030-How-to-hide-an-action.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-030-How-to-hide-an-action.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to hide an action
---------------------
+[//]: # (content copied to _user-guide_xxx)
+
The mechanism for hiding an action is broadly the same as for hiding a
property <!--(see ?)--> or a collection <!--(see ?)-->.
Modified: isis/site/trunk/content/how-tos/how-to-02-050-How-to-prevent-a-property-from-being-modified.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-050-How-to-prevent-a-property-from-being-modified.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-050-How-to-prevent-a-property-from-being-modified.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-050-How-to-prevent-a-property-from-being-modified.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to prevent a property from being modified
---------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Preventing the user from modifying a property value is known as
'disabling' the property. Note that this doesn't prevent the property
from being modified programmatically.
Modified: isis/site/trunk/content/how-tos/how-to-02-060-How-to-prevent-a-collection-from-being-modified.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-060-How-to-prevent-a-collection-from-being-modified.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-060-How-to-prevent-a-collection-from-being-modified.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-060-How-to-prevent-a-collection-from-being-modified.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to prevent a collection from being modified
-----------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Preventing the user from adding to or removing from a collection is
known as 'disabling' the collection.
Modified: isis/site/trunk/content/how-tos/how-to-02-070-How-to-prevent-an-action-from-being-invoked.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-070-How-to-prevent-an-action-from-being-invoked.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-070-How-to-prevent-an-action-from-being-invoked.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-070-How-to-prevent-an-action-from-being-invoked.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to prevent an action from being invoked
-------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Preventing the user from invoking an action is known as 'disabling' the
action.
Modified: isis/site/trunk/content/how-tos/how-to-02-100-How-to-validate-user-input-for-a-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-100-How-to-validate-user-input-for-a-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-100-How-to-validate-user-input-for-a-property.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-100-How-to-validate-user-input-for-a-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to validate user input for a property
-----------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
### Declarative validation
For properties that accept a text input string, such as `String` and
Modified: isis/site/trunk/content/how-tos/how-to-02-110-How-to-validate-an-object-being-added-or-removed-from-a-collection.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-110-How-to-validate-an-object-being-added-or-removed-from-a-collection.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-110-How-to-validate-an-object-being-added-or-removed-from-a-collection.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-110-How-to-validate-an-object-being-added-or-removed-from-a-collection.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to validate an object being added or removed from a collection
------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
A `validateAddToXxx()` method can be used to check that an object is
valid to be added to a collection. Conversely, the
validateRemoveFromXxx() method can be used to check that it is valid to
Modified: isis/site/trunk/content/how-tos/how-to-02-120-How-to-validate-an-action-parameter-argument.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-02-120-How-to-validate-an-action-parameter-argument.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-02-120-How-to-validate-an-action-parameter-argument.md (original)
+++ isis/site/trunk/content/how-tos/how-to-02-120-How-to-validate-an-action-parameter-argument.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to validate an action parameter argument
--------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
### Declarative validation
For parameters that accept a text input string, such as `String` and
Modified: isis/site/trunk/content/how-tos/how-to-03-010-How-to-specify-a-set-of-choices-for-a-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-010-How-to-specify-a-set-of-choices-for-a-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-010-How-to-specify-a-set-of-choices-for-a-property.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-010-How-to-specify-a-set-of-choices-for-a-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify a set of choices for a property
----------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
The simplest way to provide the user with a set of choices for a
property (possibly rendered as a drop-down list, for example) is to
ensure that the type used by the property is marked up as `@Bounded`
Modified: isis/site/trunk/content/how-tos/how-to-03-015-How-to-specify-an-autocomplete-for-a-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-015-How-to-specify-an-autocomplete-for-a-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-015-How-to-specify-an-autocomplete-for-a-property.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-015-How-to-specify-an-autocomplete-for-a-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify an auto-complete for a property
----------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Using the auto-complete method you can allow the user to search for objects based on a single string. These will be made available to the user through a device such as a drop-down list.
The syntax for properties is:
Modified: isis/site/trunk/content/how-tos/how-to-03-017-How-to-specify-default-value-of-an-object-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-017-How-to-specify-default-value-of-an-object-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-017-How-to-specify-default-value-of-an-object-property.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-017-How-to-specify-default-value-of-an-object-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify default value of an object property
--------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
See [How to set up the initial value of a property programmatically](../more-advanced-topics/how-to-07-010-How-to-set-up-the-initial-value-of-a-property-programmatically.html).
Modified: isis/site/trunk/content/how-tos/how-to-03-020-How-to-specify-a-set-of-choices-for-an-action-parameter.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-020-How-to-specify-a-set-of-choices-for-an-action-parameter.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-020-How-to-specify-a-set-of-choices-for-an-action-parameter.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-020-How-to-specify-a-set-of-choices-for-an-action-parameter.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify a set of choices for an action parameter
-------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
The programmer may provide a set of choices for the value of any or all
of the parameters of an action. These will be made available to the user
- for example as a drop-down list.
Modified: isis/site/trunk/content/how-tos/how-to-03-022-How-to-specify-dependent-choices-for-action-parameters.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-022-How-to-specify-dependent-choices-for-action-parameters.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-022-How-to-specify-dependent-choices-for-action-parameters.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-022-How-to-specify-dependent-choices-for-action-parameters.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify dependent choices for action parameters
------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Sometimes there is a dependency between the value of one parameter and the set of values to another. For example, if selecting a particular category, then this implies a set of subcategories belonging to that category. Or, if selecting a particular country, then this implies a set of states/counties within that country.
To specify such a dependency, the `choicesNActionName()` can be overloaded with the `N-1` preceding parameters.
Modified: isis/site/trunk/content/how-tos/how-to-03-025-How-to-specify-an-autocomplete-for-an-action-parameter.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-025-How-to-specify-an-autocomplete-for-an-action-parameter.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-025-How-to-specify-an-autocomplete-for-an-action-parameter.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-025-How-to-specify-an-autocomplete-for-an-action-parameter.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify an auto-complete for an action parameter [1.3.0+]
-------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Using the auto-complete method you can allow the user to search for objects based on a single string. These will be made available to the user through a device such as a drop-down list.
The syntax is:
Modified: isis/site/trunk/content/how-tos/how-to-03-030-How-to-specify-that-a-class-of-objects-has-a-limited-number-of-instances.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-030-How-to-specify-that-a-class-of-objects-has-a-limited-number-of-instances.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-030-How-to-specify-that-a-class-of-objects-has-a-limited-number-of-instances.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-030-How-to-specify-that-a-class-of-objects-has-a-limited-number-of-instances.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify that a class of objects has a limited number of instances
------------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Sometimes an entity may only have a relatively small number of
instances, for example the types of credit cards accepted (Visa,
Mastercard, Amex). Viewers will typically expected to render the
Modified: isis/site/trunk/content/how-tos/how-to-03-040-How-to-find-an-entity-(for-an-action-parameter-or-property)-using-auto-complete.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-040-How-to-find-an-entity-%28for-an-action-parameter-or-property%29-using-auto-complete.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-040-How-to-find-an-entity-(for-an-action-parameter-or-property)-using-auto-complete.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-040-How-to-find-an-entity-(for-an-action-parameter-or-property)-using-auto-complete.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to find an entity (for an action parameter or property) using auto-complete
-------------------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Some viewers (eg the Wicket viewer) allow an entity to be specified (as
an argument for an action parameter, or as the new value of a property)
by enabling the user to type its title. The framework then searches for
Modified: isis/site/trunk/content/how-tos/how-to-03-050-How-to-specify-default-values-for-an-action-parameter.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-03-050-How-to-specify-default-values-for-an-action-parameter.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-03-050-How-to-specify-default-values-for-an-action-parameter.md (original)
+++ isis/site/trunk/content/how-tos/how-to-03-050-How-to-specify-default-values-for-an-action-parameter.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify default values for an action parameter
-----------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
When an action is about to be invoked, then default values can be
provided for any or all of its parameters.
Modified: isis/site/trunk/content/how-tos/how-to-04-000-How-to-derive-properties-and-collections-and-other-side-effects.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-04-000-How-to-derive-properties-and-collections-and-other-side-effects.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-04-000-How-to-derive-properties-and-collections-and-other-side-effects.md (original)
+++ isis/site/trunk/content/how-tos/how-to-04-000-How-to-derive-properties-and-collections-and-other-side-effects.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to derive properties and collections, and other side-effects
========
+[//]: # (content copied to _user-guide_xxx)
+
The Isis viewers will automatically render the state of properties and
collections, but the values of such need not be persisted; they can be
derived from other information available to the object.
Modified: isis/site/trunk/content/how-tos/how-to-08-000-How-to-handle-security-concerns.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-08-000-How-to-handle-security-concerns.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-08-000-How-to-handle-security-concerns.md (original)
+++ isis/site/trunk/content/how-tos/how-to-08-000-How-to-handle-security-concerns.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to handle security concerns
===============================
+[//]: # (content copied to _user-guide_xxx)
+
> Further validation how-to's that apply across all class members
This chapter has some additional recipes/how-tos relating to
Modified: isis/site/trunk/content/how-tos/how-to-09-010-How-to-register-domain-services,-repositories-and-factories.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-09-010-How-to-register-domain-services%2C-repositories-and-factories.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-09-010-How-to-register-domain-services,-repositories-and-factories.md (original)
+++ isis/site/trunk/content/how-tos/how-to-09-010-How-to-register-domain-services,-repositories-and-factories.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to register domain services, repositories and factories
-----------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Domain services (which includes repositories and factories) can either be automatically registered (by virtue of being present on the classpath and annotated appropriately) or must be explicitly registered in the `isis.properties` configuration file, under the `isis.services` key (a comma-separated list).
### Automatic Registration
Modified: isis/site/trunk/content/how-tos/how-to-09-040-How-to-write-a-custom-repository.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-09-040-How-to-write-a-custom-repository.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-09-040-How-to-write-a-custom-repository.md (original)
+++ isis/site/trunk/content/how-tos/how-to-09-040-How-to-write-a-custom-repository.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to write a custom repository
--------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Repositories are defined as interfaces within the domain, and their implementation will vary by object store. During prototyping and for much of development, you will probably find it easiest to use an in-memory object store or perhaps the XML object store, with only a small number of instances. The `DomainObjectContainer` provides a set of methods that make it easy to pull back all instances from the object store which can then be filtered as required. Later on, you can replace
the implementation depending upon the specifics of the object store that you'll be using for production.
Modified: isis/site/trunk/content/how-tos/how-to-09-050-How-to-use-Factories.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-09-050-How-to-use-Factories.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-09-050-How-to-use-Factories.md (original)
+++ isis/site/trunk/content/how-tos/how-to-09-050-How-to-use-Factories.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to use Factories
--------------------
+[//]: # (content copied to _user-guide_xxx)
+
Like repositories, factories are defined by interface in the domain, decoupling the domain objects from their actual implementation.
Unlike repositories, there is no particular need to change the implementation when moving from one object store to another, because in all cases the factory can simply delegate to its injected `DomainObjectContainer`.
Modified: isis/site/trunk/content/how-tos/how-to-customize-styling-for-a-domain-object.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/how-tos/how-to-customize-styling-for-a-domain-object.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/how-tos/how-to-customize-styling-for-a-domain-object.md (original)
+++ isis/site/trunk/content/how-tos/how-to-customize-styling-for-a-domain-object.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
title: How to customize the styling of a domain object (1.8.0)
+[//]: # (content copied to _user-guide_xxx)
+
The [Wicket viewer](../components/viewers/wicket/about.html) will query each object when being rendered to determine if
any instance-specific CSS class name should be used to wrap the HTML representing that domain object.
Modified: isis/site/trunk/content/intro/elevator-pitch/common-use-cases.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/elevator-pitch/common-use-cases.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/elevator-pitch/common-use-cases.md (original)
+++ isis/site/trunk/content/intro/elevator-pitch/common-use-cases.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Common Use Cases
+[//]: # (content copied to _user-guide_xxx)
+
## <a name="screencast"></a>Screencast
How Apache Isis builds a webapp from the underlying domain object model...
Modified: isis/site/trunk/content/intro/elevator-pitch/isis-in-pictures.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/elevator-pitch/isis-in-pictures.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/elevator-pitch/isis-in-pictures.md (original)
+++ isis/site/trunk/content/intro/elevator-pitch/isis-in-pictures.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Dynamically builds the UI
+[//]: # (content copied to _user-guide_xxx)
+
{isis-in-pictures
Isis dynamically builds a generic UI directlyo from the underlying domain objects. It works by building an internal metamodel that describes the structure and behaviour of the domain objects, and then uses this metamodel to render the objects. You can think of it as akin to an object-relational mapper; however rather than projecting the domain objects into a database, it projects them onto a web page.
Modified: isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md (original)
+++ isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: SimpleApp Archetype
+[//]: # (content copied to _user-guide_xxx)
+
The quickest way to get started with Apache Isis is to run the simple archetype. This will generate a very simple one-class domain model, called `SimpleObject`, with a single property `name`. There is also a corresponding `SimpleObjectRepository` domain service. From this you can easily rename these initial classes, and extend to build up your own Isis domain application.
## Generating the App (stable release)
Modified: isis/site/trunk/content/intro/getting-started/todoapp-archetype.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/getting-started/todoapp-archetype.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/getting-started/todoapp-archetype.md (original)
+++ isis/site/trunk/content/intro/getting-started/todoapp-archetype.md Tue May 5 19:51:18 2015
@@ -1,4 +1,6 @@
Title: TodoApp Archetype
+[//]: # (content copied to _user-guide_xxx)
+
> as of 1.8.0 the todoapp is no longer released; the example app has instead moved to [Isis addons](https://github.com/isisaddons/isis-app-todoapp) (not ASF). This allows us to provide a more fully-fledged example that integrates with other Isis addons modules.
Modified: isis/site/trunk/content/intro/learning-more/articles-and-presentations.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/learning-more/articles-and-presentations.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/learning-more/articles-and-presentations.md (original)
+++ isis/site/trunk/content/intro/learning-more/articles-and-presentations.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Articles, Conference Sessions, Podcasts
+[//]: # (content copied to _user-guide_xxx)
+
Some articles and recorded material relating to either Apache Isis (or its predecessor, the Naked Objects framework), or its 'sister' open source project on the .NET platform, Naked Objects .NET. We've **highlighted** some of the better ones...
2014
Modified: isis/site/trunk/content/intro/learning-more/books.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/learning-more/books.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/learning-more/books.md (original)
+++ isis/site/trunk/content/intro/learning-more/books.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Books
+[//]: # (content copied to _user-guide_xxx)
+
Although it has evolved since, the *Apache Isis* framework started out as an open source implementation of the naked objects pattern. Indeed, the generic user interfaces provided by Isis [Wicket](../../components/viewers/wicket/about.html) viewer and the [Restful Objects](../../components/viewers/restfulobjects/about.html) viewer are both "just" naked objects implementations; the first serves up a default generic representation of domain objects for human interaction, the latter serving up representation intended for machine consumption rather than human beings.
If the idea of naked objects is of interest, then there are a couple of books on the topic that you might want to read.
Modified: isis/site/trunk/content/intro/learning-more/hexagonal-architecture.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/learning-more/hexagonal-architecture.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/learning-more/hexagonal-architecture.md (original)
+++ isis/site/trunk/content/intro/learning-more/hexagonal-architecture.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Hexagonal Architecture
+[//]: # (content copied to _user-guide_core-concepts_hexagonal-architecture)
+
{stub
This page is a stub.
}
Modified: isis/site/trunk/content/intro/powered-by/TransportPlanner/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/powered-by/TransportPlanner/about.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/powered-by/TransportPlanner/about.md (original)
+++ isis/site/trunk/content/intro/powered-by/TransportPlanner/about.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: TransportPlanner Script
+[//]: # (content copied to _user-guide_xxx)
+
###Log in
- log in with chris/pass
- a user with less privileges is arne/pass (Arne is not allowed to plan. He represents a customer who only is able to create a transport demand)
Modified: isis/site/trunk/content/intro/powered-by/powered-by.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/powered-by/powered-by.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/powered-by/powered-by.md (original)
+++ isis/site/trunk/content/intro/powered-by/powered-by.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Powered by
+[//]: # (content copied to _user-guide_xxx)
+
Here are some freely accessible (and sometimes open source) applications that are powered by Isis.
>If you have written an app in Isis that you'd like to share, please mention it on the [mailing list](../../support.html).
Modified: isis/site/trunk/content/intro/resources/cheat-sheet.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/resources/cheat-sheet.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/resources/cheat-sheet.md (original)
+++ isis/site/trunk/content/intro/resources/cheat-sheet.md Tue May 5 19:51:18 2015
@@ -1,3 +1,5 @@
Title: Cheat Sheet
+[//]: # (content copied to _user-guide_xxx)
+
The cheat sheet ([pdf](resources/IsisCheatSheet.pdf) [docx](resources/IsisCheatSheet.docx)) summarises the main programming conventions to follow when writing an Isis application.
Modified: isis/site/trunk/content/intro/resources/editor-templates.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/resources/editor-templates.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/resources/editor-templates.md (original)
+++ isis/site/trunk/content/intro/resources/editor-templates.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Editor Templates
+[//]: # (content copied to _user-guide_xxx)
+
The following table lists various IDE templates (for IntelliJ and Eclipse) when writing Isis domain objects and unit tests:
<table class="table table-striped table-bordered table-condensed">
Modified: isis/site/trunk/content/intro/resources/icons.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/resources/icons.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/resources/icons.md (original)
+++ isis/site/trunk/content/intro/resources/icons.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Icons
+[//]: # (content copied to _user-guide_xxx)
+
Most Isis viewers use icons to help identify domain objects in the user interface. It's a good idea to ensure that these are styled consistently. To get you started, we couple of basic icon sets:
* [haywood](https://github.com/apache/isis/blob/master/src/site/resources/images/icons/haywood.zip?raw=true)
Modified: isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md (original)
+++ isis/site/trunk/content/intro/tutorials/apacheconeu-2014.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Stop scaffolding, start coding
+[//]: # (content copied to _user-guide_xxx)
+
{apacheconeu2014
{note
Modified: isis/site/trunk/content/intro/tutorials/screencasts.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/tutorials/screencasts.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/tutorials/screencasts.md (original)
+++ isis/site/trunk/content/intro/tutorials/screencasts.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Screencasts
+[//]: # (content copied to _user-guide_xxx)
+
We've prepared some screencasts to help you quickly see what Apache Isis has to offer.
<table class="table table-bordered table-hover">
Modified: isis/site/trunk/content/intro/tutorials/step-by-step-petclinic.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/tutorials/step-by-step-petclinic.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/tutorials/step-by-step-petclinic.md (original)
+++ isis/site/trunk/content/intro/tutorials/step-by-step-petclinic.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Step-by-step tutorial: Petclinic
+[//]: # (content copied to _user-guide_xxx)
+
{step-by-step
{note
Modified: isis/site/trunk/content/intro/tutorials/tutorials.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/intro/tutorials/tutorials.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/intro/tutorials/tutorials.md (original)
+++ isis/site/trunk/content/intro/tutorials/tutorials.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: Tutorials
+[//]: # (content copied to _user-guide_xxx)
+
## Stop Scaffolding, Start Coding
This [tutorial](apacheconeu-2014.html) was originally put together for Apache Con Europe 2014.
Modified: isis/site/trunk/content/more-advanced-topics/Fixture-Scripts.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/Fixture-Scripts.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/Fixture-Scripts.md (original)
+++ isis/site/trunk/content/more-advanced-topics/Fixture-Scripts.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
Fixture Scripts
===============
+[//]: # (content copied to _user-guide_xxx)
+
Fixture scripts are intended to support development and testing, by setting up the system into a known state. A
fixture script is invoked using a "fixture script" service, and typically invokes business actions on domain objects,
either directly, or by delegating to child fixture scripts (the composite pattern).
Modified: isis/site/trunk/content/more-advanced-topics/ViewModel.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/ViewModel.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/ViewModel.md (original)
+++ isis/site/trunk/content/more-advanced-topics/ViewModel.md Tue May 5 19:51:18 2015
@@ -1,5 +1,7 @@
Title: ViewModels
+[//]: # (content copied to _user-guide_xxx)
+
In most cases users can accomplish the business operations they need by invoking actions directly on domain entities. For some high-volume or specialized uses cases,
though, there may be a requirement to bring together data or functionality that spans several entities.
Modified: isis/site/trunk/content/more-advanced-topics/are-you-sure-idiom.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/are-you-sure-idiom.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/are-you-sure-idiom.md (original)
+++ isis/site/trunk/content/more-advanced-topics/are-you-sure-idiom.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
Title: 'Are you sure?' idiom
----------
+[//]: # (content copied to _user-guide_xxx)
+
[//]: # (content copied to user-guide_how-tos_tips-n-tricks_are-you-sure)
If providing an action that will perform irreversible changes, include a
Modified: isis/site/trunk/content/more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to decouple dependencies using contributions
------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
In a small application (a dozen or less entities, say) there is little risk in having cyclic
dependencies between entities, but as your application gets larger this coupling will cause problems - the inevitable [big ball of mud](http://en.wikipedia.org/wiki/Big_ball_of_mud).
Modified: isis/site/trunk/content/more-advanced-topics/how-to-01-065-How-to-add-an-action-to-be-called-on-every-object-in-a-list.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-01-065-How-to-add-an-action-to-be-called-on-every-object-in-a-list.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-01-065-How-to-add-an-action-to-be-called-on-every-object-in-a-list.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-01-065-How-to-add-an-action-to-be-called-on-every-object-in-a-list.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to add an action to be called on every entity within a list
---------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Usually an action is performed on a single instance of an entity (or domain service). To indicate that a given action should be called for every instance of a list (eg as returned by a domain service finder), add the `@Bulk` annotation:
public class SomeDomainService {
Modified: isis/site/trunk/content/more-advanced-topics/how-to-02-040-How-to-specify-that-none-of-an-object's-members-is-visible.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-02-040-How-to-specify-that-none-of-an-object%27s-members-is-visible.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-02-040-How-to-specify-that-none-of-an-object's-members-is-visible.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-02-040-How-to-specify-that-none-of-an-object's-members-is-visible.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify that none of an object's members is visible
----------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
To when an object is visible, provide a `hidden()` method:
public class TrackingAction implements Tracking {
Modified: isis/site/trunk/content/more-advanced-topics/how-to-02-080-How-to-specify-that-none-of-an-object's-members-can-be-modified-or-invoked.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-02-080-How-to-specify-that-none-of-an-object%27s-members-can-be-modified-or-invoked.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-02-080-How-to-specify-that-none-of-an-object's-members-can-be-modified-or-invoked.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-02-080-How-to-specify-that-none-of-an-object's-members-can-be-modified-or-invoked.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify that none of an object's members can be modified/invoked
-----------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Some objects have state which should not be modifiable only under
certain conditions; for example an invoice can not be modified after it
has been paid. The viewer is expected to interpret this by suppressing
Modified: isis/site/trunk/content/more-advanced-topics/how-to-02-090-How-to-specify-that-an-object-is-immutable.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-02-090-How-to-specify-that-an-object-is-immutable.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-02-090-How-to-specify-that-an-object-is-immutable.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-02-090-How-to-specify-that-an-object-is-immutable.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify that an object is immutable (that none of its members can ever be modified)
------------------------------------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Some objects have state which should not be modifiable; for example
those representing reference data. The viewer is expected to interpret
this by which suppressing any sort of "edit" button.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-02-130-How-to-validate-declaratively-using-MustSatisfy.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-02-130-How-to-validate-declaratively-using-MustSatisfy.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-02-130-How-to-validate-declaratively-using-MustSatisfy.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-02-130-How-to-validate-declaratively-using-MustSatisfy.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to validate declaratively using @MustSatisfy
------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
The `@MustSatisfy` annotation is an alternative to using imperative
validation, allowing validation rules to be captured in an
(implementation of a) `org.apache.isis.applib.spec.Specification`.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-010-How-to-make-a-derived-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-010-How-to-make-a-derived-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-010-How-to-make-a-derived-property.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-010-How-to-make-a-derived-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to make a derived property
------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
### Read-only
Most derived properties are read-only, their value being derived from
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-015-Password-properties-and-params.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-015-Password-properties-and-params.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-015-Password-properties-and-params.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-015-Password-properties-and-params.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to use a Password field
--------------------
+[//]: # (content copied to _user-guide_xxx)
+
Isis provides the `org.apache.isis.applib.value.Password` value type which the Wicket viewer will automatically render
using an appropriate `input type=password` field.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-020-How-to-make-a-derived-collection.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-020-How-to-make-a-derived-collection.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-020-How-to-make-a-derived-collection.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-020-How-to-make-a-derived-collection.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to make a derived collection
--------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Collections can be derived by omitting the mutator (the same way as
[properties](./how-to-04-010-How-to-make-a-derived-property.html). It should however be annotated with Isis' `@NotPersisted` annotation.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-030-How-to-inline-the-results-of-a-query-only-repository-action.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-030-How-to-inline-the-results-of-a-query-only-repository-action.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-030-How-to-inline-the-results-of-a-query-only-repository-action.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-030-How-to-inline-the-results-of-a-query-only-repository-action.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to inline the results of a query-only repository action
-----------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
While derived properties <!--(?)--> and derived collections <!--(?)--> typically "walk
the graph" to associated objects, there is nothing to prevent the
returned value being the result of invoking a repository (domain
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-040-How-to-trigger-other-behaviour-when-a-property-is-changed.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-040-How-to-trigger-other-behaviour-when-a-property-is-changed.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-040-How-to-trigger-other-behaviour-when-a-property-is-changed.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-040-How-to-trigger-other-behaviour-when-a-property-is-changed.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to trigger other behaviour when a property is changed
---------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
If you want to invoke functionality whenever a property is changed by
the user, then you should create a supporting `modifyXxx()` method and
include the functionality within that. The syntax is:
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-050-How-to-trigger-other-behaviour-when-an-object-is-added-or-removed.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-050-How-to-trigger-other-behaviour-when-an-object-is-added-or-removed.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-050-How-to-trigger-other-behaviour-when-an-object-is-added-or-removed.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-050-How-to-trigger-other-behaviour-when-an-object-is-added-or-removed.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to trigger other behaviour when an object is added or removed
-----------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
A collection may have a corresponding `addToXxx()` and/or
`removeFromXxx()` method. If present, and direct manipulation of the
contents of the connection has not been disabled (see ?), then they will
Modified: isis/site/trunk/content/more-advanced-topics/how-to-04-060-How-to-set-up-and-maintain-bidirectional-relationships.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-04-060-How-to-set-up-and-maintain-bidirectional-relationships.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-04-060-How-to-set-up-and-maintain-bidirectional-relationships.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-04-060-How-to-set-up-and-maintain-bidirectional-relationships.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to set up and maintain bidirectional relationships
------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
> **Note**:
>
> If using the [JDO Objectstore](../../components/objectstores/jdo/about.html) then there is generally no need to explicitly maintain bidirectional relationships. Indeed, doing so may cause subtle errors. See [here](../../components/objectstores/jdo/managed-1-to-m-relationships.html) for more details.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-05-010-How-to-specify-a-name-or-description-for-an-object.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-05-010-How-to-specify-a-name-or-description-for-an-object.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-05-010-How-to-specify-a-name-or-description-for-an-object.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-05-010-How-to-specify-a-name-or-description-for-an-object.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify a name and/or description for an object
------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
By default, the name (or type) of an object, as displayed to the user
will be the class name. However, if an `@Named` annotation is included,
then this will override the default name. This might be used to include
Modified: isis/site/trunk/content/more-advanced-topics/how-to-05-020-How-to-specify-a-name-or-description-for-a-property.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-05-020-How-to-specify-a-name-or-description-for-a-property.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-05-020-How-to-specify-a-name-or-description-for-a-property.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-05-020-How-to-specify-a-name-or-description-for-a-property.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify a name and/or description for a property
-------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
### Specifying the name for a property
By default the framework will use the property name itself to label the
Modified: isis/site/trunk/content/more-advanced-topics/how-to-05-030-How-to-specify-a-name-or-description-for-a-collection.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-05-030-How-to-specify-a-name-or-description-for-a-collection.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-05-030-How-to-specify-a-name-or-description-for-a-collection.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-05-030-How-to-specify-a-name-or-description-for-a-collection.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify a name and/or description for a collection
---------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
### Specifying the name for a collection
By default the framework will use the collection name itself to label
Modified: isis/site/trunk/content/more-advanced-topics/how-to-05-040-How-to-specify-names-or-description-for-an-action.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-05-040-How-to-specify-names-or-description-for-an-action.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-05-040-How-to-specify-names-or-description-for-an-action.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-05-040-How-to-specify-names-or-description-for-an-action.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify names and/or description for an action
-----------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
### Specifying the name for an action
By default the framework will use the action name itself to label the
Modified: isis/site/trunk/content/more-advanced-topics/how-to-06-010-How-to-pass-a-messages-and-errors-back-to-the-user.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-06-010-How-to-pass-a-messages-and-errors-back-to-the-user.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-06-010-How-to-pass-a-messages-and-errors-back-to-the-user.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-06-010-How-to-pass-a-messages-and-errors-back-to-the-user.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to pass a messages and errors back to the user
--------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Sometimes, within an action it is necessary or desirable to pass a
message to the user, for example to inform them of the results of their
action ('5 payments have been issued') or that the action was not
Modified: isis/site/trunk/content/more-advanced-topics/how-to-07-010-How-to-set-up-the-initial-value-of-a-property-programmatically.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-07-010-How-to-set-up-the-initial-value-of-a-property-programmatically.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-07-010-How-to-set-up-the-initial-value-of-a-property-programmatically.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-07-010-How-to-set-up-the-initial-value-of-a-property-programmatically.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to set up the initial value of a property programmatically
--------------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
After an object has been created <!--(see ?)-->, there are several different
ways to setup the initial values for an object's properties.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-07-020-How-to-insert-behaviour-into-the-object-life-cycle.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-07-020-How-to-insert-behaviour-into-the-object-life-cycle.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-07-020-How-to-insert-behaviour-into-the-object-life-cycle.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-07-020-How-to-insert-behaviour-into-the-object-life-cycle.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to insert behaviour into the object life cycle
--------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
*Apache Isis* is responsible for managing the object lifecycle,
persisting, updating or removing objects from the persistent object
store as required. For many applications the domain objects are unaware
Modified: isis/site/trunk/content/more-advanced-topics/how-to-07-030-How-to-ensure-object-is-in-valid-state.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-07-030-How-to-ensure-object-is-in-valid-state.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-07-030-How-to-ensure-object-is-in-valid-state.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-07-030-How-to-ensure-object-is-in-valid-state.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to ensure object is in valid state
--------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
A `validate()` method may be added to provided validation at object level, prior to making an object persistent.
The syntax is:
Modified: isis/site/trunk/content/more-advanced-topics/how-to-07-040-How-to-specify-that-an-object-should-not-be-persisted.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-07-040-How-to-specify-that-an-object-should-not-be-persisted.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-07-040-How-to-specify-that-an-object-should-not-be-persisted.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-07-040-How-to-specify-that-an-object-should-not-be-persisted.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to specify that an object should not be persisted
-----------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Non-persisted objects are intended to be used as view models; they aggregate some state with respect to a certain process. This may be read-only (eg a projection of certain informaiton) or read-write (eg a wizard-like process object). Either way, the viewer is expected to interpret this by not providing any sort of automatic "save" menu item if such an object is returned to the GUI.
Non-persisted objects that are read-only are typically also marked as immutable <!--(see ?)-->.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-08-010-Hiding,-disabling-or-validating-for-specific-users-or-roles.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-08-010-Hiding%2C-disabling-or-validating-for-specific-users-or-roles.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-08-010-Hiding,-disabling-or-validating-for-specific-users-or-roles.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-08-010-Hiding,-disabling-or-validating-for-specific-users-or-roles.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
Hiding, disabling or validating for specific users or roles
-----------------------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Generally it is not good practice to embed knowledge of roles and/or
users into the domain classes; instead, this should be the
responsibility of the framework or platform and should be specified and
Modified: isis/site/trunk/content/more-advanced-topics/how-to-09-020-How-to-write-a-typical-domain-service.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-09-020-How-to-write-a-typical-domain-service.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-09-020-How-to-write-a-typical-domain-service.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-09-020-How-to-write-a-typical-domain-service.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
Singleton & request-scoped domain services
-----------------------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Domain services (by which we also mean repositories and factories) 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.
Modified: isis/site/trunk/content/more-advanced-topics/how-to-hide-part-of-a-title.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/more-advanced-topics/how-to-hide-part-of-a-title.md?rev=1677885&r1=1677884&r2=1677885&view=diff
==============================================================================
--- isis/site/trunk/content/more-advanced-topics/how-to-hide-part-of-a-title.md (original)
+++ isis/site/trunk/content/more-advanced-topics/how-to-hide-part-of-a-title.md Tue May 5 19:51:18 2015
@@ -1,6 +1,8 @@
How to hide part of a title
--------------------------------
+[//]: # (content copied to _user-guide_xxx)
+
Normally the visibility of doamin object properties is solely the framework viewers' concern; the domain objects do not
need to know which class members are visible or not.