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 2019/11/13 21:14:03 UTC
[isis] 06/07: ISIS-2062: cleans up some docs, bumps the UI bundle
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit c9727e6fa8d39de90cf74cde70eb11107e8bc841
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Nov 13 21:03:50 2019 +0000
ISIS-2062: cleans up some docs, bumps the UI bundle
---
adocs/documentation/.gitignore | 1 -
adocs/documentation/Gemfile | 24 -
adocs/documentation/Gemfile.lock | 47 --
adocs/documentation/README.adoc | 85 ---
adocs/documentation/addanchor.groovy | 63 --
adocs/documentation/check-bookmarks.sh | 18 -
adocs/documentation/check-includes.sh | 23 -
adocs/documentation/edit.sh | 25 -
adocs/documentation/pom-pdf.xml | 195 -----
adocs/documentation/pom.xml | 541 --------------
adocs/documentation/preview-html.sh | 6 -
adocs/documentation/preview-pdf.sh | 2 -
adocs/documentation/publish.sh | 10 -
adocs/documentation/src/main/asciidoc/index.html | 808 ---------------------
adocs/template/document.html.erb | 285 --------
.../components/toc/modules/ROOT/pages/about.adoc | 2 +-
.../modules/_to-repurpose/_attributes.adoc | 6 +
.../modules/_to-repurpose/attachments/.gitkeep | 0
...alysis-of-commands-vs-eventmetadata-vs-etc.xlsx | Bin
...mand-dto-vs-interaction-dto-vs-interaction.xlsx | Bin
.../pptx/commands-vs-actioninvocationevent.pptx | Bin
.../_to-repurpose/attachments}/theme/isis-logo.png | Bin
.../modules/_to-repurpose/examples/.gitkeep | 0
.../modules/_to-repurpose/images/.gitkeep | 0
.../modules/_to-repurpose}/images/PDF-50.png | Bin
.../images/index-screenshots/010-sign-in.pdn | Bin
.../images/index-screenshots/010-sign-in.png | Bin
.../images/index-screenshots/020-object-layout.pdn | Bin
.../images/index-screenshots/020-object-layout.png | Bin
.../030-declarative-business-rules.pdn | Bin
.../030-declarative-business-rules.png | Bin
.../040-imperative-business-rules.pdn | Bin
.../040-imperative-business-rules.png | Bin
.../index-screenshots/050-action-with-args.pdn | Bin
.../index-screenshots/050-action-with-args.png | Bin
.../060-action-with-args-autocomplete.pdn | Bin
.../060-action-with-args-autocomplete.png | Bin
.../images/index-screenshots/070-jdo.pdn | Bin
.../images/index-screenshots/070-jdo.png | Bin
.../images/index-screenshots/080-rest-api.pdn | Bin
.../images/index-screenshots/080-rest-api.png | Bin
.../images/index-screenshots/090-integtesting.pdn | Bin
.../images/index-screenshots/090-integtesting.png | Bin
.../modules/_to-repurpose}/images/isis-favicon.png | Bin
.../_to-repurpose}/images/isis-logo-48x48.pdn | Bin
.../_to-repurpose}/images/isis-logo-48x48.png | Bin
.../_to-repurpose}/images/isis-logo-568x286.pdn | Bin
.../_to-repurpose}/images/isis-logo-568x286.png | Bin
.../_to-repurpose}/images/todoapp/dashboard.png | Bin
.../_to-repurpose}/images/todoapp/swagger-ui.png | Bin
.../_to-repurpose}/images/todoapp/todoitem.png | Bin
.../userguide/modules/_to-repurpose/nav.adoc | 4 +
.../modules/_to-repurpose/pages/_attributes.adoc | 4 +
.../modules/_to-repurpose}/pages/about.adoc | 7 +-
.../_to-repurpose/partials/_attributes.adoc | 4 +
antora/theme/ui-bundle.zip | Bin 312376 -> 312806 bytes
.../doc/modules/commons/partials/module-nav.adoc | 2 +-
.../detached-tests/partials/module-nav.adoc | 2 +-
.../doc/modules/metamodel/partials/module-nav.adoc | 2 +-
.../codegen-bytebuddy/partials/module-nav.adoc | 2 +-
core/plugins/jdo/src/main/doc/antora.yml | 3 +
.../plugins/jdo/src/main/doc/modules/ROOT/nav.adoc | 39 +-
.../jdo/src/main/doc/modules/ROOT/pages/about.adoc | 2 +-
.../runtime-extensions/partials/module-nav.adoc | 2 +-
.../modules/runtime-web/partials/module-nav.adoc | 2 +-
.../doc/modules/runtime/partials/module-nav.adoc | 2 +-
.../src/main/doc/modules/keycloak/pages/about.adoc | 6 +-
.../doc/modules/keycloak/partials/module-nav.adoc | 2 +-
.../integ-test-support/maven-configuration.adoc | 6 +-
.../unit-test-support/maven-configuration.adoc | 4 +-
.../doc/modules/ROOT/pages/layout-resources.adoc | 6 +-
examples/apps/demo/src/main/doc/antora.yml | 2 +-
examples/apps/helloworld/src/main/doc/antora.yml | 2 +-
.../helloworld/src/main/doc/modules/ROOT/nav.adoc | 2 +-
.../src/main/doc/modules/ROOT/pages/about.adoc | 2 +-
examples/apps/simpleapp/src/main/doc/antora.yml | 2 +-
.../simpleapp/src/main/doc/modules/ROOT/nav.adoc | 2 +-
.../src/main/doc/modules/ROOT/pages/about.adoc | 4 +-
preview-scratch.sh | 6 +
site-scratch.yml | 94 +--
site.yml | 1 -
81 files changed, 129 insertions(+), 2230 deletions(-)
diff --git a/adocs/documentation/.gitignore b/adocs/documentation/.gitignore
deleted file mode 100644
index eb5a316..0000000
--- a/adocs/documentation/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-target
diff --git a/adocs/documentation/Gemfile b/adocs/documentation/Gemfile
deleted file mode 100644
index abaaafd..0000000
--- a/adocs/documentation/Gemfile
+++ /dev/null
@@ -1,24 +0,0 @@
-source 'https://rubygems.org'
-
-# only compatible with ruby 2.0
-# http://stackoverflow.com/questions/29123339/error-installed-wdm-gem-on-windows-system
-gem 'wdm', '>= 0.1.0' if Gem.win_platform?
-
-
-#https://github.com/guard/listen
-gem 'listen', '~> 2.7' # this prevents upgrading to 3.x
-gem 'asciidoctor'
-
-#gem 'asciidoctor-diagram', '~> 1.2.0.pre
-gem 'asciidoctor-diagram', '~> 1.2.1'
-
-gem 'tilt'
-gem 'thread_safe'
-gem 'coderay'
-
-#gem 'pygments'
-gem 'rouge'
-gem 'webrick'
-
-gem 'launchy', '~> 2.4.3'
-gem 'slop', '~> 4.1.0'
diff --git a/adocs/documentation/Gemfile.lock b/adocs/documentation/Gemfile.lock
deleted file mode 100644
index fbe1b91..0000000
--- a/adocs/documentation/Gemfile.lock
+++ /dev/null
@@ -1,47 +0,0 @@
-GEM
- remote: https://rubygems.org/
- specs:
- addressable (2.3.8)
- asciidoctor (1.5.2)
- asciidoctor-diagram (1.2.1)
- asciidoctor (~> 1.5.0)
- rjb (~> 1.4.8)
- celluloid (0.16.0)
- timers (~> 4.0.0)
- coderay (1.1.0)
- ffi (1.11.1)
- ffi (1.11.1-x64-mingw32)
- hitimes (1.2.2)
- launchy (2.4.3)
- addressable (~> 2.3)
- listen (2.10.0)
- celluloid (~> 0.16.0)
- rb-fsevent (>= 0.9.3)
- rb-inotify (>= 0.9)
- rb-fsevent (0.9.4)
- rb-inotify (0.9.5)
- ffi (>= 0.5.0)
- rjb (1.4.9)
- rouge (1.8.0)
- slop (4.1.0)
- thread_safe (0.3.5)
- tilt (2.0.1)
- timers (4.0.1)
- hitimes
- webrick (1.3.1)
-
-PLATFORMS
- ruby
- x64-mingw32
-
-DEPENDENCIES
- asciidoctor
- asciidoctor-diagram (~> 1.2.1)
- coderay
- launchy (~> 2.4.3)
- listen (~> 2.7)
- rouge
- slop (~> 4.1.0)
- thread_safe
- tilt
- webrick
diff --git a/adocs/documentation/README.adoc b/adocs/documentation/README.adoc
deleted file mode 100644
index 362bab5..0000000
--- a/adocs/documentation/README.adoc
+++ /dev/null
@@ -1,85 +0,0 @@
-= Apache Isis
-
-ifndef::env-github[]
-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[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.
-endif::env-github[]
-
-This directory contains the source documentation that constitutes both the Apache Isis' documentation (meaning the website and the users' guide, the reference guide and contributors' guide) It is written using http://www.methods.co.nz/asciidoc/[Asciidoc], specifically the link:http://asciidoctor.org/[Asciidoctor] implementation.
-
-The website is created by running build tools (documented below) which create the HTML version of the site and guides.
-You can therefore easily check the documentation before raising a pull request
-
-So, if you want to contribute documentation - either just to fix a typo, or to write a how-to or longer article - then fork the repo, write or modify the the `.adoc` source file, and raise a pull request.
-
-
-== Naming Conventions
-
-For documents with inclusions, use '_' to separate out the logical hierarchy:
-
-[source]
-----
-xxx-xxx/xxx-xxx.adoc
- _xxx-xxx_ppp-ppp.adoc
- _xxx-xxx_qqq-qqq.adoc
- _xxx-xxx_qqq-qqq_mmm-mmm.adoc
- _xxx-xxx_qqq-qqq_nnn-nnn.adoc
-----
-
-Any referenced images should be in subdirectories of the `images` directory:
-
-[source]
-----
-xxx-xxx/images/.
- /ppp-ppp/.
- /qqq-qqq/.
- /mmm-mmm
- /nnn-nnn
-----
-
-And similarly any resources should be in the `resources` subdirectory:
-
-[source]
-----
-xxx-xxx/resources/.
- ppp-ppp/.
- qqq-qqq/.
- /mmm-mmm/
- /nnn-nnn/
-----
-
-
-
-== Build and Review (using Maven)
-
-To (re)build the documentation locally prior to release, use:
-
-[source]
-----
-sh preview-html.sh
-----
-
-The site will be generated at `target/site/index.html`, and then uses Python to start a webserver and a browser pointing at the site.
-
-
-
-
-== Publish procedure
-
-Only Apache Isis committers can publish to link:http://isis.apache.org[isis.apache.org].
-See the link:http://isis.apache.org/guides/cgcom.html#_cg_asciidoc[committers' guide] for details.
-
diff --git a/adocs/documentation/addanchor.groovy b/adocs/documentation/addanchor.groovy
deleted file mode 100644
index e56492a..0000000
--- a/adocs/documentation/addanchor.groovy
+++ /dev/null
@@ -1,63 +0,0 @@
-/*
- * 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.
- */
-
-def cli = new CliBuilder( usage: 'groovy addanchor [-x]')
-cli.x(argName: 'exec', longOpt: 'exec', 'execute (perform changes if any found)')
-
-def options=cli.parse(args)
-
-if(options.x) {
- println("-x (execute) flag specified: will update anchors")
-} else {
- println("-x (execute) flag not specified: no changes will be made")
-}
-
-def currentDir = new File(".");
-
-currentDir.eachFileRecurse { file ->
- if (! (file.canonicalPath =~ /[\\\/]target[\\\/]/) &&
- ! (file.canonicalPath =~ /[\\\/]target-ide[\\\/]/) ) {
-
- def basename = file.name
- def dirname = file.parent
-
- if (basename.endsWith(".adoc") && !dirname.endsWith("\\__")) {
-
- // derive anchor
- def lastIndex = basename.lastIndexOf(".");
- def anchor = basename.substring(0,lastIndex);
-
- def fileText = file.text;
-
- // strip any existing anchor if required
- def hasAnchor = fileText.find("^\\[\\[.+\\]\\]")
- if(hasAnchor != null) {
- def sw = new StringWriter()
- file.filterLine(sw) { ! (it =~ /^\[\[.+\]\]/ ) }
- fileText = sw.toString()
- }
-
- // write out new
- println file.canonicalPath
-
- if(options.x) {
- file.write("[[" + anchor + "]]\n");
- file.append(fileText)
- }
- }
- }
-}
diff --git a/adocs/documentation/check-bookmarks.sh b/adocs/documentation/check-bookmarks.sh
deleted file mode 100644
index 1bed42c..0000000
--- a/adocs/documentation/check-bookmarks.sh
+++ /dev/null
@@ -1,18 +0,0 @@
-
-#root="src/main/asciidoc/guides/cgcom/cgcom.adoc"
-root="src"
-
-for adoc in $(find $root -name "*.adoc" -print) ; do
-
- base_adoc=$(basename $adoc .adoc)
- dir_adoc=$(dirname $adoc)
- #echo "^\[\[_${base_adoc}\]\]$"
-
- for incl in $(grep "^\[\[.*\]\]$" $adoc | grep -v "^\[\[${base_adoc}\]\]$" | grep -v "^\[\[_${base_adoc}\]\]$" | grep -v "^\[\[__" ); do
-
- echo "$adoc : $incl"
-
- done
-
-
-done
diff --git a/adocs/documentation/check-includes.sh b/adocs/documentation/check-includes.sh
deleted file mode 100644
index 0bc1d56..0000000
--- a/adocs/documentation/check-includes.sh
+++ /dev/null
@@ -1,23 +0,0 @@
-
-root="src/main/asciidoc/guides/cgcom/cgcom.adoc"
-root="src"
-
-for adoc in $(find $root -name "*.adoc" -print) ; do
-
- base_adoc=$(basename $adoc .adoc)
- dir_adoc=$(dirname $adoc)
-
- for incl in $(grep "^include::" $adoc ); do
-
- match=$(echo $incl | grep "^include::_$base_adoc" )
- if [ -z "$match" ] ; then
- match2=$(echo $incl | grep "^include::$base_adoc" )
- if [ -z "$match2" ] ; then
- echo "$adoc : $incl"
- fi
- fi
-
- done
-
-
-done
diff --git a/adocs/documentation/edit.sh b/adocs/documentation/edit.sh
deleted file mode 100755
index 3f93b9c..0000000
--- a/adocs/documentation/edit.sh
+++ /dev/null
@@ -1,25 +0,0 @@
-#!/bin/bash
-
-searchTerm="$@"
-edit=gedit
-
-function searchDir {
- files=($1*.adoc)
- if [ -f ${files[0]} ]; then
- loc=`grep -l "$searchTerm" $1*.adoc`
- if [ -n "$loc" ]; then
- echo "Found in $loc"
- $edit $loc
- exit
- fi
- fi
-
- for dir in $1*/
- do
- if [ -d "$dir" ]; then
- searchDir $dir
- fi
- done
-}
-
-searchDir src/main/asciidoc/
diff --git a/adocs/documentation/pom-pdf.xml b/adocs/documentation/pom-pdf.xml
deleted file mode 100644
index df190bc..0000000
--- a/adocs/documentation/pom-pdf.xml
+++ /dev/null
@@ -1,195 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-<!--
- 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.
--->
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <groupId>org.apache</groupId>
- <artifactId>apache</artifactId>
- <version>14</version>
- <relativePath/>
- </parent>
-
- <groupId>org.apache.isis.docs</groupId>
- <artifactId>isis-documentation-pdf</artifactId>
- <version>2.0.0-M2-SNAPSHOT</version>
- <packaging>pom</packaging>
-
- <name>Apache Isis Docs</name>
- <description>
- Apache Isis Website and Documentation, written using Asciidoctor
- </description>
- <url>http://isis.apache.org</url>
-
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-
- <asciidoctor.maven.plugin.version>1.5.6</asciidoctor.maven.plugin.version>
- <asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version>
- <asciidoctorj.version>1.5.6</asciidoctorj.version>
- <asciidoctorj.diagram.version>1.5.4.1</asciidoctorj.diagram.version>
- <incode-asciidoctor-extension-monotree.version>0.0.2</incode-asciidoctor-extension-monotree.version>
- <jruby.version>1.7.26</jruby.version>
-
- <build.dir>${project.basedir}/target/site</build.dir>
-
- <message>updating content (built from adocs/documentation in isis.git repo)</message>
- </properties>
-
- <scm>
- <connection>scm:git:https://github.com/apache/isis.git</connection>
- <developerConnection>scm:git:https://github.com/apache/isis.git</developerConnection>
- <url>https://github.com/apache/isis.git</url>
- <tag>HEAD</tag>
- </scm>
-
- <repositories>
- <repository>
- <id>rubygems-proxy-releases</id>
- <name>RubyGems.org Proxy (Releases)</name>
- <url>http://rubygems-proxy.torquebox.org/releases</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
- </repositories>
-
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <version>${asciidoctor.maven.plugin.version}</version>
- <dependencies>
- <dependency>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctorj-pdf</artifactId>
- <version>${asciidoctorj.pdf.version}</version>
- </dependency>
- <!-- Comment this section to use the default jruby artifact provided by the plugin -->
- <dependency>
- <groupId>org.jruby</groupId>
- <artifactId>jruby-complete</artifactId>
- <version>${jruby.version}</version>
- </dependency>
- <!-- Comment this section to use the default AsciidoctorJ artifact provided by the plugin -->
- <dependency>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctorj</artifactId>
- <version>${asciidoctorj.version}</version>
- </dependency>
- <dependency>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctorj-diagram</artifactId>
- <version>${asciidoctorj.diagram.version}</version>
- </dependency>
- <dependency>
- <groupId>org.incode.asciidoctor.monotree</groupId>
- <artifactId>incode-asciidoctor-extension-monotree</artifactId>
- <version>${incode-asciidoctor-extension-monotree.version}</version>
- </dependency>
- </dependencies>
- <configuration>
- <!-- If you set baseDir to ${project.basedir}, top-level includes are resolved relative to the project root -->
- <!--
- <baseDir>${project.basedir}</baseDir>
- -->
- <!-- Attributes common to all output formats -->
- <attributes>
- <endpoint-url>http://isis.apache.org</endpoint-url>
- <sourcedir>${project.build.sourceDirectory}</sourcedir>
- <project-version>${project.version}</project-version>
- </attributes>
- <requires>
- <require>asciidoctor-diagram</require>
- </requires>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
-
- <profiles>
- <profile>
- <id>pdf</id>
- <activation>
- <property>
- <name>!skip.pdf</name>
- </property>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>generate-pdf-doc</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- <configuration>
- <backend>pdf</backend>
-
- <sourceDirectory>src/main/asciidoc/guides</sourceDirectory>
- <outputDirectory>${project.reporting.outputDirectory}/guides</outputDirectory>
-
- <!-- Since 1.5.0-alpha.9 PDF back-end can use 'rouge' as well as 'coderay'
- for source highlighting -->
- <!-- Due to a known issue on windows, it is recommended to use 'coderay' until an new version of 'rouge' is released.
- see discussions: https://github.com/asciidoctor/asciidoctor-maven-examples/pull/58
- https://github.com/asciidoctor/asciidoctorj-pdf/issues/3
- https://github.com/jneen/rouge/issues/661
- -->
- <sourceHighlighter>coderay</sourceHighlighter>
- <preserveDirectories>true</preserveDirectories>
- <relativeBaseDir>true</relativeBaseDir>
- <doctype>book</doctype>
-
- <attributes>
- <sourcedir>${project.build.sourceDirectory}</sourcedir>
- <imagesdir/>
-
- <pdf-stylesdir>${project.basedir}/src/main/theme</pdf-stylesdir>
- <pdf-style>custom</pdf-style>
-
- <icons>font</icons>
- <pagenums/>
- <toc/>
- <idprefix/>
- <idseparator>-</idseparator>
- </attributes>
-
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
-
- </profiles>
-
-</project>
diff --git a/adocs/documentation/pom.xml b/adocs/documentation/pom.xml
deleted file mode 100644
index 9599ffa..0000000
--- a/adocs/documentation/pom.xml
+++ /dev/null
@@ -1,541 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-<!--
- 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.
--->
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <groupId>org.apache</groupId>
- <artifactId>apache</artifactId>
- <version>14</version>
- <relativePath/>
- </parent>
-
- <groupId>org.apache.isis.docs</groupId>
- <artifactId>isis-documentation</artifactId>
- <version>2.0.0-M2-SNAPSHOT</version>
- <packaging>pom</packaging>
-
- <name>Apache Isis Docs</name>
- <description>
- Apache Isis Website and Documentation, written using Asciidoctor
- </description>
- <url>http://isis.apache.org</url>
-
- <properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-
- <asciidoctor.maven.plugin.version>1.5.6</asciidoctor.maven.plugin.version>
- <asciidoctorj.version>1.5.6</asciidoctorj.version>
- <asciidoctorj.diagram.version>1.5.4.1</asciidoctorj.diagram.version>
- <incode-asciidoctor-extension-monotree.version>0.0.2</incode-asciidoctor-extension-monotree.version>
- <incode-asciidoctor-extension-improvethisdoc.version>0.0.4</incode-asciidoctor-extension-improvethisdoc.version>
-
- <jruby.version>1.7.26</jruby.version>
-
- <build.dir>${project.basedir}/target/site</build.dir>
-
- <!-- expects isis-site to be checked out to /c/github/apache/isis-site, vs /c/github/apache/isis -->
- <isis-site.dir>../../../isis-site</isis-site.dir>
- <isis-site-latest.dir>${isis-site.dir}/latest</isis-site-latest.dir>
- <isis-site-content.dir>${isis-site.dir}/content</isis-site-content.dir>
- <isis-site-search.dir>${isis-site.dir}/search</isis-site-search.dir>
- <message>updating content (built from adocs/documentation in isis.git repo)</message>
- </properties>
-
- <scm>
- <connection>scm:git:https://github.com/apache/isis.git</connection>
- <developerConnection>scm:git:https://github.com/apache/isis.git</developerConnection>
- <url>https://github.com/apache/isis.git</url>
- <tag>HEAD</tag>
- </scm>
-
- <repositories>
- <repository>
- <id>rubygems-proxy-releases</id>
- <name>RubyGems.org Proxy (Releases)</name>
- <url>http://rubygems-proxy.torquebox.org/releases</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
- </repositories>
-
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <version>${asciidoctor.maven.plugin.version}</version>
- <dependencies>
- <!-- Comment this section to use the default jruby artifact provided by the plugin -->
- <dependency>
- <groupId>org.jruby</groupId>
- <artifactId>jruby-complete</artifactId>
- <version>${jruby.version}</version>
- </dependency>
- <!-- Comment this section to use the default AsciidoctorJ artifact provided by the plugin -->
- <dependency>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctorj</artifactId>
- <version>${asciidoctorj.version}</version>
- </dependency>
- <dependency>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctorj-diagram</artifactId>
- <version>${asciidoctorj.diagram.version}</version>
- </dependency>
- <dependency>
- <groupId>org.incode.asciidoctor.monotree</groupId>
- <artifactId>incode-asciidoctor-extension-monotree</artifactId>
- <version>${incode-asciidoctor-extension-monotree.version}</version>
- </dependency>
- <dependency>
- <groupId>org.incode.asciidoctor.improvethisdoc</groupId>
- <artifactId>incode-asciidoctor-extension-improvethisdoc</artifactId>
- <version>${incode-asciidoctor-extension-improvethisdoc.version}</version>
- </dependency>
- </dependencies>
- <configuration>
- <!-- If you set baseDir to ${project.basedir}, top-level includes are resolved relative to the project root -->
- <!--
- <baseDir>${project.basedir}</baseDir>
- -->
- <!-- Attributes common to all output formats -->
- <attributes>
- <endpoint-url>http://isis.apache.org</endpoint-url>
- <sourcedir>${project.build.sourceDirectory}</sourcedir>
- <project-version>${project.version}</project-version>
- </attributes>
- <requires>
- <require>asciidoctor-diagram</require>
- </requires>
- <attributes>
- <!-- Example below shows how to specify in this pom instead of System's PATH,
- the location of dot command of Graphviz, required by PlantUML libraries -->
- <!-- Windows:
- <graphvizdot>C:\Program Files (x86)\Graphviz2.38\bin\dot.exe</graphvizdot>
- -->
- <!-- *nix :
- <graphvizdot>/usr/local/bin/dot</graphvizdot>
- -->
- </attributes>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
-
- <profiles>
- <profile>
- <id>html</id>
- <activation>
- <property>
- <name>!skip.html</name>
- </property>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>output-html</id>
- <phase>compile</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- <configuration>
- <backend>html5</backend>
-
- <sourceDirectory>src/main/asciidoc/</sourceDirectory>
- <outputDirectory>${project.reporting.outputDirectory}/</outputDirectory>
-
- <!--
- <sourceDocumentName>guides/ugvw/ugvw.adoc</sourceDocumentName>
- <sourceDocumentName>guides/rgsvc/rgsvc.adoc</sourceDocumentName>
- -->
-
- <sourceHighlighter>coderay</sourceHighlighter>
- <templateDir>../template</templateDir>
- <eruby>erb</eruby>
- <preserveDirectories>true</preserveDirectories>
- <relativeBaseDir>true</relativeBaseDir>
-
- <attributes>
- <sourcedir>${project.build.sourceDirectory}</sourcedir>
- <imagesdir/>
-
- <toc>right</toc>
- <icons>font</icons>
- <version>${project.version}</version>
-
- <improvethisdoc.rootDir>/adocs/documentation</improvethisdoc.rootDir>
- <improvethisdoc.srcDir>/src/main/asciidoc</improvethisdoc.srcDir>
- <improvethisdoc.organisation>apache</improvethisdoc.organisation>
- <improvethisdoc.repo>isis</improvethisdoc.repo>
- <improvethisdoc.branch>master</improvethisdoc.branch>
- <improvethisdoc.label>Edit</improvethisdoc.label>
- </attributes>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
-
-
- <profile>
- <id>delete</id>
- <activation>
- <property>
- <name>!skip.delete</name>
- </property>
- </activation>
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <version>1.8</version>
- <executions>
- <execution>
- <id>clean</id>
- <phase>clean</phase>
- <configuration>
- <target>
- <echo message=""/>
- <echo message=""/>
- <echo message="deleting everything in ${isis-site-latest.dir}"/>
- <echo message=""/>
- <mkdir
- dir="${isis-site-latest.dir}"/>
- <delete includeemptydirs="true">
- <fileset dir="${isis-site-latest.dir}" includes="**/*"/>
- </delete>
-
- <echo message=""/>
- <echo message=""/>
- <mkdir
- dir="${isis-site-content.dir}/versions/SNAPSHOT"/>
- <echo message="deleting everything in ${isis-site-content.dir}/versions/SNAPSHOT"/>
- <echo message=""/>
- <delete includeemptydirs="true">
- <fileset dir="${isis-site-content.dir}/versions/SNAPSHOT" includes="**/*"/>
- </delete>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="deleting everything in ${isis-site-content.dir} (excluding 'versions' subdir)"/>
- <echo message=""/>
- <delete includeemptydirs="true">
- <fileset dir="${isis-site-content.dir}" includes="**/*" excludes="versions/**"/>
- </delete>
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
-
- <profile>
- <id>copy</id>
- <activation>
- <property>
- <name>!skip.copy</name>
- </property>
- </activation>
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <version>1.8</version>
- <executions>
- <execution>
- <id>package</id>
- <phase>package</phase>
- <configuration>
- <target>
- <echo message=""/>
- <echo message=""/>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="copying all from ${build.dir} to ${isis-site-latest.dir}"/>
- <echo message=""/>
- <copy todir="${isis-site-latest.dir}" overwrite="true" force="true">
- <fileset dir="${build.dir}"/>
- </copy>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="using node to rebuild search index"/>
- <exec executable="node" dir="${isis-site-search.dir}">
- <arg value="--max_old_space_size=2048"/>
- <arg value="_scripts/index.js"/>
- <arg value="../latest/"/>
- <arg value="-o"/>
- <arg value="../latest/elasticlunr/index.json"/>
- <arg value="-V"/>
- </exec>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="converting CRLF to LF for all text files under ${isis-site-latest.dir}"/>
-
- <echo message="... .html files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.html"
- eol="lf"
- eof="remove"
- fixlast="true"/>
-
- <echo message="... .xml files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.xml"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .xsd files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.xsd"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .css files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.css"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .svg files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.svg"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .less files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.less"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .scss files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.scss"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .js files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.js"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .sh files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.sh"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <echo message="... .rdf files"/>
- <fixcrlf srcdir="${isis-site-latest.dir}"
- includes="**/*.rdf"
- eol="lf"
- eof="remove"
- fixlast="false"/>
-
- <!-- for these files, encoding seems to go from UTF8 to ASCII when
- apply fixcrlf, so just copy over again... -->
- <echo message=""/>
- <echo message=""/>
- <echo message="copying over slick CSS and SCSS from ${build.dir} to ${isis-site-latest.dir}"/>
- <echo message=""/>
- <copy todir="${isis-site-latest.dir}" overwrite="true" force="true">
- <fileset dir="${build.dir}" includes="**/css/slick/**/*"/>
- </copy>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="copying all (except index.html) from ${isis-site-latest.dir} to ${isis-site-content.dir}/versions/SNAPSHOT"/>
- <echo message=""/>
- <copy todir="${isis-site-content.dir}/versions/SNAPSHOT" overwrite="true" force="true">
- <fileset dir="${isis-site-latest.dir}" excludes="index.html"/>
- </copy>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="copying the redirect index.html from ${isis-site-content.dir}/versions/current to ${isis-site-content.dir}/versions/SNAPSHOT"/>
- <echo message=""/>
- <copy todir="${isis-site-content.dir}/versions/SNAPSHOT" overwrite="true" force="true">
- <fileset dir="${isis-site-content.dir}/versions/current" includes="index.html"/>
- </copy>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="copying all (except index.html) from ${isis-site-content.dir}/versions/current to ${isis-site-content.dir}"/>
- <echo message=""/>
- <copy todir="${isis-site-content.dir}" overwrite="true" force="true">
- <fileset dir="${isis-site-content.dir}/versions/current" excludes="index.html"/>
- </copy>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="copying index.html from ${isis-site-latest.dir} to ${isis-site-content.dir}"/>
- <echo message=""/>
- <copy todir="${isis-site-content.dir}" overwrite="true" force="true">
- <fileset dir="${isis-site-latest.dir}" includes="index.html"/>
- </copy>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="TO COMPLETE:"/>
- <echo message=""/>
- <echo message=" cd ${isis-site.dir}"/>
- <echo message=" sh preview.sh"/>
- <echo message=" git commit -am 'some message'"/>
- <echo message=" git push"/>
- <echo message=""/>
- <echo message=""/>
-
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
-
- <profile>
- <id>reindex</id>
- <activation>
- <property>
- <name>reindex</name>
- </property>
- </activation>
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <version>1.8</version>
- <executions>
- <execution>
- <id>compile</id>
- <phase>compile</phase>
- <configuration>
- <target>
- <echo message=""/>
- <echo message=""/>
- <echo message="using node to rebuild search index"/>
- <exec executable="node" dir=".">
- <arg value="--max_old_space_size=2048"/>
- <arg value="${isis-site-search.dir}/_scripts/index.js"/>
- <arg value="target/site"/>
- <arg value="-o"/>
- <arg value="target/site/elasticlunr/index.json"/>
- <arg value="-V"/>
- </exec>
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
-
- <profile>
- <id>commit</id>
- <activation>
- <property>
- <name>!skip.commit</name>
- </property>
- </activation>
- <build>
- <plugins>
-<!--
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <version>1.8</version>
- <executions>
- <execution>
- <id>install</id>
- <phase>install</phase>
- <configuration>
- <target>
- <echo message=""/>
- <echo message=""/>
- <echo message="git commit -m '${message}' "/>
- <echo message=""/>
- <exec executable="git" dir="${isis-site-latest.dir}">
- <arg value="commit"/>
- <arg value="-m"/>
- <arg value="${message}"/>
- </exec>
-
- <echo message=""/>
- <echo message=""/>
- <echo message="git reset --hard"/>
- <echo message=""/>
- <exec executable="git" dir="${isis-site-latest.dir}">
- <arg value="reset"/>
- <arg value="--hard"/>
- </exec>
- <echo message=""/>
- </target>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- -->
- </plugins>
- </build>
- </profile>
-
- </profiles>
-
-</project>
diff --git a/adocs/documentation/preview-html.sh b/adocs/documentation/preview-html.sh
deleted file mode 100644
index 3926261..0000000
--- a/adocs/documentation/preview-html.sh
+++ /dev/null
@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-mvn compile $* && python -m webbrowser -t http://localhost:4000 && pushd target/site && python -m http.server 4000 && popd
-#mvn compile -Dreindex -o && python -m webbrowser -t http://localhost:4000 && pushd target/site && python -m http.server 4000 && popd
-
-#mvn compile -o && python -m webbrowser -t http://localhost:4000/guides/ugvw/ugvw.html && pushd target/site && python -m http.server 4000 && popd
-#mvn compile -o -Dreindex && python -m webbrowser -t http://localhost:4000/guides/ugvw/ugvw.html && pushd target/site && python -m http.server 4000 && popd
diff --git a/adocs/documentation/preview-pdf.sh b/adocs/documentation/preview-pdf.sh
deleted file mode 100644
index 69edafa..0000000
--- a/adocs/documentation/preview-pdf.sh
+++ /dev/null
@@ -1,2 +0,0 @@
-#!/usr/bin/env bash
-mvn compile -f pom-pdf.xml && mvn compile -o && python -m webbrowser -t http://localhost:4000 && pushd target/site && python -m http.server 4000 && popd
diff --git a/adocs/documentation/publish.sh b/adocs/documentation/publish.sh
deleted file mode 100644
index 62970ed..0000000
--- a/adocs/documentation/publish.sh
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-if [ "$1" = "" ]; then
- MSG=`git log -1 --pretty=%B`
-else
- MSG=$1
-fi
-echo $MSG
-mvn clean
-mvn install -f pom-pdf.xml -D message="$MSG"
-mvn install -D message="$MSG"
diff --git a/adocs/documentation/src/main/asciidoc/index.html b/adocs/documentation/src/main/asciidoc/index.html
deleted file mode 100644
index 01b4f8b..0000000
--- a/adocs/documentation/src/main/asciidoc/index.html
+++ /dev/null
@@ -1,808 +0,0 @@
-<!doctype html>
-<html>
-<head>
- <!--
-
- 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.
-
- -->
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <!-- No caching headers -->
- <meta http-equiv="cache-control" content="no-cache">
- <meta http-equiv="pragma" content="no-cache">
- <meta http-equiv="expires" content="-1">
- <title>Apache Isis</title>
- <link rel="icon" type="image/png" href="./images/isis-favicon.png">
- <!--
- Based on DataNucleus' template,
- that was in turn based on an earlier version of Apache Isis' template,
- that was in turn based on Apache Deltaspike's template.
-
- This template uses
- * Bootstrap v3.3.7 (https://getbootstrap.com/) for navbar.
- * Bootstrap TOC plugin v0.4.1 (https://afeld.github.io/bootstrap-toc/)
- for the table of contents.
- * jQuery (necessary for Bootstrap's JavaScript plugins)
- * Font-Awesome for some icons used by Asciidoctor
-
- Also:
- * Bootswatch "flatly" theme for Bootstrap (https://bootswatch.com/flatly).
- * slick.js (carousel)
- * add a link to all headers (home-grown, adapted from blog posts)
- * integration of elasticlunr.js (home-grown, adapted from blog posts)
- -->
- <link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet">
- <link href="./css/bootstrap-toc/0.4.1/bootstrap-toc.min.css" rel="stylesheet">
- <link href="./css/asciidoctor/foundation.css" rel="stylesheet">
- <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.3.0/css/font-awesome.min.css" rel="stylesheet">
-
- <link href="css/slick/1.5.0/slick.css" rel="stylesheet">
- <link href="css/slick/1.5.0/slick-theme.css" rel="stylesheet">
-
- <link href="./css/search-panel/search-panel.css" rel="stylesheet">
- <link href="./css/header-links/header-links.css" rel="stylesheet">
- <link href="./css/customisations.css" rel="stylesheet">
- <!-- Coderay syntax formatter -->
- <style type="text/css">
-
- /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
-/*pre.CodeRay {background-color:#f7f7f8;}*/
-.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
-.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
-.CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
-table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
-table.CodeRay td{vertical-align: top;line-height:1.45}
-table.CodeRay td.line-numbers{text-align:right}
-table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
-table.CodeRay td.code{padding:0 0 0 .5em}
-table.CodeRay td.code>pre{padding:0}
-.CodeRay .debug{color:#fff !important;background:#000080 !important}
-.CodeRay .annotation{color:#007}
-.CodeRay .attribute-name{color:#000080}
-.CodeRay .attribute-value{color:#700}
-.CodeRay .binary{color:#509}
-.CodeRay .comment{color:#998;font-style:italic}
-.CodeRay .char{color:#04d}
-.CodeRay .char .content{color:#04d}
-.CodeRay .char .delimiter{color:#039}
-.CodeRay .class{color:#458;font-weight:bold}
-.CodeRay .complex{color:#a08}
-.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
-.CodeRay .color{color:#099}
-.CodeRay .class-variable{color:#369}
-.CodeRay .decorator{color:#b0b}
-.CodeRay .definition{color:#099}
-.CodeRay .delimiter{color:#000}
-.CodeRay .doc{color:#970}
-.CodeRay .doctype{color:#34b}
-.CodeRay .doc-string{color:#d42}
-.CodeRay .escape{color:#666}
-.CodeRay .entity{color:#800}
-.CodeRay .error{color:#808}
-.CodeRay .exception{color:inherit}
-.CodeRay .filename{color:#099}
-.CodeRay .function{color:#900;font-weight:bold}
-.CodeRay .global-variable{color:#008080}
-.CodeRay .hex{color:#058}
-.CodeRay .integer,.CodeRay .float{color:#099}
-.CodeRay .include{color:#555}
-.CodeRay .inline{color:#000}
-.CodeRay .inline .inline{background:#ccc}
-.CodeRay .inline .inline .inline{background:#bbb}
-.CodeRay .inline .inline-delimiter{color:#d14}
-.CodeRay .inline-delimiter{color:#d14}
-.CodeRay .important{color:#555;font-weight:bold}
-.CodeRay .interpreted{color:#b2b}
-.CodeRay .instance-variable{color:#008080}
-.CodeRay .label{color:#970}
-.CodeRay .local-variable{color:#963}
-.CodeRay .octal{color:#40e}
-.CodeRay .predefined{color:#369}
-.CodeRay .preprocessor{color:#579}
-.CodeRay .pseudo-class{color:#555}
-.CodeRay .directive{font-weight:bold}
-.CodeRay .type{font-weight:bold}
-.CodeRay .predefined-type{color:inherit}
-.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
-.CodeRay .key{color:#808}
-.CodeRay .key .delimiter{color:#606}
-.CodeRay .key .char{color:#80f}
-.CodeRay .value{color:#088}
-.CodeRay .regexp .delimiter{color:#808}
-.CodeRay .regexp .content{color:#808}
-.CodeRay .regexp .modifier{color:#808}
-.CodeRay .regexp .char{color:#d14}
-.CodeRay .regexp .function{color:#404;font-weight:bold}
-.CodeRay .string{color:#d20}
-.CodeRay .string .string .string{background:#ffd0d0}
-.CodeRay .string .content{color:#d14}
-.CodeRay .string .char{color:#d14}
-.CodeRay .string .delimiter{color:#d14}
-.CodeRay .shell{color:#d14}
-.CodeRay .shell .delimiter{color:#d14}
-.CodeRay .symbol{color:#990073}
-.CodeRay .symbol .content{color:#a60}
-.CodeRay .symbol .delimiter{color:#630}
-.CodeRay .tag{color:#008080}
-.CodeRay .tag-special{color:#d70}
-.CodeRay .variable{color:#036}
-.CodeRay .insert{background:#afa}
-.CodeRay .delete{background:#faa}
-.CodeRay .change{color:#aaf;background:#007}
-.CodeRay .head{color:#f8f;background:#505}
-.CodeRay .insert .insert{color:#080}
-.CodeRay .delete .delete{color:#800}
-.CodeRay .change .change{color:#66f}
-.CodeRay .head .head{color:#f4f}
-
- </style>
-</head>
-<body data-spy="scroll" data-target="#toc">
-<div id="basedir" style="display:none;">
- ./
-</div>
-<div id="docname" style="display:none;">
- index
-</div>
-<div id="filetype" style="display:none;">
- html
-</div>
-<!-- Navbar -->
-<nav class="navbar navbar-default navbar-fixed-top">
- <div class="container">
- <div class="navbar-header">
- <!-- Three line menu button for use on mobile screens -->
- <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>
- <a class="navbar-brand" href="./index.html"> <img alt="Brand" src="./images/isis-logo-48x48.png"> </a>
- <a class="navbar-brand" href="./index.html">Apache Isis</a>
- </div>
- <!-- Navbar that will collapse on mobile screens -->
- <div id="navbar" class="navbar-collapse collapse">
- <ul class="nav navbar-nav">
- <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Documentation<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li><a href="./documentation.html">Table of Contents</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">User Guides</li>
- <li><a href="./guides/ugfun/ugfun.html">Fundamentals</a></li>
- <li><a href="./guides/ugvw/ugvw.html">Wicket Viewer</a></li>
- <li><a href="./guides/ugvro/ugvro.html">Restful Objects Viewer</a></li>
- <li><a href="./guides/ugodn/ugodn.html">DataNucleus Object Store</a></li>
- <li><a href="./guides/ugsec/ugsec.html">Security</a></li>
- <li><a href="./guides/ugtst/ugtst.html">Testing</a></li>
- <li><a href="./guides/ugbtb/ugbtb.html">Beyond the Basics</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Reference Guides</li>
- <li><a href="./guides/rgant/rgant.html">Annotations</a></li>
- <li><a href="./guides/rgsvc/rgsvc.html">Domain Services</a></li>
- <li><a href="./guides/rgcfg/rgcfg.html">Core Config' Properties</a></li>
- <li><a href="./guides/rgcms/rgcms.html">Classes, Methods and Schema</a></li>
- <li><a href="./guides/rgmvn/rgmvn.html">Maven plugin</a></li>
- <li><a href="./guides/rgfis/rgfis.html">Framework Internal Services</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Javadoc</li>
- <li><a href="http://javadoc.io/doc/org.apache.isis.core/isis-core-applib">Applib</a></li>
- </ul> </li>
- <li class="dropdown hidden-sm hidden-md"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Downloads<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li class="dropdown-header">Maven archetypes</li>
- <li><a href="guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype">helloworld</a></li>
- <li><a href="guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype">simpleapp</a></li>
- <li role="separator" class="divider"></li>
- <li><a href="downloads.html">Downloads</a></li>
- <li><a href="release-notes/release-notes.html">Release Notes</a></li>
- <li><a href="migration-notes/migration-notes.html">Migration Notes</a></li>
- <li role="separator" class="divider"></li>
- <li><a href="https://github.com/apache/isis">Github mirror</a></li>
- </ul> </li>
- <li class="dropdown hidden-sm"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Support<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Guides</li>
- <li><a href="guides/dg/dg.html">Developers' Guide</a></li>
- <li><a href="guides/cgcom/cgcom.html">Committers' Guide</a></li>
- <li><a href="guides/htg.html">Hints-n-Tips Guide</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Mailing Lists</li>
- <li><a href="support.html">How to subscribe</a></li>
- <li><a href="https://lists.apache.org/list.html?users@isis.apache.org">Archives (ASF Pony mail)</a></li>
- <li><a href="http://isis.markmail.org/search/?q=">Archives (Markmail)</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Other Resources</li>
- <li><a href="https://issues.apache.org/jira/browse/ISIS">ASF JIRA</a></li>
- <li><a href="http://stackoverflow.com/questions/tagged/isis">Stack Overflow</a></li>
- <li><a href="help.html">Wiki, Fisheye etc</a></li>
- </ul> </li>
- <li class="dropdown hidden-sm hidden-md"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">@ASF<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li><a href="http://www.apache.org/">Apache Homepage</a></li>
- <li><a href="https://www.apache.org/events/current-event">Events</a></li>
- <li><a href="https://www.apache.org/licenses/">Licenses</a></li>
- <li><a href="https://www.apache.org/security/">Security</a></li>
- <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
- <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
- <li role="separator" class="divider"></li>
- <li><a href="https://whimsy.apache.org/board/minutes/Isis.html">PMC board minutes</a></li>
- </ul> </li>
- </ul>
- <div class="nav navbar-nav navbar-right">
- <!-- 'style' added to fix height of input box. FIX THIS -->
- <form class="navbar-form" role="search" id="search-form" style="padding: 1px 15px;">
- <div class="form-group">
- <input class="form-control" id="search-field" type="text" size="30" placeholder="Search">
- </div>
- </form>
- </div>
- <ul class="nav navbar-nav navbar-right">
- <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Versions<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li><a href="documentation.html">1.17.0 (current)</a></li>
- <!--
- <li role="separator" class="divider"></li>
- <li><a href="versions/SNAPSHOT/documentation.html">2.0.0-M2-SNAPSHOT</a></li>
- -->
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">2.0.0 Milestones</li>
- <li><a href="versions/2.0.0-M2/documentation.html">2.0.0-M2</a></li>
- <li><a href="versions/2.0.0-M1/documentation.html">2.0.0-M1</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Archive</li>
- <li><a href="versions/1.17.0/documentation.html">1.17.0</a></li>
- <li><a href="versions/1.16.2/documentation.html">1.16.2</a></li>
- <li><a href="versions/1.16.1/documentation.html">1.16.1</a></li>
- <li><a href="versions/1.16.0/documentation.html">1.16.0</a></li>
- <li><a href="versions/1.15.1/documentation.html">1.15.1</a></li>
- <li><a href="versions/1.15.0/documentation.html">1.15.0</a></li>
- <li><a href="versions/1.14.0/documentation.html">1.14.0</a></li>
- <li><a href="versions/1.13.2.1/documentation.html">1.13.2.1</a></li>
- <li><a href="versions/1.13.2/documentation.html">1.13.2</a></li>
- <li><a href="versions/1.13.1/documentation.html">1.13.1</a></li>
- <li><a href="versions/1.13.0/documentation.html">1.13.0</a></li>
- <li><a href="versions/1.12.2/documentation.html">1.12.2</a></li>
- <li><a href="versions/1.12.1/documentation.html">1.12.1</a></li>
- <li><a href="versions/1.12.0/documentation.html">1.12.0</a></li>
- <li><a href="versions/1.11.1/documentation.html">1.11.1</a></li>
- <li><a href="versions/1.11.0/documentation.html">1.11.0</a></li>
- </ul> </li>
- </ul>
- </div>
- </div>
-</nav>
-<div class="container">
- <div class="row">
- <div class="col-sm-12">
- <div id="search-panel">
- <div id="search-results"></div>
- <div>
- <br>
- <a href="#" id="search-results-clear">clear</a>
- </div>
- </div>
- </div>
- </div>
- <div class="row">
- <div class="col-sm-12">
- <div id="doc-content">
-
- <div class="row">
- <div class="col-sm-12">
-
- <div class="panel radius">
-
- <div class="row">
- <div class="hidden-xs hidden-sm hidden-md col-lg-6">
- <img class="logo" src="images/isis-logo-568x286.png" alt="Apache Isis"/>
-
- <div class="description">
- <h3 class="legend">Domain Driven Applications, Quickly</h3>
- <p>Apache Isis™ is a framework for rapidly developing domain-driven apps in Java. Write your business logic in entities, domain services or view models, and the framework dynamically generates a representation of that domain model as a webapp or a rich hypermedia REST API.</p>
-
- <p><a class="button btn btn-primary btn-md learn-more" href="documentation.html" role="button">Learn more »</a></p>
- </div>
-
- </div>
- <div class="hidden-xs hidden-sm hidden-md col-lg-1">
-
- </div>
- <div class="col-sm-12 col-md-12 col-lg-4">
-
- <div class="quote-carousel">
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis' philosophy is awesome - it drives you to focus on the domain model and encourages you to practice Behavior Driven Development. In addition, it brings the team together, sets the common platform and provides the right set of tools to work collaboratively which is simply great for the software development. It's a fabulously fantastic framework! A big thank you to the Apache Isis team.</p>
- <small>Mansingh Shitole, Senior Developer, PRIME Research, Germany - Frankfurt / Mainz</small>
-
- </div>
- </div>
- </blockquote>
- </div>
-
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis enabled us to concentrate on modelling the domain and getting the UI and REST Interface with nearly no effort so we could build a fast and reliable application. Now we've started using it for the second project and I'm still very impressed by the framework and the community behind it.</p>
- <small>Timothy Simecsek, NTT DATA Österreich GmbH</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>We'd been looking for a RAD-tool for building our app; after trying different tools, Apache Isis gave us the most confidence for getting the job done. It's really remarkable how easy it is to use, while contributors and users on the Isis' active mailing list are ready to help on more advanced topics.</p>
- <small>Erik de Hair, pocos.nl</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>A fantastic framework! With Apache Isis we can prototype a deployable application in minutes rather than days.</p>
- <small>Jeremy Branham</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>With its automatic UI and REST web services generation, Apache Isis kept our developers amazed and happy. Having had strenuous experiences with architecture and infrastructure concerns differing from project to project, it's like having back the fun in software development</p>
- <small>Willie Loyd Tandingan</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis' focus on the business domain improves communication between our end-users, architects and developers. Having a better application in a fraction of the time and cost is something we highly appreciate.</p>
- <small>Cesar Lugo</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>I like the guidance Apache Isis gives me for structuring code along the lines of Domain Driven Design. My first web application in plain Java without writing a single line of DDL or HTML/*Script.</p>
- <small>Joerg Rade</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>The Apache Isis team is very supportive. They even added new functionality for Summernote when I needed a WYSIWYG editor in my prototype project.</p>
- <small>Marianne Hagaseth</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>What interests me most about Apache Isis is its goal of making both developers and users co-owners of their domain models. Apache Isis will be of interest to businesses who see their custom software as a strategic investment. It's not trying to be all things to all people, but it has depth and also, I predict, a bright future.</p>
- <small>Steve Cameron</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>As students most of us prefer sticking with business logic than spending much time with UX enhancements. Apache Isis provides a great platform to create a perfectly working prototypes with loads of inbuilt UX concerns and customizations without worrying a single bit on the GUI perspective.
- And I must say this: "Great Support from the development team"</p>
- <small>Vishma Dias, University of Moratuwa, Sri Lanka.</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis has allowed us to be focused on the Domain instead of infrastructure issues. The extensive metamodel let us further automate and enhance our custom viewer and integrate with external frameworks. </p>
- <small>Nacho Canovas</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Support from the Apache Isis community is excellent. I sense a love and dedication that is inspiring.</p>
- <small>Johan Doornenbal</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis provided us with a great starting point for our app; we simply took the todoapp archetype and used it as a template to help set up our integration tests and BDD specs. We were productive almost immediately</p>
- <small>Vladimir Nisevic, A1 Telekom Austria</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis enabled us to focus on the problem domain and data quality and - because the UI was generated for us by the framework - not get distracted by UI concerns. Identified security issues were quickly addressed by the Apache Isis committers.</p>
- <small>Architect</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>We use Apache Isis because of its simple and fast user interface generation.</p>
- <small>Andreas Lechner</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis is an easy to learn, efficient and productive RAD platform. Further I can say it is evolving to be
- "the best RAD platform" without any exaggerations. The help from the community is simply wonderful.</p>
- <small>Theekshana Dilshan, Computer Science and Engineering, University of Moratuwa, Sri Lanka.</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>Apache Isis is one of the best tools for hackathons. Given a 2 day hackathon challenge I have the perfect framework to create my prototype helping me to focus on business logic.</p>
- <small>Sunand Padmanabhan</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- <div>
- <blockquote>
- <div class="row">
- <div class="col-sm-12">
- <p>From a Sprint retrospective, the criticism of one lead developer sounded more like praise:</p>
- <p>"The problem is that if we show this to the customer they will think that all the work is done."</p>
- <small>provided by Ged Byrne</small>
- </div>
- </div>
- </blockquote>
- </div>
-
- </div>
-
- <div>
- <p align="center">
- <i>
- hover to stop scrolling; click arrows to resume
- <br/><a href="quotes.html" target="_blank">view all quotes</a>
- </i>
- </p>
- </div>
- </div>
- <div class="hidden-xs hidden-sm hidden-md col-lg-1">
-
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-12 hidden-lg">
- <div class="description">
- <h3 class="legend">Domain Driven Applications, Quickly</h3>
- <p>Apache Isis™ is a framework for rapidly developing domain-driven apps in Java. Write your business logic in entities, domain services or view models, and the framework dynamically generates a representation of that domain model as a webapp or a rich hypermedia REST API.</p>
-
- <p><a class="button btn btn-primary btn-md learn-more" href="documentation.html" role="button">Learn more »</a></p>
- </div>
- </div>
- </div>
- </div>
-
-
-
- <div class="container">
- <div class="row">
- <div class="col-sm-12 col-md-4 col-lg-4">
- <h2>UI & REST "for free"</h2>
- <p>Apache Isis dynamically builds both a generic UI and also a rich hypermedia REST API directly from the underlying domain objects.
- This makes for extremely rapid prototyping and a short feedback cycle, perfect for agile development.
- The UI can also be extended for specific use cases, and can be themed using <a href="http://getbootstrap.com">Bootstrap</a>.</p>
- <p><a class="button small info radius" href="pages/isis-in-pictures/isis-in-pictures.html" role="button">See Apache Isis in action »</a></p>
- </div>
- <div class="col-sm-12 col-md-4 col-lg-4">
- <h2>Domain-Driven</h2>
- <p>The core of an Apache Isis application are the domain objects, either persisted entities or view models.
- Business rules can be associated directly with domain objects, or can be factored out into separate
- services. Apache Isis performs dependency injection everywhere to ensure that the application remains decoupled.</p>
- <p><a class="button small info radius" href="documentation.html" role="button">Read the docs »</a></p>
- </div>
- <div class="col-sm-12 col-md-4 col-lg-4">
- <h2>Add-ons <small>(non ASF)</small></h2>
- <p>Apache Isis has a large number of github-hosted add-on modules for security, auditing, command profiling,
- mail merge and other cross-cutting concerns. It also has a number of UI extensions for maps, calendars etc.
- as well as a catalog of generic subdomains such as documents, communications, notes and tasks. All are open source and
- designed for out-of-the-box use or to fork as you require.</p>
- <p>Check out <a class="button small info radius" href="http://www.isisaddons.org" role="button">the add-ons »</a> and <a class="button small info radius" href="http://catalog.incode.org" role="button">the catalog »</a></p>
- </div>
- </div>
-
- <br/>
-
- <div class="row">
- <div class="col-sm-12">
- <h4>A typical application built with Apache Isis</h4>
- <br/>
- <p>Like all Apache Isis apps, the UI is dynamically built from the domain model. The screenshot below
- shows a demo "todoapp" (source code available on <a href="http://github.com/isisaddons/isis-app-todoapp">github</a>)</p>
-
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-offset-1 col-sm-10">
- <a href="images/todoapp/todoitem.png"><img src="images/todoapp/todoitem.png"
- style="padding: 2px;border: 1px solid #021a40;"
- /></a>
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-12">
- <br/>
- <br/>
- <p>The above screenshot shows the <code>ToDoItem</code> entity. An (optional) XML layout file provides metadata dividing the object members into rows, columns and tabs. Apache Isis also supports view models as well as entities, so you can also create dashboards, home pages and similar:</p>
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-offset-1 col-sm-10 ">
- <a href="images/todoapp/dashboard.png"><img src="images/todoapp/dashboard.png" style="padding: 2px;border: 1px solid #021a40;" /></a>
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-12">
- <br/>
- <br/>
- <p>Apache Isis also provides a rich REST API with a full set of hypermedia controls. The framework provides two default representations, pluggable for other representations. The framework also automatically generates a Swagger spec to allow REST clients to be code-generated, and (for developers) exposes the REST API through the Swagger UI:</p>
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-offset-1 col-sm-10">
- <a href="images/todoapp/swagger-ui.png"><img src="images/todoapp/swagger-ui.png" style="padding: 2px;border: 1px solid #021a40;" /></a>
- </div>
- </div>
-
- <div class="row">
- <div class="col-sm-12">
- <h4>Getting started</h4>
- <br/>
- <p>Start developing your own Apache Isis application using either the minimal <a href="guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype">helloworld archetype</a> or alternatively with the more structured <a href="guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype">simpleapp archetype</a>.
- </p>
- </div>
- </div>
- <div class="row">
- <div class="col-sm-12">
- To use the current production 1.x version (from a *nix bash shell):
- <br/>
- <br/>
- </div>
- </div>
- <div class="row">
- <div class="col-sm-5">
- <div class=panel>
- <pre>
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=helloworld-archetype \
- -D archetypeVersion=1.17.0 \
- -D groupId=com.mycompany \
- -D artifactId=myapp \
- -D version=1.0-SNAPSHOT \
- -B</pre>
- </div>
- </div>
- <div class="col-sm-1">
- <p>or</p>
- </div>
- <div class="col-sm-5">
- <div class=panel>
- <pre>
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=1.17.0 \
- -D groupId=com.mycompany \
- -D artifactId=myapp \
- -D version=1.0-SNAPSHOT \
- -B</pre>
- </div>
- </div>
- <div class="col-sm-1">
- </div>
- </div>
- <div class="row">
- <div class="col-sm-12">
- To use the beta 2.x milestone release, use:
- <br/>
- <br/>
- </div>
- </div>
- <div class="row">
- <div class="col-sm-5">
- <div class=panel>
- <pre>
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=helloworld-archetype \
- -D archetypeVersion=2.0.0-M2 \
- -D groupId=com.mycompany \
- -D artifactId=myapp \
- -D version=1.0-SNAPSHOT \
- -B</pre>
- </div>
- </div>
- <div class="col-sm-1">
- <p>or</p>
- </div>
- <div class="col-sm-5">
- <div class=panel>
- <pre>
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=2.0.0-M2 \
- -D groupId=com.mycompany \
- -D artifactId=myapp \
- -D version=1.0-SNAPSHOT \
- -B</pre>
- </div>
- </div>
- <div class="col-sm-1">
- </div>
- </div>
- <div class="row">
- <div class="col-sm-12">
- <p>Adjust as necessary if using Windows.</p>
- </div>
- </div>
-
- <br/>
-
- <div class="row">
- <div class="col-sm-12">
- <h4>Tutorial</h4>
- <br/>
- <p>... and this short tutorial should give you an idea as to how Apache Isis dynamically builds the UI:</p>
- </div>
- </div>
-
- <div class="row panel">
-
- <div class="col-sm-1">
-
- </div>
- <div class="col-sm-10">
-
- <div class="tutorial-carousel">
-
- <div>
- <img src="images/index-screenshots/010-sign-in.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/020-object-layout.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/030-declarative-business-rules.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/040-imperative-business-rules.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/050-action-with-args.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/060-action-with-args-autocomplete.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/070-jdo.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/080-rest-api.png"/>
- </div>
- <div>
- <img src="images/index-screenshots/090-integtesting.png"/>
- </div>
- </div>
- <div>
- <p align="center"><i>hover to stop scrolling; click arrows to resume</i></p>
- </div>
- </div>
- <div class="col-sm-1">
-
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
-</div>
-<footer class="footer">
- <div class="container">
- <p class="text-center small text-muted"> Copyright © 2010~2018 The Apache Software Foundation, licensed under the Apache License, v2.0. <br> Apache, the Apache feather logo, Apache Isis, and the Apache Isis project logo are all trademarks of The Apache Software Foundation. </p>
- </div>
-</footer>
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
-<script src="./js/bootstrap/3.3.7/bootstrap.min.js"></script>
-<script src="./js/bootstrap-toc/0.4.1/bootstrap-toc.min.js"></script>
-<script src="./js/slick/1.5.0/slick.min.js"></script>
-<script src="./js/elasticlunr/elasticlunr.min.js"></script>
-<script src="./js/search-panel/search-panel.js"></script>
-<script src="./js/header-link/header-link.js"></script>
-<script src="./js/toc-scroll/toc-scroll.js"></script>
-
-<script src="./js/slick-carousel-wiring.js"></script>
-
-</body>
-</html>
diff --git a/adocs/template/document.html.erb b/adocs/template/document.html.erb
deleted file mode 100644
index ea1c8b8..0000000
--- a/adocs/template/document.html.erb
+++ /dev/null
@@ -1,285 +0,0 @@
-<%#encoding:UTF-8%><!DOCTYPE html>
-<head>
- <!--
- 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.
- -->
-
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <!-- No caching headers -->
- <meta http-equiv="cache-control" content="no-cache"/>
- <meta http-equiv="pragma" content="no-cache"/>
- <meta http-equiv="expires" content="-1"/>
-
- <title><%= document.name %></title>
-
- <link rel="icon" type="image/png" href="<%= (attr :_basedir) %>images/isis-favicon.png"/>
-
- <!--
- Based on DataNucleus' template,
- that was in turn based on an earlier version of Apache Isis' template,
- that was in turn based on Apache Deltaspike's template.
-
- This template uses
- * Bootstrap v3.3.7 (https://getbootstrap.com/) for navbar.
- * Bootstrap TOC plugin v0.4.1 (https://afeld.github.io/bootstrap-toc/)
- for the table of contents.
- * jQuery (necessary for Bootstrap's JavaScript plugins)
- * Font-Awesome for some icons used by Asciidoctor
-
- Also:
- * Bootswatch "flatly" theme for Bootstrap (https://bootswatch.com/flatly).
- * slick.js (carousel)
- * add a link to all headers (home-grown, adapted from blog posts)
- * integration of elasticlunr.js (home-grown, adapted from blog posts)
- -->
- <link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet">
- <link href="<%= (attr :_basedir) %>css/bootstrap-toc/0.4.1/bootstrap-toc.min.css" rel="stylesheet"/>
-
- <link href="<%= (attr :_basedir) %>css/asciidoctor/foundation.css" rel="stylesheet"/>
-
- <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.3.0/css/font-awesome.min.css" rel="stylesheet">
-
- <%
- def is_toc?
- not (attributes.has_key?('notoc'))
- end
- def is_pdf?
- attributes.has_key?('generate_pdf')
- end
- %>
-
- <link href="<%= (attr :_basedir) %>css/slick/1.5.0/slick.css" rel="stylesheet">
- <link href="<%= (attr :_basedir) %>css/slick/1.5.0/slick-theme.css" rel="stylesheet">
-
- <link href="<%= (attr :_basedir) %>css/search-panel/search-panel.css" rel="stylesheet"/>
- <link href="<%= (attr :_basedir) %>css/header-links/header-links.css" rel="stylesheet"/>
- <link href="<%= (attr :_basedir) %>css/sticky-header/sticky-header.css" rel="stylesheet"/>
- <link href="<%= (attr :_basedir) %>css/customisations.css" rel="stylesheet"/>
-
- <!-- Coderay syntax formatter -->
- <style type="text/css">
- <%= ::Asciidoctor::Stylesheets.instance.coderay_stylesheet_data %>
- </style>
-</head>
-
-<body data-spy="scroll" data-target="#toc">
-
-<div id="basedir" style="display:none;"><%= (attr :_basedir) %></div>
-<div id="docname" style="display:none;"><%= (attr :docname) %></div>
-<div id="filetype" style="display:none;"><%= (attr :filetype) %></div>
-
-<!-- Navbar -->
-<nav class="navbar navbar-default navbar-static-top header">
- <div class="container">
- <div class="navbar-header">
- <!-- Three line menu button for use on mobile screens -->
- <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a class="navbar-brand" href="<%= (attr :_basedir) %>index.html">
- <img alt="Brand" src="<%= (attr :_basedir) %>images/isis-logo-48x48.png"/>
- </a>
-
- <a class="navbar-brand" href="<%= (attr :_basedir) %>index.html">Apache Isis</a>
-
- </div>
-
- <!-- Navbar that will collapse on mobile screens -->
- <div id="navbar" class="navbar-collapse collapse">
- <ul class="nav navbar-nav">
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Documentation<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li><a href="<%= (attr :_basedir) %>documentation.html">Table of Contents</a></li>
-
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">User Guides</li>
- <li><a href="<%= (attr :_basedir) %>guides/ugfun/ugfun.html">Fundamentals</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugvw/ugvw.html">Wicket Viewer</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugvro/ugvro.html">Restful Objects Viewer</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugodn/ugodn.html">DataNucleus Object Store</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugsec/ugsec.html">Security</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugtst/ugtst.html">Testing</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugbtb/ugbtb.html">Beyond the Basics</a></li>
-
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Reference Guides</li>
- <li><a href="<%= (attr :_basedir) %>guides/rgant/rgant.html">Annotations</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/rgsvc/rgsvc.html">Domain Services</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/rgcfg/rgcfg.html">Core Config' Properties</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/rgcms/rgcms.html">Classes, Methods and Schema</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/rgmvn/rgmvn.html">Maven plugin</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/rgfis/rgfis.html">Framework Internal Services</a></li>
-
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Javadoc</li>
- <li><a href="http://javadoc.io/doc/org.apache.isis.core/isis-core-applib">Applib</a></li>
-
- </ul>
- </li>
-
- <li class="dropdown hidden-sm hidden-md">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Downloads<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li class="dropdown-header">Maven archetypes</li>
- <li><a href="<%= (attr :_basedir) %>guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype">helloworld</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype">simpleapp</a></li>
-
- <li role="separator" class="divider"></li>
- <li><a href="<%= (attr :_basedir) %>downloads.html">Downloads</a></li>
- <li><a href="<%= (attr :_basedir) %>release-notes/release-notes.html">Release Notes</a></li>
- <li><a href="<%= (attr :_basedir) %>migration-notes/migration-notes.html">Migration Notes</a></li>
-
- <li role="separator" class="divider"></li>
- <li><a href="https://github.com/apache/isis">Github mirror</a></li>
- </ul>
- </li>
-
- <li class="dropdown hidden-sm">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Support<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li class="dropdown-header">Guides</li>
- <li><a href="<%= (attr :_basedir) %>guides/dg/dg.html">Developers' Guide</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/cgcom/cgcom.html">Committers' Guide</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/htg.html">Hints-n-Tips Guide</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Mailing Lists</li>
- <li><a href="<%= (attr :_basedir) %>support.html">How to subscribe</a></li>
- <li><a href="https://lists.apache.org/list.html?users@isis.apache.org">Archives (ASF Pony mail)</a></li>
- <li><a href="http://isis.markmail.org/search/?q=">Archives (Markmail)</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Other Resources</li>
- <li><a href="https://issues.apache.org/jira/browse/ISIS">ASF JIRA</a></li>
- <li><a href="https://stackoverflow.com/questions/tagged/isis">Stack Overflow</a></li>
- <li><a href="<%= (attr :_basedir) %>help.html">Wiki, Fisheye etc.</a></li>
- </ul>
- </li>
-
- <li class="dropdown hidden-sm hidden-md">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">@ASF<span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li><a href="https://www.apache.org/">Apache Homepage</a></li>
- <li><a href="https://www.apache.org/events/current-event">Events</a></li>
- <li><a href="https://www.apache.org/licenses/">Licenses</a></li>
- <li><a href="https://www.apache.org/security/">Security</a></li>
- <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
- <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
- <li role="separator" class="divider"></li>
- <li><a href="https://whimsy.apache.org/board/minutes/Isis.html">PMC board minutes</a></li>
- </ul>
- </li>
-
- </ul>
-
- <div class="nav navbar-nav navbar-right">
-
- <!-- 'style' added to fix height of input box. FIX THIS -->
- <form class="navbar-form" role="search" id="search-form" style="padding: 1px 15px;">
- <div class="form-group">
- <input class="form-control" id="search-field" type="text" size="30" placeholder="Search"/>
- </div>
- </form>
- </div>
-
- <p class="nav navbar-text navbar-right small">v2.0.0-M2</p>
-
- </div>
- </div>
-</nav>
-
-
-<div class="container">
-
- <% if is_toc? then %>
- <div class="row-fluid">
- <div class="col-xs-12 col-sm-12 col-md-12 col-lg-9">
- <div id="search-panel">
- <div id="search-results"></div>
- <div>
- <br/>
- <a href="#" id="search-results-clear">clear</a>
- </div>
- </div>
- <% if is_pdf? then %>
- <span class="pdf-link"><a href="<%= (attr :docname) %>.pdf"><img src="<%= (attr :_basedir) %>images/PDF-50.png"></img></a></span>
- <% end %>
- <div class="page-title">
- <h1><%= document.name %></h1>
- </div>
- <div id="doc-content">
- <%= document.content %>
- </div>
- </div>
- <div class="hidden-xs hidden-sm hidden-md col-lg-3">
- <nav id="toc" data-spy="affix" data-toggle="toc"></nav>
- </div>
- </div>
- <% else %>
- <!-- Front Page, no TOC and no heading -->
- <div class="row">
- <div class="col-sm-12">
- <div id="search-panel">
- <div id="search-results"></div>
- <div>
- <br/>
- <a href="#" id="search-results-clear">clear</a>
- </div>
- </div>
- <div id="doc-content">
- <%= document.content %>
- </div>
- </div>
- </div>
- <% end %>
-
-
-</div>
-
-<footer class="footer">
- <div class="container">
- <div class="row">
- <p class="text-center small text-muted">
- Copyright © 2010~2018 The Apache Software Foundation, licensed under the Apache License, v2.0.
- <br/>
- Apache, the Apache feather logo, Apache Isis, and the Apache Isis project logo are all trademarks of The Apache Software Foundation.
- </p>
- </div>
- </div>
-</footer>
-
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
-<script src="<%= (attr :_basedir) %>js/bootstrap/3.3.7/bootstrap.min.js"></script>
-<script src="<%= (attr :_basedir) %>js/bootstrap-toc/0.4.1/bootstrap-toc.min.js"></script>
-
-<script src="<%= (attr :_basedir) %>js/slick/1.5.0/slick.min.js"></script>
-<script src="<%= (attr :_basedir) %>js/elasticlunr/elasticlunr.min.js"></script>
-
-<script src="<%= (attr :_basedir) %>js/sticky-header/sticky-header.js"></script>
-<script src="<%= (attr :_basedir) %>js/search-panel/search-panel.js"></script>
-<script src="<%= (attr :_basedir) %>js/header-link/header-link.js"></script>
-<script src="<%= (attr :_basedir) %>js/toc-scroll/toc-scroll.js"></script>
-
-</body>
-</html>
\ No newline at end of file
diff --git a/antora/components/toc/modules/ROOT/pages/about.adoc b/antora/components/toc/modules/ROOT/pages/about.adoc
index 2e7323b..4789ac4 100644
--- a/antora/components/toc/modules/ROOT/pages/about.adoc
+++ b/antora/components/toc/modules/ROOT/pages/about.adoc
@@ -1,7 +1,7 @@
= Menu
: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 ag [...]
include::_attributes.adoc[]
-
+:page-role: -toc
[cols="1a,1a,1a",frame="none", grid="none", stripes="none"]
|===
diff --git a/antora/components/userguide/modules/_to-repurpose/_attributes.adoc b/antora/components/userguide/modules/_to-repurpose/_attributes.adoc
new file mode 100644
index 0000000..43cb529
--- /dev/null
+++ b/antora/components/userguide/modules/_to-repurpose/_attributes.adoc
@@ -0,0 +1,6 @@
+ifndef::env-site,env-github[]
+:attachmentsdir: {moduledir}/attachments
+:examplesdir: {moduledir}/examples
+:imagesdir: {moduledir}/images
+:partialsdir: {moduledir}/partials
+endif::[]
diff --git a/antora/components/userguide/modules/_to-repurpose/attachments/.gitkeep b/antora/components/userguide/modules/_to-repurpose/attachments/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/documentation/src/main/excel/analysis-of-commands-vs-eventmetadata-vs-etc.xlsx b/antora/components/userguide/modules/_to-repurpose/attachments/excel/analysis-of-commands-vs-eventmetadata-vs-etc.xlsx
similarity index 100%
rename from adocs/documentation/src/main/excel/analysis-of-commands-vs-eventmetadata-vs-etc.xlsx
rename to antora/components/userguide/modules/_to-repurpose/attachments/excel/analysis-of-commands-vs-eventmetadata-vs-etc.xlsx
diff --git a/adocs/documentation/src/main/excel/command-dto-vs-interaction-dto-vs-interaction.xlsx b/antora/components/userguide/modules/_to-repurpose/attachments/excel/command-dto-vs-interaction-dto-vs-interaction.xlsx
similarity index 100%
rename from adocs/documentation/src/main/excel/command-dto-vs-interaction-dto-vs-interaction.xlsx
rename to antora/components/userguide/modules/_to-repurpose/attachments/excel/command-dto-vs-interaction-dto-vs-interaction.xlsx
diff --git a/adocs/documentation/src/main/pptx/commands-vs-actioninvocationevent.pptx b/antora/components/userguide/modules/_to-repurpose/attachments/pptx/commands-vs-actioninvocationevent.pptx
similarity index 100%
rename from adocs/documentation/src/main/pptx/commands-vs-actioninvocationevent.pptx
rename to antora/components/userguide/modules/_to-repurpose/attachments/pptx/commands-vs-actioninvocationevent.pptx
diff --git a/adocs/documentation/src/main/theme/isis-logo.png b/antora/components/userguide/modules/_to-repurpose/attachments/theme/isis-logo.png
similarity index 100%
rename from adocs/documentation/src/main/theme/isis-logo.png
rename to antora/components/userguide/modules/_to-repurpose/attachments/theme/isis-logo.png
diff --git a/antora/components/userguide/modules/_to-repurpose/examples/.gitkeep b/antora/components/userguide/modules/_to-repurpose/examples/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/antora/components/userguide/modules/_to-repurpose/images/.gitkeep b/antora/components/userguide/modules/_to-repurpose/images/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/documentation/src/main/asciidoc/images/PDF-50.png b/antora/components/userguide/modules/_to-repurpose/images/PDF-50.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/PDF-50.png
rename to antora/components/userguide/modules/_to-repurpose/images/PDF-50.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/010-sign-in.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/010-sign-in.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/010-sign-in.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/010-sign-in.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/010-sign-in.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/010-sign-in.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/010-sign-in.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/010-sign-in.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/020-object-layout.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/020-object-layout.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/020-object-layout.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/020-object-layout.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/020-object-layout.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/020-object-layout.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/020-object-layout.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/020-object-layout.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/030-declarative-business-rules.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/030-declarative-business-rules.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/030-declarative-business-rules.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/030-declarative-business-rules.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/030-declarative-business-rules.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/030-declarative-business-rules.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/030-declarative-business-rules.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/030-declarative-business-rules.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/040-imperative-business-rules.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/040-imperative-business-rules.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/040-imperative-business-rules.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/040-imperative-business-rules.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/040-imperative-business-rules.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/040-imperative-business-rules.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/040-imperative-business-rules.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/040-imperative-business-rules.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/050-action-with-args.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/050-action-with-args.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/050-action-with-args.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/050-action-with-args.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/050-action-with-args.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/050-action-with-args.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/050-action-with-args.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/050-action-with-args.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/060-action-with-args-autocomplete.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/060-action-with-args-autocomplete.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/060-action-with-args-autocomplete.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/060-action-with-args-autocomplete.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/060-action-with-args-autocomplete.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/060-action-with-args-autocomplete.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/060-action-with-args-autocomplete.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/060-action-with-args-autocomplete.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/070-jdo.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/070-jdo.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/070-jdo.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/070-jdo.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/070-jdo.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/070-jdo.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/070-jdo.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/070-jdo.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/080-rest-api.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/080-rest-api.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/080-rest-api.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/080-rest-api.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/080-rest-api.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/080-rest-api.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/080-rest-api.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/080-rest-api.png
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/090-integtesting.pdn b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/090-integtesting.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/090-integtesting.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/090-integtesting.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/index-screenshots/090-integtesting.png b/antora/components/userguide/modules/_to-repurpose/images/index-screenshots/090-integtesting.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/index-screenshots/090-integtesting.png
rename to antora/components/userguide/modules/_to-repurpose/images/index-screenshots/090-integtesting.png
diff --git a/adocs/documentation/src/main/asciidoc/images/isis-favicon.png b/antora/components/userguide/modules/_to-repurpose/images/isis-favicon.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/isis-favicon.png
rename to antora/components/userguide/modules/_to-repurpose/images/isis-favicon.png
diff --git a/adocs/documentation/src/main/asciidoc/images/isis-logo-48x48.pdn b/antora/components/userguide/modules/_to-repurpose/images/isis-logo-48x48.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/isis-logo-48x48.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/isis-logo-48x48.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/isis-logo-48x48.png b/antora/components/userguide/modules/_to-repurpose/images/isis-logo-48x48.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/isis-logo-48x48.png
rename to antora/components/userguide/modules/_to-repurpose/images/isis-logo-48x48.png
diff --git a/adocs/documentation/src/main/asciidoc/images/isis-logo-568x286.pdn b/antora/components/userguide/modules/_to-repurpose/images/isis-logo-568x286.pdn
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/isis-logo-568x286.pdn
rename to antora/components/userguide/modules/_to-repurpose/images/isis-logo-568x286.pdn
diff --git a/adocs/documentation/src/main/asciidoc/images/isis-logo-568x286.png b/antora/components/userguide/modules/_to-repurpose/images/isis-logo-568x286.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/isis-logo-568x286.png
rename to antora/components/userguide/modules/_to-repurpose/images/isis-logo-568x286.png
diff --git a/adocs/documentation/src/main/asciidoc/images/todoapp/dashboard.png b/antora/components/userguide/modules/_to-repurpose/images/todoapp/dashboard.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/todoapp/dashboard.png
rename to antora/components/userguide/modules/_to-repurpose/images/todoapp/dashboard.png
diff --git a/adocs/documentation/src/main/asciidoc/images/todoapp/swagger-ui.png b/antora/components/userguide/modules/_to-repurpose/images/todoapp/swagger-ui.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/todoapp/swagger-ui.png
rename to antora/components/userguide/modules/_to-repurpose/images/todoapp/swagger-ui.png
diff --git a/adocs/documentation/src/main/asciidoc/images/todoapp/todoitem.png b/antora/components/userguide/modules/_to-repurpose/images/todoapp/todoitem.png
similarity index 100%
rename from adocs/documentation/src/main/asciidoc/images/todoapp/todoitem.png
rename to antora/components/userguide/modules/_to-repurpose/images/todoapp/todoitem.png
diff --git a/antora/components/userguide/modules/_to-repurpose/nav.adoc b/antora/components/userguide/modules/_to-repurpose/nav.adoc
new file mode 100644
index 0000000..217ce49
--- /dev/null
+++ b/antora/components/userguide/modules/_to-repurpose/nav.adoc
@@ -0,0 +1,4 @@
+* Module Template
+
+** xref:about.adoc[About]
+
diff --git a/antora/components/userguide/modules/_to-repurpose/pages/_attributes.adoc b/antora/components/userguide/modules/_to-repurpose/pages/_attributes.adoc
new file mode 100644
index 0000000..e8ada7c
--- /dev/null
+++ b/antora/components/userguide/modules/_to-repurpose/pages/_attributes.adoc
@@ -0,0 +1,4 @@
+ifndef::env-site,env-github[]
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
+endif::[]
diff --git a/core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc b/antora/components/userguide/modules/_to-repurpose/pages/about.adoc
similarity index 83%
copy from core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc
copy to antora/components/userguide/modules/_to-repurpose/pages/about.adoc
index 54d76c5..6410c5f 100644
--- a/core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc
+++ b/antora/components/userguide/modules/_to-repurpose/pages/about.adoc
@@ -1,6 +1,7 @@
-= Shiro Security
+= About
: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 ag [...]
include::_attributes.adoc[]
-:page-partial:
-This guide describes the configuration of the Shiro implementation of Apache Isis' `Authenticator and `Authorizor` APIs.
+This doc module is empty, intended for use as a template when creating new modules.
+
+
diff --git a/antora/components/userguide/modules/_to-repurpose/partials/_attributes.adoc b/antora/components/userguide/modules/_to-repurpose/partials/_attributes.adoc
new file mode 100644
index 0000000..e8ada7c
--- /dev/null
+++ b/antora/components/userguide/modules/_to-repurpose/partials/_attributes.adoc
@@ -0,0 +1,4 @@
+ifndef::env-site,env-github[]
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
+endif::[]
diff --git a/antora/theme/ui-bundle.zip b/antora/theme/ui-bundle.zip
index 8280e33..d8a6096 100644
Binary files a/antora/theme/ui-bundle.zip and b/antora/theme/ui-bundle.zip differ
diff --git a/core/commons/src/main/doc/modules/commons/partials/module-nav.adoc b/core/commons/src/main/doc/modules/commons/partials/module-nav.adoc
index 0e27d3e..5c35621 100644
--- a/core/commons/src/main/doc/modules/commons/partials/module-nav.adoc
+++ b/core/commons/src/main/doc/modules/commons/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:commons:about.adoc[Core: Commons]
+* xref:core:commons:about.adoc[Commons]
diff --git a/core/detached-tests/src/main/doc/modules/detached-tests/partials/module-nav.adoc b/core/detached-tests/src/main/doc/modules/detached-tests/partials/module-nav.adoc
index f9d35cb..ae84950 100644
--- a/core/detached-tests/src/main/doc/modules/detached-tests/partials/module-nav.adoc
+++ b/core/detached-tests/src/main/doc/modules/detached-tests/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:detached-tests:about.adoc[Core: Detached Tests]
+* xref:core:detached-tests:about.adoc[Detached Tests]
diff --git a/core/metamodel/src/main/doc/modules/metamodel/partials/module-nav.adoc b/core/metamodel/src/main/doc/modules/metamodel/partials/module-nav.adoc
index f9d35cb..6c2d627 100644
--- a/core/metamodel/src/main/doc/modules/metamodel/partials/module-nav.adoc
+++ b/core/metamodel/src/main/doc/modules/metamodel/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:detached-tests:about.adoc[Core: Detached Tests]
+* xref:core:detached-tests:about.adoc[MetaModel]
diff --git a/core/plugins/codegen-bytebuddy/src/main/doc/modules/codegen-bytebuddy/partials/module-nav.adoc b/core/plugins/codegen-bytebuddy/src/main/doc/modules/codegen-bytebuddy/partials/module-nav.adoc
index 6e9ca2c..8e00155 100644
--- a/core/plugins/codegen-bytebuddy/src/main/doc/modules/codegen-bytebuddy/partials/module-nav.adoc
+++ b/core/plugins/codegen-bytebuddy/src/main/doc/modules/codegen-bytebuddy/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:codegen-bytebuddy:about.adoc[Core: Byte Buddy Proxy Factory]
+* xref:core:codegen-bytebuddy:about.adoc[Byte Buddy Proxy Factory]
diff --git a/core/plugins/jdo/src/main/doc/antora.yml b/core/plugins/jdo/src/main/doc/antora.yml
index 8b132a9..b16cf5d 100644
--- a/core/plugins/jdo/src/main/doc/antora.yml
+++ b/core/plugins/jdo/src/main/doc/antora.yml
@@ -1,3 +1,6 @@
name: odn
title: "DataNucleus ObjectStore"
version: master
+start_page: ROOT:about.adoc
+nav:
+ - modules/ROOT/nav.adoc
diff --git a/core/plugins/jdo/src/main/doc/modules/ROOT/nav.adoc b/core/plugins/jdo/src/main/doc/modules/ROOT/nav.adoc
index 1df76be..9f4575d 100644
--- a/core/plugins/jdo/src/main/doc/modules/ROOT/nav.adoc
+++ b/core/plugins/jdo/src/main/doc/modules/ROOT/nav.adoc
@@ -1,27 +1,24 @@
-* xref:about.adoc[About]
+* xref:configuring.adoc[Configuring]
+** xref:configuring/properties.adoc[Properties]
+** xref:configuring/bulk-load.adoc[Bulk Load]
+** xref:configuring/disabling-persistence-by-reachability.adoc[Disabling Persistence by Reachability]
+** xref:configuring/persistence-xml.adoc[Persistence XML]
+** xref:configuring/using-jndi-data-source.adoc[Using JNDI Data Source]
-** xref:configuring.adoc[Configuring]
-*** xref:configuring/properties.adoc[Properties]
-*** xref:configuring/bulk-load.adoc[Bulk Load]
-*** xref:configuring/disabling-persistence-by-reachability.adoc[Disabling Persistence by Reachability]
-*** xref:configuring/persistence-xml.adoc[Persistence XML]
-*** xref:configuring/using-jndi-data-source.adoc[Using JNDI Data Source]
+* xref:jdo-mappings.adoc[JDO Mappings]
+** xref:jdo-mappings/1-to-m-bidirectional-relationships.adoc[1-to-m bidirectional relationships]
+** xref:jdo-mappings/mandatory-properties-in-subtypes.adoc[Mandatory properties in subtypes]
+** xref:jdo-mappings/mapping-to-a-view.adoc[Mapping to a View]
-** xref:jdo-mappings.adoc[JDO Mappings]
-*** xref:jdo-mappings/1-to-m-bidirectional-relationships.adoc[1-to-m bidirectional relationships]
-*** xref:jdo-mappings/mandatory-properties-in-subtypes.adoc[Mandatory properties in subtypes]
-*** xref:jdo-mappings/mapping-to-a-view.adoc[Mapping to a View]
+* xref:db-schemas.adoc[DB Schemas]
-** xref:db-schemas.adoc[DB Schemas]
-
-
-** xref:hints-and-tips.adoc[Hints-n-Tips]
-*** xref:hints-and-tips/overriding-jdo-annotations.adoc[Overriding JDO Annotations]
-*** xref:hints-and-tips/subtype-entity-not-fully-populated.adoc[Subtype entity not fully populated]
-*** xref:hints-and-tips/java8.adoc[Java 8]
-*** xref:hints-and-tips/diagnosing-n-plus-1.adoc[Diagnosing n-plus-1]
-*** xref:hints-and-tips/typesafe-queries-and-fetchgroups.adoc[Typesafe Queries and Fetchgroups]
-*** xref:hints-and-tips/jdoql-and-timestamps.adoc[JDOQL and Timestamps]
+* xref:hints-and-tips.adoc[Hints-n-Tips]
+** xref:hints-and-tips/overriding-jdo-annotations.adoc[Overriding JDO Annotations]
+** xref:hints-and-tips/subtype-entity-not-fully-populated.adoc[Subtype entity not fully populated]
+** xref:hints-and-tips/java8.adoc[Java 8]
+** xref:hints-and-tips/diagnosing-n-plus-1.adoc[Diagnosing n-plus-1]
+** xref:hints-and-tips/typesafe-queries-and-fetchgroups.adoc[Typesafe Queries and Fetchgroups]
+** xref:hints-and-tips/jdoql-and-timestamps.adoc[JDOQL and Timestamps]
diff --git a/core/plugins/jdo/src/main/doc/modules/ROOT/pages/about.adoc b/core/plugins/jdo/src/main/doc/modules/ROOT/pages/about.adoc
index f401bba..797002b 100644
--- a/core/plugins/jdo/src/main/doc/modules/ROOT/pages/about.adoc
+++ b/core/plugins/jdo/src/main/doc/modules/ROOT/pages/about.adoc
@@ -1,6 +1,6 @@
= DataNucleus Object Store
include::_attributes.adoc[]
-
+:page-toc: ~
The DataNucleus Object Store enables domain objects to be persisted to relational as well as NoSQL databases.
The object store is implemented using link:http://datanucleus.org[DataNucleus].
diff --git a/core/runtime-extensions/src/main/doc/modules/runtime-extensions/partials/module-nav.adoc b/core/runtime-extensions/src/main/doc/modules/runtime-extensions/partials/module-nav.adoc
index 456ed02..58ba6f9 100644
--- a/core/runtime-extensions/src/main/doc/modules/runtime-extensions/partials/module-nav.adoc
+++ b/core/runtime-extensions/src/main/doc/modules/runtime-extensions/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:runtime-extensions:about.adoc[Core: Runtime Extensions]
+* xref:core:runtime-extensions:about.adoc[Runtime Extensions]
diff --git a/core/runtime-web/src/main/doc/modules/runtime-web/partials/module-nav.adoc b/core/runtime-web/src/main/doc/modules/runtime-web/partials/module-nav.adoc
index a033580..d2fe2f2 100644
--- a/core/runtime-web/src/main/doc/modules/runtime-web/partials/module-nav.adoc
+++ b/core/runtime-web/src/main/doc/modules/runtime-web/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:runtime-web:about.adoc[Core: Runtime Web]
+* xref:core:runtime-web:about.adoc[Runtime Web]
diff --git a/core/runtime/src/main/doc/modules/runtime/partials/module-nav.adoc b/core/runtime/src/main/doc/modules/runtime/partials/module-nav.adoc
index 851f8bf..60d2df4 100644
--- a/core/runtime/src/main/doc/modules/runtime/partials/module-nav.adoc
+++ b/core/runtime/src/main/doc/modules/runtime/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:core:runtime:about.adoc[Core: Runtime]
+* xref:core:runtime:about.adoc[Runtime]
diff --git a/core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc b/core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc
index 54d76c5..0f55aae 100644
--- a/core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc
+++ b/core/security/keycloak/src/main/doc/modules/keycloak/pages/about.adoc
@@ -1,6 +1,8 @@
-= Shiro Security
+= Keycloak Security
: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 ag [...]
include::_attributes.adoc[]
:page-partial:
-This guide describes the configuration of the Shiro implementation of Apache Isis' `Authenticator and `Authorizor` APIs.
+This guide describes the configuration of the Keycloak implementation of Apache Isis' `Authenticator and `Authorizor` APIs.
+
+TODO
\ No newline at end of file
diff --git a/core/security/keycloak/src/main/doc/modules/keycloak/partials/module-nav.adoc b/core/security/keycloak/src/main/doc/modules/keycloak/partials/module-nav.adoc
index ac7c186..4da6a3e 100644
--- a/core/security/keycloak/src/main/doc/modules/keycloak/partials/module-nav.adoc
+++ b/core/security/keycloak/src/main/doc/modules/keycloak/partials/module-nav.adoc
@@ -1 +1 @@
-* xref:security:keycloak:about.adoc[Keycloak]
+* xref:security:keycloak:about.adoc[Keycloak Implementation]
diff --git a/core/testsupport/integtestsupport/src/main/doc/modules/integ-test-support/pages/integ-test-support/maven-configuration.adoc b/core/testsupport/integtestsupport/src/main/doc/modules/integ-test-support/pages/integ-test-support/maven-configuration.adoc
index 15d2b27..af8abbe 100644
--- a/core/testsupport/integtestsupport/src/main/doc/modules/integ-test-support/pages/integ-test-support/maven-configuration.adoc
+++ b/core/testsupport/integtestsupport/src/main/doc/modules/integ-test-support/pages/integ-test-support/maven-configuration.adoc
@@ -4,7 +4,7 @@
include::_attributes.adoc[]
-Apache Isis' integration test support is automatically configured if you use the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
+Apache Isis' integration test support is automatically configured if you use the xref:simpleapp:ROOT:about.adoc[SimpleApp starter app].
To set it up manually, update the `pom.xml` of your domain object model module:
[source,xml]
@@ -21,7 +21,7 @@ To set it up manually, update the `pom.xml` of your domain object model module:
[NOTE]
====
-This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
+This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:simpleapp:ROOT:about.adoc[SimpleApp starter app].
====
We also recommend that you configure the `maven-surefire-plugin` to pick up the following class patterns:
@@ -52,5 +52,5 @@ We also recommend that you configure the `maven-surefire-plugin` to pick up the
[NOTE]
====
-This can also be done using mavenmixins; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
+This can also be done using mavenmixins; see the xref:simpleapp:ROOT:about.adoc[SimpleApp starter app].
====
diff --git a/core/testsupport/unittestsupport/src/main/doc/modules/unit-test-support/pages/unit-test-support/maven-configuration.adoc b/core/testsupport/unittestsupport/src/main/doc/modules/unit-test-support/pages/unit-test-support/maven-configuration.adoc
index fef964f..c2d00ec 100644
--- a/core/testsupport/unittestsupport/src/main/doc/modules/unit-test-support/pages/unit-test-support/maven-configuration.adoc
+++ b/core/testsupport/unittestsupport/src/main/doc/modules/unit-test-support/pages/unit-test-support/maven-configuration.adoc
@@ -20,7 +20,7 @@ To set it up manually, update the `pom.xml` of your domain object model module:
[NOTE]
====
-This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
+This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:simpleapp:ROOT:about.adoc[SimpleApp starter app].
====
@@ -52,5 +52,5 @@ We also recommend that you configure the `maven-surefire-plugin` to pick up the
[NOTE]
====
-This can also be done using mavenmixins; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
+This can also be done using mavenmixins; see the xref:simpleapp:ROOT:about.adoc[SimpleApp starter app].
====
diff --git a/core/viewer-restfulobjects/src/main/doc/modules/ROOT/pages/layout-resources.adoc b/core/viewer-restfulobjects/src/main/doc/modules/ROOT/pages/layout-resources.adoc
index c4c61b9..4b3a03f 100644
--- a/core/viewer-restfulobjects/src/main/doc/modules/ROOT/pages/layout-resources.adoc
+++ b/core/viewer-restfulobjects/src/main/doc/modules/ROOT/pages/layout-resources.adoc
@@ -13,7 +13,7 @@ This chapter provides details of these resources, the link ``Rel``s to access th
The xref:refguide:applib-svc:presentation-layer-spi/MenuBarsService.adoc[`MenuBarsService`] provides the `menu.layout.xml` XML document which defines how to group the various domain service actions into menubars, menus and menu sections.
-For example, the xref:helloworld:ROOT:about.adoc[Hello World archetype] has the following layout:
+For example, the xref:helloworld:ROOT:about.adoc[Hello World starter app] has the following layout:
[source,xml]
----
@@ -135,7 +135,7 @@ Note that because of dynamic icons (the xref:refguide:applib-cm:methods.adoc#ico
The xref:refguide:applib-svc:presentation-layer-spi/GridService.adoc[`GridService`] provides an XML document which defines the layout of any of domain object.
Typically this is the contents of the `Xxx.layout.xml` file (where `Xxx` is the domain type).
-For example, in the xref:helloworld:ROOT:about.adoc[Hello World archetype] the `HelloWorld` domain object has a layout defined by `HelloWorld.layout.xml`.
+For example, in the xref:helloworld:ROOT:about.adoc[Hello World starter app] the `HelloWorld` domain object has a layout defined by `HelloWorld.layout.xml`.
The representation returned by the domain object resource (section 14.4 of the RO spec v1.0) has been extended to provide a link to this resource:
@@ -162,7 +162,7 @@ In a similar way to the `menu.layout.xml`, the representations is supplemented w
* `collection`
* `action`
-For example, the layout for a "HelloWorldObject" instance in the hello world archetype (with `Accept: appication/xml` HTTP header) is:
+For example, the layout for a "HelloWorldObject" instance in the hello world starter app (with `Accept: appication/xml` HTTP header) is:
[source,xml]
----
diff --git a/examples/apps/demo/src/main/doc/antora.yml b/examples/apps/demo/src/main/doc/antora.yml
index e39e66e..ae6f4a2 100644
--- a/examples/apps/demo/src/main/doc/antora.yml
+++ b/examples/apps/demo/src/main/doc/antora.yml
@@ -1,5 +1,5 @@
name: demoapp
-title: "Example App - Demo"
+title: "Tutorial App - Demo"
version: master
start_page: ROOT:about.adoc
nav:
diff --git a/examples/apps/helloworld/src/main/doc/antora.yml b/examples/apps/helloworld/src/main/doc/antora.yml
index 0543740..456e1ff 100644
--- a/examples/apps/helloworld/src/main/doc/antora.yml
+++ b/examples/apps/helloworld/src/main/doc/antora.yml
@@ -1,5 +1,5 @@
name: helloworld
-title: "Example App - Hello World"
+title: "Starter App - Hello World"
version: master
start_page: ROOT:about.adoc
nav:
diff --git a/examples/apps/helloworld/src/main/doc/modules/ROOT/nav.adoc b/examples/apps/helloworld/src/main/doc/modules/ROOT/nav.adoc
index d33e04b..b626900 100644
--- a/examples/apps/helloworld/src/main/doc/modules/ROOT/nav.adoc
+++ b/examples/apps/helloworld/src/main/doc/modules/ROOT/nav.adoc
@@ -1,2 +1,2 @@
-* xref:about.adoc[Hello World Archetype]
+* xref:about.adoc[Hello World Starter App]
diff --git a/examples/apps/helloworld/src/main/doc/modules/ROOT/pages/about.adoc b/examples/apps/helloworld/src/main/doc/modules/ROOT/pages/about.adoc
index bb9877e..66cfb36 100644
--- a/examples/apps/helloworld/src/main/doc/modules/ROOT/pages/about.adoc
+++ b/examples/apps/helloworld/src/main/doc/modules/ROOT/pages/about.adoc
@@ -10,7 +10,7 @@ Both the business logic and supporting bootstrapping classes are in a single Mav
[TIP]
====
We don't recommend that you use the helloworld archetype as the basis for your own applications.
-Instead, use the xref:simpleapp:ROOT:about.adoc[simpleapp archetype].
+Instead, use the xref:simpleapp:ROOT:about.adoc[SimpleApp starter app].
This also creates a minimal application, but provides more structure and example tests, useful as you build out your own app.
====
diff --git a/examples/apps/simpleapp/src/main/doc/antora.yml b/examples/apps/simpleapp/src/main/doc/antora.yml
index ce97f9a..514eb32 100644
--- a/examples/apps/simpleapp/src/main/doc/antora.yml
+++ b/examples/apps/simpleapp/src/main/doc/antora.yml
@@ -1,5 +1,5 @@
name: simpleapp
-title: "Example App - SimpleApp"
+title: "Starter App - SimpleApp"
version: master
start_page: ROOT:about.adoc
nav:
diff --git a/examples/apps/simpleapp/src/main/doc/modules/ROOT/nav.adoc b/examples/apps/simpleapp/src/main/doc/modules/ROOT/nav.adoc
index 8fc72b0..026a8cd 100644
--- a/examples/apps/simpleapp/src/main/doc/modules/ROOT/nav.adoc
+++ b/examples/apps/simpleapp/src/main/doc/modules/ROOT/nav.adoc
@@ -1,2 +1,2 @@
-* xref:about.adoc[Simple App Archetype]
+* xref:about.adoc[Simple App starter app]
diff --git a/examples/apps/simpleapp/src/main/doc/modules/ROOT/pages/about.adoc b/examples/apps/simpleapp/src/main/doc/modules/ROOT/pages/about.adoc
index d4602b9..a64a55e 100644
--- a/examples/apps/simpleapp/src/main/doc/modules/ROOT/pages/about.adoc
+++ b/examples/apps/simpleapp/src/main/doc/modules/ROOT/pages/about.adoc
@@ -1,7 +1,9 @@
-= Simple App Archetype
+= Simple App Starter App
: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 ag [...]
include::_attributes.adoc[]
+NOTE: these notes are out-of-date and need to be reviewed.
+
The quickest way to get started building an application "for real" is to run the `simpleapp` archetype.
Like the xref:helloworld:ROOT:about.adoc[helloworld starter app], this too will generate a very simple one-class domain model (an entity called `SimpleObject` with a couple of properties).
diff --git a/preview-scratch.sh b/preview-scratch.sh
new file mode 100644
index 0000000..9eb501d
--- /dev/null
+++ b/preview-scratch.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+rm -rf antora/target/site \
+&& rm -rf core/config/_adoc/modules/config/examples/generated \
+&& groovy scripts/generateConfigDocs -f "./core/config/target/classes/META-INF/spring-configuration-metadata.json" -o ./core/config/_adoc/modules/config/examples/generated \
+&& antora site-scratch.yml $@ \
+&& serve antora/target/site
diff --git a/site-scratch.yml b/site-scratch.yml
index d6f252c..3fddf01 100644
--- a/site-scratch.yml
+++ b/site-scratch.yml
@@ -34,144 +34,149 @@ content:
# branches: HEAD
- url: .
- start_path: core/applib/_adoc # refguide
+ start_path: core/applib/src/main/doc # refguide
branches: HEAD
# - url: .
-# start_path: core/commons/_adoc # core
+# start_path: core/commons/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/config/_adoc # refguide
+# start_path: core/config/src/main/doc # refguide
# branches: HEAD
# - url: .
-# start_path: core/detached-tests/_adoc # core
+# start_path: core/detached-tests/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/metamodel/_adoc # core
+# start_path: core/metamodel/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/plugins/codegen-bytebuddy/_adoc # core
+# start_path: core/plugins/codegen-bytebuddy/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/plugins/jaxrs-resteasy-4/_adoc # vro
+# start_path: core/plugins/jaxrs-resteasy-4/src/main/doc # vro
# branches: HEAD
# - url: .
-# start_path: core/plugins/jdo/_adoc # userguide
+# start_path: core/plugins/jdo/src/main/doc # userguide
# branches: HEAD
# - url: .
-# start_path: core/runtime/_adoc # core
+# start_path: core/runtime/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/runtime-extensions/_adoc # core
+# start_path: core/runtime-extensions/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/runtime-services/_adoc # core
+# start_path: core/runtime-services/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/runtime-web/_adoc # core
+# start_path: core/runtime-web/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: core/schema/_adoc # refguide
+# start_path: core/schema/src/main/doc # refguide
# branches: HEAD
- url: .
- start_path: core/security/api/_adoc # security
+ start_path: core/security/api/src/main/doc # security
branches: HEAD
- url: .
- start_path: core/security/bypass/_adoc # security
+ start_path: core/security/bypass/src/main/doc # security
branches: HEAD
- url: .
- start_path: core/security/shiro/_adoc # security
+ start_path: core/security/shiro/src/main/doc # security
+ branches: HEAD
+ - url: .
+ start_path: core/security/keycloak/src/main/doc # security
branches: HEAD
# - url: .
-# start_path: core/testsupport/unittestsupport/_adoc # testing
+# start_path: core/testsupport/unittestsupport/src/main/doc # testing
# branches: HEAD
# - url: .
-# start_path: core/testsupport/integtestsupport/_adoc # testing
+# start_path: core/testsupport/integtestsupport/src/main/doc # testing
# branches: HEAD
# to be resurrected somehow.
#- url: .
- # start_path: core/testsupport/mvnplugin/_adoc
+ # start_path: core/testsupport/mvnplugin/src/main/doc
# branches: HEAD
# - url: .
-# start_path: core/viewer-restfulobjects/_adoc # vro
+# start_path: core/viewer-restfulobjects/src/main/doc # vro
# branches: HEAD
# - url: .
-# start_path: core/viewer-wicket/_adoc # vw
+# start_path: core/viewer-wicket/src/main/doc # vw
# branches: HEAD
# - url: .
-# start_path: examples/apps/demo/_adoc # demoapp
+# start_path: examples/apps/demo/src/main/doc # demoapp
# branches: HEAD
# - url: .
-# start_path: examples/apps/helloworld/_adoc # helloworld
+# start_path: examples/apps/helloworld/src/main/doc # helloworld
# branches: HEAD
# - url: .
-# start_path: examples/apps/simpleapp/_adoc # simpleapp
+# start_path: examples/apps/simpleapp/src/main/doc # simpleapp
# branches: HEAD
# - url: .
-# start_path: examples/smoketests/_adoc # core
+# start_path: examples/smoketests/src/main/doc # core
# branches: HEAD
# - url: .
-# start_path: extensions/asciidoc/_adoc # vw
+# start_path: extensions/core/incubator/src/main/doc # extensions
# branches: HEAD
# - url: .
-# start_path: extensions/fixtures/_adoc # testing
+# start_path: extensions/core/legacy/src/main/doc # extensions
# branches: HEAD
# - url: .
-# start_path: extensions/incubator/_adoc # extensions
+# start_path: extensions/core/spring/src/main/doc # extensions
# branches: HEAD
# - url: .
-# start_path: extensions/legacy/_adoc # extensions
+# start_path: extensions/security/secman/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/markdown/_adoc # vw
+# start_path: extensions/security/secman/api/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/restclient/_adoc # vro
+# start_path: extensions/security/secman/encryption-jbcrypt/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/secman/_adoc # secman
+# start_path: extensions/security/secman/model/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/secman/api/_adoc # secman
+# start_path: extensions/security/secman/persistence-jdo/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/secman/encryption-jbcrypt/_adoc # secman
+# start_path: extensions/security/secman/realm-shiro/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/secman/model/_adoc # secman
+# start_path: extensions/testing/fixtures/src/main/doc # testing
# branches: HEAD
# - url: .
-# start_path: extensions/secman/persistence-jdo/_adoc # secman
+# start_path: extensions/testing/specsupport/src/main/doc # secman
# branches: HEAD
# - url: .
-# start_path: extensions/secman/realm-shiro/_adoc # secman
+# start_path: extensions/vro/restclient/src/main/doc # vro
# branches: HEAD
# - url: .
-# start_path: extensions/specsupport/_adoc # secman
+# start_path: extensions/vw/asciidoc/src/main/doc # vw
# branches: HEAD
# - url: .
-# start_path: extensions/spring/_adoc # extensions
+# start_path: extensions/vw/exceldownload/src/main/doc # vw
# branches: HEAD
# - url: .
-# start_path: extensions/sse/_adoc # vw
+# start_path: extensions/vw/markdown/src/main/doc # vw
# branches: HEAD
# - url: .
-# start_path: extensions/exceldownload/_adoc # vw
+# start_path: extensions/vw/sse/src/main/doc # vw
# branches: HEAD
# - url: .
-# start_path: mavendeps/_adoc
+# start_path: mavendeps/src/main/doc
# branches: HEAD
# - url: .
-# start_path: mixins/_adoc
+# start_path: mixins/src/main/doc
# branches: HEAD
ui:
bundle:
- url: ./antora/theme/ui-bundle.zip
+ url: ../isis-antora/build/ui-bundle.zip
+ #url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
+ #url: ./antora/theme/ui-bundle.zip
snapshot: true
supplemental_files: antora/supplemental-ui
@@ -186,7 +191,6 @@ asciidoc:
idprefix: ""
idseparator: "-"
plantuml-server-url: "http://www.plantuml.com/plantuml"
- page-toc: ""
isiscurr: "2.0.0-M2"
isisnext: "2.0.0-M3"
isisnextafter: "2.0.0-M4"
diff --git a/site.yml b/site.yml
index 36aa1bc..bb70c54 100644
--- a/site.yml
+++ b/site.yml
@@ -191,7 +191,6 @@ asciidoc:
idprefix: ""
idseparator: "-"
plantuml-server-url: "http://www.plantuml.com/plantuml"
- page-toc: ""
isiscurr: "2.0.0-M2"
isisnext: "2.0.0-M3"
isisnextafter: "2.0.0-M4"