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/12/22 00:27:13 UTC
isis-site git commit: ISIS-1275: minor tidy-up of config prop docs
for RO viewer
Repository: isis-site
Updated Branches:
refs/heads/asf-site 524735aa8 -> 554d5341d
ISIS-1275: minor tidy-up of config prop docs for RO viewer
Project: http://git-wip-us.apache.org/repos/asf/isis-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis-site/commit/554d5341
Tree: http://git-wip-us.apache.org/repos/asf/isis-site/tree/554d5341
Diff: http://git-wip-us.apache.org/repos/asf/isis-site/diff/554d5341
Branch: refs/heads/asf-site
Commit: 554d5341db63190854dda5816281cca512c0680e
Parents: 524735a
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Mon Dec 21 23:24:35 2015 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Mon Dec 21 23:24:35 2015 +0000
----------------------------------------------------------------------
content/guides/ugvro.html | 164 +++++++++++++++++++++--------------------
1 file changed, 83 insertions(+), 81 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis-site/blob/554d5341/content/guides/ugvro.html
----------------------------------------------------------------------
diff --git a/content/guides/ugvro.html b/content/guides/ugvro.html
index 1a0f430..79693ec 100644
--- a/content/guides/ugvro.html
+++ b/content/guides/ugvro.html
@@ -1060,7 +1060,7 @@ this resource:</p>
...
} ],
"dependencies" : [ ],
- "$$ro" : { <i class="conum" data-value="5"></i><b>(5)</b>
+ "$$ro" : { <i class="conum" data-value="6"></i><b>(6)</b>
"links" : [ ... ],
"extensions" : { ... },
"title" : "Buy bread due by 2015-12-04",
@@ -1425,10 +1425,85 @@ basis (as is the case with the <code>Accept</code> header used for the Apache Is
deprecated, and may be removed in the future.</p>
</div>
<div class="paragraph">
+<p>Details can be found in <a href="#_ugvro_configuration-properties_deprecated">here</a>.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_ugvro_configuration-properties">5. Configuration Properties</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The Restful Objects viewer provides a couple of configuration option that extend/simplify/alter the representations
+generated from the Restful Objects specification.</p>
+</div>
+<div class="paragraph">
+<p>These configuration properties are typically stored in <code>WEB-INF/viewer_restfulobjects.properties</code>. However, you can
+place all configuration properties into <code>WEB-INF/isis.properties</code> if you wish (the configuration properties from all
+config files are merged together).</p>
+</div>
+<div class="sect2">
+<h3 id="_ugvro_configuration-properties_standard">5.1. Standard</h3>
+<div class="paragraph">
+<p>The following configuration properties are supported:</p>
+</div>
+<table class="tableblock frame-all grid-all spread">
+<caption class="title">Table 1. Restful Objects Viewer Configuration Properties</caption>
+<colgroup>
+<col style="width: 33%;">
+<col style="width: 16%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Property</th>
+<th class="tableblock halign-left valign-top">Value<br>
+(<em>default value</em>)</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p><code>isis.viewer.restfulobjects.</code><br>
+<code>honorUiHints</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code> (<code><em>false</em></code>)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A mechanism for reducing the number of round-trips by eagerly rendering collections; discussed <a href="#_ugvro_ro-spec_extensions_minimizing-round-trips_honor-ui-hints">here</a>.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p><code>isis.viewer.restfulobjects.</code><br>
+<code>strictAcceptChecking</code><br>
+(<code>1.11.0-SNAPSHOT</code>)</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code> (<code><em>false</em></code>)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to strictly enforce the <code>Accept</code> header checking for the default RO-spec representations (by the
+<code>ContentNegotiationServiceForRestfulObjectsV1_0</code> service). Will otherwise accept anything. <br>
+</p><p class="tableblock">This is convenient because it allows the <code>Accept</code> header to be set to that of the
+<a href="#_ugvro_simplified-representations">Apache Isis profile</a> for all resources, rather than simply the
+handful of resources that supported that profile.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect2">
+<h3 id="_ugvro_configuration-properties_deprecated">5.2. Deprecated</h3>
+<div class="paragraph">
+<p>There are also a number of configuration properties that can be used to suppress or simplify the default RO-spec
+representations.</p>
+</div>
+<div class="paragraph">
+<p>These configuration properties pre-date the support, introduced in <code>1.11.0-SNAPSHOT</code>, for the Apache Isis profile, and
+are limited by the fact that they are global configuration settings, so cannot be influenced on a request-by-request
+basis (as is the case with the <code>Accept</code> header used for the Apache Isis profile). They have therefore been
+deprecated, and may be removed in the future.</p>
+</div>
+<div class="paragraph">
<p>Nevertheless, those configuration properties are:</p>
</div>
<table class="tableblock frame-all grid-all spread">
-<caption class="title">Table 1. Deprecated Configuration Properties</caption>
+<caption class="title">Table 2. Deprecated Configuration Properties</caption>
<colgroup>
<col style="width: 33%;">
<col style="width: 16%;">
@@ -1585,84 +1660,6 @@ property in the representations with reflect these settings.</p>
</div>
</div>
<div class="sect1">
-<h2 id="_ugvro_configuration-properties">5. Configuration Properties</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>The Restful Objects viewer provides a couple of configuration option that extend/simplify/alter the representations
-generated from the Restful Objects specification.</p>
-</div>
-<div class="paragraph">
-<p>These configuration properties are typically stored in <code>WEB-INF/viewer_restfulobjects.properties</code>. However, you can
-place all configuration properties into <code>WEB-INF/isis.properties</code> if you wish (the configuration properties from all
-config files are merged together).</p>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-<div class="paragraph">
-<p>As of <code>1.11.0-SNAPSHOT</code> these configuration settings should be considered deprecated, because the
-<a href="#_ugvro_simplified-representations">simplified representation</a> support provided by the Apache Isis profile is a more flexible solution.</p>
-</div>
-<div class="paragraph">
-<p>Also, be aware enabling these settings makes the representations non-standard with respect to
-<a href="http://restfulobjects.org">Restful Object spec</a>.</p>
-</div>
-</td>
-</tr>
-</table>
-</div>
-<table class="tableblock frame-all grid-all spread">
-<caption class="title">Table 2. Restful Objects Viewer Configuration Properties</caption>
-<colgroup>
-<col style="width: 33%;">
-<col style="width: 16%;">
-<col style="width: 50%;">
-</colgroup>
-<thead>
-<tr>
-<th class="tableblock halign-left valign-top">Property</th>
-<th class="tableblock halign-left valign-top">Value<br>
-(<em>default value</em>)</th>
-<th class="tableblock halign-left valign-top">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><code>isis.viewer.restfulobjects.</code><br>
-<code>honorUiHints</code></p>
-</div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code> (<code><em>false</em></code>)</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">A mechanism for reducing the number of round-trips by eagerly rendering collections; discussed <a href="#_ugvro_ro-spec_extensions_minimizing-round-trips_honor-ui-hints">here</a>.</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><code>isis.viewer.restfulobjects.</code><br>
-<code>strictAcceptChecking</code><br>
-(<code>1.11.0-SNAPSHOT</code>)</p>
-</div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code> (<code><em>false</em></code>)</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Whether to strictly enforce the <code>Accept</code> header checking for the default RO-spec representations (by the
-<code>ContentNegotiationServiceForRestfulObjectsV1_0</code> service). Will otherwise accept anything. <br>
-+
-This is convenient because it allows the <code>Accept</code> header to be set to that of the
-<a href="#_ugvro_simplified-representations">Apache Isis profile</a> for all resources, rather than simply the
-handful of resources that supported that profile.</p></td>
-</tr>
-</tbody>
-</table>
-<div class="paragraph">
-<p>There are also a number of configuration properties that can be used to suppress or simplify the default RO-spec
-representations. These pre-date the Apache Isis profile <code>1.11.0-SNAPSHOT</code> support, so are considered deprecated.
-Discussion of them can nevertheless be found <a href="#_ugvro_simplified-representations_configuration-properties">here</a>.</p>
-</div>
-</div>
-</div>
-<div class="sect1">
<h2 id="_ugvro_hints-and-tips">6. Hints and Tips</h2>
<div class="sectionbody">
<div class="paragraph">
@@ -1823,7 +1820,12 @@ findCustomer.get({<span class="key">queryString</span>: JSON.stringify(findCusto
<li><a href="#_ugvro_simplified-representations_configuration-properties">4.6. Global Config Props (Deprecated)</a></li>
</ul>
</li>
-<li><a href="#_ugvro_configuration-properties">5. Configuration Properties</a></li>
+<li><a href="#_ugvro_configuration-properties">5. Configuration Properties</a>
+<ul class="sectlevel2">
+<li><a href="#_ugvro_configuration-properties_standard">5.1. Standard</a></li>
+<li><a href="#_ugvro_configuration-properties_deprecated">5.2. Deprecated</a></li>
+</ul>
+</li>
<li><a href="#_ugvro_hints-and-tips">6. Hints and Tips</a>
<ul class="sectlevel2">
<li><a href="#_using_chrome_tools">6.1. Using Chrome Tools</a></li>