Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
ISIS-1164: pretty printing, updating TODOs, exteralized config; chang…
…ing 'Isis' to 'Apache Isis'
  • Loading branch information
danhaywood committed Jun 26, 2015
1 parent 34bca92 commit 18f75b9
Show file tree
Hide file tree
Showing 18 changed files with 286 additions and 286 deletions.
4 changes: 2 additions & 2 deletions content/applying-patches.html
Expand Up @@ -497,11 +497,11 @@ <h2 id="_diff_files">Diff files</h2>
<div class="paragraph">
<p>If a diff file has been provided, then it can easily be applied using eGit&#8217;s wizards (Eclipse&#8217;s Git integration)…</p>
</div>
<div class="admonitionblock important">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
TODO - this stuff needs fleshing out &#8230;&#8203;
Expand Down
2 changes: 1 addition & 1 deletion content/books.html
Expand Up @@ -487,7 +487,7 @@ <h1>
<p><br/><br/></p>
</div>
<div class="paragraph">
<p>Although it has evolved since, the <em>Apache Isis</em> framework started out as an open source implementation of the naked objects pattern. Indeed, the generic user interfaces provided by Isis <a href="../../components/viewers/wicket/about.html">Wicket</a> viewer and the <a href="../../components/viewers/restfulobjects/about.html">Restful Objects</a> viewer are both "just" naked objects implementations; the first serves up a default generic representation of domain objects for human interaction, the latter serving up representation intended for machine consumption rather than human beings.</p>
<p>Although it has evolved since, the <em>Apache Isis</em> framework started out as an open source implementation of the naked objects pattern. Indeed, the generic user interfaces provided by Apache Isis <a href="../../components/viewers/wicket/about.html">Wicket</a> viewer and the <a href="../../components/viewers/restfulobjects/about.html">Restful Objects</a> viewer are both "just" naked objects implementations; the first serves up a default generic representation of domain objects for human interaction, the latter serving up representation intended for machine consumption rather than human beings.</p>
</div>
<div class="paragraph">
<p>If the idea of naked objects is of interest, then there are a couple of books on the topic that you might want to read.</p>
Expand Down
8 changes: 4 additions & 4 deletions content/common-use-cases.html
Expand Up @@ -506,13 +506,13 @@ <h2 id="_prototyping">Prototyping</h2>
<h2 id="_deploy_as_an_human_usable_webapp">Deploy as an human-usable webapp</h2>
<div class="sectionbody">
<div class="paragraph">
<p>One of the original motivations for Isis itself was to be able automatically generate a user interface for a domain object model.</p>
<p>One of the original motivations for Apache Isis itself was to be able automatically generate a user interface for a domain object model.</p>
</div>
<div class="paragraph">
<p>Isis' has a pluggable architecture allowing different user interface technologies. The principal implementation (as configured by the <a href="./simple-archetype.html">simple archetype</a>) is the <a href="guides/ug.html#_ug_wicket-viewer">Wicket viewer</a>. This provides an appealing default user interface, with the ability to customize the user interface by writing new <a href="http://wicket.apache.org">Apache Wicket</a> components. Some third-party components can be found in the (non-ASF) <a href="http://isisaddons.org">Isis Addons</a> (non-ASF) project, integrating the Wicket viewer with <a href="https://github.com/isisaddons/isis-wicket-gmap3">google maps</a>, <a href="https://github.com/isisaddons/isis-wicket-fullcalendar2">a full calendar</a> and a <a href="https://github.com/isisaddons/isis-wicket-excel">export to Excel</a> component.</p>
</div>
<div class="paragraph">
<p>Deploying on Isis means that the framework also manages object persistence. Again this is pluggable, but the principal implementation is the JDO/DataNucleus objectstore. Because JDO supports both SQL and NoSQL databases, you can then deploy on a variety of platforms, including the <a href="https://developers.google.com/appengine/">Google App Engine (GAE)</a> and <a href="http://neo4j.com/">Neo4J</a>.</p>
<p>Deploying on Apache Isis means that the framework also manages object persistence. Again this is pluggable, but the principal implementation is the JDO/DataNucleus objectstore. Because JDO supports both SQL and NoSQL databases, you can then deploy on a variety of platforms, including the <a href="https://developers.google.com/appengine/">Google App Engine (GAE)</a> and <a href="http://neo4j.com/">Neo4J</a>.</p>
</div>
</div>
</div>
Expand All @@ -523,7 +523,7 @@ <h2 id="_deploy_as_a_restful_web_service">Deploy as a RESTful web service</h2>
<p>REST (Representation State Transfer) is an architectural style for building highly scalable distributed systems, using the same principles as the World Wide Web. Many commercial web APIs (twitter, facebook, Amazon) are implemented as either pure REST APIs or some approximation therein.</p>
</div>
<div class="paragraph">
<p>The <a href="http://restfulobjects.org">Restful Objects specification</a> defines a means by a domain object model can be exposed as RESTful resources using JSON representations over HTTP. Isis' <a href="guides/ug.html#_ug_restfulobjects_viewer">RestfulObjects viewer</a> is an implementation of that spec, making any Isis domain object automatically available via REST.</p>
<p>The <a href="http://restfulobjects.org">Restful Objects specification</a> defines a means by a domain object model can be exposed as RESTful resources using JSON representations over HTTP. Isis' <a href="guides/ug.html#_ug_restfulobjects_viewer">RestfulObjects viewer</a> is an implementation of that spec, making any Apache Isis domain object automatically available via REST.</p>
</div>
<div class="paragraph">
<p>There are two main use cases for deploying Isis as a RESTful web service are:</p>
Expand Down Expand Up @@ -557,7 +557,7 @@ <h2 id="_deploy_as_a_restful_web_service">Deploy as a RESTful web service</h2>
<h2 id="_deploy_on_your_own_platform">Deploy on your own platform</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The programming model defined by Isis deliberately minimizes the dependencies on the rest of the framework. In fact, the only hard dependency that the domain model classes have on Isis is through the <code>org.apache.isis.applib</code> classes, mostly to pick up annotations such as <code>@Disabled</code>. The idea is to make it easy to be able to write take a domain object prototyped and/or tested using Isis, but to deploy on some other framework&#8217;s runtime.</p>
<p>The programming model defined by Apache Isis deliberately minimizes the dependencies on the rest of the framework. In fact, the only hard dependency that the domain model classes have on Isis is through the <code>org.apache.isis.applib</code> classes, mostly to pick up annotations such as <code>@Disabled</code>. The idea is to make it easy to be able to write take a domain object prototyped and/or tested using Isis, but to deploy on some other framework&#8217;s runtime.</p>
</div>
<div class="paragraph">
<p>If you are interested in taking this approach, note that there is one important interface that must be implemented by your own framework, namely <code>DomainObjectContainer</code>. This interface represents the one-and-only "touchpoint" between the domain objects and the runtime. If you inspect the methods then you&#8217;ll see it covers such concerns as persistence, and of raising warnings or errors.</p>
Expand Down
4 changes: 2 additions & 2 deletions content/contributing.html
Expand Up @@ -542,7 +542,7 @@ <h2 id="_recommended_workflow_github">Recommended Workflow (github)</h2>
<p>Use github to raise a <a href="https://help.github.com/articles/using-pull-requests/">pull request</a> for your feature</p>
</li>
<li>
<p>An Isis committer will review your change, and apply it if suitable.</p>
<p>An Apache Isis committer will review your change, and apply it if suitable.</p>
</li>
</ol>
</div>
Expand Down Expand Up @@ -622,7 +622,7 @@ <h2 id="_setting_up_your_fork_clone">Setting up your fork/clone</h2>
<h2 id="_commit_messages">Commit messages</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Although with git your commits are always performed on your local repo, those commit messages become public when the patch is applied by an Isis committer. You should take time to write a meaningful commit message that helps explain what the patch refers to; if you don&#8217;t then there&#8217;s a chance that your patch may be rejected and not applied. No-one likes hard work to go to waste!</p>
<p>Although with git your commits are always performed on your local repo, those commit messages become public when the patch is applied by an Apache Isis committer. You should take time to write a meaningful commit message that helps explain what the patch refers to; if you don&#8217;t then there&#8217;s a chance that your patch may be rejected and not applied. No-one likes hard work to go to waste!</p>
</div>
<div class="paragraph">
<p>We therefore recommend that your commit messages are as follows [1]:</p>
Expand Down
2 changes: 1 addition & 1 deletion content/documentation.html
Expand Up @@ -515,7 +515,7 @@ <h1>
<p><a href="./powered-by.html">Powered by Isis</a></p>
</li>
<li>
<p><a href="./how-isis-works.html">How Isis Works</a> <span class="image"><a class="image" href="how-isis-works.html"><img src="images/tv_show-25.png" alt="tv_show-25" width="25px"></a></span></p>
<p><a href="./how-isis-works.html">How Apache Isis Works</a> <span class="image"><a class="image" href="how-isis-works.html"><img src="images/tv_show-25.png" alt="tv_show-25" width="25px"></a></span></p>
</li>
<li>
<p><a href="./common-use-cases.html">Common Use Cases</a></p>
Expand Down
2 changes: 1 addition & 1 deletion content/downloads.html
Expand Up @@ -503,7 +503,7 @@ <h2 id="_getting_started">Getting Started</h2>
<h2 id="_formal_releases">Formal Releases</h2>
<div class="sectionbody">
<div class="paragraph">
<p>If you want to build Isis from formally released source tarballs, you can download from here:</p>
<p>If you want to build Apache Isis from formally released source tarballs, you can download from here:</p>
</div>
<div class="paragraph">
<p>Core:</p>
Expand Down
4 changes: 2 additions & 2 deletions content/editor-templates.html
Expand Up @@ -487,7 +487,7 @@ <h1>
<p><br/><br/><br/></p>
</div>
<div class="paragraph">
<p>We provide IDE templates (for IntelliJ and Eclipse) for writing Isis domain objects, and also for unit tests (JUnit and JMock).</p>
<p>We provide IDE templates (for IntelliJ and Eclipse) for writing Apache Isis domain objects, and also for unit tests (JUnit and JMock).</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -558,7 +558,7 @@ <h2 id="_download">Download</h2>
</tbody>
</table>
<div class="paragraph">
<p>The most commonly used Isis domain objects templates are also listed on the <a href="./cheat-sheet.html">Isis cheat sheet</a>.</p>
<p>The most commonly used Apache Isis domain objects templates are also listed on the <a href="./cheat-sheet.html">Isis cheat sheet</a>.</p>
</div>
</div>
</div>
Expand Down
12 changes: 6 additions & 6 deletions content/guides/dg.html
Expand Up @@ -494,11 +494,11 @@ <h1>
<div class="sect1">
<h2 id="_dg_cmd-line">Developing from the Command Line</h2>
<div class="sectionbody">
<div class="admonitionblock important">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
TODO
Expand Down Expand Up @@ -1156,11 +1156,11 @@ <h3 id="_advanced">Advanced</h3>
</div>
<div class="sect3">
<h4 id="_setting_up_dynamic_reloading">Setting up Dynamic Reloading</h4>
<div class="admonitionblock important">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
TODO - see <a href="http://blog.jetbrains.com/idea/2013/07/get-true-hot-swap-in-java-with-dcevm-and-intellij-idea/">IntelliJ blog</a>.
Expand All @@ -1171,11 +1171,11 @@ <h4 id="_setting_up_dynamic_reloading">Setting up Dynamic Reloading</h4>
</div>
<div class="sect3">
<h4 id="_setting_up_jrebel">Setting up JRebel</h4>
<div class="admonitionblock important">
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
TODO
Expand Down

0 comments on commit 18f75b9

Please sign in to comment.