You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by rs...@apache.org on 2015/05/08 02:33:39 UTC
deltaspike git commit: DELTASPIKE-895 Documentation site improvements
Repository: deltaspike
Updated Branches:
refs/heads/master 5630c49d0 -> 8a84303c9
DELTASPIKE-895 Documentation site improvements
Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/8a84303c
Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/8a84303c
Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/8a84303c
Branch: refs/heads/master
Commit: 8a84303c91df932d8b3f668b61eaec818a6e0336
Parents: 5630c49
Author: Ron Smeral <rs...@apache.org>
Authored: Fri May 8 02:16:54 2015 +0200
Committer: Ron Smeral <rs...@apache.org>
Committed: Fri May 8 02:17:19 2015 +0200
----------------------------------------------------------------------
.../src/main/asciidoc/bean-validation.adoc | 2 +
documentation/src/main/asciidoc/cdiimp.adoc | 4 +-
documentation/src/main/asciidoc/configure.adoc | 4 +-
documentation/src/main/asciidoc/core.adoc | 3 +
documentation/src/main/asciidoc/data.adoc | 2 +
documentation/src/main/asciidoc/index.adoc | 85 ++--
documentation/src/main/asciidoc/jpa.adoc | 3 +
documentation/src/main/asciidoc/jsf.adoc | 3 +
documentation/src/main/asciidoc/modules.adoc | 27 +-
.../src/main/asciidoc/partial-bean.adoc | 2 +
documentation/src/main/asciidoc/scheduler.adoc | 3 +
documentation/src/main/asciidoc/security.adoc | 2 +
documentation/src/main/asciidoc/servlet.adoc | 2 +
.../src/main/asciidoc/test-control.adoc | 3 +
site/src/main/asciidoc/addons.adoc | 2 +
site/src/main/asciidoc/articles.adoc | 2 +
site/src/main/asciidoc/community.adoc | 3 -
site/src/main/asciidoc/documentation.adoc | 2 +
site/src/main/asciidoc/download.adoc | 2 +
site/src/main/asciidoc/examples.adoc | 2 +
site/src/main/asciidoc/javadoc.adoc | 4 +-
site/src/main/asciidoc/migration-guide.adoc | 5 -
site/src/main/asciidoc/news.adoc | 92 ++---
site/src/main/asciidoc/release-preparation.adoc | 5 +-
site/src/main/asciidoc/source.adoc | 2 +
template/document.html.erb | 390 +++++++++++++------
26 files changed, 443 insertions(+), 213 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/bean-validation.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/bean-validation.adoc b/documentation/src/main/asciidoc/bean-validation.adoc
index beb6c7e..f471dbe 100644
--- a/documentation/src/main/asciidoc/bean-validation.adoc
+++ b/documentation/src/main/asciidoc/bean-validation.adoc
@@ -1,3 +1,5 @@
+:moduledeps: core
+
= Bean Validation Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/cdiimp.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/cdiimp.adoc b/documentation/src/main/asciidoc/cdiimp.adoc
index ada7a22..ae46a1e 100644
--- a/documentation/src/main/asciidoc/cdiimp.adoc
+++ b/documentation/src/main/asciidoc/cdiimp.adoc
@@ -24,7 +24,7 @@ Instructions are provided here for adding the required resources to both Maven-b
=== Declare CDI Dependencies
-==== Option A: Declare Dependencies for Maven-based Projects
+==== Dependencies for Maven-based Projects
For Maven-based projects, the Container Control module is available in Maven Central together with the other DeltaSpike modules. You must configure your project to use the DeltaSpike Container Control API and one of the CDI container-specific modules.
. Open the project `pom.xml` file for editing
@@ -126,7 +126,7 @@ c. Add the DeltaSpike Apache OpenWebBeans-specific Container Control module to t
mvn clean install
----
-==== Option B: Declare Dependencies for Maven-independent Projects
+==== Dependencies for Maven-independent Projects
For Maven-independent projects, the Container Control module is distributed together with the other DeltaSpike modules in `distribution-fill-<version>.zip`. You must add two of the files from the `cdictrl` directory to your project, namely `deltaspike-cdictrl-api.jar` and the .jar file that corresponds to the CDI container you have chosen. Add these files to the project `WEB-INF/lib` or `EAR/lib` directory for .war and .ear projects respectively.
== Next
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/configure.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/configure.adoc b/documentation/src/main/asciidoc/configure.adoc
index 8d71101..c42befb 100644
--- a/documentation/src/main/asciidoc/configure.adoc
+++ b/documentation/src/main/asciidoc/configure.adoc
@@ -6,7 +6,7 @@ DeltaSpike is available for use in Maven-based and Maven-independent projects. I
NOTE: You can also opt to use the lastest DeltaSpike snapshots; for more information, see <<snapshots#,Use DeltaSpike Snapshots>>.
-== Option A: Configure DeltaSpike in Maven-based Projects
+== Maven-based Projects
DeltaSpike released versions are available from the Maven Central repository for use in Maven-based projects. This means that you do not need to modify your Maven configuration `settings.xml` file; when building projects, Maven automatically searches the online Maven Central repository for project dependencies and downloads sources to your local Maven repository.
To begin use the DeltaSpike releases from Maven Central, you simply need to configure the project `pom.xml` file for each project with information about the release version and modules you want to use. At a minimum, you must add the DeltaSpike Core module, which provides the DeltaSpike API and utility classes.
@@ -58,7 +58,7 @@ For instructions on adding the optional DeltaSpike modules, see the relevant mod
* <<test-control#,Test-Control>>
[[config-maven-indep]]
-== Option B: Configure DeltaSpike in Maven-independent Projects
+== Maven-independent Projects
Deltaspike is provided as a set of downloadable .jar files for projects not utilizing the Maven build system. Alternatively, you can build the DeltaSpike .jar files from source; for instructions, see <<build#,Build DeltaSpike from Source>>. In both cases, you must add the DeltaSpike .jar files directly to your projects.
To use DeltaSpike without Maven from the downloadable .jar files, complete the following steps:
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/core.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/core.adoc b/documentation/src/main/asciidoc/core.adoc
index 84da0f2..617cb94 100644
--- a/documentation/src/main/asciidoc/core.adoc
+++ b/documentation/src/main/asciidoc/core.adoc
@@ -1,3 +1,6 @@
+:modulebase: core
+:moduleconf: api:org.apache.deltaspike.core.api.config.base.CoreBaseConfig
+
= Core Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/data.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/data.adoc b/documentation/src/main/asciidoc/data.adoc
index 48af549..4786dab 100644
--- a/documentation/src/main/asciidoc/data.adoc
+++ b/documentation/src/main/asciidoc/data.adoc
@@ -1,3 +1,5 @@
+:moduledeps: core, jpa, partial-bean
+
= Data Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/index.adoc b/documentation/src/main/asciidoc/index.adoc
index 76c388f..cd5502d 100644
--- a/documentation/src/main/asciidoc/index.adoc
+++ b/documentation/src/main/asciidoc/index.adoc
@@ -1,32 +1,61 @@
+:notoc:
+
= Documentation
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-* Get Started
-** <<overview#,Overview of DeltaSpike>>
-** <<configure#,Configure DeltaSpike in Your Projects>>
-** <<cdiimp#,Enable CDI For Your Java Environment>>
-** link:http://deltaspike.apache.org/examples.html[See DeltaSpike in Action]
-* Use Individual Modules
-** <<modules#,Overview of DeltaSpike Modules>>
-** <<core#,Core>>
-** <<bean-validation#,Bean Validation>>
-** <<container-control#,Container Control>>
-** <<data#,Data>>
-** <<jpa#,JPA>>
-** <<jsf#,JSF>>
-** <<partial-bean#,Partial-Bean>>
-** <<scheduler#,Scheduler>>
-** <<security#,Security>>
-** <<servlet#,Servlet>>
-** <<test-control#,Test-Control>>
-* Advanced Information
-** <<build#,Build and Test DeltaSpike from Source>>
-** <<snapshots#,Use DeltaSpike Snapshots>>
-** link:https://deltaspike.apache.org/migration-guide.html[Migrate to DeltaSpike]
-** link:https://deltaspike.apache.org/source.html[Contribute to the DeltaSpike Source]
-** <<spi#,DeltaSpike Service Provider Interface (SPI)>>
-* Access More DeltaSpike Resources
-** link:http://deltaspike.apache.org/articles.html[Articles and Blogs]
-** link:http://deltaspike.apache.org/addons.html[Add-ons]
-** link:https://deltaspike.apache.org/external.html[External Examples]
+++++
+<style>
+#doc-content h2 {
+ border-bottom: none;
+}
+</style>
+<div class="row-fluid">
+ <div class="span4">
+ <h2>Get Started</h2>
+ <ul class="nav nav-list toc-like">
+ <li><a href="overview.html">Overview of DeltaSpike</a></li>
+ <li><a href="configure.html">Configure DeltaSpike in Your Projects</a></li>
+ <li><a href="cdiimp.html">Enable CDI For Your Java Environment</a></li>
+ <li><a href="../examples.html">See DeltaSpike in Action</a></li>
+ </ul>
+
+ <h2>More resources</h2>
+ <ul class="nav nav-list toc-like">
+ <li><a href="../articles.html">Articles and Blogs</a></li>
+ <li><a href="../addons.html">Add-ons</a></li>
+ <li><a href="../external.html">External Examples</a></li>
+ </ul>
+ </div>
+
+ <div class="span4">
+ <h2>Modules</h2>
+ <ul class="nav nav-list toc-like">
+ <li><a href="modules.html">Overview of DeltaSpike Modules</a></li>
+ <li><a href="core.html">Core</a></li>
+ <li><a href="bean-validation.html">Bean Validation</a></li>
+ <li><a href="container-control.html">Container Control</a></li>
+ <li><a href="data.html">Data</a></li>
+ <li><a href="jpa.html">JPA</a></li>
+ <li><a href="jsf.html">JSF</a></li>
+ <li><a href="partial-bean.html">Partial-Bean</a></li>
+ <li><a href="scheduler.html">Scheduler</a></li>
+ <li><a href="security.html">Security</a></li>
+ <li><a href="servlet.html">Servlet</a></li>
+ <li><a href="test-control.html">Test-Control</a></li>
+ </ul>
+ </div>
+
+ <div class="span4">
+ <h2>Advanced information</h2>
+ <ul class="nav nav-list toc-like">
+ <li><a href="build.html">Build and Test DeltaSpike from Source</a></li>
+ <li><a href="snapshots.html">Use DeltaSpike Snapshots</a></li>
+ <li><a href="../migration-guide.html">Migrate to DeltaSpike</a></li>
+ <li><a href="../source.html">Contribute to the DeltaSpike Source</a></li>
+ <li><a href="spi.html">DeltaSpike Service Provider Interface (SPI)</a></li>
+ </ul>
+ </div>
+
+</div>
+++++
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/jpa.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/jpa.adoc b/documentation/src/main/asciidoc/jpa.adoc
index 8e71d90..5ba3f6a 100644
--- a/documentation/src/main/asciidoc/jpa.adoc
+++ b/documentation/src/main/asciidoc/jpa.adoc
@@ -1,3 +1,6 @@
+:moduledeps: core
+:moduleconf: api:org.apache.deltaspike.jpa.api.transaction.TransactionConfig
+
= JPA Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/jsf.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/jsf.adoc b/documentation/src/main/asciidoc/jsf.adoc
index ebf25b5..865877b 100644
--- a/documentation/src/main/asciidoc/jsf.adoc
+++ b/documentation/src/main/asciidoc/jsf.adoc
@@ -1,3 +1,6 @@
+:moduledeps: core, security
+:moduleconf: api:org.apache.deltaspike.jsf.api.config.base.JsfBaseConfig, api:org.apache.deltaspike.jsf.api.config.JsfModuleConfig
+
= JSF Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/modules.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/modules.adoc b/documentation/src/main/asciidoc/modules.adoc
index f281aad..5b8466d 100644
--- a/documentation/src/main/asciidoc/modules.adoc
+++ b/documentation/src/main/asciidoc/modules.adoc
@@ -1,21 +1,22 @@
+:notoc:
+
= Overview of DeltaSpike Modules
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
DeltaSpike consists of ready-to-use modules. These include a core module and a number of optional modules for providing additional enterprise functionality to your applications. An overview of each module is provided here and for more information see the linked individual module pages.
-[cols="1,1,2a"]
-.DeltaSpike Modules
+[cols="1,3a"]
|===
-|<<core#,Core>> | Required | For fundamental and defining DeltaSpike API and utility classes
-|<<bean-validation#,Bean Validation>> | Optional | For adding CDI support in Bean Validation, enabling creation of CDI aware `ConstraintValidator` methods that can use business objects (EJBs, ManagedBeans) to support validation needs
-|<<container-control#,Container Control>> | Optional | For CDI container booting and shutdown and associated context lifecycle management
-|<<data#,Data>> | Optional | For an enhanced JPA experience with declarative queries, reducing boilerplate to a minimum
-|<<jpa#,JPA>> | Optional | For transactional context and scope
-|<<jsf#,JSF>> | Optional | For CDI integration with JSF, with type-safe view config, multi-window handling, new scopes (WindowScoped, ViewScope, ViewAccessScoped, GroupedConversationScoped) and integration with DeltaSpike “core” messages and exception handling
-|<<partial-bean#,Partial-Bean>> | Optional | For implementing a generic handler to replace manual implementations of interfaces (or abstract classes)
-|<<scheduler#,Scheduler>> | Optional | For simple integration with Quartz v2 (default) or any other scheduler that supports cron-expressions for job-classes
-|<<security#,Security>> | Optional | For intercept and security checking on method calls
-|<<servlet#,Servlet>> | Optional | For integration with the Java Servlet API, enabling injection of common servlet objects and propagation of servlet events to the CDI event bus
-|<<test-control#,Test-Control>> | Optional | For writing CDI-based tests easily
+|<<core#,Core>> | For fundamental and defining DeltaSpike API and utility classes
+|<<bean-validation#,Bean Validation>> | For adding CDI support in Bean Validation, enabling creation of CDI aware `ConstraintValidator` methods that can use business objects (EJBs, ManagedBeans) to support validation needs
+|<<container-control#,Container Control>> | For CDI container booting and shutdown and associated context lifecycle management
+|<<data#,Data>> | For an enhanced JPA experience with declarative queries, reducing boilerplate to a minimum
+|<<jpa#,JPA>> | For transactional context and scope
+|<<jsf#,JSF>> | For CDI integration with JSF, with type-safe view config, multi-window handling, new scopes (WindowScoped, ViewScope, ViewAccessScoped, GroupedConversationScoped) and integration with DeltaSpike “core” messages and exception handling
+|<<partial-bean#,Partial-Bean>> | For implementing a generic handler to replace manual implementations of interfaces (or abstract classes)
+|<<scheduler#,Scheduler>> | For simple integration with Quartz v2 (default) or any other scheduler that supports cron-expressions for job-classes
+|<<security#,Security>> | For intercept and security checking on method calls
+|<<servlet#,Servlet>> | For integration with the Java Servlet API, enabling injection of common servlet objects and propagation of servlet events to the CDI event bus
+|<<test-control#,Test-Control>> | For writing CDI-based tests easily
|===
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/partial-bean.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/partial-bean.adoc b/documentation/src/main/asciidoc/partial-bean.adoc
index e5a2208..b5a1c69 100644
--- a/documentation/src/main/asciidoc/partial-bean.adoc
+++ b/documentation/src/main/asciidoc/partial-bean.adoc
@@ -1,3 +1,5 @@
+:moduledeps: core
+
= Partial-Bean Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/scheduler.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/scheduler.adoc b/documentation/src/main/asciidoc/scheduler.adoc
index 321201f..70fe4ba 100644
--- a/documentation/src/main/asciidoc/scheduler.adoc
+++ b/documentation/src/main/asciidoc/scheduler.adoc
@@ -1,3 +1,6 @@
+:moduledeps: core, container-control
+:moduleconf: impl:org.apache.deltaspike.scheduler.impl.SchedulerBaseConfig
+
= Scheduler Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/security.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/security.adoc b/documentation/src/main/asciidoc/security.adoc
index 79446be..362a37a 100644
--- a/documentation/src/main/asciidoc/security.adoc
+++ b/documentation/src/main/asciidoc/security.adoc
@@ -1,3 +1,5 @@
+:moduledeps: core
+
= Security Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/servlet.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/servlet.adoc b/documentation/src/main/asciidoc/servlet.adoc
index c756e55..4466a0c 100644
--- a/documentation/src/main/asciidoc/servlet.adoc
+++ b/documentation/src/main/asciidoc/servlet.adoc
@@ -1,3 +1,5 @@
+:moduledeps: core
+
= Servlet Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/documentation/src/main/asciidoc/test-control.adoc
----------------------------------------------------------------------
diff --git a/documentation/src/main/asciidoc/test-control.adoc b/documentation/src/main/asciidoc/test-control.adoc
index 64e0fc2..0ce28dd 100644
--- a/documentation/src/main/asciidoc/test-control.adoc
+++ b/documentation/src/main/asciidoc/test-control.adoc
@@ -1,3 +1,6 @@
+:moduledeps: core, container-control
+:moduleconf: api:org.apache.deltaspike.testcontrol.api.junit.TestBaseConfig, impl:org.apache.deltaspike.testcontrol.impl.jsf.MyFacesTestBaseConfig
+
= Test-Control Module
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/addons.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/addons.adoc b/site/src/main/asciidoc/addons.adoc
index 94fdaf0..dd8b52f 100644
--- a/site/src/main/asciidoc/addons.adoc
+++ b/site/src/main/asciidoc/addons.adoc
@@ -1,3 +1,5 @@
+:notoc:
+
= Add-ons
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/articles.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/articles.adoc b/site/src/main/asciidoc/articles.adoc
index 32352a8..e9e65e9 100644
--- a/site/src/main/asciidoc/articles.adoc
+++ b/site/src/main/asciidoc/articles.adoc
@@ -1,3 +1,5 @@
+:notoc:
+
= Articles and Blogs
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/community.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/community.adoc b/site/src/main/asciidoc/community.adoc
index d2a2f53..db9415c 100644
--- a/site/src/main/asciidoc/community.adoc
+++ b/site/src/main/asciidoc/community.adoc
@@ -2,9 +2,6 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-== Introduction
-
-
== Users
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/documentation.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/documentation.adoc b/site/src/main/asciidoc/documentation.adoc
index 3ba7bff..4719b7e 100644
--- a/site/src/main/asciidoc/documentation.adoc
+++ b/site/src/main/asciidoc/documentation.adoc
@@ -1,3 +1,5 @@
+:notoc:
+
= Documentation
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/download.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/download.adoc b/site/src/main/asciidoc/download.adoc
index f451a80..b51380f 100644
--- a/site/src/main/asciidoc/download.adoc
+++ b/site/src/main/asciidoc/download.adoc
@@ -1,3 +1,5 @@
+:notoc:
+
= Download
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/examples.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/examples.adoc b/site/src/main/asciidoc/examples.adoc
index aab6600..7c957df 100644
--- a/site/src/main/asciidoc/examples.adoc
+++ b/site/src/main/asciidoc/examples.adoc
@@ -1,3 +1,5 @@
+:notoc:
+
= See DeltaSpike in Action
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/javadoc.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/javadoc.adoc b/site/src/main/asciidoc/javadoc.adoc
index 3184b20..13a828f 100644
--- a/site/src/main/asciidoc/javadoc.adoc
+++ b/site/src/main/asciidoc/javadoc.adoc
@@ -1,4 +1,6 @@
-= Javadoc
+:notoc:
+
+= Javadoc
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/migration-guide.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/migration-guide.adoc b/site/src/main/asciidoc/migration-guide.adoc
index c440538..9f3e76f 100644
--- a/site/src/main/asciidoc/migration-guide.adoc
+++ b/site/src/main/asciidoc/migration-guide.adoc
@@ -2,11 +2,6 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
-== Introduction
-
-
-
== Apache MyFaces CODI to Apache DeltaSpike
=== Example Overview
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/news.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/news.adoc b/site/src/main/asciidoc/news.adoc
index 067bbd2..55200f4 100644
--- a/site/src/main/asciidoc/news.adoc
+++ b/site/src/main/asciidoc/news.adoc
@@ -1,25 +1,25 @@
-= Apache DeltaSpike News
+:notoc:
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+= Apache DeltaSpike News
-== Overview
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-=== New PMC Member (21.04.2015)
+== New PMC Member (21.04.2015)
Rafael Benevides joined our PMC.
-=== New Committer (17.14.2015)
+== New Committer (17.14.2015)
Ron Smeral joined our development community.
-=== 15th Release (1.3.0) (10.03.2015)
+== 15th Release (1.3.0) (10.03.2015)
The Apache DeltaSpike team is pleased to announce the 15th release
(v1.3.0).
The http://s.apache.org/DeltaSpike_1.3.0[release notes] contains 31 JIRA tickets.
-=== 14th Release (1.2.1) (20.12.2014)
+== 14th Release (1.2.1) (20.12.2014)
The Apache DeltaSpike team is pleased to announce the 14th release
(v1.2.1).
@@ -27,18 +27,18 @@ The Apache DeltaSpike team is pleased to announce the 14th release
The http://s.apache.org/DeltaSpike_1.2.1[release notes] contains 19 JIRA tickets.
-=== 13th Release (1.2.0) (30.11.2014)
+== 13th Release (1.2.0) (30.11.2014)
The Apache DeltaSpike team is pleased to announce the 13th release
(v1.2.0).
The http://s.apache.org/DeltaSpike_1.2.0[release notes] contains 22 JIRA tickets.
-=== New PMC Member (20.11.2014)
+== New PMC Member (20.11.2014)
Thomas Andraschko joined our PMC.
-=== 12th Release (1.1.0) (01.11.2014)
+== 12th Release (1.1.0) (01.11.2014)
The Apache DeltaSpike team is pleased to announce the 12th release (v1.1.0).
@@ -46,12 +46,12 @@ The Apache DeltaSpike team is pleased to announce the 12th release (v1.1.0).
The http://s.apache.org/DeltaSpike_1.1.0[release notes] contains 24 JIRA tickets.
-=== Duke's Choice Award (28.09.2014)
+== Duke's Choice Award (28.09.2014)
We won a https://blogs.oracle.com/java/entry/2014_duke_s_choice_award[Duke's Choice Award]!
-=== 11th Release (1.0.3) (21.09.2014)
+== 11th Release (1.0.3) (21.09.2014)
The Apache DeltaSpike team is pleased to announce the 11th release (v1.0.3).
@@ -59,33 +59,33 @@ The Apache DeltaSpike team is pleased to announce the 11th release (v1.0.3).
The http://s.apache.org/DeltaSpike_1.0.3[release notes] contains 20 JIRA tickets.
-=== 10th Release (1.0.2) (17.08.2014)
+== 10th Release (1.0.2) (17.08.2014)
The Apache DeltaSpike team is pleased to announce the 10th release (v1.0.2).
The http://s.apache.org/DeltaSpike_1.0.2[release notes] contains 15 JIRA tickets.
-=== 9th Release (1.0.1) (13.07.2014)
+== 9th Release (1.0.1) (13.07.2014)
The Apache DeltaSpike team is pleased to announce the 9th release (v1.0.1).
The http://s.apache.org/DeltaSpike_1.0.1[release notes] contains 18 JIRA tickets.
-=== 8th Release (1.0.0) (14.06.2014)
+== 8th Release (1.0.0) (14.06.2014)
The Apache DeltaSpike team is pleased to announce the 8th release (v1.0.0).
The http://s.apache.org/DeltaSpike_1.0.0[release notes] contains 48 JIRA tickets.
-=== New Committer (18.05.2014)
+== New Committer (18.05.2014)
Rafael Benevides joined our development community.
-=== 7th Release (0.7) (03.05.2014)
+== 7th Release (0.7) (03.05.2014)
The Apache DeltaSpike team is pleased to announce the 7th release (v0.7).
@@ -93,19 +93,19 @@ The Apache DeltaSpike team is pleased to announce the 7th release (v0.7).
The http://s.apache.org/DS-0.7-RNotes[release notes] contains 35 JIRA tickets.
-=== 6th Release (0.6) (20.03.2014)
+== 6th Release (0.6) (20.03.2014)
The Apache DeltaSpike team is pleased to announce the 6th release (v0.6).
The http://s.apache.org/DS-0.6-RNotes[release notes] contains 102 JIRA tickets.
-=== New Committer (14.12.2013)
+== New Committer (14.12.2013)
Thomas Andraschko joined our development community.
-=== 5th Release (0.5) (18.09.2013)
+== 5th Release (0.5) (18.09.2013)
The Apache DeltaSpike team is pleased to announce the 5th release (v0.5).
@@ -113,7 +113,7 @@ The Apache DeltaSpike team is pleased to announce the 5th release (v0.5).
The http://s.apache.org/DS-0.5-RNotes[release notes] contains 29 JIRA tickets.
-=== 4th Release (0.4) (31.05.2013)
+== 4th Release (0.4) (31.05.2013)
The Apache DeltaSpike team is pleased to announce the fourth release (v0.4).
@@ -122,13 +122,13 @@ This is our first release as a top level project!
The http://s.apache.org/DS-0.4-RNotes[release notes] contains a large list of bug fixes and new features.
-=== Graduation (28.05.2013)
+== Graduation (28.05.2013)
The Apache DeltaSpike team is pleased to announce that we have complete graduation as a top level project.
-=== 3rd Release (0.3 incubating) (22.08.2012)
+== 3rd Release (0.3 incubating) (22.08.2012)
The Apache DeltaSpike team is pleased to announce the second release (v0.3-incubating).
@@ -136,23 +136,23 @@ The Apache DeltaSpike team is pleased to announce the second release (v0.3-incub
The http://s.apache.org/DeltaSpike_03incubating[release notes] contains 104 JIRA tickets.
-=== New Committer (21.08.2012)
+== New Committer (21.08.2012)
Bolesław Dawidowicz joined our development community.
-=== New Committers (11.07.2012)
+== New Committers (11.07.2012)
Charles Moulliard and Romain Manni-Bucau joined our development community.
-=== Apache CMS (30.05.2012)
+== Apache CMS (30.05.2012)
The setup of the project-site in Apache CMS started.
-=== 2nd Release (0.2 incubating) (22.04.2012)
+== 2nd Release (0.2 incubating) (22.04.2012)
The Apache DeltaSpike team is pleased to announce the second release (v0.2-incubating).
@@ -160,100 +160,100 @@ The Apache DeltaSpike team is pleased to announce the second release (v0.2-incub
The http://s.apache.org/DeltaSpike_02incubating[release notes] contains 61 JIRA tickets.
-=== 1st Release (0.1 incubating) (10.02.2012)
+== 1st Release (0.1 incubating) (10.02.2012)
The Apache DeltaSpike team is pleased to http://s.apache.org/cTt[announce] the first release (v0.1-incubating).
The first release contains about 5 000 lines of code (including tests and 10 000 including comments). The http://s.apache.org/DeltaSpike_01incubating[release notes] contains 42 JIRA tickets.
-=== Execution of integration tests with remote servers (01.02.2012)
+== Execution of integration tests with remote servers (01.02.2012)
C4J helps us with nightly builds which deploy our integration tests to remote-servers (AS7 and GF3).
-=== New Committer (29.01.2012)
+== New Committer (29.01.2012)
Lukasz Lenart joined our development community.
-=== New Committer (28.01.2012)
+== New Committer (28.01.2012)
Christian Kaltepoth joined our development community.
-=== New Committer (27.01.2012)
+== New Committer (27.01.2012)
Rudy De Busscher joined our development community.
-=== Nabble Mirror (21.01.2012)
+== Nabble Mirror (21.01.2012)
Dan Allen created a http://s.apache.org/deltaspike-dev_nabble[Nabble mirror] for the dev-list (based on http://incubator.apache.org/mail/deltaspike-dev/)
-=== New Committers (13.01.2012)
+== New Committers (13.01.2012)
Dan Allen and Lincoln Baxter III are our first committers after the initial committers.
-=== GitHub Mirror (12.01.2012)
+== GitHub Mirror (12.01.2012)
The infra team created our mirror (https://github.com/apache/incubator-deltaspike)
-=== Creation of the Status Page (30.12.2011)
+== Creation of the Status Page (30.12.2011)
We created an initial version of our status page (http://incubator.apache.org/guides/website.html)
-=== Nightly builds (29.12.2011)
+== Nightly builds (29.12.2011)
The infra team added the GIT plugin to Jenkins and we created build jobs for nightly builds which get deployed to
https://repository.apache.org/content/groups/snapshots/org/apache/deltaspike/
-=== Sonar build (29.12.2011)
+== Sonar build (29.12.2011)
Gavin McDonald did the Sonar setup
(https://analysis.apache.org/dashboard/index/org.apache.deltaspike:deltaspike-project)
-=== First Commit (22.12.2011)
+== First Commit (22.12.2011)
The infra team created our GIT repository and we made the first commit.
-=== First JIRA ticket (13.12.2011)
+== First JIRA ticket (13.12.2011)
We created our JIRA project and filed the first ticket.
-=== First report 12.2011 (12.12.2011)
+== First report 12.2011 (12.12.2011)
We submitted the first report to
http://wiki.apache.org/incubator/December2011
-=== Twitter Account
+== Twitter Account
We created our Twitter account https://twitter.com/deltaspiketeam[@DeltaSpikeTeam]
-=== Mailing-lists (8.12.2011)
+== Mailing-lists (8.12.2011)
Matt Benson created our https://s.apache.org/Kpg[mailing-lists].
-=== Vote closed (7.12.2011)
+== Vote closed (7.12.2011)
The vote to join the incubator was closed. There were 8 binding +1
@@ -295,13 +295,13 @@ Our mentors are:
* Matthias Wessendorf
-=== Vote to join the Incubator (4.12.2011)
+== Vote to join the Incubator (4.12.2011)
Gerhard Petracek started the official http://s.apache.org/h8[vote].
-=== Proposal (30.11.2011)
+== Proposal (30.11.2011)
After some discussions between the teams (of Apache MyFaces CODI, Seam3 and CDISource), Mark Struberg submitted the
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/release-preparation.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/release-preparation.adoc b/site/src/main/asciidoc/release-preparation.adoc
index 476c5cb..b2cea9c 100644
--- a/site/src/main/asciidoc/release-preparation.adoc
+++ b/site/src/main/asciidoc/release-preparation.adoc
@@ -1,10 +1,9 @@
+:notoc:
+
= Reviewing an Apache Release
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-== Introduction
-
-
Once a Release has been staged on http://repository.apache.org it must
be reviewed by each PMC member *before* casting his VOTE.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/site/src/main/asciidoc/source.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/source.adoc b/site/src/main/asciidoc/source.adoc
index 7d8023d..6448e23 100644
--- a/site/src/main/asciidoc/source.adoc
+++ b/site/src/main/asciidoc/source.adoc
@@ -1,3 +1,5 @@
+:notoc:
+
= Contribute to the DeltaSpike Source
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://git-wip-us.apache.org/repos/asf/deltaspike/blob/8a84303c/template/document.html.erb
----------------------------------------------------------------------
diff --git a/template/document.html.erb b/template/document.html.erb
index 0d02277..85fb412 100644
--- a/template/document.html.erb
+++ b/template/document.html.erb
@@ -1,129 +1,299 @@
<%#encoding:UTF-8%><!DOCTYPE html>
<head>
-<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">
-<meta name="description" content="deltaspike-generate-pages">
-<meta name="author" content="chm">
-<!-- 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>
-
-<!--
- 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.
--->
-
-<!-- Styles -->
-
-<link href="https://deltaspike.apache.org/resources/css/bootstrap.css" rel="stylesheet">
-<link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css" rel="stylesheet">
-<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.1.0/css/font-awesome.min.css" rel="stylesheet" >
-
-<style type="text/css">
-<%= ::Asciidoctor::Stylesheets.instance.coderay_stylesheet_data %>
-
-body {
- padding-top: 60px;
- padding-bottom: 40px;
-}
-</style>
-
-<script type="text/javascript">
-
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-36103647-1']);
- _gaq.push(['_trackPageview']);
-
- (function() {
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
- })();
-
- </script>
+ <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">
+ <meta name="description" content="deltaspike-generate-pages">
+ <meta name="author" content="chm">
+ <!-- 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>
+
+ <!--
+ 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.
+ -->
+
+ <!-- Styles -->
+ <link href="https://deltaspike.apache.org/resources/css/bootstrap.css" rel="stylesheet">
+ <link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.1.0/css/font-awesome.min.css" rel="stylesheet">
+
+ <%
+ def is_toc?
+ not (attributes.has_key?('notoc'))
+ end
+ %>
+
+ <% if is_toc? then %>
+ <!-- Tocify - nice dynamic autoscrolling TOC -->
+ <link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/stylesheets/jquery.tocify.min.css" rel="stylesheet">
+ <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script>
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script>
+
+
+ <script type="text/javascript">
+ $(function () {
+ $("#toc").tocify({
+ scrollTo: 50,
+ extendPage: true,
+ context: "#doc-content",
+ selectors: "h2,h3,h4,h5"
+ });
+ $(".fallback-toc").hide();
+ });
+ </script>
+ <% end %>
+
+ <style type="text/css">
+ <%= ::Asciidoctor::Stylesheets.instance.coderay_stylesheet_data %>
+
+ body {
+ padding-top: 60px;
+ padding-bottom: 40px;
+ }
+
+ .toc-like {
+ border-radius: 6px;
+ border: 1px solid #ccc;
+ }
+
+ .toc-like li {
+ line-height: 30px;
+ text-indent: 10px;
+ }
+
+ .toc-like li.custom-toc-header {
+ font-weight: bold;
+ background: #666;
+ color: white;
+ cursor: initial !important;
+ padding: 5px;
+ }
+
+ .toc-like li.custom-toc-header a {
+ color: white;
+ font-style: normal;
+ text-shadow: none;
+ padding: 0;
+ }
+
+ .toc-like li.custom-toc-header:hover a {
+ background: #666;
+ }
+
+ .page-title {
+ text-align: left;
+ }
+
+ #doc-content h2,
+ #doc-content h3,
+ #doc-content h4,
+ #doc-content h5,
+ #doc-content h6 {
+ padding-top: 0;
+ margin-top: 25px;
+ margin-bottom: 10px;
+ line-height: 1.4em;
+ }
+
+ #doc-content h2 {
+ border-bottom: 1px solid lightgrey;
+ }
+
+
+ </style>
+
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-36103647-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function () {
+ var ga = document.createElement('script');
+ ga.type = 'text/javascript';
+ ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
</head>
<body>
- <div class="navbar navbar-fixed-top">
+<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
- <div class="container">
- <a class="btn btn-navbar" data-toggle="collapse"
- data-target=".nav-collapse"> <span class="icon-bar"></span> <span
- class="icon-bar"></span> <span class="icon-bar"></span>
- </a>
- <a class="brand logocolor" href="<%= (attr :sitebasedir) %>/index.html">Apache DeltaSpike</a>
- <div class="nav-collapse">
-
- <%
- def active_page(page)
- docpage = attributes.has_key?('docpage') ? attributes['docpage'] : attributes['docname']
- 'class="active"' if docpage == page
- end
- %>
- <ul class="nav">
- <li><a href="<%= (attr :sitebasedir) %>/index.html">Home</a></li>
- <li <%= active_page("documentation") %>><a href="<%= (attr :sitebasedir) %>/documentation">Documentation</a></li>
- <li <%= active_page("javadoc") %> ><a href="<%= (attr :sitebasedir) %>/javadoc.html">Javadoc</a></li>
- <li <%= active_page("source") %>><a href="<%= (attr :sitebasedir) %>/source.html">Source</a></li>
- <li <%= active_page("download") %>><a href="<%= (attr :sitebasedir) %>/download.html">Download</a></li>
- <li <%= active_page("community") %>><a href="<%= (attr :sitebasedir) %>/community.html">Community</a></li>
- <!-- <li><a href="./support.html">Support</a></li> -->
- <li <%= active_page("news") %>><a href="<%= (attr :sitebasedir) %>/news.html">News</a></li>
- <li <%= active_page("migration-guide") %>><a href="<%= (attr :sitebasedir) %>/migration-guide.html">Migration</a></li>
- </ul>
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse"
+ data-target=".nav-collapse"> <span class="icon-bar"></span> <span
+ class="icon-bar"></span> <span class="icon-bar"></span>
+ </a>
+ <a class="brand logocolor" href="<%= (attr :sitebasedir) %>/index.html">Apache DeltaSpike</a>
+
+ <div class="nav-collapse">
+
+ <%
+ def active_page(page)
+ docpage = attributes.has_key?('docpage') ? attributes['docpage'] : attributes['docname']
+ 'class="active"' if docpage == page
+ end
+ %>
+ <ul class="nav">
+ <li><a href="<%= (attr :sitebasedir) %>/index.html">Home</a></li>
+ <li <%= active_page("documentation") %>><a href="<%= (attr :sitebasedir) %>/documentation">Documentation</a></li>
+ <li <%= active_page("javadoc") %> ><a href="<%= (attr :sitebasedir) %>/javadoc.html">Javadoc</a></li>
+ <li <%= active_page("source") %>><a href="<%= (attr :sitebasedir) %>/source.html">Source</a></li>
+ <li <%= active_page("download") %>><a href="<%= (attr :sitebasedir) %>/download.html">Download</a></li>
+ <li <%= active_page("community") %>><a href="<%= (attr :sitebasedir) %>/community.html">Community</a></li>
+ <!-- <li><a href="./support.html">Support</a></li> -->
+ <li <%= active_page("news") %>><a href="<%= (attr :sitebasedir) %>/news.html">News</a></li>
+ <li <%= active_page("migration-guide") %>><a href="<%= (attr :sitebasedir) %>/migration-guide.html">Migration</a></li>
+ </ul>
+ </div>
+ <!--/.nav-collapse -->
+ <form id="search-form" action="https://www.google.com/search"
+ method="get" class="navbar-search pull-right">
+ <input value="deltaspike.apache.org" name="sitesearch"
+ type="hidden"> <input class="search-query" name="q"
+ id="query" type="text">
+ </form>
</div>
- <!--/.nav-collapse -->
- <form id="search-form" action="https://www.google.com/search"
- method="get" class="navbar-search pull-right">
- <input value="deltaspike.apache.org" name="sitesearch"
- type="hidden"> <input class="search-query" name="q"
- id="query" type="text">
- </form>
- </div>
</div>
- </div>
+</div>
- <div class="container">
- <div class="row">
- <div class="span12">
- <div class="page-title">
- <h1><%= document.name %></h1>
- </div>
+<div class="container">
+ <div class="row-fluid">
+
+ <%
+ MODULEDEPS = 'moduledeps' unless defined? MODULEDEPS
+ MODULECONF = 'moduleconf' unless defined? MODULECONF
+ MODULEBASE = 'modulebase' unless defined? MODULEBASE
+ CONF_LINK = "https://github.com/apache/deltaspike/blob/master/deltaspike/%{base}/%{proj}/src/main/java/%{fqn}.java" unless defined? CONF_LINK
+
+ # module dependencies
+ def dep_name(short_name)
+ short_name.tr('-', ' ').capitalize
+ end
+
+ def has_deps?
+ if attributes.has_key?(MODULEDEPS) && !(attributes[MODULEDEPS].empty?)
+ attributes[MODULEDEPS].split(%r{\s*,\s*}).size > 0
+ else
+ false
+ end
+ end
+
+ def deps_list()
+ attributes[MODULEDEPS].split(%r{\s*,\s*})
+ end
+
+ # module configuration
+ def module_base()
+ if attributes.has_key?(MODULEBASE) && !(attributes[MODULEBASE].empty?)
+ attributes[MODULEBASE]
+ else
+ 'modules/' + attributes['docname']
+ end
+ end
- <div id="toc" class="<%= attr 'toc-class', 'toc' %>">
- <%= converter.convert_with_options @document, 'outline', :toclevels => 4 %>
- <hr>
- <%= document.content %>
+ def conf_name(fqn)
+ fqn[fqn.rindex(".")+1..-1]
+ end
+
+ def conf_link(in_fqn)
+ CONF_LINK % { base: module_base(), proj: in_fqn.split(':')[0], fqn: in_fqn.split(':')[1].tr('.', '/') }
+ end
+
+ def has_conf?
+ if attributes.has_key?(MODULECONF) && !(attributes[MODULECONF].empty?)
+ attributes[MODULECONF].split(%r{\s*,\s*}).size > 0
+ else
+ false
+ end
+ end
+
+ def conf_list()
+ attributes[MODULECONF].split(%r{\s*,\s*})
+ end
+ %>
+
+ <div class="<%= if is_toc? or has_deps? or has_conf? then
+ 'span8'
+ else
+ 'span12'
+ end %>">
+ <div class="page-title">
+ <h1><%= document.name %></h1>
+ </div>
+
+ <div id="doc-content">
+ <%= document.content %>
+ </div>
</div>
- <hr>
+ <% if is_toc? or has_deps? or has_conf? then %>
+ <div class="span4">
+ <div id="toc">
+ <div class="moduledeps">
+ <ul class="toc-like nav nav-list">
+ <% if has_deps? then %>
+ <li class="custom-toc-header">Depends on</li>
+ <% deps_list().each { |dep| %>
+ <li><a href="<%= dep %>.html"><%= dep_name(dep) %></a></li>
+ <% } %>
+ <% end %>
+ <% if has_conf? then %>
+ <li class="custom-toc-header"><a href="core.html#_internal_configuration">Configuration</a></li>
+ <% conf_list().each { |conf| %>
+ <li><a href="<%= conf_link(conf) %>"><%= conf_name(conf) %></a></li>
+ <% } %>
+ <% end %>
+ <% if is_toc? && (has_deps? or has_conf?) then %>
+ <li class="custom-toc-header">Table of Contents</li>
+ <% end %>
+ </ul>
+ </div>
+ </div>
+ <% if is_toc? then %>
+ <div class="fallback-toc">
+ <%= converter.convert_with_options @document, 'outline', :toclevels => 4 %>
+ </div>
+ <% end %>
+ </div>
+ <% end %>
+ </div>
+ <div class="row">
+ <hr>
<footer>
- <p>Copyright © 2011-2014 The Apache Software Foundation,
- Licensed under the Apache License, Version 2.0.</p>
- <p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ <p>Copyright © 2011-2014 The Apache Software Foundation,
+ Licensed under the Apache License, Version 2.0.</p>
+
+ <p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
</footer>
- </div>
</div>
- </div>
+</div>
+
</body>
</html>