Author: danhaywood
Date: Mon Nov 26 16:53:07 2012
New Revision: 1413716
URL: http://svn.apache.org/viewvc?rev=1413716&view=rev
Log:
working on isis documentation page
Added:
isis/site/trunk/content/getting-started/resources/
isis/site/trunk/content/getting-started/resources/IsisCheatSheet.pdf
(with props)
isis/site/trunk/content/learning-more/books-and-articles.md
isis/site/trunk/content/learning-more/isis-reference-documentation.md
- copied unchanged from r1413632,
isis/site/trunk/content/learning-more/module-documentation.md
isis/site/trunk/content/learning-more/resources/
isis/site/trunk/content/learning-more/resources/presentations/
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-notes.pdf
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-slides.pdf
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.odp
(with props)
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.ppt
(with props)
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.pptx
(with props)
Removed:
isis/site/trunk/content/learning-more/module-documentation.md
Modified:
isis/site/trunk/content/documentation.md
isis/site/trunk/content/getting-started/cheat-sheet.md
isis/site/trunk/content/getting-started/icons.md
isis/site/trunk/content/learning-more/about.md
isis/site/trunk/content/learning-more/common-use-cases.md
Modified: isis/site/trunk/content/documentation.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1413716&r1=1413715&r2=1413716&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Mon Nov 26 16:53:07 2012
@@ -16,7 +16,8 @@ Title: Documentation
- [Common Use Cases](learning-more/common-use-cases.html)
- [Presentations](learning-more/presentations.html)
- [Isis Programming Model](learning-more/isis-programming-model.html)
-- [Isis Module Documentation](learning-more/isis-module-documentation.html)
+- [Isis Reference
Documentation](learning-more/isis-reference-documentation.html)
+- [Books and Articles](learning-more/books-and-articles.html)
}
Modified: isis/site/trunk/content/getting-started/cheat-sheet.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/cheat-sheet.md?rev=1413716&r1=1413715&r2=1413716&view=diff
==============================================================================
--- isis/site/trunk/content/getting-started/cheat-sheet.md (original)
+++ isis/site/trunk/content/getting-started/cheat-sheet.md Mon Nov 26 16:53:07
2012
@@ -1,9 +1,3 @@
Title: Cheat Sheet
-{stub
-This page is a stub.
-}
-
-Isis graduated from the Apache incubator in October 2012; we are currently
setting ourselves up as a top-level project.
-
-In the meantime you can access our original incubator website
[here](http://incubator.apache.org/isis "Apache Isis (incubator website)").
+This [cheat sheet](resources/IsisCheatSheet.pdf) (pdf) summarises the main
programming conventions to follow when writing an Isis application.
\ No newline at end of file
Modified: isis/site/trunk/content/getting-started/icons.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/icons.md?rev=1413716&r1=1413715&r2=1413716&view=diff
==============================================================================
--- isis/site/trunk/content/getting-started/icons.md (original)
+++ isis/site/trunk/content/getting-started/icons.md Mon Nov 26 16:53:07 2012
@@ -1,9 +1,6 @@
Title: Icons
-{stub
-This page is a stub.
-}
+Most Isis viewers use icons to help identify domain objects in the user
interface. It's a good idea to ensure that these are styled consistently. To
get you started, we provide a number of icon sets, and reference a few others
freely available.
-Isis graduated from the Apache incubator in October 2012; we are currently
setting ourselves up as a top-level project.
+Currently our [icon sets](http://incubator.apache.org/isis/icons.html) are
available from our original incubator website. We will move this content when
that site is decommissioned.
-In the meantime you can access our original incubator website
[here](http://incubator.apache.org/isis "Apache Isis (incubator website)").
Added: isis/site/trunk/content/getting-started/resources/IsisCheatSheet.pdf
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/resources/IsisCheatSheet.pdf?rev=1413716&view=auto
==============================================================================
Binary file - no diff available.
Propchange: isis/site/trunk/content/getting-started/resources/IsisCheatSheet.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: isis/site/trunk/content/learning-more/about.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/about.md?rev=1413716&r1=1413715&r2=1413716&view=diff
==============================================================================
--- isis/site/trunk/content/learning-more/about.md (original)
+++ isis/site/trunk/content/learning-more/about.md Mon Nov 26 16:53:07 2012
@@ -3,4 +3,5 @@ Title: Learning More
- [Common Use Cases](common-use-cases.html)
- [Presentations](presentations.html)
- [Isis Programming Model](isis-programming-model.html)
-- [Isis Module Documentation](isis-module-documentation.html)
+- [Isis Reference Documentation](isis-reference-documentation.html)
+- [Books and Articles](books-and-articles.html)
Added: isis/site/trunk/content/learning-more/books-and-articles.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/books-and-articles.md?rev=1413716&view=auto
==============================================================================
--- isis/site/trunk/content/learning-more/books-and-articles.md (added)
+++ isis/site/trunk/content/learning-more/books-and-articles.md Mon Nov 26
16:53:07 2012
@@ -0,0 +1,9 @@
+Title: Books and Articles
+
+{stub
+This page is a stub.
+}
+
+Isis graduated from the Apache incubator in October 2012; we are currently
setting ourselves up as a top-level project.
+
+In the meantime you can access our original incubator website
[here](http://incubator.apache.org/isis "Apache Isis (incubator website)").
Modified: isis/site/trunk/content/learning-more/common-use-cases.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/common-use-cases.md?rev=1413716&r1=1413715&r2=1413716&view=diff
==============================================================================
--- isis/site/trunk/content/learning-more/common-use-cases.md (original)
+++ isis/site/trunk/content/learning-more/common-use-cases.md Mon Nov 26
16:53:07 2012
@@ -1,9 +1,47 @@
Title: Common Use Cases
-{stub
-This page is a stub.
-}
+### Prototyping
-Isis graduated from the Apache incubator in October 2012; we are currently
setting ourselves up as a top-level project.
+Isis is great for rapid prototyping, because all you need to write in order to
get an application up-and-running is the domain model objects.
-In the meantime you can access our original incubator website
[here](http://incubator.apache.org/isis "Apache Isis (incubator website)").
+By focussing just on the domain, you'll also find that you start to develop a
ubiquitous language - a set of terms and concepts that the entire team
(business and technologists alike) have a shared understanding.
+
+Once you've sketched out your domain model, you can then either start-over
using your preferred framework, or you might choose to take the domain model
forward into more formal specification and testing.
+
+### Deploy on your own App
+
+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 `org.apache.isis.applib` classes,
mostly to pick up annotations such as `@Disabled`. 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's runtime.
+
+If you are interested in taking this approach, note that there is one
important interface that must be implemented by your own framework, namely
`DomainObjectContainer`. This interface represents the one-and-only
"touchpoint" between the domain objects and the runtime. If you inspect the
methods then you'll see it covers such concerns as persistence, and of raising
warnings or errors.
+
+Isis' own runtime injects an (implementation of this) interface into each and
every domain object. You will likely need to do something similar within your
own framework, (or come up with an equivalent mechanism, eg Service Locator
pattern).
+
+### Deploy on Isis as a auto-generated Webapp
+
+One of the original motivations for Isis itself was to be able automatically
generate a user interface for a domain object model.
+
+Isis provides two alternative user interface webapps:
+
+- the [Wicket viewer](../viewers/wicket/about.html) provides an appealing
default user interface, with the ability to customize the user interface by
writing new [Apache Wicket](http://wicket.apache.org) components
+
+- the [Scimpi viewer](../viewers/scimpi/about.html) provides a JSF-like taglib
approach for building web pages. All domain objects have a default
representation, but can be customized on a per-type basis.
+
+Deploying on Isis means that the framework also manages object persistence.
Several object stores are provided, the main alternatives are the
[JDO](../objectstores/jdo/about.html) objectstore and the
[NoSQL](../objectstores/nosql/about.html) objectstore.
+
+### Deploy on Isis as a RESTful web service
+
+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.
+
+The [Restful Objects specification](http://restfulobjects.org) defines a means
by a domain object model can be exposed as RESTful resources using JSON
representations over HTTP. Isis' [RestfulObjects
viewer](../viewers/resstfulobjects/about.html) is an implementation of that
spec, making any Isis domain object automatically available via REST.
+
+There are two main use cases for deploying Isis as a RESTful web service are:
+
+- to allow a custom UI to be built against the RESTful API
+
+ For example, using Javascript/JQuery, or an RIA technology such as Flex,
JavaFX, Silverlight
+
+- to enable integration between systems
+
+ REST is designed to be machine-readable, and so is an excellent choice for
synchronous data interchange scenarios.
+
+As for the auto-generated webapps, the framework manages object persistence,
either the [JDO](../objectstores/jdo/about.html) objectstore and the
[NoSQL](../objectstores/nosql/about.html) objectstore. It is also perfectly
possible to deploy the RESTful API alongside an auto-generated webapp; both
work from the same domain object model.
\ No newline at end of file
Added:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-notes.pdf
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-notes.pdf?rev=1413716&view=auto
==============================================================================
Files
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-notes.pdf
(added) and
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-notes.pdf
Mon Nov 26 16:53:07 2012 differ
Added:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-slides.pdf
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-slides.pdf?rev=1413716&view=auto
==============================================================================
Files
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-slides.pdf
(added) and
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis-slides.pdf
Mon Nov 26 16:53:07 2012 differ
Added:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.odp
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.odp?rev=1413716&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.odp
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.ppt
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.ppt?rev=1413716&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.ppt
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.pptx
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.pptx?rev=1413716&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
isis/site/trunk/content/learning-more/resources/presentations/IntroducingApacheIsis.pptx
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
