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 <<>> of the new content type module + [artifactId] The <<>> of the new content type module. It is + recommended (for official modules mandatory) to use the + following pattern for the <<>>: + <<>>. 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 <<>>. It is recommanded to place all + classes belonging to a content type into a separate package. For + example for the content <<>> all classes + belonging to that content type should be placed into the package + <<>>. + [typeName] The name of the type. Must be a valid class name. If the + recommended pattern for the <<>> is used the last + token of the <<>> (with a capitalised + first letter) should be used. For instance the type name of + <<>> should be <<>>. + [schemaName] The name of the database schema used to store the tables for + the module. Defaults to the <<>>. It is recommended + to customise the <<>> 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 <<>> a valid schema names would + be <<>>, <<>> or + <<>>. + + + \ 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 @@ + + + + + + + + + + + + + + + + +