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/06/01 17:57:26 UTC
[4/4] isis git commit: ISIS-1133: working on the annotations.
ISIS-1133: working on the annotations.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/4a9da14d
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/4a9da14d
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/4a9da14d
Branch: refs/heads/ISIS-1133
Commit: 4a9da14d9ac6b2af48bf0186058ccdeed02c7267
Parents: d85483a
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Mon Jun 1 16:57:16 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Mon Jun 1 16:57:16 2015 +0100
----------------------------------------------------------------------
adocs/documentation/monitor.rb | 34 +++--
.../_ug_appendices_release-notes.adoc | 4 +-
...re-concepts_framework-provided-services.adoc | 2 +-
..._core-concepts_other-deployment-options.adoc | 2 +-
...cepts_philosophy_hexagonal-architecture.adoc | 2 +-
...ncepts_philosophy_naked-objects-pattern.adoc | 2 +-
...ts_principles_apache-isis-vs_metawidget.adoc | 2 +-
...ache-isis-vs_mvc-server-side-frameworks.adoc | 4 +-
.../asciidoc/user-guide/_ug_deployment_gae.adoc | 2 +-
...ug_getting-started_datanucleus-enhancer.adoc | 2 +-
...dless-access_BackgroundCommandExecution.adoc | 2 +-
.../user-guide/_ug_how-tos_domain-services.adoc | 2 +-
.../user-guide/_ug_isis-addons-modules.adoc | 2 +-
..._ug_isis-addons-modules_devutils-module.adoc | 2 +-
.../user-guide/_ug_isis-in-pictures.adoc | 56 ++++----
..._ug_more-advanced_decoupling_db-schemas.adoc | 2 +-
.../user-guide/_ug_more-advanced_i18n.adoc | 2 +-
...ug_reference-annotations_aaa_deprecated.adoc | 4 +-
...ug_reference-annotations_manpage-Action.adoc | 15 ++-
...erence-annotations_manpage-ActionLayout.adoc | 49 ++++---
...ations_manpage-ActionLayout_bookmarking.adoc | 63 ++++-----
...ions_manpage-ActionLayout_contributedAs.adoc | 49 +++----
...notations_manpage-ActionLayout_cssClass.adoc | 58 +++------
...tations_manpage-ActionLayout_cssClassFa.adoc | 80 ++++--------
...ations_manpage-ActionLayout_describedAs.adoc | 22 +++-
...annotations_manpage-ActionLayout_hidden.adoc | 117 ++++-------------
...-annotations_manpage-ActionLayout_named.adoc | 43 ++++---
...ence-annotations_manpage-Action_command.adoc | 42 +++---
...-annotations_manpage-Action_domainEvent.adoc | 41 +++---
...rence-annotations_manpage-Action_hidden.adoc | 25 +++-
...nce-annotations_manpage-Action_invokeOn.adoc | 45 ++++---
...e-annotations_manpage-Action_publishing.adoc | 25 ++--
...e-annotations_manpage-Action_restrictTo.adoc | 10 +-
...ce-annotations_manpage-Action_semantics.adoc | 12 +-
...rence-annotations_manpage-Action_typeOf.adoc | 12 +-
...eference-annotations_manpage-Collection.adoc | 19 ++-
...ce-annotations_manpage-CollectionLayout.adoc | 8 +-
...tions_manpage-CollectionLayout_cssClass.adoc | 15 ++-
...ns_manpage-CollectionLayout_describedAs.adoc | 13 ++
...tations_manpage-CollectionLayout_hidden.adoc | 7 +
...otations_manpage-CollectionLayout_named.adoc | 14 +-
...otations_manpage-CollectionLayout_paged.adoc | 7 +
...tations_manpage-CollectionLayout_render.adoc | 7 +
...tions_manpage-CollectionLayout_sortedBy.adoc | 7 +
...otations_manpage-Collection_domainEvent.adoc | 117 ++++++++---------
...-annotations_manpage-Collection_editing.adoc | 128 ++++---------------
...e-annotations_manpage-Collection_hidden.adoc | 117 +++--------------
...erence-annotations_manpage-DomainObject.adoc | 4 +-
...-annotations_manpage-DomainObjectLayout.adoc | 16 ++-
...ons_manpage-DomainObjectLayout_cssClass.adoc | 34 ++---
...s_manpage-DomainObjectLayout_cssClassFa.adoc | 44 ++-----
..._manpage-DomainObjectLayout_describedAs.adoc | 7 +-
...ations_manpage-DomainObjectLayout_named.adoc | 14 +-
...ations_manpage-DomainObjectLayout_paged.adoc | 1 -
...rence-annotations_manpage-DomainService.adoc | 4 +-
...annotations_manpage-DomainServiceLayout.adoc | 9 +-
...tions_manpage-DomainServiceLayout_named.adoc | 11 ++
...reference-annotations_manpage-Parameter.adoc | 4 +-
...nce-annotations_manpage-ParameterLayout.adoc | 12 +-
...ations_manpage-ParameterLayout_cssClass.adoc | 7 +-
...ons_manpage-ParameterLayout_describedAs.adoc | 5 +
...notations_manpage-ParameterLayout_named.adoc | 11 ++
..._reference-annotations_manpage-Property.adoc | 9 +-
...ence-annotations_manpage-PropertyLayout.adoc | 6 +-
...tations_manpage-PropertyLayout_cssClass.adoc | 12 +-
...ions_manpage-PropertyLayout_describedAs.adoc | 11 ++
...notations_manpage-PropertyLayout_hidden.adoc | 8 ++
...ns_manpage-PropertyLayout_labelPosition.adoc | 8 ++
...ations_manpage-PropertyLayout_multiLine.adoc | 6 +
...nnotations_manpage-PropertyLayout_named.adoc | 18 ++-
...page-PropertyLayout_renderedAsDayBefore.adoc | 7 +
...nnotations_manpage-Property_domainEvent.adoc | 92 ++++++-------
...ce-annotations_manpage-Property_editing.adoc | 113 +++-------------
...nce-annotations_manpage-Property_hidden.adoc | 110 ++++------------
...reference-annotations_manpage-ViewModel.adoc | 2 +-
...nce-annotations_manpage-ViewModelLayout.adoc | 12 +-
...ations_manpage-ViewModelLayout_cssClass.adoc | 7 +-
...ions_manpage-ViewModelLayout_cssClassFa.adoc | 9 +-
...ons_manpage-ViewModelLayout_describedAs.adoc | 5 +
...notations_manpage-ViewModelLayout_named.adoc | 14 +-
.../_ug_reference-methods_reserved_aaa.adoc | 2 +-
.../_ug_reference-services-api_aaa.adoc | 2 +-
...ices-api_manpage-BulkInteractionContext.adoc | 2 +-
...nce-services-api_manpage-CommandContext.adoc | 6 +-
...ce-services-api_manpage-EventBusService.adoc | 2 +-
...-services-api_manpage-QueryResultsCache.adoc | 2 +-
...ference-services-api_manpage-ScratchPad.adoc | 4 +-
...ce-services-spi_manpage-AuditingService.adoc | 2 +-
...nce-services-spi_manpage-CommandService.adoc | 2 +-
...-services-spi_manpage-PublishingService.adoc | 2 +-
.../main/asciidoc/user-guide/_ug_runtime.adoc | 4 +-
.../_ug_runtime_application-specific.adoc | 25 ++++
...s_disabling-persistence-by-reachability.adoc | 2 +-
.../main/asciidoc/user-guide/_ug_security.adoc | 4 +-
.../_ug_security_shiro-jdbc-realm.adoc | 2 +-
.../asciidoc/user-guide/_ug_testing_aaa.adoc | 2 +-
...esting_integ-test-support_typical-usage.adoc | 2 +-
..._wicket-viewer_customisation_brand-logo.adoc | 2 +-
...ewer_customisation_tweaking-css-classes.adoc | 4 +-
.../_ug_wicket-viewer_isis-addons.adoc | 2 +-
...cket-viewer_layout_static-object-layout.adoc | 2 +-
.../ActionLayout/bookmarking.png | Bin 0 -> 93128 bytes
.../party-agreementrole-agreement.png | Bin 10310 -> 0 bytes
.../party-agreementrole-agreement.png | Bin 0 -> 10310 bytes
.../src/main/asciidoc/user-guide/ug.adoc | 34 ++---
105 files changed, 900 insertions(+), 1138 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/monitor.rb
----------------------------------------------------------------------
diff --git a/adocs/documentation/monitor.rb b/adocs/documentation/monitor.rb
index 1f00861..8d7ef8b 100644
--- a/adocs/documentation/monitor.rb
+++ b/adocs/documentation/monitor.rb
@@ -44,9 +44,8 @@ targetBaseDir = File.absolute_path 'target/site'
srcBasePath = Pathname.new srcBaseDir
targetBasePath = Pathname.new targetBaseDir
-i=0
-def process(file,srcBasePath,targetBasePath,templateDir,i,priming)
+def process(file,srcBasePath,targetBasePath,templateDir,i,lastTimeGenerated,priming)
workingDir = Dir.pwd
@@ -80,16 +79,24 @@ def process(file,srcBasePath,targetBasePath,templateDir,i,priming)
unless regenerate == "" then
- cmd = "asciidoctor #{regenerate} --require asciidoctor-diagram --backend html --eruby erb --template-dir '#{templateDir}' --destination-dir='#{targetRelDir}' -a imagesdir='' -a toc=right -a icons=font -a source-highlighter=coderay"
+ # don't regenerate more often than every 5 seconds
+ currentTime = Time.now
+ if not priming and
+ currentTime.to_i < lastTimeGenerated.to_i + 5 then
+ puts "skipping regeneration (5 seconds not yet elapsed)"
+ else
- unless priming then
- puts ""
- puts "#{i}: #{cmd}"
- end
+ cmd = "asciidoctor #{regenerate} --require asciidoctor-diagram --backend html --eruby erb --template-dir '#{templateDir}' --destination-dir='#{targetRelDir}' -a imagesdir='' -a toc=right -a icons=font -a source-highlighter=coderay"
- system cmd
+ unless priming then
+ puts ""
+ puts "#{i}: #{cmd}"
+ end
+ system cmd
+ lastTimeGenerated=Time.now
+ end
end
else
@@ -111,11 +118,14 @@ def process(file,srcBasePath,targetBasePath,templateDir,i,priming)
Dir.chdir workingDir
- return i+1
+ return i+1, lastTimeGenerated
end
+i=0
+lastTimeGenerated = Time.now - 10
+
#
# process all files
#
@@ -131,7 +141,7 @@ if processAll then
files.each { |file|
absFile = File.absolute_path file
- i = process absFile, srcBasePath, targetBasePath, templateDir, i, true
+ i,lastTimeGenerated = process absFile, srcBasePath, targetBasePath, templateDir, i, lastTimeGenerated, true
}
end
@@ -155,12 +165,12 @@ directories = Dir.glob("src/main/asciidoc/**/*/")
fileListener = Listen.to(directories) do |modified, added, removed|
unless modified.length==0
modified.each { |file|
- i = process file, srcBasePath, targetBasePath, templateDir, i, false
+ i,lastTimeGenerated = process file, srcBasePath, targetBasePath, templateDir, i, lastTimeGenerated, false
}
end
unless added.length==0
added.each { |file|
- i = process file, srcBasePath, targetBasePath, templateDir, i, false
+ i,lastTimeGenerated = process file, srcBasePath, targetBasePath, templateDir, i, lastTimeGenerated, false
}
end
unless removed.length==0
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_appendices_release-notes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_appendices_release-notes.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_appendices_release-notes.adoc
index 92bdae9..0b122c3 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_appendices_release-notes.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_appendices_release-notes.adoc
@@ -12,7 +12,7 @@
| 24-feb-2015
| * link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12328845[core-1.8.0]
* link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12328847[archetype-1.8.0]
-| Wicket viewer moved into core; todoapp archetype moved to http://isisaddons.org[Isis Addons] (non-ASF).
+| Wicket viewer moved into core; todoapp archetype moved to link:http://www.isisaddons.org[Isis Addons] (non-ASF).
| 1.7.0
| 18-oct-2014
@@ -28,7 +28,7 @@
* link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12325318[viewer-wicket-1.6.0]
* link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12326462[archetype-simpleapp-1.6.0]
* link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12326461[archetype-todoapp-1.6.0]
-| Restful Objects viewer, JDO/Datanucleus Objectstore and Shiro Security all moved into core. Quickstart-wrj archetype renamed to todoapp; simple-wrj archetype renamed to simpleapp. Some functionality copied/refactored as http://isisaddons.org[Isis Addons] (non-ASF).
+| Restful Objects viewer, JDO/Datanucleus Objectstore and Shiro Security all moved into core. Quickstart-wrj archetype renamed to todoapp; simple-wrj archetype renamed to simpleapp. Some functionality copied/refactored as link:http://www.isisaddons.org[Isis Addons] (non-ASF).
| 1.5.0
| 08-jun-2014
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_framework-provided-services.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_framework-provided-services.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_framework-provided-services.adoc
index 566ac21..425c905 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_framework-provided-services.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_framework-provided-services.adoc
@@ -25,7 +25,7 @@ It is possible to replacing automatically-registered domain services.
Unless indicated as SPI, each of the following has an implementation in Isis core.
-A full list of services (including those with implementations in http://isisaddons.org[Isis Addons] (non-ASF)) can be found in the xref:_ug_domain-services-spi[Domain Services (SPI)] chapter.
+A full list of services (including those with implementations in link:http://www.isisaddons.org[Isis Addons] (non-ASF)) can be found in the xref:_ug_domain-services-spi[Domain Services (SPI)] chapter.
### `DomainObjectContainer`
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_other-deployment-options.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_other-deployment-options.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_other-deployment-options.adoc
index bdd2b4b..53d9620 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_other-deployment-options.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_other-deployment-options.adoc
@@ -20,7 +20,7 @@ Apache Wicket, and therefore Apache Isis in this configuration, is a stateful ar
The UI UI generated by the Wicket viewer is well suited to many line-of-business apps, but it's also worth knowing that (with a little knowledge of the Wicket APIs) it relatively straightforward to extend. As described in xref:_ug_isis-addons-modules[Isis addons] chapter, the viewer already has integrations with https://github.com/isisaddons/isis-wicket-gmap3[google maps], https://github.com/isisaddons/isis-wicket-fullcalendar2[a full calendar] and an https://github.com/isisaddons/isis-wicket-excel[export to Excel] component. We are also aware of integrations with SVG images (for floor maps of shopping center) and of custom widgets displaying a catalogue (text and images) of medical diseases.
-Deploying on Isis means that the framework also manages object persistence. For many line-of-business applications this will mean using a relational database. It is also possible (courtesy of its integratinon with link:http://www.datanucleus.org[DataNucleus]) to deploy an Isis app to a NoSQL store such as Neo4J or MongoDB; and it is also possible to deploy to cloud platforms such as https://developers.google.com/appengine/[Google App Engine (GAE)].
+Deploying on Isis means that the framework also manages object persistence. For many line-of-business applications this will mean using a relational database. It is also possible (courtesy of its integratinon with link:http://www.datanucleus.org[DataNucleus]) to deploy an Isis app to a NoSQL store such as Neo4J or MongoDB; and it is also possible to deploy to cloud platforms such as link:https://cloud.google.com/appengine/docs[Google App Engine (GAE)].
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_hexagonal-architecture.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_hexagonal-architecture.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_hexagonal-architecture.adoc
index 1cac2bd..7e33166 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_hexagonal-architecture.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_hexagonal-architecture.adoc
@@ -12,7 +12,7 @@ A few years ago Alistair Cockburn reworked the traditional layered architecture
[TIP]
====
-The hexagonal architecture is also known as the link:http://c2.com/cgi/wiki?PortsAndAdaptersArchitecture:[Ports and Adapters] architecture or (less frequently) as the link:http://jeffreypalermo.com/blog/the-onion-architecture-part-1/[Onion] architecture.
+The hexagonal architecture is also known as the link:http://c2.com/cgi/wiki?PortsAndAdaptersArchitecture[Ports and Adapters] architecture or (less frequently) as the link:http://jeffreypalermo.com/blog/the-onion-architecture-part-1/[Onion] architecture.
====
.The hexagonal architecture emphasizes multiple implementations of the different layers.
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_naked-objects-pattern.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_naked-objects-pattern.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_naked-objects-pattern.adoc
index 646ab6a..e870754 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_naked-objects-pattern.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_philosophy_naked-objects-pattern.adoc
@@ -35,7 +35,7 @@ One of the external examiners for Richard's PhD was link:http://en.wikipedia.org
Reenskaug then goes on to say that "this simple and powerful idea failed because ... users were used to seeing [objects] from different perspectives. The visible and tangible object would get very complex if it should be able to show itself and be manipulated in many different ways."
-In Apache Isis the responsibility of rendering an object is not the object itself, it is the framework. Rather, the object inspects the object and uses that to decide how to render the object. This is also extensible. In the http://isisaddons.org[Isis Addons] (non-ASF) the http://github.com/isisaddons/isis-wicket-gmap3[Isis addons' gmap3] wicket extension renders any object with latitude/longitude on a map, while http://github.com/isisaddons/isis-wicket-fullcalendar2[Isis addons' fullcalendar2 wicket extension] renders any object with date(s) on a calendar.
+In Apache Isis the responsibility of rendering an object is not the object itself, it is the framework. Rather, the object inspects the object and uses that to decide how to render the object. This is also extensible. In the link:http://www.isisaddons.org[Isis Addons] (non-ASF) the http://github.com/isisaddons/isis-wicket-gmap3[Isis addons' gmap3] wicket extension renders any object with latitude/longitude on a map, while http://github.com/isisaddons/isis-wicket-fullcalendar2[Isis addons' fullcalendar2 wicket extension] renders any object with date(s) on a calendar.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_metawidget.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_metawidget.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_metawidget.adoc
index 931479a..11e851f 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_metawidget.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_metawidget.adoc
@@ -9,7 +9,7 @@ MetaWidget (mentioned xref:_ug_core-concepts_philosophy_naked-objects-pattern_ob
However, there is a difference in philosophy in that MW is not a full-stack framework and does not (in their words) try to "own the UI". Rather they support a huge variety of UI technologies and allow the domain object to be rendered in any of them.
-In contrast, Apache Isis is full-stack and does generate a complete UI; we then allow you to customize or extend this UI (as per the various http://isisaddons.org[Isis Addons] (non-ASF), and we also provide a full REST API through the xref:_ug_restfulobjects-viewer[Restful Objects viewer]
+In contrast, Apache Isis is full-stack and does generate a complete UI; we then allow you to customize or extend this UI (as per the various link:http://www.isisaddons.org[Isis Addons] (non-ASF), and we also provide a full REST API through the xref:_ug_restfulobjects-viewer[Restful Objects viewer]
Also, it's worth noting that MetaWidget does have an elegant pipeline architecture, with APIs to allow even its metamodel to be replaced. It would be feasible and probably quite straightforward to use Isis' own metamodel as an implementation of the MetaWidget API. This would allow MetaWidget to be able to render an Isis domain application.
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_mvc-server-side-frameworks.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_mvc-server-side-frameworks.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_mvc-server-side-frameworks.adoc
index dd12a31..e527e6d 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_mvc-server-side-frameworks.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_core-concepts_principles_apache-isis-vs_mvc-server-side-frameworks.adoc
@@ -6,13 +6,13 @@
-Some of most commonly used frameworks today are link:http://www.springframework.org/[Spring MVC], link:http://rubyonrails.org/[Ruby on Rails] and link:http://www.grails.org[Grails], all of which implement one flavour or another of the server-side MVC pattern. The MVC 1.0 specification (scheduled for JavaEE 8) is also similar.
+Some of most commonly used frameworks today are link:http://www.spring.io/[Spring MVC], link:http://rubyonrails.org/[Ruby on Rails] and link:http://www.grails.org[Grails], all of which implement one flavour or another of the server-side MVC pattern. The MVC 1.0 specification (scheduled for JavaEE 8) is also similar.
These frameworks all use the classic *model-view-controller* ( _MVC_) pattern for web applications, with scaffolding, code-generation, and/or metaprogramming tools for the controllers and views, as well as convention over configuration to define how these components interact. The views provided out of the box by these frameworks tend to be simple _CRUD_-style interfaces. More sophisticated behavior is accomplished by customizing the generated controllers.
The most obvious difference when developing an Apache Isis application is its deliberate lack of an explicit controller layer; non- _CRUD_ behavior is automatically made available in its generic object-oriented _UI_s. More sophisticated UIs can be built either by xref:_ug_extending_wicket-viewer[extending Isis' Wicket viewer] or by writing a bespoke UI leveraging the REST (hypermedia) API automatically exposed by xref:_ug_restfulobjects-viewer[Isis' Restful Objects viewer]. Other frameworks can also be used to implement REST APIs, of course, but generally they require a significant amount of development to get anywhere near the level of sophistication provided automatically by Isis' REST API.
-Although these frameworks all provide their own ecosystems of extensions, Isis' equivalent http://isisaddons.org[Isis Addons] (non-ASF) tend to work at a higher-level of abstraction. For example, each of these frameworks will integrate with various security mechanism, but the http://github.com/isisaddons/isis-module-security[Isis addons' security module] provides a full subdomain of users, roles, features and permissions that can be plugged into any Isis application. Similarly, the http://github.com/isisaddons/isis-module-command[Isis addons' command] and http://github.com/isisaddons/isis-module-audit[Isis addons' audit] modules in combination provide a support for auditing and traceability that can also be used for out of the box profiling. Again, these addons can be plugged into any Isis app.
+Although these frameworks all provide their own ecosystems of extensions, Isis' equivalent link:http://www.isisaddons.org[Isis Addons] (non-ASF) tend to work at a higher-level of abstraction. For example, each of these frameworks will integrate with various security mechanism, but the http://github.com/isisaddons/isis-module-security[Isis addons' security module] provides a full subdomain of users, roles, features and permissions that can be plugged into any Isis application. Similarly, the http://github.com/isisaddons/isis-module-command[Isis addons' command] and http://github.com/isisaddons/isis-module-audit[Isis addons' audit] modules in combination provide a support for auditing and traceability that can also be used for out of the box profiling. Again, these addons can be plugged into any Isis app.
In terms of testing support, each of these other frameworks provide mechanisms to allow the webapp to be tested from within a JUnit test harness. Isis' support is similar. Where Isis differs though is that it enables end-to-end testing without the need for slow and fragile Selenium tests. Instead, Isis provides a "xref:_ug_testing_integ-test-support_wrapper-factory[WrapperFactory]" domain service that allows the generic UI provided to in essence be simulated. On a more pragmatic level, the http://github.com/isisaddons/isis-module-fakedata[Isis addons' fakedata] module does "what it says on the tin", allowing both unit- and integration-tests to focus on the salient data and fake out the rest.
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_deployment_gae.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_deployment_gae.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_deployment_gae.adoc
index 66cee87..53cd4da 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_deployment_gae.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_deployment_gae.adoc
@@ -29,7 +29,7 @@ Note: if you store a relationship with a String key it means that the parent obj
Currently Isis' `Blob` and `Clob` types and the JODA types (`LocalDate` et al) are _not_ supported in GAE.
-Instead, GAE defines a https://developers.google.com/appengine/docs/java/datastore/entities#Properties_and_Value_Types[fixed set of value types], including `BlobKey`. Members of the Isis community have this working, though I haven't seen the code.
+Instead, GAE defines a link:https://cloud.google.com/appengine/docs/java/datastore/entities#Properties_and_Value_Types[fixed set of value types], including `BlobKey`. Members of the Isis community have this working, though I haven't seen the code.
The above notwithstanding, Andy Jefferson at DataNucleus tells us:
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_getting-started_datanucleus-enhancer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_getting-started_datanucleus-enhancer.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_getting-started_datanucleus-enhancer.adoc
index bf33ad6..fc7d02a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_getting-started_datanucleus-enhancer.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_getting-started_datanucleus-enhancer.adoc
@@ -6,7 +6,7 @@
-link:http://www.datanucleus.org/[DataNucleus] is the reference implementation of the JDO (Java data objects) spec, and Isis integrates with DataNucleus as its persistence layer. Datanucleus is a very powerful library, allowing domain entities to be mapped not only to relational database tables, but also to NoSQL stores such as link:http://neo4j.com/[Neo4J], link:https://www.mongodb.org/[MongoDB] and link:http://cassandra.apache.org/[Apache Cassandra].
+link:http://www.datanucleus.org/[DataNucleus] is the reference implementation of the JDO (Java data objects) spec, and Isis integrates with DataNucleus as its persistence layer. Datanucleus is a very powerful library, allowing domain entities to be mapped not only to relational database tables, but also to NoSQL stores such as link:http://neo4j.com/[Neo4J], link:http://www.mongodb.org/[MongoDB] and link:http://cassandra.apache.org/[Apache Cassandra].
With such power comes a little bit of complexity to the development environment: all domain entities must be enhanced through the DataNucleus enhancer.
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_headless-access_BackgroundCommandExecution.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_headless-access_BackgroundCommandExecution.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_headless-access_BackgroundCommandExecution.adoc
index 76e598a..756b530 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_headless-access_BackgroundCommandExecution.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_headless-access_BackgroundCommandExecution.adoc
@@ -47,7 +47,7 @@ image::{_imagesdir}headless-access/BackgroundCommandExecution.png[width="400px"]
The `BackgroundCommandExecutionFromBackgroundCommandServiceJdo` is a concrete subclass of <<BackgroundCommandExecution>>, the intended use being for the class to be instantiated regularly (eg every 10 seconds) by a scheduler such as http://quartz-scheduler.org[Quartz]) to poll for ``Command``s to be executed, and then execute them.
-This implementation queries for ``Command``s persisted by the http://isisaddons.org/isis-module-command[Isis addons Command Module]'s implementations of <<CommandService>> and <<BackgroundCommandService>> using the `BackgroundCommandServiceJdoRepository`.
+This implementation queries for ``Command``s persisted by the link:http://www.isisaddons.org/isis-module-command[Isis addons Command Module]'s implementations of <<CommandService>> and <<BackgroundCommandService>> using the `BackgroundCommandServiceJdoRepository`.
The diagram below shows the inheritance hierarchy for this class:
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_how-tos_domain-services.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_how-tos_domain-services.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_how-tos_domain-services.adoc
index 2aefa14..5b4325a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_how-tos_domain-services.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_how-tos_domain-services.adoc
@@ -13,7 +13,7 @@ IMPORTANT: TODO
IMPORTANT: TODO
-It's worth extending the <<_hexagonal_architecture, Hexagonal Architecture> to show where domain services -- and in particular the domain services provided by http://isisaddons.org[Isis Addons] (non-ASF) -- fit in:
+It's worth extending the <<_hexagonal_architecture, Hexagonal Architecture> to show where domain services -- and in particular the domain services provided by link:http://www.isisaddons.org[Isis Addons] (non-ASF) -- fit in:
.The hexagonal architecture with Isis addons
image::{_imagesdir}how-tos/domain-services/hexagonal-architecture-addons.png[width="700px"]
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules.adoc
index ea9658c..a516f28 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules.adoc
@@ -6,7 +6,7 @@
-The http://isisaddons.org[Isis Addons] website provides a number of reusable modules and other extensions for Apache Isis. This chapter focuses just on the modules, all of which have a name of the form `isis-module-xxx`.
+The link:http://www.isisaddons.org[Isis Addons] website provides a number of reusable modules and other extensions for Apache Isis. This chapter focuses just on the modules, all of which have a name of the form `isis-module-xxx`.
[WARNING]
====
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules_devutils-module.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules_devutils-module.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules_devutils-module.adoc
index 593789a..7ff5f34 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules_devutils-module.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-addons-modules_devutils-module.adoc
@@ -11,7 +11,7 @@ In 1.6.0 this implementation was released as part of _org.apache.isis.core:isis-
====
-The `DeveloperUtilitiesService` service provides a number of development-time utilities, mostly related to accessing/interacting with the Isis metamodel. These are visible in the UI, either as menu actions or as contributed actions. All actions are annotated with xref:_ug_reference-annotations_manpage_Action_restrictTo[`@Action#restrictTo()`] to restrict to prototype mode (suppressed from production mode).
+The `DeveloperUtilitiesService` service provides a number of development-time utilities, mostly related to accessing/interacting with the Isis metamodel. These are visible in the UI, either as menu actions or as contributed actions. All actions are annotated with xref:_ug_reference-annotations_manpage-Action_restrictTo[`@Action#restrictTo()`] to restrict to prototype mode (suppressed from production mode).
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-in-pictures.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-in-pictures.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-in-pictures.adoc
index 9cf648d..18d5ac5 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-in-pictures.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_isis-in-pictures.adoc
@@ -26,7 +26,7 @@ Let's start with the basics...
Apache Isis integrates with http://shiro.apache.org[Apache Shiro]. The core framework supports file-based realms, while the Isis Addons http://github.com/isisaddons/isis-module-security[security module] (non ASF) provides a well-features subdomain of users, roles and permissions against features derived from the Isis metamodel. The example todoapp integrates with the security module.
-image::https://raw.github.com/apache/isis/master/images/010-login.png[width="600px",link="https://raw.github.com/apache/isis/master/images/010-login.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/010-login.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/010-login.png"]
@@ -35,7 +35,7 @@ image::https://raw.github.com/apache/isis/master/images/010-login.png[width="600
Apache Isis has lots of features to help you prototype and then fully test your application. One such are fixture scripts, which allow pre-canned data to be installed in the running application. This is great to act as the starting point for identifying new stories; later on when the feature is being implemented, the same fixture script can be re-used within that feature's integration tests. (More on tests later).
-image::https://raw.github.com/apache/isis/master/images/020-install-fixtures.png[width="600px",link="https://raw.github.com/apache/isis/master/images/020-install-fixtures.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/020-install-fixtures.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/020-install-fixtures.png"]
@@ -43,7 +43,7 @@ image::https://raw.github.com/apache/isis/master/images/020-install-fixtures.png
Most of the time the end-user interacts with representations of persistent domain entities, but Isis also supports view models which can aggregate data from multiple sources. The todoapp example uses a "dashboard" view model to list todo items not yet done vs those completed.
-image::https://raw.github.com/apache/isis/master/images/030-dashboard-view-model.png[width="600px",link="https://raw.github.com/apache/isis/master/images/030-dashboard-view-model.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/030-dashboard-view-model.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/030-dashboard-view-model.png"]
In general we recommend to initially focus only on domain entities; this will help drive out a good domain model. Later on view models can be introduced in support of specific use cases.
@@ -55,7 +55,7 @@ In general we recommend to initially focus only on domain entities; this will he
The screenshot below is of the todoapp's `ToDoItem` domain entity. Like all web pages, this UI is generated at runtime, directly from the domain object itself. There are no controllers or HTML to write.
-image::https://raw.github.com/apache/isis/master/images/040-domain-entity.png[width="600px",link="https://raw.github.com/apache/isis/master/images/040-domain-entity.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/040-domain-entity.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/040-domain-entity.png"]
In addition to the domain entity, Apache Isis allows layout metadata hints to be provided, for example to specify the grouping of properties, the positioning of those groups into columns, the association of actions (the buttons) with properties or collections, the icons on the buttons, and so on. This metadata can be specified either as annotations or in JSON form; the benefit of the latter is that it can be updated (and the UI redrawn) without restarting the app.
@@ -68,7 +68,7 @@ Any production-ready app will require this metadata but (like the view models di
By default properties on domain entities are editable, meaning they can be changed directly. In the todoapp example, the `ToDoItem`'s description is one such editable property:
-image::https://raw.github.com/apache/isis/master/images/050-edit-property.png[width="600px",link="https://raw.github.com/apache/isis/master/images/050-edit-property.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/050-edit-property.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/050-edit-property.png"]
Note that some of the properties are read-only even in edit mode; individual properties can be made non-editable. It is also possible to make all properties disabled and thus enforce changes only through actions (below).
@@ -80,7 +80,7 @@ Note that some of the properties are read-only even in edit mode; individual pro
The other way to modify an entity is to an invoke an action. In the screenshot below the `ToDoItem`'s category and subcategory can be updated together using an action:
-image::https://raw.github.com/apache/isis/master/images/060-invoke-action.png[width="600px",link="https://raw.github.com/apache/isis/master/images/060-invoke-action.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/060-invoke-action.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/060-invoke-action.png"]
There are no limitations on what an action can do; it might just update a single object, it could update multiple objects. Or, it might not update any objects at all, but could instead perform some other activity, such as sending out email or printing a document.
@@ -96,12 +96,12 @@ As an alternative to placing actions (business logic) on a domain object, it can
In the screenshot below the highlighted "export as xml" action, the "relative priority" property (and "previous" and "next" actions) and also the "similar to" collection are all contributed:
-image::https://raw.github.com/apache/isis/master/images/065-contributions.png[width="600px",link="https://raw.github.com/apache/isis/master/images/065-contributions.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/065-contributions.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/065-contributions.png"]
Contributions are defined by the signature of the actions on the contributing service. The code snippet below shows how this works for the "export as xml" action:
-image::https://raw.github.com/apache/isis/master/images/067-contributed-action.png[width="600px",link="https://raw.github.com/apache/isis/master/images/067-contributed-action.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/067-contributed-action.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/067-contributed-action.png"]
@@ -111,20 +111,20 @@ image::https://raw.github.com/apache/isis/master/images/067-contributed-action.p
The Apache Isis viewer is implemented using http://wicket.apache.org[Apache Wicket], and has been architected to be extensible. For example, when a collection of objects is rendered, this is just one several views, as shown in the selector drop-down:
-image::https://raw.github.com/apache/isis/master/images/070-pluggable-views.png[width="600px",link="https://raw.github.com/apache/isis/master/images/070-pluggable-views.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/070-pluggable-views.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/070-pluggable-views.png"]
The Isis Addons' https://github.com/isisaddons/isis-wicket-gmap3[gmap3 component] (non ASF) will render any domain entity (such as `ToDoItem`) that implements its `Locatable` interface:
-image::https://raw.github.com/apache/isis/master/images/080-gmap3-view.png[width="600px",link="https://raw.github.com/apache/isis/master/images/080-gmap3-view.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/080-gmap3-view.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/080-gmap3-view.png"]
Similarly the Isis Addons' https://github.com/isisaddons/isis-wicket-fullcalendar2[fullcalendar2 component] (non ASF) will render any domain entity (such as `ToDoItem`) that implements its `Calendarable` interface:
-image::https://raw.github.com/apache/isis/master/images/090-fullcalendar2-view.png[width="600px",link="https://raw.github.com/apache/isis/master/images/090-fullcalendar2-view.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/090-fullcalendar2-view.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/090-fullcalendar2-view.png"]
@@ -132,14 +132,14 @@ image::https://raw.github.com/apache/isis/master/images/090-fullcalendar2-view.p
Yet another "view" (though this one is rather simpler is that provided by the Isis Addons https://github.com/isisaddons/isis-wicket-excel[excel component] (non ASF). This provides a download button to the table as a spreadsheet:
-image::https://raw.github.com/apache/isis/master/images/100-excel-view-and-docx.png[width="600px",link="https://raw.github.com/apache/isis/master/images/100-excel-view-and-docx.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/100-excel-view-and-docx.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/100-excel-view-and-docx.png"]
The screenshot above also shows an "export to Word" action. This is _not_ a view but instead is a (contributed) action that uses the Isis Addons https://github.com/isisaddons/isis-module-docx[docx module] (non ASF) to perform a "mail-merge":
-image::https://raw.github.com/apache/isis/master/images/110-docx.png[width="600px",link="https://raw.github.com/apache/isis/master/images/110-docx.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/110-docx.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/110-docx.png"]
@@ -151,28 +151,28 @@ As well as providing extensions to the UI, the Isis Addons provides a rich set o
Under the activity menu are four sets of services which provide support for https://github.com/isisaddons/isis-module-sessionlogger[user session logging/auditing] (non ASF), https://github.com/isisaddons/isis-module-command[command profiling] (non ASF), https://github.com/isisaddons/isis-module-audit[(object change) auditing] (shown, non-ASF) and (inter-system) https://github.com/isisaddons/isis-module-publishing[event publishing] (non ASF):
-image::https://raw.github.com/apache/isis/master/images/120-auditing.png[width="600px",link="https://raw.github.com/apache/isis/master/images/120-auditing.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/120-auditing.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/120-auditing.png"]
In the security menu is access to the rich set of functionality provided by the Isis addons https://github.com/isisaddons/isis-module-security[security module] (non ASF):
-image::https://raw.github.com/apache/isis/master/images/130-security.png[width="600px",link="https://raw.github.com/apache/isis/master/images/130-security.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/130-security.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/130-security.png"]
In the prototyping menu is the ability to download a GNU gettext `.po` file for translation. This file can then be translated into multiple languages so that your app can support different locales. Note that this feature is part of Apache Isis core (it is not in Isis Addons):
-image::https://raw.github.com/apache/isis/master/images/140-i18n.png[width="600px",link="https://raw.github.com/apache/isis/master/images/140-i18n.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/140-i18n.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/140-i18n.png"]
The Isis addons also provides a module for managing application and user https://github.com/isisaddons/isis-module-settings[settings] (non ASF). Most apps (the todoapp example included) won't expose these services directly, but will usually wrap them in their own app-specific settings service that trivially delegates to the settings module's services:
-image::https://raw.github.com/apache/isis/master/images/150-appsettings.png[width="600px",link="https://raw.github.com/apache/isis/master/images/150-appsettings.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/150-appsettings.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/150-appsettings.png"]
@@ -181,7 +181,7 @@ image::https://raw.github.com/apache/isis/master/images/150-appsettings.png[widt
Of the various Isis addons, the https://github.com/isisaddons/isis-module-security[security module] has the most features. One significant feature is the ability to associate users and objects with a "tenancy". The todoapp uses this feature so that different users' list of todo items are kept separate from one another. A user with administrator is able to switch their own "tenancy" to the tenancy of some other user, in order to access the objects in that tenancy:
-image::https://raw.github.com/apache/isis/master/images/160-switch-tenancy.png[width="600px",link="https://raw.github.com/apache/isis/master/images/160-switch-tenancy.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/160-switch-tenancy.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/160-switch-tenancy.png"]
@@ -192,13 +192,13 @@ For more details, see the https://github.com/isisaddons/isis-module-security[sec
Most of the https://github.com/isisaddons/isis-module-security[security module]'s services are on the security module, which would normally be provided only to administrators. Kept separate is the "me" action:
-image::https://raw.github.com/apache/isis/master/images/170-me.png[width="600px",link="https://raw.github.com/apache/isis/master/images/170-me.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/170-me.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/170-me.png"]
Assuming they have been granted permissions, this allows a user to access an entity representing their own user account:
-image::https://raw.github.com/apache/isis/master/images/180-app-user-entity.png[width="600px",link="https://raw.github.com/apache/isis/master/images/180-app-user-entity.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/180-app-user-entity.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/180-app-user-entity.png"]
@@ -209,7 +209,7 @@ If not all of these properties are required, then they can be hidden either usin
Apache Isis' Wicket viewer uses http://getbootstrap.com[Twitter Bootstrap], which means that it can be themed. If more than one theme has been configured for the app, then the viewer allows the end-user to switch their theme:
-image::https://raw.github.com/apache/isis/master/images/190-switch-theme.png[width="600px",link="https://raw.github.com/apache/isis/master/images/190-switch-theme.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/190-switch-theme.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/190-switch-theme.png"]
@@ -218,7 +218,7 @@ image::https://raw.github.com/apache/isis/master/images/190-switch-theme.png[wid
In addition to Isis' Wicket viewer, it also provides a fully fledged REST API, as an implementation of the http://restfulobjects.org[Restful Objects] specification. The screenshot below shows accessing this REST API using a Chrome plugin:
-image::https://raw.github.com/apache/isis/master/images/200-rest-api.png[width="600px",link="https://raw.github.com/apache/isis/master/images/200-rest-api.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/200-rest-api.png[width="600px",link="https://raw.githubusercontent.com/apache/isis/master/images/200-rest-api.png"]
@@ -232,19 +232,19 @@ Like the Wicket viewer, the REST API is generated automatically from the domain
Earlier on we noted that Apache Isis allows fixtures to be installed through the UI. These same fixture scripts can be reused within integration tests. For example, the code snippet below shows how the `FixtureScripts` service injected into an integration test can then be used to set up data:
-image::https://raw.github.com/apache/isis/master/images/210-fixture-scripts.png[width="500px",link="https://raw.github.com/apache/isis/master/images/210-fixture-scripts.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/210-fixture-scripts.png[width="500px",link="https://raw.githubusercontent.com/apache/isis/master/images/210-fixture-scripts.png"]
The tests themselves are run in junit. While these are integration tests (so talking to a real database), they are no more complex than a regular unit test:
-image::https://raw.github.com/apache/isis/master/images/220-testing-happy-case.png[width="400px",link="https://raw.github.com/apache/isis/master/images/220-testing-happy-case.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/220-testing-happy-case.png[width="400px",link="https://raw.githubusercontent.com/apache/isis/master/images/220-testing-happy-case.png"]
To simulate the business rules enforced by Apache Isis, the domain object can be "wrapped" in a proxy. For example, if using the Wicket viewer then Apache Isis will enforce the rule (implemented in the `ToDoItem` class itself) that a completed item cannot have the "completed" action invoked upon it. The wrapper simulates this by throwing an appropriate exception:
-image::https://raw.github.com/apache/isis/master/images/230-testing-wrapper-factory.png[width="550px",link="https://raw.github.com/apache/isis/master/images/230-testing-wrapper-factory.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/230-testing-wrapper-factory.png[width="550px",link="https://raw.githubusercontent.com/apache/isis/master/images/230-testing-wrapper-factory.png"]
@@ -257,7 +257,7 @@ Contributions, discussed earlier, are an important tool in ensuring that the pac
Another important tool to ensure your codebase remains maintainable is Isis' internal event bus. It is probably best explained by example; the code below says that the "complete" action should emit a `ToDoItem.Completed` event:
-image::https://raw.github.com/apache/isis/master/images/240-domain-events.png[width="400px",link="https://raw.github.com/apache/isis/master/images/240-domain-events.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/240-domain-events.png[width="400px",link="https://raw.githubusercontent.com/apache/isis/master/images/240-domain-events.png"]
@@ -265,14 +265,14 @@ image::https://raw.github.com/apache/isis/master/images/240-domain-events.png[wi
Domain service (application-scoped, stateless) can then subscribe to this event:
-image::https://raw.github.com/apache/isis/master/images/250-domain-event-subscriber.png[width="450px",link="https://raw.github.com/apache/isis/master/images/250-domain-event-subscriber.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/250-domain-event-subscriber.png[width="450px",link="https://raw.githubusercontent.com/apache/isis/master/images/250-domain-event-subscriber.png"]
And this test verifies that completing an action causes the subscriber to be called:
-image::https://raw.github.com/apache/isis/master/images/260-domain-event-test.png[width="850px",link="https://raw.github.com/apache/isis/master/images/260-domain-event-test.png"]
+image::https://raw.githubusercontent.com/apache/isis/master/images/260-domain-event-test.png[width="850px",link="https://raw.githubusercontent.com/apache/isis/master/images/260-domain-event-test.png"]
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_decoupling_db-schemas.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_decoupling_db-schemas.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_decoupling_db-schemas.adoc
index d368179..60ec4d0 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_decoupling_db-schemas.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_decoupling_db-schemas.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
In the same way that Java packages act as a namespace for domain objects, it's good practice to map domain entities to
-their own (database) schemas. As of 1.9.0-SNAPSHOT, all the http://isisaddons.org[Isis Addons] (non-ASF) modules do this, for example:
+their own (database) schemas. As of 1.9.0-SNAPSHOT, all the link:http://www.isisaddons.org[Isis Addons] (non-ASF) modules do this, for example:
[source,java]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_i18n.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_i18n.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_i18n.adoc
index 98077e2..cf3fff7 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_i18n.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_more-advanced_i18n.adoc
@@ -18,7 +18,7 @@ Isis does not translate the values of your domain objects, though. So, if you h
Most Java frameworks tackle i18n by using Java's own `ResourceBundle` API. However, there are some serious drawbacks in this approach, such as:
* if a string appears more than once (eg "name" or "description") then it must be translated everywhere it appears in every resource bundle file
-* there is no support for plural forms (see this link:http://stackoverflow.com/a/14327683/56880[SO answer])
+* there is no support for plural forms (see this link:http://stackoverflow.com/questions/14326653/java-internationalization-i18n-with-proper-plurals/14327683#14327683[SO answer])
* there is no tooling support for translators
Apache Isis therefore takes a different approach, drawing inspiration from GNU's https://www.gnu.org/software/gettext/manual/index.html[gettext] API and specifically its `.pot` and `.po` files. These are intended to be used as follows:
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_aaa_deprecated.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_aaa_deprecated.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_aaa_deprecated.adoc
index 9016b16..3291d7e 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_aaa_deprecated.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_aaa_deprecated.adoc
@@ -5,9 +5,9 @@
:_imagesdir: images/
-As Apache Isis has evolved and grown, we found ourselves adding more and more annotations; but most of these related to either an object type (entity, view model, service) or an object member (property, collection, action). It became harder and harder for end programmers to discover these new features.
+As Apache Isis has evolved and grown, we found ourselves adding more and more annotations; but most of these related to either an object type (entity, view model, service) or an object member (property, collection, action). Over time it became harder and harder for end programmers to discover these new features.
-Accordingly, we decided to unify the semantics into the main (core) annotations listed xref:_ug_reference-annotations_aaa_main[above].
+Accordingly, (in v1.8.0) we decided to unify the semantics into the main (core) annotations listed xref:_ug_reference-annotations_aaa_main[above].
The annotations listed in the table below are still supported by Apache Isis, but will be retired in Isis v2.0.
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-Action.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-Action.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-Action.adoc
index f6a2586..b3b36ff 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-Action.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-Action.adoc
@@ -10,7 +10,7 @@ The `@Action` annotation groups together all domain-specific metadata for an inv
The table below summarizes the annotation's attributes.
.`@Action` attributes
-[cols="2,2,4", options="header"]
+[cols="2,2,4a", options="header"]
|===
| Attribute
@@ -21,19 +21,20 @@ The table below summarizes the annotation's attributes.
|xref:_ug_reference-annotations_manpage-Action_command[`command()`]
|`AS_CONFIGURED`, `ENABLED`, `DISABLED` +
(`AS_CONFIGURED`)
-|whether the action invocation should be reified into a `o.a.i.applib.services.command.Command` object.
+|whether the action invocation should be reified into a `o.a.i.applib.` +
+`services.command.Command` object.
|`commandExecuteIn()`
|`FOREGROUND`,`BACKGROUND` +
(`FOREGROUND`)
-|whether to execute the command immediately, or to persist it (assuming that an appropriate implementation of `CommandService` has been configured) such that a background scheduler can execute the command asynchronously
+|whether to execute the command immediately, or to persist it (assuming that an appropriate implementation of xref:_ug_reference-services-spi_manpage-CommandService[`CommandService`] has been configured) such that a background scheduler can execute the command asynchronously
|`commandPersistence()`
|`PERSISTED`,`NOT_PERSISTED`,`IF_HINTED` +
(`PERSISTED`)
-|whether the reified `Command` (as provided by the `CommandContext` domain service) should actually be persisted (assuming an appropriate implementation of `CommandService` has been configured).
+|whether the reified `Command` (as provided by the `CommandContext` domain service) should actually be persisted (assuming an appropriate implementation of xref:_ug_reference-services-spi_manpage-CommandService[`CommandService`] has been configured).
|xref:_ug_reference-annotations_manpage-Action_domainEvent[`domainEvent()`]
@@ -43,8 +44,8 @@ The table below summarizes the annotation's attributes.
|xref:_ug_reference-annotations_manpage-Action_hidden[`hidden()`]
-|`true`,`false` +
-(`false`)
+|`EVERYWHERE`,`NOWHERE` +
+(`NOWHERE`)
|indicates where (in the UI) the action should be hidden from the user.
@@ -53,6 +54,8 @@ The table below summarizes the annotation's attributes.
(`OBJECT_ONLY`)
|whether an action can be invoked on a single object and/or on many objects in a collection.
+Currently this is only supported for no-arg actions.
+
|xref:_ug_reference-annotations_manpage-Action_publishing[`publishing()`]
|`AS_CONFIGURED`, `ENABLED`, `DISABLED` +
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout.adoc
index cf9b9d1..24dcaa6 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout.adoc
@@ -9,8 +9,8 @@ The `@ActionLayout` annotation applies to actions, collecting together all UI hi
The table below summarizes the annotation's attributes.
-.`@Action` attributes
-[cols="2,2,4", options="header"]
+.`@ActionLayout` attributes
+[cols="2,2,4a", options="header"]
|===
| Attribute
@@ -19,38 +19,55 @@ The table below summarizes the annotation's attributes.
|xref:_ug_reference-annotations_manpage-ActionLayout_bookmarking[`bookmarking()`]
-|
-|
+|`AS_ROOT`, `NEVER` +
+(`NEVER`)
+|indicates if an action (with safe xref:_ug_reference-annotations_manpage-Action_semantics[action semantics]) is automatically bookmarked.
|xref:_ug_reference-annotations_manpage-ActionLayout_contributedAs[`contributedAs()`]
-|
-|
+|`AS_BOTH`, `AS_ACTION`, `AS_ASSOCIATION`, `AS_NEITHER` +
+(`AS_BOTH`)
+|for a domain service action that can be contributed, whether to contribute as an action or as an association (ie a property or collection). +
+
+For a domain service action to be contributed, the domain services must have a xref:_ug_reference-annotations_manpage-DomainService_nature[nature] nature of either `VIEW` or `VIEW_CONTRIBUTIONS_ONLY`, and the action must have xref:_ug_reference-annotations_manpage-Action_semantics[safe action semantics], and takes a single argument, namely the contributee domain object.
|xref:_ug_reference-annotations_manpage-ActionLayout_cssClass[`cssClass()`]
-|
-|
+|Any string valid as a CSS class
+|an additional CSS class around the HTML that represents for the action, to allow additional styling. +
+
+Supported by the xref:_ug_wicket-viewer[Wicket viewer] but currently ignored by the xref:_ug_restfulobjects-viewer[RestfulObjects viewer].
|xref:_ug_reference-annotations_manpage-ActionLayout_cssClassFa[`cssClassFa()`]
-|
-|
+|Any valid link:http://fortawesome.github.io/Font-Awesome/[Font awesome] icon name
+|specify a font awesome icon for the action's menu link or icon. +
+
+Supported by the xref:_ug_wicket-viewer[Wicket viewer] but currently ignored by the xref:_ug_restfulobjects-viewer[RestfulObjects viewer].
+
+
+|`cssClassFaPosition()`
+|`LEFT`, `RIGHT` +
+(`LEFT`)
+|Positioning of the icon on the button/menu item.
|xref:_ug_reference-annotations_manpage-ActionLayout_describedAs[`describedAs()`]
-|
-|
+|String.
+|provides a short description of the action, eg for rendering as a 'tool tip'.
|xref:_ug_reference-annotations_manpage-ActionLayout_hidden[`hidden()`]
-|
-|
+|`EVERYWHERE`,`NOWHERE` +
+(`NOWHERE`)
+|indicates where (in the UI) the action should be hidden from the user.
|xref:_ug_reference-annotations_manpage-ActionLayout_named[`named()`]
-|
-|
+|String.
+|to override the name inferred from the action's name in code. +
+
+A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.
|===
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_bookmarking.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_bookmarking.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_bookmarking.adoc
index b12167a..97f1f52 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_bookmarking.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_bookmarking.adoc
@@ -6,73 +6,54 @@
+The `bookmarking()` attribute indicates if an action (with safe xref:_ug_reference-annotations_manpage-Action_semantics[action semantics]) is automatically bookmarked.
-IMPORTANT: WIP ... this section
+(In the Wicket viewer), a link to a bookmarked object is shown in the bookmarks panel:
-The `@Bookmarkable` annotation indicates that an entity or an action (with safe xref:_ug_reference-annotations_manpage_Action_semantics[action semantics]) is automatically bookmarked.
+image::{_imagesdir}reference-annotations/ActionLayout/bookmarking.png[width="720px",link="{_imagesdir}reference-annotations/ActionLayout/bookmarking.png"]
-(In the Wicket viewer), a link to a bookmarked object is shown in the bookmarks panel that slides out from the left:
-
-<img src="images/Bookmarkable.png" width="640px"/>
+[NOTE]
+====
+It is also possible to mark domain entities as xref:_ug_reference-annotations_manpage-DomainObjectLayout_bookmarking[bookmarkable]; the screenshot shows this.
-For example:
+Note also that this screenshot relates to a earlier version of the UI (specfically, pre 1.8.0).
+====
-[source,java]
-----
-@Bookmarkable
-public class ToDoItem ... {
- ...
-}
-----
-indicates that the `ToDoItem` class is bookmarkable, while:
+For example:
[source,java]
----
-@Named("ToDos")
public class ToDoItems {
-
- @Bookmarkable
- @ActionSemantics(Of.SAFE)
+ @Action(semantics=SemanticsOf.SAFE)
+ @ActionLayout(bookmarking=BookmarkPolicy.AS_ROOT)
@MemberOrder(sequence = "1")
public List<ToDoItem> notYetComplete() {
...
}
-
}
----
-indicates that the "not yet complete" action is bookmarkable.
-
-It is also possible to nest bookmarkable entities. For example, this screenshot is taken from http://github.com/estatio/estatio[Estatio]:
+indicates that the `notYetComplete()` action is bookmarkable.
-<img src="images/Bookmarkable-nested.png" width="640px"/>
-For example, the `Property` entity "[OXF] Oxford Super Mall" is a root bookmark (the default), but the `Unit` child entity "[OXF-001] Unit 1" only appears as a bookmark if its parent `Property` has already been visited. This is accomplished with the following annotations:
-
-[source,java]
-----
-@Bookmarkable
-public class Property { ... }
-----
-
-and
-
-[source,java]
-----
-@Bookmarkable(BookmarkPolicy.AS_CHILD)
-public abstract class Unit { ... }
-----
-
-The nesting can be done to any level; the Estatio screenshot also shows a bookmark nesting 3 deep: `Lease` -> `LeaseItem` -> `LeaseTerm`.
[NOTE]
====
-Replaces deprecated `@Bookmarkable` annotation.
+The enum value `AS_CHILD` has no meaning for actions; it relates only to bookmarked xref:_ug_reference-annotations_manpage-DomainObject_bookmarking[domain object]s.
====
+As an alternative to using the annotation, the dynamic xref:_ug_wicket-viewer_layout_dynamic-object-layout[`.layout.json`]
+can be used instead, eg:
+
+[source,javascript]
+----
+"notYetComplete": {
+ "actionLayout": { "bookmarking": "AS_ROOT" }
+}
+----
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_contributedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_contributedAs.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_contributedAs.adoc
index f1c943d..6b5531f 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_contributedAs.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_contributedAs.adoc
@@ -6,48 +6,49 @@
-IMPORTANT: WIP ... this section
+For a domain service action that _can_ be contributed, the `contributedAs()` attribute determines how it is contributed: as an action or as an association (ie a property or collection).
-The `@NotContributed` annotation applies only to action methods, and
-specifically to the actions of services. If present, it indicates that
-the action should not be contributed to any of its domain object
-arguments.
+The distinction between property or collection is automatic: if the action returns a `java.util.Collection` (or subtype) then the action is contributed as a collection; otherwise it is contributed as a property.
+
+For a domain service action to be contributed, the domain services must have a xref:_ug_reference-annotations_manpage-DomainService_nature[nature] nature of either `VIEW` or `VIEW_CONTRIBUTIONS_ONLY`, and the action must have xref:_ug_reference-annotations_manpage-Action_semantics[safe action semantics], and takes a single argument, namely the contributee domain object.
For example:
[source,java]
----
-public class OrderServices {
- @NotContributed
- public void cancel(Order order);
+@DomainService(nature=NatureOfService.VIEW_CONTRIBUTIONS_ONLY)
+public class CustomerContributions {
+ @Action(semantics=SemanticsOf.SAFE)
+ @ActionLayout(contributedAs=Contributed.AS_ASSOCIATION)
+ public List<Order> mostRecentOrders(Customer customer) { ... }
...
}
----
-If the action should neither be contributed nor appear in the service's
-service menu, then you could instead simply mark it as `@Hidden`.
-
-
-
-
+[TIP]
+====
+The `@ActionLayout` is not required if the action does not have safe semantics, or if the action takes more than one argument; in these cases the action can only be contributed _as_ an action.
+====
-== Contributing of one-arg actions
-Actions that accept a single argument will, by default, also be contributed as an association:
+It's also possible to use the attribute to suppress the action completely:
-* if the action returns a single object (value or entity) then the action will be contributed as a property
-* if the action returns a list then the action will be contributed as a collection
+[source,java]
+----
+@DomainService(nature=NatureOfService.VIEW)
+public class OrderContributions {
+ @ActionLayout(contributedAs=Contributed.AS_NEITHER)
+ public void cancel(Order order);
+ ...
+}
+----
-This behaviour can be influenced by specifying the "As." attribute:
+In such cases, though, it would probably make more sense to annotate the action as either xref:_ug_reference-annotations_manpage-Action_hidden[hidden] or indeed xref:_ug_reference-annotations_manpage-Programmatic[`@Programmatic`].
-* use `@NotContributed(As.ACTION)` to contribute the action as an association
-* use `@NotContributed(As.ASSOCIATION)` to contribute the action as an action
-* use `@NotContributed` to not contribute the action at all.
[NOTE]
====
-Replaces the deprecated `@NotContributed` annotation.
+Unlike other `@ActionLayout` attributes, this attribute _cannot_ be specified dynamically in the `.layout.json` xref:_ug_wicket-viewer_layout_dynamic-object-layout[dynamic layout file] because it relates to the contributor domain service, not the contributee domain object.
====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClass.adoc
index d192fbb..7023e1b 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClass.adoc
@@ -6,69 +6,45 @@
-IMPORTANT: WIP ... this section
+The `cssClass()` attribute can be used to render additional CSS classes in the HTML that represents the action. Application-specific CSS can then be used to target and adjust the UI representation of that particular element.
+[NOTE]
+====
+This attribute can also be applied to xref:_ug_reference-annotations_manpage-DomainObjectLayout_cssClass[domain objects], xref:_ug_reference-annotations_manpage-ViewModelLayout_cssClass[view models], xref:_ug_reference-annotations_manpage-PropertyLayout_cssClass[properties], xref:_ug_reference-annotations_manpage-CollectionLayout_cssClass[collections] and xref:_ug_reference-annotations_manpage-ParameterLayout_cssClass[action parameters].
+====
-The `CssClass` annotation applies to object and also to any object member (property, collection or action). It is used by the Wicket viewer as a UI hint to render specified CSS classes around the representation of the element.
-
-Application-specific CSS can then be used to target and adjust the UI representation of that particular element.
For example:
[source,java]
----
-@CssClass("x-main")
-public class ToDoItem { ... }
-----
-
-or
-
-[source,java]
-----
public class ToDoItem {
-
- @CssClass("x-key")
- public LocalDate getDueBy() { ... }
-
+ @ActionLayout(cssClass="x-key")
+ public ToDoItem postpone(LocalDate until) { ... }
+ ...
}
----
+[NOTE]
+====
+The similar xref:_ug_reference-annotations_manpage-ActionLayout_cssClassFa[`@ActionLayout#cssClassFa()`] annotation attribute is also used as a hint
+to apply CSS, specifically to add http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icons] on action menu items or buttons.
+====
-== Alternatives (`.layout.json`)
-
-As an alternative to using the `@CssClass` annotation, the `.layout.json` xref:_ug_wicket-viewer_layout_dynamic-object-layout[dynamic layout file]
-can be specified, eg:
+As an alternative to using the annotation, the dynamic xref:_ug_wicket-viewer_layout_dynamic-object-layout[`.layout.json`]
+can be used instead, eg:
[source,javascript]
----
-{
- "span": 6,
- "memberGroups": {
- "Priority": {
- "members": {
- ...
- "dueBy": {
- "cssClass": { "value": "x-key" }
- }
- ....
- }
- },
- ...
- }
+"postpone": {
+ "actionLayout": { "cssClass": "x-key" }
}
----
-Note that this (currently) only supports class members, not classes
-[NOTE]
-====
-The similar xref:_ug_reference-annotations_manpage_ActionLayout_cssClassFa[`@ActionLayout#cssClassFa()`] annotation attribute is also used as a hint
-to apply CSS, but in particular to allow http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icons]
-to be rendered on action butotns or as the icon for classes.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClassFa.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClassFa.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClassFa.adoc
index b959106..a11b2e5 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClassFa.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_cssClassFa.adoc
@@ -5,40 +5,28 @@
:_imagesdir: images/
-IMPORTANT: WIP ... this section
+The `cssClassFa()` attribute is used to specify the name of a link:http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icon] name, to be rendered on the action's representation as a button or menu item. The related `cssClassFaPosition()` attribute specifies the positioning of the icon, to the left or the right of the text.
-
-
-The `CssClassFa` annotation applies to objects and also to object actions,
-and is used by the Wicket viewer as a UI hint.
-
-For object actions, the viewer will render the specified
-http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icon]
-on the action's button (or menu item).
-
-For objects, it will be used as an icon. Note that this is only used if
-the object does not have a `getIconName()` method.
+[NOTE]
+====
+These attributes can also be applied to xref:_ug_reference-annotations_manpage-DomainObjectLayout_cssClass[domain objects] and to xref:_ug_reference-annotations_manpage-ViewModelLayout_cssClassFa[view models] to specify the object's icon.
+====
For example:
[source,java]
----
-@CssClassFa("fa-check-circle")
-public class ToDoItem { ... }
-----
-
-or
-
-[source,java]
-----
public class ToDoItem {
-
- @CssClass("fa-step-backward")
+ @ActionLayout(
+ cssClassFa="fa-step-backward"
+ )
public ToDoItem previous() { ... }
- @CssClass("fa-step-forward")
+ @ActionLayout(
+ cssClassFa="fa-step-forward",
+ cssClassFaPosition=ActionLayout.CssClassFaPosition.RIGHT
+ )
public ToDoItem next() { ... }
-
}
----
@@ -46,47 +34,29 @@ There can be multiple "fa-" classes, eg to mirror or rotate the icon. There
is no need to include the "fa" class; it will be automatically appended.
-
-
-== Alternatives (`.layout.json`)
-
-As an alternative to using the `@CssClass` annotation, the `.layout.json` xref:_ug_wicket-viewer_layout_dynamic-object-layout[dynamic layout file]
-can be specified, eg:
+As an alternative to using the annotation, the dynamic xref:_ug_wicket-viewer_layout_dynamic-object-layout[`.layout.json`]
+can be used instead, eg:
[source,javascript]
----
-{
- "span": 6,
- "memberGroups": {
- "Priority": {
- "members": {
- ...
- "relativePriority": {
- "actions": {
- "previous": {
- "cssClassFa": { "value": "fa-step-backward" }
- },
- "next": {
- "cssClassFa": { "value": "fa-step-forward" }
- }
- }
- },
- ....
- }
- },
- ...
+"previous": {
+ "actionLayout": {
+ "cssClassFa": "fa-step-backward",
+ "cssClassFaPosition": "LEFT"
+ }
+},
+"next": {
+ "actionLayout": {
+ "cssClassFa": "fa-step-forward",
+ "cssClassFaPosition": "RIGHT"
}
}
----
-Note that this (currently) only supports class members, not classes.
[NOTE]
====
-The similar xref:_ug_reference-annotations_manpage_ActionLayout_cssClass[`@ActionLayout#cssClass()`] annotation attribute is also used as a hint to apply CSS, but for wrapping the representation of an object or object member so that it can be styled in an application-specific way.
+The similar xref:_ug_reference-annotations_manpage-ActionLayout_cssClass[`@ActionLayout#cssClass()`] annotation attribute is also used as a hint to apply CSS, but for wrapping the representation of an object or object member so that it can be styled in an application-specific way.
====
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/4a9da14d/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_describedAs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_describedAs.adoc
index a25aea1..55d0353 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_describedAs.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/_ug_reference-annotations_manpage-ActionLayout_describedAs.adoc
@@ -6,19 +6,20 @@
-IMPORTANT: WIP ... this section
+The `describedAs()` attribute is used to provide a short description of something that features on the user interface. For example, in the xref:_ug_wicket-viewer[Wicket viewer] it is displayed as a 'tool tip'.
+[NOTE]
+====
+The `describedAs()` attribute can also be specified for xref:_ug_reference-annotations_manpage-CollectionLayout_describedAs[collections], xref:_ug_reference-annotations_manpage-PropertyLayout_describedAs[properties], xref:_ug_reference-annotations_manpage-ParameterLayout_describedAs[parameters], xref:_ug_reference-annotations_manpage-DomainObjectLayout_describedAs[domain objects] and xref:_ug_reference-annotations_manpage-ViewModelLayout_describedAs[view models].
+====
-The `@DescribedAs` annotation is used to provide a short description of something that features on the user interface. How this description is used will depend upon the viewing mechanism - but it may be thought of as being like a 'tool tip'.
-
-Descriptions may be provided for objects, members (properties, collections and actions), and for individual parameters within an action method. `@DescribedAs` therefore works in a very similar manner to `@Named` <!--(see ?)-->.
For example:
[source,java]
----
public class Customer {
- @DescribedAs("Place a repeat order of the last (most recently placed) order")
+ @ActionLayout(describedAs="Place a repeat order of the last (most recently placed) order")
public Order placeRepeatOrder(...) { ... }
}
----
@@ -26,3 +27,14 @@ public class Customer {
+As an alternative to using the annotation, the dynamic xref:_ug_wicket-viewer_layout_dynamic-object-layout[`.layout.json`]
+can be used instead, eg:
+
+[source,javascript]
+----
+"postpone": {
+ "actionLayout": { "describedAs": "Place a repeat order of the last (most recently placed) order" }
+}
+----
+
+