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/04/16 09:53:33 UTC
[1/3] isis git commit: ISIS-1133: fixing bad includes
Repository: isis
Updated Branches:
refs/heads/master a6ad2f582 -> 9ccb95ab5
ISIS-1133: fixing bad includes
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/35acd7f3
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/35acd7f3
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/35acd7f3
Branch: refs/heads/master
Commit: 35acd7f39f567f520f90c451715fdf58d9357a52
Parents: a6ad2f5
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Wed Apr 15 22:55:56 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Wed Apr 15 22:55:56 2015 +0100
----------------------------------------------------------------------
adocs/documentation/README.md | 25 ++++++++++-----
adocs/documentation/pom.xml | 2 +-
.../src/main/asciidoc/documentation.adoc | 32 --------------------
...ps-n-tricks-overrriding-jdo-annotations.adoc | 5 ---
.../asciidoc/user-guide/user-guide-how-tos.adoc | 11 ++++---
.../main/asciidoc/user-guide/user-guide.adoc | 10 +++---
adocs/pom.xml | 8 ++---
7 files changed, 33 insertions(+), 60 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/documentation/README.md
----------------------------------------------------------------------
diff --git a/adocs/documentation/README.md b/adocs/documentation/README.md
index c5a524e..1233a23 100644
--- a/adocs/documentation/README.md
+++ b/adocs/documentation/README.md
@@ -27,11 +27,9 @@ License
Apache Isis is licensed under ALv2.
See the LICENSE file for the full license text.
-Publish procedure
+One time configuration
-----------------
-To publish the documentation at [Isis Site](http://isis.apache.org/) you have do the following steps:
-
Put the following information in your ~/.m2/settings.xml file
<server>
@@ -40,12 +38,23 @@ Put the following information in your ~/.m2/settings.xml file
<password><YOUR_PASSWORD></password>
</server>
-To publish to [staging area](http://isis.apache.org/staging/documentation), run:
- mvn clean site-deploy
+Publish procedure
+-----------------
+
+To publish the documentation at [Isis Site](http://isis.apache.org/) you have do the following steps:
+
+To publish to [staging server](http://isis.staging.apache.org/docs), run:
+
+ mvn clean site-deploy
-To publish to [production area](http://isis.apache.org/documentation), run:
+Then log in to <https://cms.apache.org/isis/publish> and click on the `Submit` button.
+
+
+Preview procedure
+-----------------
+Note that it is also possible to push to a ["preview" area](http://isis.staging.apache.org/preview/docs) on the staging server;
+in general you can skip this unless you want to double-check your edits first:
- mvn clean site-deploy -Pproduction
+ mvn clean site-deploy -Ppreview
-After log in to <https://cms.apache.org/isis/publish> and click on the `Submit` button.
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/documentation/pom.xml
----------------------------------------------------------------------
diff --git a/adocs/documentation/pom.xml b/adocs/documentation/pom.xml
index 9a56dcf..ed244b9 100644
--- a/adocs/documentation/pom.xml
+++ b/adocs/documentation/pom.xml
@@ -37,7 +37,7 @@
<properties>
<svn.scmPubUrl>https://svn.apache.org/repos/asf/isis/site/trunk/content/docs/</svn.scmPubUrl>
- <svn.scmPubUrlStaging>https://svn.apache.org/repos/asf/isis/site/trunk/content/staging/docs/</svn.scmPubUrlStaging>
+ <svn.scmPubUrlPreview>https://svn.apache.org/repos/asf/isis/site/trunk/content/preview/docs/</svn.scmPubUrlPreview>
</properties>
<build>
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/documentation/src/main/asciidoc/documentation.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/documentation.adoc b/adocs/documentation/src/main/asciidoc/documentation.adoc
deleted file mode 100644
index e6362c1..0000000
--- a/adocs/documentation/src/main/asciidoc/documentation.adoc
+++ /dev/null
@@ -1,32 +0,0 @@
-= Documentation
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-:toc: right
-:numbered:
-
-ifdef::env-github[]
-[TIP]
-----
-You are browsing this file on Github.
-
-For the links below, replace the `.html` with `.adoc` to find the original source (otherwise they will 404).
-----
-endif::[]
-
-Finding your way around:
-
-* Introducing Isis
-** link:introducing-apache-isis/isis-in-pictures/isis-in-pictures.html[Isis in Pictures]
-** link:introducing-apache-isis/common-use-cases/common-use-cases.html[Common Use Cases]
-* Getting Started
-** link:getting-started/archetype/simpleapp-archetype.html[SimpleApp Archetype]
-** Development Environments
-*** link:getting-started/development-environment/intellij-idea/intellij-idea.html[Intellij IDEA]
-*** link:getting-started/development-environment/eclipse/eclipse.html[Eclipse]
-*** link:getting-started/development-environment/cmd-line/cmd-line.html[(Maven) Command Line]
-* User Guide
-** link:user-guide/user-guide.html[User Guide]
-* Release Notes
-** link:release-notes/release-notes.html[Release Notes]
-
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overrriding-jdo-annotations.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overrriding-jdo-annotations.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overrriding-jdo-annotations.adoc
deleted file mode 100644
index c9dafcb..0000000
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overrriding-jdo-annotations.adoc
+++ /dev/null
@@ -1,5 +0,0 @@
-== How Tos: Tips n Tricks: Overriding JDO Annotations
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
index d86e777..a56b09d 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
@@ -58,9 +58,10 @@ include::user-guide-how-tos-drop-downs-and-defaults.adoc[leveloffset=+1]
include::user-guide-how-tos-triggering-events.adoc[leveloffset=+1]
-## Idioms and Patterns
-include::user-guide-how-tos-patterns.adoc[leveloffset=+1]
+## Tips n Tricks
+
+include::user-guide-how-tos-tips-n-tricks.adoc[leveloffset=+1]
@@ -69,24 +70,24 @@ include::user-guide-how-tos-patterns.adoc[leveloffset=+1]
include::user-guide-how-tos-error-handling.adoc[leveloffset=+1]
+
## i18n
include::user-guide-how-tos-i18n.adoc[leveloffset=+1]
+
## Multi-tenancy
include::user-guide-how-tos-multi-tenancy.adoc[leveloffset=+1]
+
## Persistence Lifecycle
include::user-guide-how-tos-persistence-lifecycle.adoc[leveloffset=+1]
-## Programming Model
-
-include::user-guide-how-tos-programming-model.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
index 2ad8188..89865a3 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
@@ -11,7 +11,7 @@ include::user-guide-core-concepts.adoc[leveloffset=+1]
## How-tos
-include::user-guide-howtos.adoc[leveloffset=+1]
+include::user-guide-how-tos.adoc[leveloffset=+1]
## Reference
@@ -36,7 +36,7 @@ include::user-guide-restful-viewer.adoc[leveloffset=+1]
## Configuration and Deployment
-include::user-guide-config.adoc[leveloffset=+1]
+include::user-guide-config-and-deployment.adoc[leveloffset=+1]
## Isis Addons (Modules)
@@ -46,7 +46,7 @@ include::user-guide-isis-addons.adoc[leveloffset=+1]
## Integrating with other Systems
-include::user-guide-integrating.adoc[leveloffset=+1]
+include::user-guide-integrating-with-other-systems.adoc[leveloffset=+1]
## Extending
@@ -54,7 +54,7 @@ include::user-guide-integrating.adoc[leveloffset=+1]
include::user-guide-extending.adoc[leveloffset=+1]
-## Trouble Shooting
+## Troubleshooting
-include::user-guide-trouble-shooting.adoc[leveloffset=+1]
+include::user-guide-troubleshooting.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/35acd7f3/adocs/pom.xml
----------------------------------------------------------------------
diff --git a/adocs/pom.xml b/adocs/pom.xml
index 7ba0943..bf29d3a 100644
--- a/adocs/pom.xml
+++ b/adocs/pom.xml
@@ -28,6 +28,7 @@
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
<version>14</version>
+ <relativePath/>
</parent>
<groupId>org.apache.isis.docs</groupId>
@@ -108,7 +109,7 @@
<version>1.1</version>
<configuration>
<content>${project.reporting.outputDirectory}</content>
- <pubScmUrl>scm:svn:${svn.scmPubUrlStaging}</pubScmUrl>
+ <pubScmUrl>scm:svn:${svn.scmPubUrl}</pubScmUrl>
<tryUpdate>true</tryUpdate>
<skipDeletedFiles>true</skipDeletedFiles>
<checkoutDirectory>${svn.scmPubCheckoutDirectory}</checkoutDirectory>
@@ -140,8 +141,7 @@
<profiles>
<profile>
- <!-- Profile used to publish documentation and site to production URL -->
- <id>production</id>
+ <id>preview</id>
<build>
<pluginManagement>
<plugins>
@@ -150,7 +150,7 @@
<artifactId>maven-scm-publish-plugin</artifactId>
<version>1.1</version>
<configuration>
- <pubScmUrl>scm:svn:${svn.scmPubUrl}</pubScmUrl>
+ <pubScmUrl>scm:svn:${svn.scmPubUrlPreview}</pubScmUrl>
</configuration>
</plugin>
</plugins>
[2/3] isis git commit: ISIS-1133: updates to documentation.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
index 9d7d33b..f94a77a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference.adoc
@@ -1,31 +1,21 @@
-= User Guide: Reference
+= Reference
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
-
-## Recognized Methods
+IMPORTANT: TODO
include::user-guide-reference-recognized-methods.adoc[leveloffset=+1]
-## Recognized Annotations
-
include::user-guide-reference-recognized-annotations.adoc[leveloffset=+1]
-## Domain Services
-
include::user-guide-reference-domain-services.adoc[leveloffset=+1]
-## Value Types
-
-include::user-guide-reference-domain-services.adoc[leveloffset=+1]
+include::user-guide-reference-value-types.adoc[leveloffset=+1]
## Applib Utility Classes
-include::user-guide-reference-domain-services.adoc[leveloffset=+1]
-
-## Convenience Superclasses
+include::user-guide-reference-applib-utility-classes.adoc[leveloffset=+1]
include::user-guide-reference-convenience-superclasses.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
index 01a9593..460c570 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-restful-viewer.adoc
@@ -3,7 +3,7 @@
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Features
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
index f1ab535..e4d69b5 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-testing.adoc
@@ -1,9 +1,9 @@
-= User Guide: Testing
+= Testing
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Unit Test Support
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
index c74c626..b6023b0 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting-datanucleus-logging.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Trouble Shooting: DataNucleus Logging
+= Trouble Shooting: DataNucleus Logging
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
index a7365a4..b8a8c22 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-troubleshooting.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Trouble Shooting
+= Trouble Shooting
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## JDO/DataNucleus Logging
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
index bbb16ff..73fb31c 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-wicket-viewer.adoc
@@ -3,7 +3,7 @@
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Features/end-user usage
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
index 89865a3..7857ea4 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide.adoc
@@ -4,57 +4,25 @@
:_imagesdir: images/
:numbered:
-## Core Concepts
-
include::user-guide-core-concepts.adoc[leveloffset=+1]
-
-## How-tos
-
include::user-guide-how-tos.adoc[leveloffset=+1]
-
-## Reference
-
include::user-guide-reference.adoc[leveloffset=+1]
-
-## Testing
-
include::user-guide-testing.adoc[leveloffset=+1]
-
-## Wicket Viewer
-
include::user-guide-wicket-viewer.adoc[leveloffset=+1]
-
-## Restful Objects Viewer
-
include::user-guide-restful-viewer.adoc[leveloffset=+1]
-
-## Configuration and Deployment
-
include::user-guide-config-and-deployment.adoc[leveloffset=+1]
-
-## Isis Addons (Modules)
-
include::user-guide-isis-addons.adoc[leveloffset=+1]
-
-## Integrating with other Systems
-
include::user-guide-integrating-with-other-systems.adoc[leveloffset=+1]
-
-## Extending
-
include::user-guide-extending.adoc[leveloffset=+1]
-
-## Troubleshooting
-
include::user-guide-troubleshooting.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/template/document.html.erb
----------------------------------------------------------------------
diff --git a/adocs/template/document.html.erb b/adocs/template/document.html.erb
index 8c28612..7f1201f 100644
--- a/adocs/template/document.html.erb
+++ b/adocs/template/document.html.erb
@@ -30,72 +30,37 @@
<meta http-equiv="pragma" content="no-cache" />
<meta http-equiv="expires" content="-1" />
-
- <link rel="stylesheet" href="<%= (attr :_basedir) %>css/foundation/5.5.1/foundation.css"/>
+ <link href="<%= (attr :_basedir) %>css/foundation/5.5.1/foundation.css" rel="stylesheet" />
<script src="<%= (attr :_basedir) %>js/foundation/5.5.1/vendor/modernizr.js"></script>
-
- <link href="<%= (attr :_basedir) %>css/asciidoctor/stylesheets/foundation-potion.css" rel="stylesheet">
-
+ <link href="<%= (attr :_basedir) %>css/asciidoctor/colony.css" rel="stylesheet">
<link href="<%= (attr :_basedir) %>css/font-awesome/4.3.0/css/font-awesome.min.css" rel="stylesheet">
+ <link href="<%= (attr :_basedir) %>css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.css" rel="stylesheet" />
+ <!--[if lt IE 9]>
+ <link href="<%= (attr :_basedir) %>css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.ie.css" rel="stylesheet" />
+ <![endif]-->
+
<style type="text/css">
- #forkongithub a{
- display: none;
- background:#090;
- color:#fff;
- text-decoration:none;
- font-family:arial, sans-serif;
- text-align:center;
- font-weight:bold;
- padding:5px 40px;
- font-size:1rem;
- line-height:2rem;
- position:relative;
- transition:0.5s;
- }
- #forkongithub a:hover{
- background:#0D0;
- color:#fff;
- }
- #forkongithub a::before,
- #forkongithub a::after{
- content:"";width:100%;
- display:block;
- position:fixed;
- top:1px;
- left:0;
- height:1px;
- background:#fff;
- z-index: 9999;
- }
- #forkongithub a::after{
- bottom:1px;
- top:auto;
- }
- @media screen and (min-width:768px){
- #forkongithub{
- position:fixed;
- display:block;
- top:0;
- right:0;
- width:250px;
- overflow:hidden;
- height:250px;
- z-index: 9999;
- }
- #forkongithub a{
- display:inherit;
- width:250px;
- position:fixed;
- font-size:small;
- top:40px;
- right:-60px;
- transform:rotate(45deg);
- -webkit-transform:rotate(45deg);
- -ms-transform:rotate(45deg);
- box-shadow:4px 4px 10px rgba(0,0,0,0.8);
- }
+ <%= ::Asciidoctor::Stylesheets.instance.coderay_stylesheet_data %>
+
+ pre.CodeRay code {
+ background-color: inherit;
+ border-style: none;
}
+ <style>
+
+ <style>
+ .github-fork-ribbon-wrapper.right {
+ position: fixed;
+ }
+ .github-fork-ribbon {
+ background: #090;
+ }
+ .github-fork-ribbon a:hover {
+ background:#0D0;
+ color:#fff;
+ font-size: 1.1em;
+ }
</style>
<style>
@@ -127,21 +92,30 @@
body div#toc.toc2 {
position: fixed;
left: auto;
- padding-top: 120px;
+ padding-top: 80px;
z-index: auto;
background-color: white;
border-left-color: #eee;
border-left-style: solid;
border-right: none;
+ min-height: 2000px;
+ }
+ </style>
+
+ <style>
+ footer {
+ margin-top: 1000px;
}
</style>
</head>
<body>
- <span id="forkongithub">
- <a href="https://github.com/apache/isis">Fork me on GitHub</a>
- </span>
+<div class="github-fork-ribbon-wrapper right" style="position: fixed;">
+ <div class="github-fork-ribbon">
+ <a href="https://github.com/apache/isis/fork">Fork me on GitHub</a>
+ </div>
+</div>
<div class="row">
@@ -246,8 +220,8 @@
<%= document.content %>
</div>
- <hr>
<footer>
+ <hr>
<p class="small">
Copyright © 2010~2015 The Apache Software Foundation, licensed under the Apache License, v2.0.
<br/>
@@ -259,15 +233,15 @@
<div class="large-4 medium-4 columns">
<!-- the 'hide' class is removed by Javascript -->
- <div id="toc" class="<%= attr 'toc-class', 'toc2' %> hide">
- <%= converter.convert_with_options @document, 'outline', :toclevels => 4 %>
+ <div id="toc" class="<%= attr 'toc-class', 'toc2' %>">
+ <%= converter.convert_with_options @document, 'outline', :toclevels => 6 %>
</div>
</div>
</div>
- <script src="<%= (attr :_basedir) %>js/foundation/5.5.1/vendor/jquery.js"></script>
- <script src="<%= (attr :_basedir) %>js/foundation/5.5.1/foundation.min.js"></script>
+<script src="<%= (attr :_basedir) %>js/foundation/5.5.1/vendor/jquery.js"></script>
+<script src="<%= (attr :_basedir) %>js/foundation/5.5.1/foundation.min.js"></script>
<script type="text/javascript">
@@ -312,11 +286,11 @@
var id = cur && cur.length ? cur[0].id : "";
- //console.log("id = " + id + ", lastId = " + lastId);
-
if (lastId !== id && id) {
scrollTo(id);
}
+
+ window.history.pushState({}, "", window.location.origin + window.location.pathname + "#" + id);
});
scrollTo = function(id) {
@@ -371,8 +345,6 @@
syncMenuItem = menuItems[0];
}
- $("#toc").removeClass("hide");
-
$(syncMenuItem).click();
});
[3/3] isis git commit: ISIS-1133: updates to documentation.
Posted by da...@apache.org.
ISIS-1133: updates to documentation.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/9ccb95ab
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/9ccb95ab
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/9ccb95ab
Branch: refs/heads/master
Commit: 9ccb95ab5fc9f29dcf72e9794bdf96518dd32f41
Parents: 35acd7f
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Thu Apr 16 08:53:07 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Thu Apr 16 08:53:07 2015 +0100
----------------------------------------------------------------------
.../0.1.1/gh-fork-ribbon.css | 140 ++++++++++++
.../0.1.1/gh-fork-ribbon.ie.css | 78 +++++++
.../archetype/simpleapp-archetype.adoc | 2 +-
.../cmd-line/cmd-line.adoc | 2 +-
.../eclipse/eclipse.adoc | 2 +-
.../010-run-configuration.png | Bin 0 -> 34826 bytes
.../020-datanucleus-enhancer-goal.png | Bin 0 -> 8491 bytes
.../030-running-unit-tests.png | Bin 0 -> 29351 bytes
...040-running-unit-tests-run-configuration.png | Bin 0 -> 37582 bytes
...ning-integration-tests-run-configuration.png | Bin 0 -> 40655 bytes
.../intellij-idea/intellij-idea.adoc | 229 +++++++++++++++++--
.../documentation/src/main/asciidoc/index.adoc | 30 +++
.../common-use-cases/common-use-cases.adoc | 2 +-
.../isis-in-pictures/isis-in-pictures.adoc | 2 +-
.../asciidoc/release-notes/release-notes.adoc | 2 +-
.../user-guide-config-and-deployment.adoc | 4 +-
...user-guide-core-concepts-apache-isis-vs.adoc | 4 +-
...ser-guide-core-concepts-building-blocks.adoc | 4 +-
...re-concepts-framework-provided-services.adoc | 4 +-
.../user-guide-core-concepts-principles.adoc | 11 +-
.../user-guide/user-guide-core-concepts.adoc | 18 +-
.../user-guide-extending-programming-model.adoc | 4 +-
.../user-guide/user-guide-extending.adoc | 4 +-
.../user-guide-how-tos-business-rules.adoc | 4 +-
.../user-guide-how-tos-class-structure.adoc | 6 +-
.../user-guide-how-tos-contributed-members.adoc | 4 +-
.../user-guide/user-guide-how-tos-crud.adoc | 4 +-
.../user-guide-how-tos-derived-members.adoc | 4 +-
...r-guide-how-tos-drop-downs-and-defaults.adoc | 4 +-
...user-guide-how-tos-entity-relationships.adoc | 6 +-
.../user-guide-how-tos-error-handling.adoc | 4 +-
.../user-guide/user-guide-how-tos-i18n.adoc | 4 +-
.../user-guide-how-tos-multi-tenancy.adoc | 4 +-
...ser-guide-how-tos-persistence-lifecycle.adoc | 4 +-
...ips-n-tricks-overriding-jdo-annotations.adoc | 5 +
.../user-guide-how-tos-tips-n-tricks.adoc | 4 +-
.../user-guide-how-tos-triggering-events.adoc | 4 +-
.../user-guide/user-guide-how-tos-ui-hints.adoc | 4 +-
.../asciidoc/user-guide/user-guide-how-tos.adoc | 58 +----
...er-guide-integrating-with-other-systems.adoc | 4 +-
.../user-guide/user-guide-isis-addons.adoc | 4 +-
...-guide-reference-applib-utility-classes.adoc | 4 +-
...uide-reference-convenience-superclasses.adoc | 4 +-
.../user-guide-reference-domain-services.adoc | 4 +-
...-guide-reference-recognized-annotations.adoc | 4 +-
...user-guide-reference-recognized-methods.adoc | 4 +-
.../user-guide-reference-value-types.adoc | 4 +-
.../user-guide/user-guide-reference.adoc | 18 +-
.../user-guide/user-guide-restful-viewer.adoc | 2 +-
.../asciidoc/user-guide/user-guide-testing.adoc | 4 +-
...ide-troubleshooting-datanucleus-logging.adoc | 4 +-
.../user-guide/user-guide-troubleshooting.adoc | 4 +-
.../user-guide/user-guide-wicket-viewer.adoc | 2 +-
.../main/asciidoc/user-guide/user-guide.adoc | 32 ---
adocs/template/document.html.erb | 120 ++++------
55 files changed, 596 insertions(+), 287 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.css
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.css b/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.css
new file mode 100644
index 0000000..ce5ed3b
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.css
@@ -0,0 +1,140 @@
+/*!
+ * "Fork me on GitHub" CSS ribbon v0.1.1 | MIT License
+ * https://github.com/simonwhitaker/github-fork-ribbon-css
+*/
+
+/* Left will inherit from right (so we don't need to duplicate code) */
+.github-fork-ribbon {
+ /* The right and left classes determine the side we attach our banner to */
+ position: absolute;
+
+ /* Add a bit of padding to give some substance outside the "stitching" */
+ padding: 2px 0;
+
+ /* Set the base colour */
+ background-color: #a00;
+
+ /* Set a gradient: transparent black at the top to almost-transparent black at the bottom */
+ background-image: -webkit-gradient(linear, left top, left bottom, from(rgba(0, 0, 0, 0)), to(rgba(0, 0, 0, 0.15)));
+ background-image: -webkit-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
+ background-image: -moz-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
+ background-image: -ms-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
+ background-image: -o-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
+ background-image: linear-gradient(to bottom, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
+
+ /* Add a drop shadow */
+ -webkit-box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.5);
+ -moz-box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.5);
+ box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.5);
+
+ /* Set the font */
+ font: 700 13px "Helvetica Neue", Helvetica, Arial, sans-serif;
+
+ z-index: 9999;
+ pointer-events: auto;
+}
+
+.github-fork-ribbon a,
+.github-fork-ribbon a:hover {
+ /* Set the text properties */
+ color: #fff;
+ text-decoration: none;
+ text-shadow: 0 -1px rgba(0, 0, 0, 0.5);
+ text-align: center;
+
+ /* Set the geometry. If you fiddle with these you'll also need
+ to tweak the top and right values in .github-fork-ribbon. */
+ width: 200px;
+ line-height: 20px;
+
+ /* Set the layout properties */
+ display: inline-block;
+ padding: 2px 0;
+
+ /* Add "stitching" effect */
+ border-width: 1px 0;
+ border-style: dotted;
+ border-color: #fff;
+ border-color: rgba(255, 255, 255, 0.7);
+}
+
+.github-fork-ribbon-wrapper {
+ width: 150px;
+ height: 150px;
+ position: absolute;
+ overflow: hidden;
+ top: 0;
+ z-index: 9999;
+ pointer-events: none;
+}
+
+.github-fork-ribbon-wrapper.fixed {
+ position: fixed;
+}
+
+.github-fork-ribbon-wrapper.left {
+ left: 0;
+}
+
+.github-fork-ribbon-wrapper.right {
+ right: 0;
+}
+
+.github-fork-ribbon-wrapper.left-bottom {
+ position: fixed;
+ top: inherit;
+ bottom: 0;
+ left: 0;
+}
+
+.github-fork-ribbon-wrapper.right-bottom {
+ position: fixed;
+ top: inherit;
+ bottom: 0;
+ right: 0;
+}
+
+.github-fork-ribbon-wrapper.right .github-fork-ribbon {
+ top: 42px;
+ right: -43px;
+
+ -webkit-transform: rotate(45deg);
+ -moz-transform: rotate(45deg);
+ -ms-transform: rotate(45deg);
+ -o-transform: rotate(45deg);
+ transform: rotate(45deg);
+}
+
+.github-fork-ribbon-wrapper.left .github-fork-ribbon {
+ top: 42px;
+ left: -43px;
+
+ -webkit-transform: rotate(-45deg);
+ -moz-transform: rotate(-45deg);
+ -ms-transform: rotate(-45deg);
+ -o-transform: rotate(-45deg);
+ transform: rotate(-45deg);
+}
+
+
+.github-fork-ribbon-wrapper.left-bottom .github-fork-ribbon {
+ top: 80px;
+ left: -43px;
+
+ -webkit-transform: rotate(45deg);
+ -moz-transform: rotate(45deg);
+ -ms-transform: rotate(45deg);
+ -o-transform: rotate(45deg);
+ transform: rotate(45deg);
+}
+
+.github-fork-ribbon-wrapper.right-bottom .github-fork-ribbon {
+ top: 80px;
+ right: -43px;
+
+ -webkit-transform: rotate(-45deg);
+ -moz-transform: rotate(-45deg);
+ -ms-transform: rotate(-45deg);
+ -o-transform: rotate(-45deg);
+ transform: rotate(-45deg);
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.ie.css
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.ie.css b/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.ie.css
new file mode 100644
index 0000000..2baa48a
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/css/github-fork-ribbon-css/0.1.1/gh-fork-ribbon.ie.css
@@ -0,0 +1,78 @@
+/*!
+ * "Fork me on GitHub" CSS ribbon v0.1.1 | MIT License
+ * https://github.com/simonwhitaker/github-fork-ribbon-css
+*/
+
+/* IE voodoo courtesy of http://stackoverflow.com/a/4617511/263871 and
+ * http://www.useragentman.com/IETransformsTranslator */
+
+ .github-fork-ribbon {
+ filter: progid:DXImageTransform.Microsoft.gradient(GradientType=0,StartColorStr='#000000', EndColorStr='#000000');
+}
+
+.github-fork-ribbon-wrapper.right .github-fork-ribbon {
+ /* IE positioning hack (couldn't find a transform-origin alternative for IE) */
+ top: -22px;
+ right: -62px;
+
+ /* IE8+ */
+ -ms-filter: "progid:DXImageTransform.Microsoft.Matrix(M11=0.7071067811865474, M12=-0.7071067811865477, M21=0.7071067811865477, M22=0.7071067811865474, SizingMethod='auto expand')";
+ /* IE6 and 7 */
+ filter: progid:DXImageTransform.Microsoft.Matrix(
+ M11=0.7071067811865474,
+ M12=-0.7071067811865477,
+ M21=0.7071067811865477,
+ M22=0.7071067811865474,
+ SizingMethod='auto expand'
+ );
+}
+
+.github-fork-ribbon-wrapper.left .github-fork-ribbon {
+ top: -22px;
+ left: -22px;
+
+ /* IE8+ */
+ -ms-filter: "progid:DXImageTransform.Microsoft.Matrix(M11=0.7071067811865483, M12=0.7071067811865467, M21=-0.7071067811865467, M22=0.7071067811865483, SizingMethod='auto expand')";
+ /* IE6 and 7 */
+ filter: progid:DXImageTransform.Microsoft.Matrix(
+ M11=0.7071067811865483,
+ M12=0.7071067811865467,
+ M21=-0.7071067811865467,
+ M22=0.7071067811865483,
+ SizingMethod='auto expand'
+ );
+}
+
+.github-fork-ribbon-wrapper.left-bottom .github-fork-ribbon {
+ /* IE positioning hack (couldn't find a transform-origin alternative for IE) */
+ top: 12px;
+ left: -22px;
+
+
+ /* IE8+ */
+ -ms-filter: "progid:DXImageTransform.Microsoft.Matrix(M11=0.7071067811865474, M12=-0.7071067811865477, M21=0.7071067811865477, M22=0.7071067811865474, SizingMethod='auto expand')";
+ /* IE6 and 7 */
+/* filter: progid:DXImageTransform.Microsoft.Matrix(
+ M11=0.7071067811865474,
+ M12=-0.7071067811865477,
+ M21=0.7071067811865477,
+ M22=0.7071067811865474,
+ SizingMethod='auto expand'
+ );
+*/}
+
+.github-fork-ribbon-wrapper.right-bottom .github-fork-ribbon {
+ top: 12px;
+ right: -62px;
+
+ /* IE8+ */
+ -ms-filter: "progid:DXImageTransform.Microsoft.Matrix(M11=0.7071067811865483, M12=0.7071067811865467, M21=-0.7071067811865467, M22=0.7071067811865483, SizingMethod='auto expand')";
+ /* IE6 and 7 */
+ filter: progid:DXImageTransform.Microsoft.Matrix(
+ M11=0.7071067811865483,
+ M12=0.7071067811865467,
+ M21=-0.7071067811865467,
+ M22=0.7071067811865483,
+ SizingMethod='auto expand'
+ );
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/archetype/simpleapp-archetype.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/archetype/simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/getting-started/archetype/simpleapp-archetype.adoc
index 259706f..1decbc9 100644
--- a/adocs/documentation/src/main/asciidoc/getting-started/archetype/simpleapp-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/getting-started/archetype/simpleapp-archetype.adoc
@@ -3,5 +3,5 @@
:_basedir: ../../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/cmd-line/cmd-line.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/cmd-line/cmd-line.adoc b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/cmd-line/cmd-line.adoc
index b9e488c..ff05492 100644
--- a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/cmd-line/cmd-line.adoc
+++ b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/cmd-line/cmd-line.adoc
@@ -3,5 +3,5 @@
:_basedir: ../../../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/eclipse/eclipse.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/eclipse/eclipse.adoc b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/eclipse/eclipse.adoc
index 6d493e4..4250a16 100644
--- a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/eclipse/eclipse.adoc
+++ b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/eclipse/eclipse.adoc
@@ -3,5 +3,5 @@
:_basedir: ../../../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/010-run-configuration.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/010-run-configuration.png b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/010-run-configuration.png
new file mode 100644
index 0000000..0c6a929
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/010-run-configuration.png differ
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/020-datanucleus-enhancer-goal.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/020-datanucleus-enhancer-goal.png b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/020-datanucleus-enhancer-goal.png
new file mode 100644
index 0000000..2dae157
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/020-datanucleus-enhancer-goal.png differ
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/030-running-unit-tests.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/030-running-unit-tests.png b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/030-running-unit-tests.png
new file mode 100644
index 0000000..b4e042a
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/030-running-unit-tests.png differ
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/040-running-unit-tests-run-configuration.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/040-running-unit-tests-run-configuration.png b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/040-running-unit-tests-run-configuration.png
new file mode 100644
index 0000000..83a4a70
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/040-running-unit-tests-run-configuration.png differ
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/050-running-integration-tests-run-configuration.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/050-running-integration-tests-run-configuration.png b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/050-running-integration-tests-run-configuration.png
new file mode 100644
index 0000000..6b0ad89
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/images/110-running-the-app/050-running-integration-tests-run-configuration.png differ
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/intellij-idea.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/intellij-idea.adoc b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/intellij-idea.adoc
index 7ea0923..06967db 100644
--- a/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/intellij-idea.adoc
+++ b/adocs/documentation/src/main/asciidoc/getting-started/development-environment/intellij-idea/intellij-idea.adoc
@@ -5,9 +5,12 @@
:toc: right
-NOTE: This doc used IntelliJ Community Edition 14.1.1, with screenshots taken for Windows. If you're a MacOS user, I'm sure you can adapt :-)
-## Download and Install
+## Setting up and Configurating IntelliJ
+
+### Download and Install
+
+WARNING: This doc used IntelliJ Community Edition 14.1.1, with screenshots taken for Windows. If you're a MacOS user, I'm sure you can adapt :-)
https://www.jetbrains.com/idea/download/[Download] latest version of IntelliJ Community Edition, and install:
@@ -47,9 +50,11 @@ Finally, if you are young and trendy, set the UI theme to Darcula:
image::{_imagesdir}010-installing/070-set-ui-theme.png[width="600px"]
-## New Project
-In IntelliJ a project can contain multiple modules; these need not be physically located together. (If you are previously an Eclipse user, it is therefore similar to an Eclipse workspace).
+
+### New Project
+
+In IntelliJ a project can contain multiple modules; these need not be physically located together. (If you are previously an Eclipse user, you can think of it as similar to an Eclipse workspace).
Start off by creating a new project:
@@ -79,7 +84,9 @@ Finally allow IntelliJ to create the directory for the new project:
.IntelliJ Create New Project
image::{_imagesdir}020-create-new-project/060-create-dir.png[width="200px"]
-## Import Settings
+
+
+### Import Settings
Next we need to configure IntelliJ with ASF/Apache Isis' standard templates and coding conventions. These are bundled as the `settings.jar` JAR file link:resources/isis-settings.jar[download from the Isis website]).
@@ -98,37 +105,57 @@ And then restart:
.IntelliJ Import Settings - Restart
image::{_imagesdir}030-import-settings/030-restart.png[width="200px"]
-## Other Settings
-There are also some other miscellaneous settings that we recommend that you adjust.
+
+### Other Settings
+
+There are also some other miscellaneous settings that we recommend that you adjust (though these are not critical).
First, specify an up-to-date Maven installation, using `File > Settings` (or `IntelliJ > Preferences` if on MacOS):
-.IntelliJ Import Settings - Maven Installation
+.IntelliJ Other Settings - Maven Installation
image::{_imagesdir}040-other-settings/010-maven-installation.png[width="600px"]
Still on the Maven settings page, configure as follows:
-.IntelliJ Import Settings - Maven Configuration
+.IntelliJ Other Settings - Maven Configuration
image::{_imagesdir}040-other-settings/020-maven-configuration.png[width="600px"]
-And on the compiler settings page, ensure that `build automatically` is enabled (and optionally `compile independent modules in parallel`):
+On the compiler settings page, ensure that `build automatically` is enabled (and optionally `compile independent modules in parallel`):
-.IntelliJ Import Settings - Compiler Settings
+.IntelliJ Other Settings - Compiler Settings
image::{_imagesdir}040-other-settings/030-build-automatically.png[width="600px"]
-## Some Plugins
+On the auto import page, check the `optimize imports on the fly` and `add unambiguous imports on the fly`
+
+.IntelliJ Other Settings - Auto Import
+image::{_imagesdir}040-other-settings/040-auto-import.png[width="600px"]
+
+
-Next, you might want to set up some additional plugins, using `File > Settings > Plugins` (or equivalently `File > Other Settings > Configure Plugins`).
+### Plugins
-Some to get you started are:
+You might also want to set up some additional plugins, using `File > Settings > Plugins` (or equivalently `File > Other Settings > Configure Plugins`).
+
+Recommended are:
+* link:https://plugins.jetbrains.com/plugin/7179?pr=idea[Maven Helper] plugin
++
+Provides better visualization of dependency trees (similar to Eclipse)
+* link:https://github.com/asciidoctor/asciidoctor-intellij-plugin[AsciiDoctor] plugin
++
+Useful if you are doing any authoring of documents.
+
+Some others you might like to explore are:
.IntelliJ Plugins
image::{_imagesdir}050-some-plugins/020-some-plugins-confirmation.png[width="400px"]
+
+
+
## Importing and Managing Maven Modules
-Finally, let's load in some actual code! We do this by importing the Maven modules.
+Let's load in some actual code! We do this by importing the Maven modules.
First up, open up the Maven tool window (`View > Tool Windows > Maven Projects`). You can then use the 'plus' button to add Maven modules. In the screenshot you can see we've loaded in Isis core; the modules are listed in the _Maven Projects_ window and corresponding (IntelliJ) modules are shown in the _Projects_ window:
@@ -156,16 +183,180 @@ image::{_imagesdir}100-maven-module-mgmt/040-ignoring-modules.png[width="730px"]
Confirm that it's ok to ignore these modules:
-.IntelliJ Maven Module Management -
+.IntelliJ Maven Module Management - Ignoring Modules (ctd)
image::{_imagesdir}100-maven-module-mgmt/050-ignoring-modules-2.png[width="300px"]
All being well you should see that the _Projects_ window now only contains the code you are working on. Its classpath dependencies will be adjusted (eg to resolve to Isis core from `.m2/repository`):
-.IntelliJ Maven Module Management -
+.IntelliJ Maven Module Management - Updated Projects Window
image::{_imagesdir}100-maven-module-mgmt/060-ignored-modules.png[width="730px"]
-## Dynamically Reloading
+## Running
+
+Let's see how to run both the app and the tests.
+
+### Running the App
+
+Once you've imported your Isis application, we should run it. We do this by creating a Run configuration, using `Run > Edit Configurations`.
+
+Set up the details as follows:
+
+.IntelliJ Running the App - Run Configuration
+image::{_imagesdir}110-running-the-app/010-run-configuration.png[width="600px"]
+
+We specify the `Main class` to be `org.apache.isis.WebServer`; this is a wrapper around Jetty. It's possible to pass program arguments to this (eg to automatically install fixtures), but for now leave this blank.
+
+Also note that `Use classpath of module` is the webapp module for your app, and that the `working directory` is `$MODULE_DIR$`.
+
+Next, and most importantly, configure the DataNucleus enhancer to run for your `dom` goal. This can be done by defining a Maven goal to run before the app:
+
+.IntelliJ Running the App - Datanucleus Enhancer Goal
+image::{_imagesdir}110-running-the-app/020-datanucleus-enhancer-goal.png[width="400px"]
+
+The `-o` flag in the goal means run off-line; this will run faster.
+
+WARNING: if you forget to set up the enhancer goal, or don't run it on the correct (dom) module, then you will get all sorts of errors when you startup. These usually manifest themselves as class cast exception in DataNucleus.
+
+You should now be able to run the app using `Run > Run Configuration`. The same configuration can also be used to debug the app if you so need.
+
+
+### Running the Unit Tests
+
+The easiest way to run the unit tests is just to right click on the `dom` module in the _Project Window_, and choose run unit tests. Hopefully your tests will pass (!).
+
+.IntelliJ Running the App - Unit Tests Run Configuration
+image::{_imagesdir}110-running-the-app/030-running-unit-tests.png[width="600px"]
+
+As a side-effect, this will create a run configuration, very similar to the one we manually created for the main app:
+
+.IntelliJ Running the App - Unit Tests Run Configuration
+image::{_imagesdir}110-running-the-app/040-running-unit-tests-run-configuration.png[width="600px"]
+
+Thereafter, you should run units by selecting this configuration (if you use the right click approach you'll end up with lots of run configurations, all similar).
+
+### Running the Integration Tests
+
+Integration tests can be run in the same way as unit tests, however the `dom` module must also have been enhanced.
+
+One approach is to initially run the tests use the right click on the `integtests` module; the tests will fail because the code won't have been enhanced, but we can then go and update the run configuration to run the datanucleus enhancer goal (same as when running the application):
+
+.IntelliJ Running the App - Integration Tests Run Configuration
+image::{_imagesdir}110-running-the-app/050-running-integration-tests-run-configuration.png[width="600px"]
+
+
+
+## Hints and Tips
+
+### Keyboard Shortcuts Cheat Sheets
+
+You can download 1-page PDFs cheat sheets for IntelliJ's keyboard shortcuts:
+* for link:https://www.jetbrains.com/idea/docs/IntelliJIDEA_ReferenceCard.pdf[Windows]
+* for MacOS:https://www.jetbrains.com/idea/docs/IntelliJIDEA_ReferenceCard_Mac.pdf[MacOS]
+
+Probably the most important shortcut on them is for `Find Action`:
+- `ctrl-shift-A` on Windows
+- `cmd-shift-A` on MacOS.
+
+This will let you search for any action just by typing its name.
+
+### Switching between Tool Windows and Editors
+
+The Tool Windows are the views around the editor (to left, bottom and right). It's possible to move these around to your preferred locations.
+
+* Use `alt-1` through `alt-9` (or `cmd-1` through `alt-9`) to select the tool windows
+** Press it twice and the tool window will hide itself; so can use to toggle
+* If in the _Project Window_ (say) and hit enter on a file, then it will be shown in the editor, but (conveniently) the focus remains in the tool window. To switch to the editor, just press `Esc`.
+** If in the _Terminal Window_, you'll need to press `Shift-Esc`.
+* If on the editor and want to locate the file in (say) the _Project Window_, use `alt-F1`.
+* To change the size of any tool window, use `ctrl-shift-arrow`
+
+Using these shortcuts you can easily toggle between the tool windows and the editor, without using the mouse. Peachy!
+
+### Navigating Around
+
+For all of the following, you don't need to type every letter, typing "ab" will actually search for ".*a.*b.*".
+
+* to open classes or files or methods that you know the name of:
+** `ctrl-N` to open class
+** `ctrl-shift-N` to open a file
+** (bit fiddly this) `ctrl-shift-alt-N` to search for any symbol.
+* open up dialog of recent files: `ctrl-E`
+* search for any file: `shift-shift`
+
+Navigating around:
+* find callers of a method (the call hierarchy): `ctrl-alt-H`
+* find subclasses or overrides: `ctrl-alt-B`
+* find superclasses/interface/declaration: `ctrl-B`
+
+Viewing the structure (ie outline) of a class
+* `ctrl-F12` will pop-up a dialog showing all members
+** hit `ctrl-F12` again to also see inherited members
+
+
+### Editing
+
+* Extend selection using `ctrl-W`
+** and contract it down again using `ctrl-shift-W`
+* to duplicate a line, it's `ctrl-D`
+** if you have some text selected (or even some lines), it'll actually duplicate the entire selection
+* to delete a line, it's `ctrl-X`
+* to move a line up or down: `shift-alt-up` and `shift-alt-down`
+** if you have selected several lines, it'll move them all togethe
+* `ctrl-shift-J` can be handy for joining lines together
+** just hit enter to split them apart (even in string quotes; IntelliJ will "do the right thing")
+
+### Intentions and Code Completion
+
+Massively useful is the "Intentions" popup; IntelliJ tries to guess what you might want to do. You can activate this using`alt-enter`, whenever you see a lightbulb/tooltip in the margin of the current line.
+
+Code completion usually happens whenever you type '.'. You can also use `ctrl-space` to bring these up.
+
+In certain circumstances (eg in methods0) you can also type `ctrl-shift-space` to get a smart list of methods etc that you might want to call. Can be useful.
+
+Last, when invoking a method, use `ctrl-P` to see the parameter types.
+
+
+### Refactoring
+
+Loads of good stuff on the `Refactor` menu; most used are:
+
+* Rename (`shift-F6`)
+* Extract
+** method: `ctrl-alt-M`
+** variable: `ctrl-alt-V`
+* Inline method/variable: `ctrl-alt-N`
+* Change signature
+
+If you can't remember all those shortcuts, just use `ctrl-shift-alt-T` (might want to rebind that to something else!) and get a context-sensitive list of refactorings available for the currently selected object
+
+
+### Troubleshooting
+
+When a Maven module is imported, IntelliJ generates its own project files (suffix `.ipr`), and the application is actually built from that.
+
+Occasionally these don't keep in sync (even if auto-import of Maven modules has been enabled).
+
+To fix the issue, try:
+* reimport module
+* rebuild selected modules/entire project
+* remove and then re-add the project
+* restart, invalidating caches
+* hit StackOverflow (!)
+
+One thing worth knowing; IntelliJ actively scans the filesystem all the time. It's therefore (almost always) fine to build the app from the Maven command line; IntelliJ will detect the changes and keep in sync. If you want to force that, use `File > Synchronize`, `ctrl-alt-Y`.
+
+
+## Advanced
+
+In this section are a couple of options that will reduce the length of the change code/build/deploy/review feedback loop.
+
+
+### Setting up Dynamic Reloading
+
+IMPORTANT: TODO
+
+### Setting up JRebel
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/index.adoc b/adocs/documentation/src/main/asciidoc/index.adoc
new file mode 100644
index 0000000..69353bd
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/index.adoc
@@ -0,0 +1,30 @@
+= Documentation
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ./
+:_imagesdir: images/
+:toc: right
+:numbered:
+
+ifdef::env-github[]
+[TIP]
+----
+You are browsing this file on Github.
+
+For the links below, replace the `.html` with `.adoc` to find the original source (otherwise they will 404).
+----
+endif::[]
+
+Finding your way around:
+
+* Introducing Isis
+** link:introducing-apache-isis/isis-in-pictures/isis-in-pictures.html[Isis in Pictures]
+** link:introducing-apache-isis/common-use-cases/common-use-cases.html[Common Use Cases]
+* Getting Started
+** link:getting-started/archetype/simpleapp-archetype.html[SimpleApp Archetype]
+** Development Environments
+*** link:getting-started/development-environment/intellij-idea/intellij-idea.html[Intellij IDEA]
+*** link:getting-started/development-environment/eclipse/eclipse.html[Eclipse]
+*** link:getting-started/development-environment/cmd-line/cmd-line.html[(Maven) Command Line]
+* link:user-guide/user-guide.html[User Guide]
+* link:release-notes/release-notes.html[Release Notes]
+
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/introducing-apache-isis/common-use-cases/common-use-cases.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/introducing-apache-isis/common-use-cases/common-use-cases.adoc b/adocs/documentation/src/main/asciidoc/introducing-apache-isis/common-use-cases/common-use-cases.adoc
index f177e4b..704531c 100644
--- a/adocs/documentation/src/main/asciidoc/introducing-apache-isis/common-use-cases/common-use-cases.adoc
+++ b/adocs/documentation/src/main/asciidoc/introducing-apache-isis/common-use-cases/common-use-cases.adoc
@@ -3,4 +3,4 @@
:_basedir: ../../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/introducing-apache-isis/isis-in-pictures/isis-in-pictures.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/introducing-apache-isis/isis-in-pictures/isis-in-pictures.adoc b/adocs/documentation/src/main/asciidoc/introducing-apache-isis/isis-in-pictures/isis-in-pictures.adoc
index 3b9a471..6f98a55 100644
--- a/adocs/documentation/src/main/asciidoc/introducing-apache-isis/isis-in-pictures/isis-in-pictures.adoc
+++ b/adocs/documentation/src/main/asciidoc/introducing-apache-isis/isis-in-pictures/isis-in-pictures.adoc
@@ -3,5 +3,5 @@
:_basedir: ../../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
index 8eab125..50b4820 100644
--- a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
+++ b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
@@ -3,4 +3,4 @@
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-config-and-deployment.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-config-and-deployment.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-config-and-deployment.adoc
index ba917c1..55621d5 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-config-and-deployment.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-config-and-deployment.adoc
@@ -1,9 +1,9 @@
-= User Guide: Configuration and Deployment
+= Configuration and Deployment
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Configuration Files
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-apache-isis-vs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-apache-isis-vs.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-apache-isis-vs.adoc
index f069d41..c64344a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-apache-isis-vs.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-apache-isis-vs.adoc
@@ -1,9 +1,9 @@
-= User Guide: Core Concepts: Apache Isis vs ...
+= Apache Isis vs ...
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## vs Spring
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-building-blocks.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-building-blocks.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-building-blocks.adoc
index 8d015dc..50044a0 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-building-blocks.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-building-blocks.adoc
@@ -1,9 +1,9 @@
-= User Guide: Core Concepts: Building Blocks
+= Building Blocks
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## A MetaModel with Explicit and Inferred Semantics
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-framework-provided-services.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-framework-provided-services.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-framework-provided-services.adoc
index 57511f5..36011ea 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-framework-provided-services.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-framework-provided-services.adoc
@@ -1,9 +1,9 @@
-= User Guide: Core Concepts: Framework-provided Services
+= Framework-provided Services
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## API vs SPI
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-principles.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-principles.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-principles.adoc
index 7653485..19fe21d 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-principles.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts-principles.adoc
@@ -1,9 +1,9 @@
-= User Guide: Core Concepts: Principles
+= Principles
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Domain-Driven Design
@@ -13,6 +13,7 @@ NOTE: TODO
## Naked Objects Pattern
+[TIP]
.Object Interface Mapping
====
Just as an ORM (such as link:http://datanucleus.org[DataNucleus] or link:http:hibernate.org[Hibernate]) maps domain entities to a database, you can think of Naked Objects as an OIM - mapping domain objects to a user interface.
@@ -24,9 +25,11 @@ Just as an ORM (such as link:http://datanucleus.org[DataNucleus] or link:http:hi
## Hexagonal Architecture
-[NOTE]
+Originally described by Alistair Cockburn, the link:http://alistair.cockburn.us/Hexagonal+architecture[Hexagonal Architecture] ...
+
+[TIP]
====
-The hexagonal architecture is also known as the ports-and-adapters architecture. another name used (less frequently) is the onion architecture.
+The hexagonal architecture is also known as the link:http://c2.com/cgi/wiki?PortsAndAdaptersArchitecture:[Ports and Adapters] architecture or (less frequently) as the link:http://jeffreypalermo.com/blog/the-onion-architecture-part-1/[Onion] architecture.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts.adoc
index 63f7b70..a310831 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-core-concepts.adoc
@@ -1,33 +1,19 @@
-= User Guide: Core Concepts
+= Core Concepts
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
-
-## Principles
+IMPORTANT: TODO
include::user-guide-core-concepts-principles.adoc[leveloffset=+1]
-
-
-## Apache Isis vs...
-
include::user-guide-core-concepts-apache-isis-vs.adoc[leveloffset=+1]
-
-
-## Building Blocks
-
include::user-guide-core-concepts-building-blocks.adoc[leveloffset=+1]
-
-## Framework-provided Services
-
include::user-guide-core-concepts-framework-provided-services.adoc[leveloffset=+2]
-
## Honouring the Single Responsibility Principle
### Behaviourally Complete vs Contributions
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending-programming-model.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending-programming-model.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending-programming-model.adoc
index 8a42fbf..289a23b 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending-programming-model.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending-programming-model.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Extending: Programming Model
+= Programming Model
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Disallowing deprecated annotations
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending.adoc
index 9b59717..34643cf 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-extending.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Extending
+= Extending
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Extending the Programming Model
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-business-rules.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-business-rules.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-business-rules.adoc
index 879b810..c78f198 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-business-rules.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-business-rules.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Business Rules
+= Business Rules
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Visibility ("see it")
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-class-structure.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-class-structure.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-class-structure.adoc
index f489c6b..7468105 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-class-structure.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-class-structure.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Class Members
+= Class Structure
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
@@ -109,7 +109,7 @@ While Isis support collections of references, the framework (currently) does not
Or, actually, you can, because that is a valid mapping supported by JDO/DataNucleus . However, Isis has no default visualization.
The workaround is to mark the collection as `@Programmatic`, as described in <<Ignoring Methods>>. This ensures that the collection is ignored by Isis.
-===
+====
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-contributed-members.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-contributed-members.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-contributed-members.adoc
index ca8a099..394cdfb 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-contributed-members.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-contributed-members.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Contributed Members
+= Contributed Members
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Contributed Action
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-crud.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-crud.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-crud.adoc
index 6cd85e8..229e2c6 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-crud.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-crud.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Object Management (CRUD)
+= Object Management (CRUD)
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Injecting Services
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-derived-members.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-derived-members.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-derived-members.adoc
index 9640959..c0e8e8e 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-derived-members.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-derived-members.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Derived Members
+= Derived Members
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Derived Property
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-drop-downs-and-defaults.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-drop-downs-and-defaults.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-drop-downs-and-defaults.adoc
index b05ac1d..618f4a9 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-drop-downs-and-defaults.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-drop-downs-and-defaults.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Business Rules
+= Business Rules
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## For Properties
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-entity-relationships.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-entity-relationships.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-entity-relationships.adoc
index ec8ab6a..b7f7d7f 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-entity-relationships.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-entity-relationships.adoc
@@ -1,11 +1,11 @@
-= User Guide: How-tos: Entity Relationships
+= Entity Relationships
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Mapping Mandatory and Optional Properties
-## Managed 1:m bidirectional relationships
+## Managed 1-m bidirectional relationships
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-error-handling.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-error-handling.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-error-handling.adoc
index 356dfdd..8564571 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-error-handling.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-error-handling.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Error Handling
+= Error Handling
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Raise message/errors to users
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-i18n.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-i18n.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-i18n.adoc
index c6bbdea..adc5590 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-i18n.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-i18n.adoc
@@ -1,7 +1,7 @@
-= User Guide: How-tos: i18n
+= i18n
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-multi-tenancy.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-multi-tenancy.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-multi-tenancy.adoc
index 68e2e5e..4f99008 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-multi-tenancy.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-multi-tenancy.adoc
@@ -1,7 +1,7 @@
-= User Guide: How-tos: Multi-tenancy
+= Multi-tenancy
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-persistence-lifecycle.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-persistence-lifecycle.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-persistence-lifecycle.adoc
index c4d39db..5226979 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-persistence-lifecycle.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-persistence-lifecycle.adoc
@@ -1,7 +1,7 @@
-= User Guide: How-tos: Persistence Lifecycle
+= Persistence Lifecycle
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overriding-jdo-annotations.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overriding-jdo-annotations.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overriding-jdo-annotations.adoc
new file mode 100644
index 0000000..c9dafcb
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks-overriding-jdo-annotations.adoc
@@ -0,0 +1,5 @@
+== How Tos: Tips n Tricks: Overriding JDO Annotations
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks.adoc
index 072642c..6ebf43a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-tips-n-tricks.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Tips n Tricks
+= Tips n Tricks
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Are You Sure? idiom
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-triggering-events.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-triggering-events.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-triggering-events.adoc
index 50a41d9..67c6552 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-triggering-events.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-triggering-events.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: Triggering Events
+= Triggering Events
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Publishing and Subscribing to Events (Pulling Changes)
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-ui-hints.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-ui-hints.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-ui-hints.adoc
index 82a6a9b..6b9b7b3 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-ui-hints.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos-ui-hints.adoc
@@ -1,9 +1,9 @@
-= User Guide: How-tos: UI Hints
+= UI Hints
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Icons and Titles
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
index a56b09d..abd6327 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-how-tos.adoc
@@ -1,90 +1,36 @@
-= User Guide: How-tos
+= How-tos
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
-
-## Class Structure
+IMPORTANT: TODO
include::user-guide-how-tos-class-structure.adoc[leveloffset=+1]
-
-
-## Entity Relationships
-
include::user-guide-how-tos-entity-relationships.adoc[leveloffset=+1]
-
-
-## Contributed Members
-
include::user-guide-how-tos-contributed-members.adoc[leveloffset=+1]
-
-
-## Derived Members
-
include::user-guide-how-tos-derived-members.adoc[leveloffset=+1]
-
-
-## Object Management (CRUD)
-
include::user-guide-how-tos-crud.adoc[leveloffset=+1]
-
-
-## UI Hints
-
include::user-guide-how-tos-ui-hints.adoc[leveloffset=+1]
-
-
-## Business Rules
-
include::user-guide-how-tos-business-rules.adoc[leveloffset=+1]
-
-
-## Drop downs and Defaults
-
include::user-guide-how-tos-drop-downs-and-defaults.adoc[leveloffset=+1]
-
-
-## Triggering Events
-
include::user-guide-how-tos-triggering-events.adoc[leveloffset=+1]
-
-
-## Tips n Tricks
-
include::user-guide-how-tos-tips-n-tricks.adoc[leveloffset=+1]
-
-
-## Error Handling
-
include::user-guide-how-tos-error-handling.adoc[leveloffset=+1]
-
-
-## i18n
-
include::user-guide-how-tos-i18n.adoc[leveloffset=+1]
-
-
-## Multi-tenancy
-
include::user-guide-how-tos-multi-tenancy.adoc[leveloffset=+1]
-
-
-## Persistence Lifecycle
-
include::user-guide-how-tos-persistence-lifecycle.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-integrating-with-other-systems.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-integrating-with-other-systems.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-integrating-with-other-systems.adoc
index f2a0ace..f8668d1 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-integrating-with-other-systems.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-integrating-with-other-systems.adoc
@@ -1,9 +1,9 @@
-= User Guide: Integrating with Other Systems
+= Integrating with Other Systems
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## Non UI Execution
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-isis-addons.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-isis-addons.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-isis-addons.adoc
index 1843011..a3d780a 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-isis-addons.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-isis-addons.adoc
@@ -1,9 +1,9 @@
-= User Guide: Isis Addons (not ASF)
+= Isis Addons (not ASF)
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
WARNING: Note that Isis addons, while maintained by Isis committers, are not part of the ASF.
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-applib-utility-classes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-applib-utility-classes.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-applib-utility-classes.adoc
index 8e84f6f..175dbfc 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-applib-utility-classes.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-applib-utility-classes.adoc
@@ -1,8 +1,8 @@
-= User Guide: Reference: Applib Utility Classes
+= Applib Utility Classes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-convenience-superclasses.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-convenience-superclasses.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-convenience-superclasses.adoc
index bb05b44..5a8e956 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-convenience-superclasses.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-convenience-superclasses.adoc
@@ -1,8 +1,8 @@
-= User Guide: Reference: Convenience Superclasses
+= Convenience Superclasses
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-domain-services.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-domain-services.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-domain-services.adoc
index 2db6ae9..2b1f4de 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-domain-services.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-domain-services.adoc
@@ -1,8 +1,8 @@
-= User Guide: Reference: Domain Services
+= Domain Services
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-annotations.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-annotations.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-annotations.adoc
index be58af2..514a56b 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-annotations.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-annotations.adoc
@@ -1,8 +1,8 @@
-= User Guide: Reference: Recognized Annotations
+= Recognized Annotations
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-methods.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-methods.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-methods.adoc
index ae518f2..ceb6a5b 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-methods.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-recognized-methods.adoc
@@ -1,8 +1,8 @@
-= User Guide: Reference: Recognized Methods
+= Recognized Methods
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/9ccb95ab/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-value-types.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-value-types.adoc b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-value-types.adoc
index 5b2a235..0808f72 100644
--- a/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-value-types.adoc
+++ b/adocs/documentation/src/main/asciidoc/user-guide/user-guide-reference-value-types.adoc
@@ -1,9 +1,9 @@
-= User Guide: Reference: Value Types
+= Value Types
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:_basedir: ../
:_imagesdir: images/
-NOTE: TODO
+IMPORTANT: TODO
## JDK