This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch maint-1.16.1
in repository

The following commit(s) were added to refs/heads/maint-1.16.1 by this push:
     new 3263275  ISIS-1589: adds documentation for .layout.fallback.xml
3263275 is described below

commit 3263275222513ebdb64e1b06c06cfa2c8e1cd79a
Author: Dan Haywood <>
AuthorDate: Fri Feb 9 12:43:38 2018 +0000

    ISIS-1589: adds documentation for .layout.fallback.xml
 .../asciidoc/guides/ugvw/_ugvw_layout_file-based.adoc   | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git 
index 36c56cd..3a30493 100644
@@ -31,12 +31,25 @@ The `Xxx.layout.xml` file is just the serialized form of a 
 These are JAXB-annotated classes with corresponding XSD schemas; the upshot of 
that is that IDEs such as IntelliJ and Eclipse can provide "intellisense", 
making iteasy to author such layout files.
+== Search Algorithm (Library Support)
+For a given domain object `Xxx` the framework initially searches for a file 
(on the classpath) called `Xxx.layout.xml`.
+If this can't be found, then the framework will search for a file named 
+If present, this will be used instead.
+This therefore allows libraries that provide a domain entities/view models 
(for example, the (non-ASF) link:[Incode Platform] 
modules) to define the UI of these objects using a layout file, while still 
allowing the consuming application to override that layout if it so requires.
 It is also possible to describe layouts using a `.layout.json` file.
 However, `.layout.json` support is deprecated; the ``.layout.xml`` file also 
enables much more sophisticated layouts than those afforded by ``.layout.json``.
 If you have an application with older `.layout.json` files, then it is 
possible to download initial `.layout.xml` files using the 
(exposed as an action on the prototyping menu).
 The `.layout.json` file will be ignored once a `.layout.xml` file is present.
@@ -54,6 +67,7 @@ The rows and columns are closely modelled on 
 More information about these classes can be found in 
xref:../rgcms/rgcms.adoc#_rgcms_classes_layout[the reference guide].  More 
information on Bootstrap 3's grid system can be found 
 == Screencast
 This link:[screencast] describes 
the feature.
@@ -447,3 +461,6 @@ Ensure the following is defined in the dom project's 
 If using an Apache Isis 
archetypes, then the POM is already correctly configured.

To stop receiving notification emails like this one, please contact

Reply via email to