directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fel...@apache.org
Subject svn commit: r606493 - in /directory/sandbox/felixk/studio-plugin/src/site: ./ apt/ apt/examples/ fml/
Date Sat, 22 Dec 2007 21:06:06 GMT
Author: felixk
Date: Sat Dec 22 13:06:05 2007
New Revision: 606493

URL: http://svn.apache.org/viewvc?rev=606493&view=rev
Log:
Some documentation

Added:
    directory/sandbox/felixk/studio-plugin/src/site/apt/examples/replace-file-in-eclipse-artifact.apt
      - copied unchanged from r606408, directory/sandbox/felixk/studio-plugin/src/site/apt/examples/replace-file-in-jar.apt
    directory/sandbox/felixk/studio-plugin/src/site/apt/examples/unpack-with-artifactid-prefix.apt
      - copied unchanged from r606408, directory/sandbox/felixk/studio-plugin/src/site/apt/examples/unpack-with-prefix.apt
Removed:
    directory/sandbox/felixk/studio-plugin/src/site/apt/examples/replace-file-in-jar.apt
    directory/sandbox/felixk/studio-plugin/src/site/apt/examples/unpack-with-prefix.apt
Modified:
    directory/sandbox/felixk/studio-plugin/src/site/apt/index.apt
    directory/sandbox/felixk/studio-plugin/src/site/fml/faq.fml
    directory/sandbox/felixk/studio-plugin/src/site/site.xml

Modified: directory/sandbox/felixk/studio-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-plugin/src/site/apt/index.apt?rev=606493&r1=606492&r2=606493&view=diff
==============================================================================
--- directory/sandbox/felixk/studio-plugin/src/site/apt/index.apt (original)
+++ directory/sandbox/felixk/studio-plugin/src/site/apt/index.apt Sat Dec 22 13:06:05 2007
@@ -34,16 +34,29 @@
 
 * Goals Overview
 
-  The directory studio maven plugin has 2 goals:
+  The directory studio maven plugin has 6 goals:
   
-  *{{{replace-file-in-eclipse-artifact-mojo.html}studio:replace-file-in-eclipse-artifact}}
takes a list of artifacts defined in
+  * {{{prepare-jar-package-mojo.html}studio:prepare-jar-package}} prepares for building jar
- copy artifacts not scoped "provided" 
+  to ${project.build.outputDirectory}/libraryPath (default is target/classes/lib)
+  
+  * {{{unpack-with-artifactid-prefix-mojo.html}studio:unpack-with-artifactid-prefix}} unpack
an artifact in a desired location and put
+  the artifact content into a directory named like the final artifacts name (This is mainly
used
+  to unpack a *-feature.jar).
+
+  * {{{clean-mojo.html}studio:clean}} cleans stuff generated by {{{eclipse-mojo.html}studio:eclipse}}
+  
+  * {{{replace-file-in-eclipse-artifact-mojo.html}studio:replace-file-in-eclipse-artifact}}
takes a list of artifacts defined in
   the plugin configuration section and a configured directory where the artifacts
   are located (not in the local maven repository, but after a being copied e.g. to target
   directory) and replaced/adds a desired file to them.
 
-  *{{{unpack-with-artifactid-prefix-mojo.html}studio:unpack-with-artifactid-prefix}} unpack
an artifact in a desired location and put
-  the artifact content into a directory named like the final artifacts name (This is mainly
used
-  to unpack a *-feature.jar).
+  * {{{eclipse-mojo.html}studio:eclipse}} prepares for eclipse:\
+      Copy artifacts nonscoped "provided" to ${basedir}/lib.\
+      Add artifacts not scoped "provided" to Bundle-ClassPath in MANIFEST.MF.\
+      Adapt ${basedir}/.classpath for artifacts not scoped "provided".\
+
+  * {{{copy-eclipse-artifact-mojo.html}studio:copy-eclipse-artifact}}Copy a set of artifacts
to a configured output directory 
+  by replacing the separator between artifactId and version by an underscore instead of a
dash.
 
   []
   
@@ -52,11 +65,3 @@
    * Instructions on how to use the dependency plugin can be found {{{usage.html}here}}.
 
   []
-
-* Examples
-
-  The following examples show how to use the directory studio maven plugin in more advanced
use-cases:
-  
-  * {{{examples/replace-file-in-jar.html}replace/update a file in jar artifacts at a given
location}}.
-
-  * {{{examples/unpack-with-prefix.html}Unpack artifact content into prefixed destination}}

