This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch maint-1.16.1
in repository https://gitbox.apache.org/repos/asf/isis.git
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 <d...@haywood-associates.co.uk>
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
a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_layout_file-based.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_layout_file-based.adoc
index 36c56cd..3a30493 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_layout_file-based.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_layout_file-based.adoc
@@ -31,12 +31,25 @@ The `Xxx.layout.xml` file is just the serialized form of a
xref:../rgcms/rgcms.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
`Xxx.layout.fallback.xml`.
+If present, this will be used instead.
+
+This therefore allows libraries that provide a domain entities/view models
(for example, the (non-ASF) link:http://platform.incode.org[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.
+
+
+
[NOTE]
====
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
xref:../rgsvc/rgsvc.adoc#_rgsvc_metadata-api_LayoutService[`LayoutService`]
(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
link:http://getbootstrap.com[Bootst
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
link:http://getbootstrap.com/css/#grid[here].
+
== Screencast
This link:https://www.youtube.com/watch?v=MxewC5Pve5k[screencast] describes
the feature.
@@ -447,3 +461,6 @@ Ensure the following is defined in the dom project's
`pom.xml`:
----
If using an Apache Isis
xref:../ugfun/ugfun.adoc#_ugfun_getting-started_helloworld-archetype[HelloWorld]
xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp]
archetypes, then the POM is already correctly configured.
+
+
+
--
To stop receiving notification emails like this one, please contact
danhayw...@apache.org.
