You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by bu...@apache.org on 2012/12/21 11:57:20 UTC
svn commit: r843345 - in /websites/staging/isis/trunk: cgi-bin/ content/
content/contributors/ content/core/ content/getting-started/
Author: buildbot
Date: Fri Dec 21 10:57:19 2012
New Revision: 843345
Log:
Staging update by buildbot for isis
Added:
websites/staging/isis/trunk/content/contributors/updating-the-applib-docs.html
Removed:
websites/staging/isis/trunk/content/contributors/recreating-the-applib-docs.html
Modified:
websites/staging/isis/trunk/cgi-bin/ (props changed)
websites/staging/isis/trunk/content/ (props changed)
websites/staging/isis/trunk/content/contributors/about.html
websites/staging/isis/trunk/content/core/applib.html
websites/staging/isis/trunk/content/documentation.html
websites/staging/isis/trunk/content/getting-started/quickstart-archetype.html
Propchange: websites/staging/isis/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Dec 21 10:57:19 2012
@@ -1 +1 @@
-1424855
+1424861
Propchange: websites/staging/isis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Dec 21 10:57:19 2012
@@ -1 +1 @@
-1424855
+1424861
Modified: websites/staging/isis/trunk/content/contributors/about.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/about.html (original)
+++ websites/staging/isis/trunk/content/contributors/about.html Fri Dec 21 10:57:19 2012
@@ -190,7 +190,8 @@
<li><a href="contributing.html">Contributing</a></li>
<li><a href="development-environment.html">Development Environment</a></li>
<li><a href="building-isis.html">Building Isis</a></li>
-<li><a href="contributors/recreating-an-archetype.html">Recreating an archetype</a></li>
+<li><a href="recreating-an-archetype.html">Recreating an archetype</a></li>
+<li><a href="updating-the-applib-docs.html">Updating the applib docs</a></li>
<li><a href="git-policy.html">Git Policy</a></li>
<li><a href="git-cookbook.html">Git Cookbook</a></li>
<li><a href="versioning-policy.html">Versioning Policy</a></li>
Added: websites/staging/isis/trunk/content/contributors/updating-the-applib-docs.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/updating-the-applib-docs.html (added)
+++ websites/staging/isis/trunk/content/contributors/updating-the-applib-docs.html Fri Dec 21 10:57:19 2012
@@ -0,0 +1,296 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+
+ <meta charset="utf-8">
+ <title>Recreating the Applib Documentation
</title>
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le styles -->
+ <link href="./../bootstrap.css" rel="stylesheet">
+ <link href="./../prettify.css" rel="stylesheet">
+ <link href="./../bootstrap-mods.css" rel="stylesheet">
+
+ <style type="text/css">
+ body {
+ padding-top: 60px;
+ }
+ .sprite {
+ display: inline-block;
+ height: 20px;
+ margin: 0 auto 4px;
+ outline: medium none;
+ text-indent: -999em;
+ width: 24px;
+ background-image: url('./../images/sprites.png');
+ background-repeat: no-repeat;
+ overflow: hidden;
+ cursor: pointer;
+ }
+ .edit-page {
+ display: inline-block;
+ height: 20px;
+ margin: 0 auto 4px;
+ outline: medium none;
+ text-indent: -999em;
+ width: 24px;
+ background-image: url('./../images/edit.png');
+ background-repeat: no-repeat;
+ overflow: hidden;
+ cursor: pointer;
+ }
+ .fb-share {
+ background-position: 0px -40px;
+ }
+ .gp-share {
+ background-position: 0px 0px;
+ }
+ .tw-share {
+ background-position: 0px -80px;
+ }
+ .markdown-content {
+ min-height: 500px;
+ }
+ .book-image img {
+ border: 1px;
+ border-style: solid;
+ }
+ .stub,.note {
+ position: relative;
+ padding: 7px 15px;
+ margin-bottom: 18px;
+ color: #404040;
+ background-color: #eedc94;
+ background-repeat: repeat-x;
+ background-image: -khtml-gradient(linear, left top, left bottom, from(#fceec1), to(#eedc94));
+ background-image: -moz-linear-gradient(top, #fceec1, #eedc94);
+ background-image: -ms-linear-gradient(top, #fceec1, #eedc94);
+ background-image: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #fceec1), color-stop(100%, #eedc94));
+ background-image: -webkit-linear-gradient(top, #fceec1, #eedc94);
+ background-image: -o-linear-gradient(top, #fceec1, #eedc94);
+ background-image: linear-gradient(top, #fceec1, #eedc94);
+ filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fceec1', endColorstr='#eedc94', GradientType=0);
+ text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
+ border-color: #eedc94 #eedc94 #e4c652;
+ border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
+ text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+ border-width: 1px;
+ border-style: solid;
+ -webkit-border-radius: 4px;
+ -moz-border-radius: 4px;
+ border-radius: 4px;
+ -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.25);
+ -moz-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.25);
+ box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.25);
+ }
+ </style>
+ <script type="text/javascript">
+ function fbshare () {
+ window.open(
+ "http://www.facebook.com/sharer/sharer.php?u="+document.URL,
+ 'Share on Facebook',
+ 'width=640,height=426');
+ };
+ function gpshare () {
+ window.open(
+ "https://plus.google.com/share?url="+document.URL,
+ 'Share on Google+',
+ 'width=584,height=385');
+ };
+ function twshare () {
+ window.open(
+ "https://twitter.com/intent/tweet?url="+document.URL+"&text=Recreating the Applib Documentation
",
+ 'Share on Twitter',
+ 'width=800,height=526');
+ };
+ </script>
+
+ <!-- Le fav and touch icons -->
+ <link rel="shortcut icon" href="./../images/favicon.ico">
+ <link rel="apple-touch-icon" href="./../images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="./../images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="./../images/apple-touch-icon-114x114.png">
+
+ <script src="./../javascript/prettify.js" type="text/javascript"></script>
+ <script src="./../javascript/jquery-latest.js"></script>
+ <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
+ <script src="./../javascript/common.js"></script>
+ <script src="./../javascript/prettyprint.js"></script>
+
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-2717626-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+
+
+ </head>
+
+ <body>
+
+ <div class="topbar">
+ <div class="fill">
+ <div class="container">
+ <a class="brand" href="./../index.html">Apache Isis</a>
+ <ul class="nav">
+ <li><a href="./../index.html">Home</a></li>
+ <li><a href="./../download.html">Download</a></li>
+ <li><a href="./../documentation.html">Documentation</a></li>
+ <li><a href="./../support.html">Support</a></li>
+ </ul>
+
+ <!-- Google CSE Search Box Begins -->
+ <div style="float: right; position: relative; ">
+ <form action="http://www.google.com/cse" id="cse-search-box" _lpchecked="1">
+ <div>
+ <input type="hidden" name="cx" value="001500763902520246267:purt3m54z98">
+ <input type="hidden" name="ie" value="UTF-8">
+ <input type="text" name="q" size="31" style="border: 1px solid rgb(126, 157, 185); padding: 2px; background-color: rgb(255, 255, 255); background-position: 0% 50%; background-repeat: no-repeat no-repeat;">
+ <input type="submit" name="sa" value="Search">
+ </div>
+ <input name="siteurl" type="hidden" value="incubator.apache.org/isis/">
+ <input name="ref" type="hidden" value="">
+ <input name="ss" type="hidden" value="677j458329j2">
+ </form>
+ </div>
+ <!-- Google CSE Search Box Ends -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div class="markdown-content">
+
+
+<div class="page-header">
+<p><a href="./../documentation.html">Docs</a> » <a href="./../contributors/about.html">Contributors</a></p>
+<h1>Recreating the Applib Documentation
+
+</h1>
+</div>
+
+<h3>Prerequisites</h3>
+
+<p>Apache Isis currently use the JIMI jar to generate documentation. Previously this file was hosted at Sun's <a href="http://java.sun.com/products/jimi/">Jimi page</a>, however since Oracle's acquisition the download is somewhat more difficult to locate.</p>
+
+<p>Once you have downloaded the file (<code>jimi_1.0.jar</code>), unzip it and locate in turn the <code>JimiProClasses.zip</code> file. This is the JAR that needs to be installed. Make a note of its location.</p>
+
+<p>To install into your local Maven repository, use:</p>
+
+<pre>
+mvn install:install-file \
+ -D groupId=com.java \
+ -D artifactId=jimi \
+ -D version=1.0 \
+ -D packaging=jar \
+ -D file=/path/to/JimiProClasses.zip
+</pre>
+
+<h3>Generate documentation</h3>
+
+<p>In the following instructions:</p>
+
+<ul>
+<li><code>$SITE</code> represents the directory where the <a href="https://svn.apache.org/repos/asf/isis/site/trunk">site's <code>trunk</code> directory</a> has been checked out to.</li>
+<li><code>$CODE</code> represents the directory where the <a href="https://git.apache.org/repos/asf/isis.git">Isis codebase</a> has been cloned to.</li>
+</ul>
+
+<p>To generate the documentation:</p>
+
+<pre>
+cd $CODE/core/applib
+mvn clean docbkx:generate-html docbkx:generate-pdf
+</pre>
+
+<p>Copy over to the site:</p>
+
+<pre>
+cp target/docbkx/html/guide/isis-applib.html $SITE/content/core/guides/.
+cp target/docbkx/pdf/isis-applib.pdf $SITE/content/core/guides/.
+</pre>
+
+<!--
+
+
+d8b90771e3cb31963a157bcf2eed5409
+
+
+
+Check any new files into the site:
+
+
+a1f92171323b943e871ee434222ede82
+
+
+
+
+Remove files that haven't been updated
+
+
+
+31265a28a518ed4f2947d9da3f22d250
+
+
+
+
+
+927005d31e51989f5f21c97e276261b5
+
+
+-->
+
+
+
+ </div>
+
+ <div id="edit" class="modal hide fade in" style="display: none; ">
+ <div class="modal-header">
+ <a class="close" data-dismiss="modal">x</a>
+
+ <h3>Thank you for contributing to the documention!</h3>
+ </div>
+ <div class="modal-body">
+ <h4>Any help with the documentation is greatly appreciated.</h4>
+ <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p>
+ <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small>
+ <!--[if gt IE 6]>
+ <h4>Internet Explorer Users</h4>
+ <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p>
+ <![endif]-->
+
+ </div>
+ <div class="modal-footer">
+ Do you have an Apache ID?
+ <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a>
+ <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a>
+ </div>
+ </div>
+ <script src="./../javascript/bootstrap-modal.js"></script>
+
+ <footer>
+ <p>
+ Copyright © 2012 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
+ <br/>
+ Apache and the Apache feather logo are trademarks of The Apache Software Foundation.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Modified: websites/staging/isis/trunk/content/core/applib.html
==============================================================================
--- websites/staging/isis/trunk/content/core/applib.html (original)
+++ websites/staging/isis/trunk/content/core/applib.html Fri Dec 21 10:57:19 2012
@@ -188,9 +188,7 @@
<p>These conventions are together known as the Apache Isis Programming Model. The Apache Isis Application Library - or AppLib - constitutes those elements of the programming model that are declarative (such as annotations and interfaces). It also contains the <code>DomainObjectContainer</code> interface, which is normally injected into your domain objects and represents the only point of coupling from your domain into the framework.</p>
-<p>See the applib programming guide (<a href="http://incubator.apache.org/isis/applib/docbkx/html/guide/isis-applib.html">HTML</a> or <a href="http://incubator.apache.org/isis/applib/docbkx/pdf/isis-applib.pdf">PDF</a>) for further details.</p>
-
-<!-- TODO: migrate content over from incubator -->
+<p>See the applib programming guide (<a href="guides/isis-applib.html">HTML</a> or <a href="guides/isis-applib.pdf">PDF</a>) for further details.</p>
Modified: websites/staging/isis/trunk/content/documentation.html
==============================================================================
--- websites/staging/isis/trunk/content/documentation.html (original)
+++ websites/staging/isis/trunk/content/documentation.html Fri Dec 21 10:57:19 2012
@@ -201,7 +201,7 @@
<h3>Archetypes</h3>
<ul>
-<li><a href="getting-started/quickstart-archetype.html">Quickstart Archetype</a> (<code>0.2.0-incubating</code>)
+<li><a href="getting-started/quickstart-archetype.html">Quickstart Archetype</a> (<code>1.0.0-RC1</code>)
<!--</li>
<li><a href="getting-started/quickstart-archetype-wicket-restful-jdo.html">Wicket/Restful/JDO Archetype</a></li>
<li><a href="getting-started/quickstart-archetype-scimpi-nosql.html">Scimpi/NoSQL Archetype</a></li>
@@ -233,6 +233,7 @@
<li><a href="contributors/development-environment.html">Development Environment</a></li>
<li><a href="contributors/building-isis.html">Building Isis</a></li>
<li><a href="contributors/recreating-an-archetype.html">Recreating an archetype</a></li>
+<li><a href="contributors/updating-the-applib-docs.html">Updating the applib docs</a></li>
<li><a href="contributors/git-policy.html">Git Policy</a></li>
<li><a href="contributors/git-cookbook.html">Git Cookbook</a></li>
<li><a href="contributors/versioning-policy.html">Versioning Policy</a></li>
@@ -252,7 +253,7 @@
<div class="group"></li>
</ul>
-<h2>Core <a href="core/release-notes/about.html">1.0.0-RC1</a></h2>
+<h2>Core <a href="core/release-notes/about.html">1.0.0-RC2</a></h2>
<p><div class="row-even">
<div class="span-one-third"></p>
@@ -296,7 +297,7 @@
<p><div class="row-odd">
<div class="span-one-third"></p>
-<h3>Wicket <a href="components/viewers/wicket/release-notes/about.html">1.0.0-RC1</a></h3>
+<h3>Wicket <a href="components/viewers/wicket/release-notes/about.html">1.0.0-RC2</a></h3>
<ul>
<li><a href="components/viewers/wicket/about.html">About</a>
@@ -304,7 +305,7 @@
<div class="span-one-third"></li>
</ul>
-<h3>RestfulObjects <a href="components/viewers/restfulobjects/release-notes/about.html">1.0.0-RC1</a></h3>
+<h3>RestfulObjects <a href="components/viewers/restfulobjects/release-notes/about.html">1.0.0-RC2</a></h3>
<ul>
<li><a href="components/viewers/restfulobjects/about.html">About</a>
@@ -365,7 +366,7 @@
<p><div class="row-even">
<div class="span-one-third"></p>
-<h3>JDO <a href="components/objectstores/jdo/release-notes/about.html">1.0.0-RC1</a></h3>
+<h3>JDO <a href="components/objectstores/jdo/release-notes/about.html">1.0.0-RC2</a></h3>
<ul>
<li><a href="components/objectstores/jdo/about.html">About</a></li>
@@ -400,7 +401,7 @@
<p><div class="row-even">
<div class="span-one-third"></p>
-<h3>File <a href="components/security/file/release-notes/about.html">1.0.0-RC1</a></h3>
+<h3>File <a href="components/security/file/release-notes/about.html">1.0.0-RC2</a></h3>
<ul>
<li><a href="components/security/file/about.html">About</a>
Modified: websites/staging/isis/trunk/content/getting-started/quickstart-archetype.html
==============================================================================
--- websites/staging/isis/trunk/content/getting-started/quickstart-archetype.html (original)
+++ websites/staging/isis/trunk/content/getting-started/quickstart-archetype.html Fri Dec 21 10:57:19 2012
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
- <title>Quickstart Archetype (0.2.0-incubating)
</title>
+ <title>Quickstart Archetype (1.0.0)
</title>
<meta name="description" content="">
<meta name="author" content="">
@@ -105,7 +105,7 @@
};
function twshare () {
window.open(
- "https://twitter.com/intent/tweet?url="+document.URL+"&text=Quickstart Archetype (0.2.0-incubating)
",
+ "https://twitter.com/intent/tweet?url="+document.URL+"&text=Quickstart Archetype (1.0.0)
",
'Share on Twitter',
'width=800,height=526');
};
@@ -179,7 +179,7 @@
<div class="page-header">
<p><a href="./../documentation.html">Docs</a> » <a href="./../getting-started/about.html">Getting Started</a></p>
-<h1>Quickstart Archetype (0.2.0-incubating)
+<h1>Quickstart Archetype (1.0.0)
</h1>
</div>
@@ -194,9 +194,9 @@
<pre>
mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis \
- -D archetypeArtifactId=quickstart-archetype \
- -D archetypeVersion=0.2.0-incubating \
+ -D archetypeGroupId=org.apache.isis.archetype \
+ -D archetypeArtifactId=quickstart_wicket_restful_jdo-archetype \
+ -D archetypeVersion=1.0.0 \
-D groupId=com.mycompany \
-D artifactId=myapp
</pre>
@@ -231,7 +231,11 @@ mvn clean install
<h3>Running the App</h3>
-<p>Once you've built the app, you can run it in a variety of ways.</p>
+<p>The <code>quickstart_wicket_restful_jdo</code> archetype generates two WAR files, one for the <a href="../components/viewers/wicket/about.html">wicket viewer</a> and one for the <a href="../components/viewers/wicket/about.html">restfulobjects viewer</a>. You can deploy either or both. The wicket viewer WAR is built by the <code>viewer-wicket</code> module; the restful objects viewer WAR is built by the <code>viewer-restfulobjects</code> module.</p>
+
+<p>By default each run with JDO objectstore configured to use an in-memory HSQLDB connection. To share data between the webapps (or indeed to persist data between runs), you'll therefore need to reconfigure both webapps to use some other shared database connection. See the <code>persistor_datanucleus.properties</code> file for details.</p>
+
+<p>Once you've built the app (having reconfigured JDO if required), you can run either WAR in a variety of ways. </p>
<p>The first is to simply deploying the generated WAR (<code>webapp/target/myapp-webapp-1.0-SNAPSHOT.war</code>) to a servlet container.</p>
@@ -243,10 +247,10 @@ mvn jetty:run
<p>If you do this, note that the context path changes; check the console output.</p>
-<p>In addition to the standard WAR< the archetype also builds a self-hosted version of the WAR. You can therefore also simply run the WAR as a standalone app:</p>
+<p>In addition to the standard WAR< the archetype also builds a self-hosted version of the WAR. You can therefore also simply run the WAR as a standalone app; for example:</p>
<pre>
-java -jar webapp/target/myapp-webapp-1.0-SNAPSHOT-jetty-console.war
+java -jar viewer-wicket/target/myapp-viewer-wicket-1.0-SNAPSHOT-jetty-console.war
</pre>
<p>This can also be accomplished using an embedded Ant target provided in the build script:</p>
@@ -268,13 +272,12 @@ mvn antrun:run
<tr><td>myapp</td><td>The parent (aggregator) module</td></tr>
<tr><td>myapp-dom</td><td>The domain object model, consisting of <tt>ToDoItem</tt> and <tt>ToDoItems</tt> (repository) interface.</td></tr>
<tr><td>myapp-fixture</td><td>Domain object fixtures used for initializing the system when being demo'ed or for unit testing.</td></tr>
-<tr><td>myapp-objstore-dflt</td><td>Implementation of <tt>ToDoItems</tt> repository, for the default (in-memory) object store.</td></tr>
-<tr><td>myapp-webapp </td><td>Run as a webapp (from <tt>web.xml</tt>) using either the HTML viewer or the JSON (RESTful) viewer</td></tr>
-<tr><td>myapp-tests-bdd</td><td>Run domain object tests using Isis' integration with the Concordion BDD framework.</td></tr>
-<tr><td>myapp-tests-junit</td><td>Run domain object tests using Isis' custom test runner for JUnit runner</td></tr>
+<tr><td>myapp-objstore-jdo</td><td>Implementation of <tt>ToDoItems</tt> repository, using JDO objectstore.</td></tr>
+<tr><td>myapp-wicket-viewer</td><td>Run as a webapp (from <tt>web.xml</tt>) using the Wicket viewer</td></tr>
+<tr><td>myapp-wicket-restfulobjects</td><td>Run as a webapp (from <tt>web.xml</tt>) using the RestfulObjects viewer</td></tr>
</table>
-<p>The most significant omission with the generated application is that it is configured only to support the default in-memory object store. What this means is that any changes you make to objects will not be persisted between runs. If you'd like to use other viewers and object stores, ask for help on the <a href="../support.html">users mailing list</a>.</p>
+<p>If you run into issues, please don't hesitate to ask for help on the <a href="../support.html">users mailing list</a>.</p>