Modified: directory/sandbox/felixk/studio-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-plugin/src/site/fml/faq.fml?rev=606493&r1=606492&r2=606493&view=diff
==============================================================================
--- directory/sandbox/felixk/studio-plugin/src/site/fml/faq.fml (original)
+++ directory/sandbox/felixk/studio-plugin/src/site/fml/faq.fml Sat Dec 22 13:06:05 2007
@@ -24,38 +24,55 @@
 <part id="general">
     <title>General</title>
    
-    <faq id="whats-foo">
+    <faq id="Adapting .classpath">
       <question>
-        What is Foo?
+        My classpath is not updated for a specific module. What is wrong?
       </question>
       <answer>
-        <p>some markup goes here</p>
-        
-        <source>some source code</source>
-        
-        <p>some markup goes here</p>
+        <p>You need to have set the skip flag to false, that the studio:eclipse goal
is executed on your module.</p>
+        <source>
+<build>
+  <plugins>
+    <plugin>
+      <groupId>org.apache.directory.studio</groupId>
+      <artifactId>maven-studio-plugin</artifactId>
+      <configuration>
+        <skip>false</skip>
+      </configuration>
+    </plugin>
+  </plugins>
+</build>
+        </source>
       </answer>
     </faq>
 
-    <faq id="whats-bar">
-      <question>
-        What is Bar?
-      </question>
-      <answer>
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
   </part>
   
   <part id="install">
     <title>Installation</title>
    
-    <faq id="how-install">
+    <faq id="Prefixing plugin goal">
       <question>
-        How do I install Foo?
+        Running mvn studio:{goal} maven doesn't finds the plugin 'studio'. What's wrong?
       </question>
       <answer>
-        <p>some markup goes here</p>
+        <p>The studio plugin has not the default package name for maven plugins. You
need to prefix the studio plugin. See
+        <a href="http://maven.apache.org/guides/introduction/introduction-to-plugin-prefix-mapping.html">Introduction
to 
+        Plugin Prefix Resolution</a> or do the prefixing within your projects root
pom:
+        <source>
+<build>
+  <plugins>
+    <plugin>
+      <groupId>org.apache.directory.studio</groupId>
+      <artifactId>maven-studio-plugin</artifactId>
+        <configuration>
+          <goalPrefix>studio</goalPrefix>
+        </configuration>
+      </plugin>
+  </plugins>
+</build>
+        </source>
+        </p>
       </answer>
     </faq>
   </part>  

Modified: directory/sandbox/felixk/studio-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-plugin/src/site/site.xml?rev=606493&r1=606492&r2=606493&view=diff
==============================================================================
--- directory/sandbox/felixk/studio-plugin/src/site/site.xml (original)
+++ directory/sandbox/felixk/studio-plugin/src/site/site.xml Sat Dec 22 13:06:05 2007
@@ -1,37 +1,39 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    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.
+  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.
 -->
 <!--
-    @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
-    @version $Id: pom.xml 353 2007-10-28 14:59:35Z felix $
+  @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+  @version $Id: pom.xml 353 2007-10-28 14:59:35Z felix $
 -->
 
 <project>
-    <body>
-        <menu name="Overview">
-            <item name="Introduction" href="index.html" />
-            <item name="Goals" href="plugin-info.html" />
-            <item name="Usage" href="usage.html" />
-            <item name="FAQ" href="faq.html" />
-        </menu>
-        <menu name="Examples">
-            <item name="Unpack with prefix" href="examples/unpack-with-prefix.html" />
-            <item name="Add/replace file in distributed artifact" href="examples/replace-file-in-jar.html"
/>
-        </menu>
-        <menu ref="reports" />
-    </body>
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html" />
+      <item name="Goals" href="plugin-info.html" />
+      <item name="Usage" href="usage.html" />
+      <item name="FAQ" href="faq.html" />
+    </menu>
+    <menu name="Examples">
+      <item name="prepare-jar-package" href="examples/prepare-jar-package.html" />
+      <item name="unpack-with-artifactid-prefix" href="examples/unpack-with-artifactid-prefix.html"
/>
+      <item name="replace-file-in-eclipse-artifact" href="examples/replace-file-in-eclipse-artifact.html"
/>
+      <item name="copy-eclipse-artifact" href="examples/copy-eclipse-artifact.html" />
+    </menu>
+    <menu ref="reports" />
+  </body>
 </project>



Mime
View raw message