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 2018/02/13 13:48:31 UTC
[04/19] isis-site git commit: publishes 1.16.1-SNAPSHOT
http://git-wip-us.apache.org/repos/asf/isis-site/blob/f27adae8/content/versions/SNAPSHOT/guides/ugvro/ugvro.pdf
----------------------------------------------------------------------
diff --git a/content/versions/SNAPSHOT/guides/ugvro/ugvro.pdf b/content/versions/SNAPSHOT/guides/ugvro/ugvro.pdf
index 37e8d9b..4bc7389 100644
--- a/content/versions/SNAPSHOT/guides/ugvro/ugvro.pdf
+++ b/content/versions/SNAPSHOT/guides/ugvro/ugvro.pdf
@@ -4,8 +4,8 @@
<< /Title (Restful Objects Viewer)
/Creator (Asciidoctor PDF 1.5.0.alpha.11, based on Prawn 1.3.0)
/Producer (Asciidoctor PDF 1.5.0.alpha.11, based on Prawn 1.3.0)
-/CreationDate (D:20180108231509+00'00')
-/ModDate (D:20180108231509+00'00')
+/CreationDate (D:20180213131254+00'00')
+/ModDate (D:20180213131254+00'00')
>>
endobj
2 0 obj
http://git-wip-us.apache.org/repos/asf/isis-site/blob/f27adae8/content/versions/SNAPSHOT/guides/ugvw/ugvw.html
----------------------------------------------------------------------
diff --git a/content/versions/SNAPSHOT/guides/ugvw/ugvw.html b/content/versions/SNAPSHOT/guides/ugvw/ugvw.html
index 227deef..347824f 100644
--- a/content/versions/SNAPSHOT/guides/ugvw/ugvw.html
+++ b/content/versions/SNAPSHOT/guides/ugvw/ugvw.html
@@ -1365,24 +1365,39 @@ table.CodeRay td.code>pre{padding:0}
<div class="paragraph">
<p>The <code>Xxx.layout.xml</code> file is just the serialized form of a <a href="../rgcms/rgcms.html#_rgcms_classes_layout"><code>Grid</code></a> layout class defined within Apache Isis' applib. 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.</p>
</div>
- <div class="admonitionblock note">
- <table>
- <tbody>
- <tr>
- <td class="icon"> <i class="fa icon-note" title="Note"></i> </td>
- <td class="content">
- <div class="paragraph">
- <p>It is also possible to describe layouts using a <code>.layout.json</code> file. However, <code>.layout.json</code> support is deprecated; the <code>.layout.xml</code> file also enables much more sophisticated layouts than those afforded by <code>.layout.json</code>.</p>
- </div>
- <div class="paragraph">
- <p>If you have an application with older <code>.layout.json</code> files, then it is possible to download initial <code>.layout.xml</code> files using the <a href="../rgsvc/rgsvc.html#_rgsvc_metadata-api_LayoutService"><code>LayoutService</code></a> (exposed as an action on the prototyping menu). The <code>.layout.json</code> file will be ignored once a <code>.layout.xml</code> file is present.</p>
- </div> </td>
- </tr>
- </tbody>
- </table>
+ <div class="sect3">
+ <h4 id="_search_algorithm_library_support">3.2.1. Search Algorithm (Library Support)</h4>
+ <div class="paragraph">
+ <p>For a given domain object <code>Xxx</code> the framework initially searches for a file (on the classpath) called <code>Xxx.layout.xml</code>.</p>
+ </div>
+ <div class="paragraph">
+ <p>If this can’t be found, then the framework will search for a file named <code>Xxx.layout.fallback.xml</code>. If present, this will be used instead.</p>
+ </div>
+ <div class="paragraph">
+ <p>This therefore allows libraries that provide a domain entities/view models (for example, the (non-ASF) <a href="http://platform.incode.org">Incode Platform</a> 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.</p>
+ </div>
+ <div class="admonitionblock note">
+ <table>
+ <tbody>
+ <tr>
+ <td class="icon"> <i class="fa icon-note" title="Note"></i> </td>
+ <td class="content">
+ <div class="paragraph">
+ <p>It is also possible to describe layouts using a <code>.layout.json</code> file. However, <code>.layout.json</code> support is deprecated; the <code>.layout.xml</code> file also enables much more sophisticated layouts than those afforded by <code>.layout.json</code>.</p>
+ </div>
+ <div class="paragraph">
+ <p>If you have an application with older <code>.layout.json</code> files, then it is possible to download initial <code>.layout.xml</code> files using the <a href="../rgsvc/rgsvc.html#_rgsvc_metadata-api_LayoutService"><code>LayoutService</code></a> (exposed as an action on the prototyping menu).</p>
+ </div>
+ <div class="paragraph">
+ <p>The <code>.layout.json</code> file will be ignored once a <code>.layout.xml</code> file is present.</p>
+ </div> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="sect3">
- <h4 id="_grids_vs_components">3.2.1. Grids vs Components</h4>
+ <h4 id="_grids_vs_components">3.2.2. Grids vs Components</h4>
<div class="paragraph">
<p>The layout file distinguishes between two types of element:</p>
</div>
@@ -1400,13 +1415,13 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="_screencast">3.2.2. Screencast</h4>
+ <h4 id="_screencast">3.2.3. Screencast</h4>
<div class="paragraph">
<p>This <a href="https://www.youtube.com/watch?v=MxewC5Pve5k">screencast</a> describes the feature.</p>
</div>
</div>
<div class="sect3">
- <h4 id="_examples">3.2.3. Examples</h4>
+ <h4 id="_examples">3.2.4. Examples</h4>
<div class="paragraph">
<p>Probably the easiest way to understand dynamic XML layouts is by example. For this we’ll use the <code>ToDoItem</code> from the (non-ASF) <a href="http://github.com/isisaddons/isis-app-todoapp">Isis addons' todoapp</a>:</p>
</div>
@@ -1570,7 +1585,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="__ugvw_layout_file-based_unreferenced">3.2.4. Unreferenced Members</h4>
+ <h4 id="__ugvw_layout_file-based_unreferenced">3.2.5. Unreferenced Members</h4>
<div class="paragraph">
<p>As noted in the preceding discussion, several of the grid’s regions have either an <code>unreferencedActions</code>, <code>unreferencedCollections</code> or <code>unreferencedProperties</code> attribute.</p>
</div>
@@ -1598,7 +1613,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="_more_advanced_features">3.2.5. More advanced features</h4>
+ <h4 id="_more_advanced_features">3.2.6. More advanced features</h4>
<div class="paragraph">
<p>This section decribes a number of more features useful in more complex layouts.</p>
</div>
@@ -1731,7 +1746,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="_migrating_from_earlier_versions">3.2.6. Migrating from earlier versions</h4>
+ <h4 id="_migrating_from_earlier_versions">3.2.7. Migrating from earlier versions</h4>
<div class="paragraph">
<p>As noted earlier on, it is possible to download layout XML files using the <a href="../rgsvc/rgsvc.html#_rgsvc_metadata-api_LayoutService"><code>LayoutService</code></a> (exposed on the prototyping menu); this will download a ZIP file of layout XML files for all domain entities and view models. Alternatively the layout XML for a single domain object can be downloaded using the <a href="../rgcms/rgcms.html#_rgcms_classes_mixins_Object">mixin action</a> (contributed to every domain object).</p>
</div>
@@ -1803,7 +1818,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="_domain_services">3.2.7. Domain Services</h4>
+ <h4 id="_domain_services">3.2.8. Domain Services</h4>
<div class="paragraph">
<p>For more information about layouts, see:</p>
</div>
@@ -1816,7 +1831,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="_required_updates_to_the_dom_project_s_pom_xml">3.2.8. Required updates to the dom project’s pom.xml</h4>
+ <h4 id="_required_updates_to_the_dom_project_s_pom_xml">3.2.9. Required updates to the dom project’s pom.xml</h4>
<div class="paragraph">
<p>Any <code>.layout.xml</code> files must be compiled and available in the classpath. Ensure the following is defined in the dom project’s <code>pom.xml</code>:</p>
</div>