mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-07-31 17:39:14 +00:00
Update site, still work in progress
This commit is contained in:
Ole Hejlskov
@@ -3,7 +3,7 @@
|
||||
<groupId>org.alfresco.maven.plugin</groupId>
|
||||
<artifactId>alfresco-maven-plugin</artifactId>
|
||||
<packaging>maven-plugin</packaging>
|
||||
<name>Maven Alfresco Plugin</name>
|
||||
<name>Alfresco Maven Plugin</name>
|
||||
|
||||
<parent>
|
||||
<groupId>org.alfresco.maven</groupId>
|
||||
|
||||
@@ -1,33 +1,23 @@
|
||||
------
|
||||
Introduction
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
------
|
||||
|
||||
Introduction
|
||||
|
||||
The Maven Alfresco Plugin provides development features to manage {{{http://www.alfresco.com}Alfresco ECM}} WAR and {{{https://wiki.alfresco.com/wiki/AMP_Files}AMP}} project lifecycles.
|
||||
The Alfresco Maven Plugin provides development features to manage {{{http://www.alfresco.com}Alfresco Platform}} WAR, JAR and {{{https://community.alfresco.com/docs/DOC-5146-amp-files}AMP}} project lifecycles.
|
||||
|
||||
* Goals Overview
|
||||
|
||||
The Maven Alfresco plugin has three goals:
|
||||
The Alfresco Maven Plugin has three goals:
|
||||
|
||||
*{{{./amp-mojo.html}alfresco:amp}} Packages an AMP file
|
||||
*{{{./run-mojo.html}alfresco:run}} Starts up Alfresco Platform, Share and Solr with your and 3rd party customizations
|
||||
|
||||
*{{{./install-mojo.html}alfresco:install}} Installs one or multiple AMPs into an Alfresco WAR / exploded WAR folder embedding {{{http://wiki.alfresco.com/wiki/Module_Management_Tool} Alfresco MMT}}
|
||||
|
||||
*{{{./set-version-mojo.html}alfresco:version}} Parses <<<$\{project.version\}>>> removing literals (for AMP compatibility) and making the <<<$\{noSnapshotVersion\}>>> property available in the POM
|
||||
|
||||
Full information is available at the {{{./plugin-info.html}goals page}}.
|
||||
|
||||
* Usage
|
||||
|
||||
General instructions on how to use the Maven Alfresco Plugin can be found on the {{{./usage.html}usage page}}.
|
||||
|
||||
The Maven Alfresco Plugin provides support for <<<amp>>> packaging in your Maven projects and allows you to
|
||||
build AMPs as well as used them as standard Maven dependencies. You can also use AMPs as part of the standard
|
||||
{{{http://maven.apache.org/plugins/maven-war-plugin/overlays.html}maven-war-plugin}} <<< <overlays> >>> configuration.
|
||||
General instructions on how to use the Alfresco Maven Plugin can be found on the {{{./usage.html}usage page}}.
|
||||
|
||||
For more complex usage of the Maven Alfresco Plugin check the {{{./advanced-usage.html}advanced usage page}}.
|
||||
@@ -1,62 +1,28 @@
|
||||
------
|
||||
Usage
|
||||
------
|
||||
Gabriele Columbro
|
||||
------
|
||||
Nov 2012
|
||||
------
|
||||
|
||||
|
||||
How to use this plugin?
|
||||
|
||||
There are fundamentally 3 methods to use this plugin:
|
||||
There are fundamentally two methods to use this plugin:
|
||||
|
||||
[[1]] Using Archetypes provided in the Alfresco SDK
|
||||
|
||||
[[2]] By using the Alfresco SDK Parent POM
|
||||
|
||||
[[3]] Via direct configuration in your POM
|
||||
|
||||
[[2]] Via direct configuration in your POM
|
||||
|
||||
* Method 1 - Using Alfresco SDK Archetypes
|
||||
|
||||
Two sample archetypes already use the plugin and provide best practice example on how to use it:
|
||||
|
||||
[[1]] The {{{../../archetypes/alfresco-amp-archetype/index.html} Alfresco AMP Archetype}} provides a sample of AMP packaging
|
||||
[[1]] The {{{../../archetypes/alfresco-platform-jar-archetype/index.html} Alfresco Platform JAR Archetype}} provides a sample of JAR packaging with AMP as an optional assembly for 3rd party dependencies
|
||||
|
||||
[[2]] The {{{../../archetypes/alfresco-allinone-archetype/index.html} Alfresco All-in-One Archetype}} provides a sample using AMPs as dependencies and WAR overlay
|
||||
[[2]] The {{{../../archetypes/alfresco-allinone-archetype/index.html} Alfresco All-in-One Archetype}} provides a sample using JARs for both Alfresco Platform and Share
|
||||
|
||||
|
||||
This is the <<recommended>> and less error-prone way of using the plugin.
|
||||
|
||||
* Method 2 - Using Alfresco SDK Parent POM
|
||||
|
||||
The {{{../../poms/alfresco-sdk-parent/index.html}Alfresco SDK Parent POM}} provides a single entry point for all SDK features.
|
||||
|
||||
By using it as parent as follows:
|
||||
|
||||
+---+
|
||||
<project>
|
||||
...
|
||||
<parent>
|
||||
<groupId>org.alfresco.maven</groupId>
|
||||
<artifactId>alfresco-sdk-parent</artifactId>
|
||||
<version>1.0</version>
|
||||
</parent>
|
||||
...
|
||||
</project>
|
||||
+---+
|
||||
|
||||
you will have automatic support for AMP packaging of your project (just add you sources in <<<src/main/amp>>>).
|
||||
|
||||
* Method 3 - Direct configuration in POM
|
||||
|
||||
If you want more control over the plugin behavior you can use it directly in your POM.
|
||||
|
||||
<<NOTE>>: The following configuration is not required when using the SDK parent, as it's already included there.
|
||||
|
||||
In order to manage AMP artifacts with the Maven Alfresco plugin you need to:
|
||||
|
||||
* Declare the plugin in your POM with <<<<extensions>>>> enabled, to allow AMP packaging lifecycle:
|
||||
|
||||
|
||||
+---+
|
||||
<project>
|
||||
[...]
|
||||
@@ -67,7 +33,25 @@ How to use this plugin?
|
||||
<groupId>org.alfresco.maven.plugin</groupId>
|
||||
<artifactId>alfresco-maven-plugin</artifactId>
|
||||
<version>${project.version}</version>
|
||||
<extensions>true</extensions>
|
||||
<plugin>
|
||||
<groupId>org.alfresco.maven.plugin</groupId>
|
||||
<artifactId>alfresco-maven-plugin</artifactId>
|
||||
<version>3.0.0</version>
|
||||
<configuration>
|
||||
<alfrescoEdition>community</alfrescoEdition>
|
||||
<enableH2>true</enableH2>
|
||||
<enablePlatform>true</enablePlatform>
|
||||
<enableSolr>true</enableSolr>
|
||||
<enableShare>false</enableShare>*
|
||||
<platformModules>
|
||||
<moduleDependency>
|
||||
<groupId>${alfresco.groupId}</groupId>
|
||||
<artifactId>alfresco-share-services</artifactId>
|
||||
<version>${alfresco.share.version}</version>
|
||||
<type>amp</type>
|
||||
</moduleDependency>
|
||||
</platformModules>
|
||||
</configuration>
|
||||
</plugin>
|
||||
...
|
||||
</plugins>
|
||||
@@ -75,25 +59,3 @@ How to use this plugin?
|
||||
[...]
|
||||
</project>
|
||||
+---+
|
||||
|
||||
* If you want to package an Alfresco Module Package from your <<<amp>>> packaging project you also need to make sure
|
||||
your AMP content gets copied to <<<\${project.build.directory}/\${project.build.finalName}>>> so the plugin can pick them up.
|
||||
Supposing your AMP sources are in <<<src/main/amp>>> you should configure the following <<<<resource>>>> block:
|
||||
|
||||
+---+
|
||||
<project>
|
||||
[...]
|
||||
<build>
|
||||
<resources>
|
||||
...
|
||||
<resource>
|
||||
<directory>src/main/amp</directory>
|
||||
<!-- This is relative to \${project.build.outputDirectory} -->
|
||||
<targetPath>../\${project.build.finalName}</targetPath>
|
||||
<filtering>${app.filtering.enabled}</filtering>
|
||||
</resource>
|
||||
</resources>
|
||||
</build>
|
||||
[...]
|
||||
</project>
|
||||
+---+
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
.pippo {}
|
||||
|
||||
body.topBarEnabled {
|
||||
padding-top: 100px;
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.1 KiB |
@@ -1,28 +1,25 @@
|
||||
<project>
|
||||
<body>
|
||||
<!--<menu ref="parent" inherit="bottom"/>-->
|
||||
<head>
|
||||
<script type="text/javascript">
|
||||
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', '${gaTrackingId}']);
|
||||
_gaq.push(['_trackPageview']);
|
||||
|
||||
(function() {
|
||||
<![CDATA[
|
||||
<script type="text/javascript">
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', '${gaTrackingId}']);
|
||||
_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>
|
||||
})();
|
||||
</script>
|
||||
]]>
|
||||
</head>
|
||||
|
||||
<menu name="Maven Alfresco Plugin">
|
||||
<menu name="Alfresco Maven Plugin">
|
||||
<item name="Introduction" href="index.html"/>
|
||||
<item name="Goals" href="plugin-info.html"/>
|
||||
<item name="Usage" href="usage.html"/>
|
||||
<item name="Advanced Usage" href="advanced-usage.html"/>
|
||||
<item name="Plexus Components" href="plexus-components.html"/>
|
||||
</menu>
|
||||
|
||||
<menu name="SDK components">
|
||||
|
||||
Reference in New Issue
Block a user