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 2017/09/25 08:33:52 UTC
[04/24] isis-site git commit: ISIS-1712 - updates docs,
replace references to isisaddons and catalog.incode.org with
platform.incode.org
http://git-wip-us.apache.org/repos/asf/isis-site/blob/e5dcb0be/content/guides/ugvw/ugvw.html
----------------------------------------------------------------------
diff --git a/content/guides/ugvw/ugvw.html b/content/guides/ugvw/ugvw.html
index d7873d5..30fdfc6 100644
--- a/content/guides/ugvw/ugvw.html
+++ b/content/guides/ugvw/ugvw.html
@@ -273,7 +273,7 @@ table.CodeRay td.code>pre{padding:0}
<p>This user guide discuss end-user features, configuration and customization of the Wicket viewer.</p>
</div>
<div class="paragraph">
- <p>It also discusses how to extend the viewer, and the (non-ASF) <a href="http://www.isisaddons.org">Isis Addons</a> wicket components.</p>
+ <p>It also discusses how to extend the viewer, and the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> wicket components.</p>
</div>
<div class="sect2">
<h3 id="_other_guides">1.1. Other Guides</h3>
@@ -967,7 +967,7 @@ table.CodeRay td.code>pre{padding:0}
</ul>
</div>
<div class="paragraph">
- <p>The Apache Isis core framework provides a default implementation of both the email notification service and the email service. If your application uses the <a href="https://github.com/isisaddons/isis-module-security">Isis addons security module</a> (not ASF) then an implementation is provided by that module; just add to the classpath. Otherwise you will need to provide your own implementation.</p>
+ <p>The Apache Isis core framework provides a default implementation of both the email notification service and the email service. If your application uses the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s security module then an implementation is provided by that module; just add to the classpath. Otherwise you will need to provide your own implementation.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -1040,7 +1040,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
<div class="ulist">
<ul>
- <li> <p>register an implementation of the <a href="../rgsvc/rgsvc.html#_rgsvc_persistence-layer-spi_UserRegistrationService">user registration service</a> (eg by using the <a href="https://github.com/isisaddons/isis-module-security">Isis addons security module</a>)</p> </li>
+ <li> <p>register an implementation of the <a href="../rgsvc/rgsvc.html#_rgsvc_persistence-layer-spi_UserRegistrationService">user registration service</a> (eg by using the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s security module)</p> </li>
<li> <p>configure the <a href="../rgsvc/rgsvc.html#_rgsvc_integration-api_EmailService">email service</a></p> </li>
</ul>
</div>
@@ -1312,7 +1312,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect3">
<h4 id="_other_annotations">3.1.4. Other Annotations</h4>
<div class="paragraph">
- <p>As of 1.8.0, all the layout annotations have been consolidated into the various <code>XxxLayout</code> annotations: <a href="../rgant/rgant.html#_rgant-ActionLayout, "><code>@ActionLayout</code></a> <a href="../rgant/rgant.html#_rgant-CollectionLayout"><code>@CollectionLayout</code></a>, <a href="../rgant/rgant.html#_rgant-DomainObjectLayout"><code>@DomainObjectLayout</code></a>, <a href="../rgant/rgant.html#_rgant-DomainServiceLayout"><code>@DomainServiceLayout</code></a>, <a href="../rgant/rgant.html#_rgant-ParameterLayout"><code>@ParameterLayout</code></a>, <a href="../rgant/rgant.html#_rgant-PropertyLayout"><code>@PropertyLayout</code></a>, and <a href="../rgant/rgant.html#_rgant-ViewModelLayout"><code>@ViewModelLayout</code></a></p>
+ <p>As of <code>1.8.0</code>, all the layout annotations have been consolidated into the various <code>XxxLayout</code> annotations: <a href="../rgant/rgant.html#_rgant-ActionLayout, "><code>@ActionLayout</code></a> <a href="../rgant/rgant.html#_rgant-CollectionLayout"><code>@CollectionLayout</code></a>, <a href="../rgant/rgant.html#_rgant-DomainObjectLayout"><code>@DomainObjectLayout</code></a>, <a href="../rgant/rgant.html#_rgant-DomainServiceLayout"><code>@DomainServiceLayout</code></a>, <a href="../rgant/rgant.html#_rgant-ParameterLayout"><code>@ParameterLayout</code></a>, <a href="../rgant/rgant.html#_rgant-PropertyLayout"><code>@PropertyLayout</code></a>, and <a href="../rgant/rgant.html#_rgant-ViewModelLayout"><code>@ViewModelLayout</code></a></p>
</div>
</div>
</div>
@@ -1966,7 +1966,7 @@ table.CodeRay td.code>pre{padding:0}
<p>Note that the last is also a prototype action (meaning it is only displayed in SERVER_PROTOTYPE (=Wicket Development) mode). In the UI it is rendered in italics.</p>
</div>
<div class="paragraph">
- <p>(It is possible to override this place of a given action by specifying <code>@MemberOrder(name="…")</code> where the name is that of a top-level menu. Prior to 1.8.0 this was the only way of doing things, as of 1.8.0 its use is not recommended).</p>
+ <p>(It is possible to override this place of a given action by specifying <code>@MemberOrder(name="…")</code> where the name is that of a top-level menu. Prior to <code>1.8.0</code> this was the only way of doing things, as of <code>1.8.0</code> its use is not recommended).</p>
</div>
</div>
<div class="sect3">
@@ -2004,24 +2004,20 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div>
<div class="sect3">
- <h4 id="_isis_add_on_modules">3.3.4. Isis Add-on modules</h4>
+ <h4 id="_incode_platform_modules">3.3.4. Incode Platform modules</h4>
<div class="paragraph">
- <p>Some of the (non-ASF) <a href="http://www.isisaddons.org">Isis Addons</a> modules also provide services whose actions appear in top-level menus.</p>
+ <p>Some of the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> modules also provide services whose actions appear in top-level menus.</p>
</div>
<div class="paragraph">
- <p>The <a href="http://github.com/isisaddons/isis-module-security">security</a>'s module places its domain service menus in three top-level menus:</p>
+ <p>The security’s module places its domain service menus in three top-level menus:</p>
</div>
<div class="ulist">
<ul>
<li> <p>its <code>ApplicationUsers</code>, <code>ApplicationRoles</code>, <code>ApplicationPermission</code>, <code>ApplicationFeatureViewModels</code> and <code>ApplicationTenancies</code> domain services are all grouped together in a single "Security" top-level menu, on the SECONDARY menu bar</p> </li>
- <li> <p>its <code>SecurityModuleAppFixturesService</code> domain service, which allows the security modules' fixture scripts to be run, is placed on a "Prototyping" top-level menu, also on the SECONDARY menu bar</p> </li>
<li> <p>its <code>MeService</code> domain service, which provides the <code>me()</code> action, is placed on the TERTIARY menu bar.</p> </li>
</ul>
</div>
<div class="paragraph">
- <p>Meanwhile the <a href="http://github.com/isisaddons/isis-module-devutils">devutils</a> module places its actions - to download layouts and so forth - on a "Prototyping" top-level menu, on the SECONDARY menu bar.</p>
- </div>
- <div class="paragraph">
<p>Currently there is no facility to alter the placement of these services. However, their UI can be suppressed using security or using a <a href="../ugbtb/ugbtb.html#_ugbtb_hints-and-tips_vetoing-visibility">vetoing subscriber</a>.</p>
</div>
</div>
@@ -2335,7 +2331,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code><br> (<code><em>false</em></code>)</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">By default, an action invocation that returns the same object will result in the page being updated. The same is true for property edits. </p><p class="tableblock">If this setting is enabled, then the viewer will always render to a new page. </p><p class="tableblock">[NOTE] ==== Note that the default behaviour is new in <code>1.15.0</code>, providing a better end-user experience. Setting this option retains the behaviour of the viewer pre-1.15.0. ====</p></td>
+ <td class="tableblock halign-left valign-top"><p class="tableblock">By default, an action invocation that returns the same object will result in the page being updated. The same is true for property edits. </p><p class="tableblock">If this setting is enabled, then the viewer will always render to a new page. </p><p class="tableblock">[NOTE] ==== Note that the default behaviour is new in <code>1.15.0</code>, providing a better end-user experience. Setting this option retains the behaviour of the viewer pre-<code>1.15.0</code>. ====</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top">
@@ -3557,7 +3553,7 @@ isis.viewer.wicket.maxTitleLengthInParentedTables=8</code></pre>
<div class="paragraph">
<p></p>
<div class="extended-quote-first">
- <p>Suppose you want to build a monitoring application, eg for an electricity grid. Data is updated in the background (eg via the Restful Objects REST API). What is needed is the ability to show an entity that includes a <a href="http://github.com/isisaddons/isis-wicket-gmap3">map</a>, and have it auto-refresh every 5 seconds or so. </p>
+ <p>Suppose you want to build a monitoring application, eg for an electricity grid. Data is updated in the background (eg via the Restful Objects REST API). What is needed is the ability to show an entity that includes a map, and have it auto-refresh every 5 seconds or so. </p>
</div>
<p></p>
</div>
@@ -3746,10 +3742,10 @@ isis.viewer.wicket.maxTitleLengthInParentedTables=8</code></pre>
</ul>
</div>
<div class="paragraph">
- <p>Replacing elements of the page is the most powerful general-purpose way to customize the look-n-feel of the viewer. Examples at the (non-ASF) <a href="http://www.isisaddons.org">Isis Add-ons</a> include the <a href="http://github.com/isisaddons/isis-wicket-gmap3">gmap3</a> extension, the <a href="http://github.com/isisaddons/isis-wicket-fullcalendar2">calendar</a> extension, the <a href="http://github.com/isisaddons/isis-wicket-excel">excel download</a> and the <a href="http://github.com/isisaddons/isis-wicket-wickedcharts">wickedcharts</a> charting integration.</p>
+ <p>Replacing elements of the page is the most powerful general-purpose way to customize the look-n-feel of the viewer. Examples in the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> include the gmap3, fullcalendar2, excel, pdfjs and wickedcharts components.</p>
</div>
<div class="paragraph">
- <p>The pages generated by Apache Isis' Wicket viewer are built up of numerous elements, from fine-grained widgets for property/parameter fields, to much larger components that take responsibility for rendering an entire entity entity, or a collection of entities. Under the covers these are all implementations of the the Apache Wicket <code>Component</code> API. The larger components delegate to the smaller, of course.</p>
+ <p>The pages generated by Apache Isis' Wicket viewer are built up of numerous elements, from fine-grained widgets for property/parameter fields, to much larger components that take responsibility for rendering an entire entity, or a collection of entities. Under the covers these are all implementations of the the Apache Wicket <code>Component</code> API. The larger components delegate to the smaller, of course.</p>
</div>
<div class="sect3">
<h4 id="_how_the_viewer_selects_components">6.2.1. How the viewer selects components</h4>
@@ -3887,14 +3883,15 @@ isis.viewer.wicket.maxTitleLengthInParentedTables=8</code></pre>
<p>For example, out-of-the-box Apache Isis provides a table view, a summary view (totals/sums/averages of any data), and a collapsed view (for <code>@Render(LAZILY)</code> collections). These are selected by clicking on the toolbar by each collection.</p>
</div>
<div class="paragraph">
- <p>Additional views though could render the objects in the collection as a variety of ways. Indeed, some third-party implementations already exist:</p>
+ <p>Additional views though could render the objects in the collection as a variety of ways. Indeed, some third-party implementations in the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> already exist, including:</p>
</div>
<div class="ulist">
<ul>
- <li> <p><a href="https://github.com/isisaddons/isis-wicket-excel">excel integration</a> (collection as a downloadable excel spreadsheet)</p> </li>
- <li> <p><a href="https://github.com/isisaddons/isis-wicket-gmap3">google maps v3 integration</a> (render any objects with a location on a map)</p> </li>
- <li> <p><a href="https://github.com/isisaddons/isis-wicket-wickedcharts">wicked charts integration</a> (barchart of any data)</p> </li>
- <li> <p><a href="https://github.com/isisaddons/isis-wicket-fullcalendar2">full calendar integration</a> (render any objects with date properties on a calendar)</p> </li>
+ <li> <p>excel component - collection as a downloadable excel spreadsheet</p> </li>
+ <li> <p>gmap3 component - render any objects with a location on a map</p> </li>
+ <li> <p>pdf.js component - render Blob containined PDF as a scrollable image</p> </li>
+ <li> <p>wicked charts component - barchart of any data</p> </li>
+ <li> <p>full calendar - render any objects with date properties on a calendar</p> </li>
</ul>
</div>
<div class="paragraph">
@@ -4104,7 +4101,7 @@ public WebRequest newWebRequest(HttpServletRequest servletRequest, String filter
</div>
</div>
<div class="paragraph">
- <p>Rather than using the static <code>DEMO_MODE_USING_CREDENTIALS_AS_QUERYARGS</code>, you might also explore using the feature toggle library provided by the (non-ASF) <a href="http://github.com/isisaddons/isis-module-togglz">Isis addons' togglz</a> module.</p>
+ <p>Rather than using the static <code>DEMO_MODE_USING_CREDENTIALS_AS_QUERYARGS</code>, you might also explore using the feature toggle library provided by the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s togglz module.</p>
</div>
</div>
</div>
@@ -4339,46 +4336,46 @@ public WebRequest newWebRequest(HttpServletRequest servletRequest, String filter
</div>
</div>
<div class="sect1">
- <h2 id="_ugvw_isis-addons">8. Appendix: Isis Add-ons (not ASF)</h2>
+ <h2 id="_ugvw_incode-platform">8. Appendix: Incode Platform (not ASF)</h2>
<div class="btn-group" style="float: right; font-size: small; padding: 6px; margin-top: -55px; ">
- <button type="button" class="btn btn-xs btn-default" onclick="window.location.href="https://github.com/apache/isis/edit/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_isis-addons.adoc""><i class="fa fa-pencil-square-o"></i> Edit</button>
+ <button type="button" class="btn btn-xs btn-default" onclick="window.location.href="https://github.com/apache/isis/edit/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_incode-platform.adoc""><i class="fa fa-pencil-square-o"></i> Edit</button>
<button type="button" class="btn btn-xs btn-default dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><span class="caret"></span><span class="sr-only">Toggle Dropdown</span></button>
<ul class="dropdown-menu">
- <li><a href="https://github.com/apache/isis/edit/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_isis-addons.adoc" target="_blank"><i class="fa fa-pencil-square-o fa-fw" aria-hidden="true"></i> Edit</a></li>
- <li><a href="https://github.com/apache/isis/commits/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_isis-addons.adoc" target="_blank"><i class="fa fa-clock-o fa-fw" aria-hidden="true"></i> History</a></li>
- <li><a href="https://github.com/apache/isis/raw/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_isis-addons.adoc" target="_blank"><i class="fa fa-file-text-o fa-fw" aria-hidden="true"></i> Raw</a></li>
- <li><a href="https://github.com/apache/isis/blame/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_isis-addons.adoc" target="_blank"><i class="fa fa-hand-o-right fa-fw" aria-hidden="true"></i> Blame</a></li>
+ <li><a href="https://github.com/apache/isis/edit/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_incode-platform.adoc" target="_blank"><i class="fa fa-pencil-square-o fa-fw" aria-hidden="true"></i> Edit</a></li>
+ <li><a href="https://github.com/apache/isis/commits/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_incode-platform.adoc" target="_blank"><i class="fa fa-clock-o fa-fw" aria-hidden="true"></i> History</a></li>
+ <li><a href="https://github.com/apache/isis/raw/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_incode-platform.adoc" target="_blank"><i class="fa fa-file-text-o fa-fw" aria-hidden="true"></i> Raw</a></li>
+ <li><a href="https://github.com/apache/isis/blame/master/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_incode-platform.adoc" target="_blank"><i class="fa fa-hand-o-right fa-fw" aria-hidden="true"></i> Blame</a></li>
</ul>
</div>
<div class="sectionbody">
<div class="paragraph">
- <p>The (non-ASF) <a href="http://www.isisaddons.org">Isis Addons</a> website provides a number of extensions to the Wicket viewer (leveraging the APIs described in <a href="../ugvw/ugvw.html#_ugvw_extending">Extending the Wicket viewer</a> section, later. While you are free to fork and adapt any of them to your needs, they are also intended for use "out-of-the-box".</p>
+ <p>The (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a> provides a number of extensions to the Wicket viewer (leveraging the APIs described in <a href="../ugvw/ugvw.html#_ugvw_extending">Extending the Wicket viewer</a> section, later. While you are free to fork and adapt any of them to your needs, they are also intended for use "out-of-the-box".</p>
</div>
<div class="paragraph">
<p>At the time of writing the addons available are:</p>
</div>
<div class="ulist">
<ul>
- <li> <p><a href="http://github.com/isisaddons/isis-wicket-excel">Excel</a> component - to export a collection of domain objects as an Excel spreadsheet</p>
+ <li> <p>Excel Wicket component - to export a collection of domain objects as an Excel spreadsheet</p>
<div class="ulist">
<ul>
- <li> <p>see also the related <a href="http://github.com/isisaddons/isis-module-excel">Excel module</a> which can be used to read/import a spreadsheet as an collection of view models or entities</p> </li>
+ <li> <p>see also the related Excel library module which can be used to read/import a spreadsheet as an collection of view models or entities</p> </li>
</ul>
</div> </li>
- <li> <p><a href="http://github.com/isisaddons/isis-wicket-fullcalendar2">Fullcalendar2</a> component - to view a collection of domain objects (with a date) on a full-page calendar</p> </li>
- <li> <p><a href="http://github.com/isisaddons/isis-wicket-gmap3">Gmap3</a> component - to view a collection of domain objects with a location on a google map</p> </li>
- <li> <p><a href="http://github.com/isisaddons/isis-wicket-pdfjs">pdf.js</a> component - to view a Blob containing a PDF as an image</p> </li>
- <li> <p><a href="http://github.com/isisaddons/isis-wicket-summernote">summernote</a> component - to edit a string property using an RTF editor</p>
+ <li> <p>ullcalendar2 Wicket component - to view a collection of domain objects (with a date) on a full-page calendar</p> </li>
+ <li> <p>Gmap3 Wicket component - to view a collection of domain objects with a location on a google map</p> </li>
+ <li> <p>pdf.js Wicket component - to view a <code>Blob</code> containing a PDF as an image</p> </li>
+ <li> <p>Summernote Wicket component - to edit a string property using an RTF editor</p>
<div class="ulist">
<ul>
<li> <p>(not yet compatible with <code>1.15.0</code>)</p> </li>
</ul>
</div> </li>
- <li> <p><a href="http://github.com/isisaddons/isis-wicket-wickedcharts">wickedcharts</a> component - low-level integration with Highcharts charting library</p> </li>
+ <li> <p>Wickedcharts Wicket component - low-level integration with Highcharts charting library</p> </li>
</ul>
</div>
<div class="paragraph">
- <p>Check the <a href="http://www.isisaddons.org">Isis Addons</a> website for the most up-to-date list.</p>
+ <p>Check the <a href="http://platform.incode.org" target="_blank">website</a> for the most up-to-date list.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -4387,7 +4384,7 @@ public WebRequest newWebRequest(HttpServletRequest servletRequest, String filter
<td class="icon"> <i class="fa icon-note" title="Note"></i> </td>
<td class="content">
<div class="paragraph">
- <p>Note that Isis addons, while maintained by Apache Isis committers, are not part of the ASF.</p>
+ <p>Note that the Incode Platform, while maintained by Apache Isis committers, are not part of the ASF.</p>
</div> </td>
</tr>
</tbody>