From 6a9b3d807097437ba032e986f6fa61a39f05ab15 Mon Sep 17 00:00:00 2001
From: jensp <jensp@8810af33-2d31-482b-a856-94f89814c4df>
Date: Thu, 22 Oct 2015 16:10:05 +0000
Subject: [PATCH] CCM NG: Documentation for the content type archetype

git-svn-id: https://svn.libreccm.org/ccm/ccm_ng@3706 8810af33-2d31-482b-a856-94f89814c4df
---
 .../src/site/apt/index.apt                    | 61 +++++++++++++++++++
 .../src/site/site.xml                         | 24 ++++++++
 2 files changed, 85 insertions(+)
 create mode 100644 ccm-cms-archetype-contenttype/src/site/apt/index.apt
 create mode 100644 ccm-cms-archetype-contenttype/src/site/site.xml

diff --git a/ccm-cms-archetype-contenttype/src/site/apt/index.apt b/ccm-cms-archetype-contenttype/src/site/apt/index.apt
new file mode 100644
index 000000000..15a777c90
--- /dev/null
+++ b/ccm-cms-archetype-contenttype/src/site/apt/index.apt
@@ -0,0 +1,61 @@
+            ------------------------------------
+            LibreCMS Archetype for Content Types
+            ------------------------------------
+                    Jens Pelzetter
+            ------------------------------------
+                      2015-10-22
+            ------------------------------------
+
+LibreCMS Archetype for Content Types
+
+    This archetype can be used.to create a skeleton for content type for
+    LibreCMS. The archetype requires the following properties:
+
+* Installation
+
+    At the moment it is necessary to install the archetype manually using
+
+--------------------------------------------------------------------------------
+    mvn install -pl ccm-cms-archetype-contenttype
+--------------------------------------------------------------------------------
+
+* Usage
+    
+    There are different ways to use an archetype to create a new module. The 
+    simplest way is use the archetype is to run the following command:
+
+----------------------------------------------------------------------------
+    mvn archetype:generate -DarchetypeGroupId=org.librecms -DarchetypeArtifactId=ccm-cms-archetype-contenttype
+--------------------------------------------------------------------------------
+
+    Maven will than ask for all required properties needed for creating a new
+    content type. The following properties are required:
+
+    [groupId] The <<<groupId>>> of the new content type module
+    [artifactId] The <<<artifactId>>> of the new content type module. It is
+                 recommended (for official modules mandatory) to use the 
+                 following pattern for the <<<artifactId>>>: 
+                 <<<ccm-cms-types-$typename>>>. For special branches like
+                 APLAWS+ or ScientificCMS the pattern might differ.
+    [package] The package for the classes of the new content type module. 
+              Defaults to the <<<groupId>>>. It is recommanded to place all 
+              classes belonging to a content type into a separate package. For 
+              example for the content <<<ccm-cms-types-foo>>> all classes 
+              belonging to that content type should be placed into the package
+              <<<org.librecms.contenttypes.foo>>>.
+    [typeName] The name of the type. Must be a valid class name. If the 
+               recommended pattern for the <<<artifactId>>> is used the last 
+               token of the <<<artifactId>>> (with a capitalised
+               first letter) should be used. For instance the type name of
+               <<<ccm-cms-types-foo>>> should be <<<Foo>>>.
+    [schemaName] The name of the database schema used to store the tables for
+                 the module. Defaults to the <<<artifactId>>>. It is recommended
+                 to customise the <<<schemaName>>> to avoid problems with SQL. 
+                 For example all dashes should be replaced with underscores. 
+                 Also the name of the schema should be shortened. For the 
+                 content type <<<ccm-cms-types-foo>>> a valid schema names would 
+                 be <<<ccm_cms_types_foo>>>, <<<cms_foo>>> or 
+                 <<<cms_types_foo>>>.
+
+
+    
\ No newline at end of file
diff --git a/ccm-cms-archetype-contenttype/src/site/site.xml b/ccm-cms-archetype-contenttype/src/site/site.xml
new file mode 100644
index 000000000..ad2aff10a
--- /dev/null
+++ b/ccm-cms-archetype-contenttype/src/site/site.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project xmlns="http://maven.apache.org/DECORATION/1.3.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 
+                             http://maven.apache.org/xsd/decoration-1.3.0.xsd">
+    
+    <body>
+        <menu name="Parent project">
+            <item name="LibreCCM" href="../index.html"/>
+        </menu>
+        
+        <menu name="Overview">
+            <item name="Using the archetype" href="index.html"/>
+        </menu>
+        
+        <!--<menu ref="reports"/>-->
+    </body>
+    <!--<skin>
+        <groupId>org.apache.maven.skins</groupId>
+        <artifactId>maven-fluido-skin</artifactId>
+        <version>1.4</version>
+    </skin>-->
+    
+</project>