You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ar...@apache.org on 2006/07/18 12:47:22 UTC

svn commit: r423044 - in /maven/plugins/trunk/maven-rar-plugin/src/site: ./ apt/ apt/examples/ fml/

Author: aramirez
Date: Tue Jul 18 03:47:20 2006
New Revision: 423044

URL: http://svn.apache.org/viewvc?rev=423044&view=rev
Log:
PR: MRAR-12

revised docs based on the comments from the dev list

Added:
    maven/plugins/trunk/maven-rar-plugin/src/site/fml/
    maven/plugins/trunk/maven-rar-plugin/src/site/fml/faq.fml
Modified:
    maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt
    maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt
    maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt
    maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt
    maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt
    maven/plugins/trunk/maven-rar-plugin/src/site/site.xml

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt Tue Jul 18 03:47:20 2006
@@ -1,5 +1,5 @@
   ------
-  Maven 2 RAR Plugin - Exclude the project jar
+  Exclude the project jar in the RAR
   ------
   Stephane Nicoll
   Allan Ramirez

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt Tue Jul 18 03:47:20 2006
@@ -1,5 +1,5 @@
   ------
-  Maven RAR Plugin - Including extra files in the RAR
+  Include extra files in the RAR
   ------
   Allan Ramirez
   ------

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt Tue Jul 18 03:47:20 2006
@@ -1,5 +1,5 @@
   ------
-  Maven 2 RAR Plugin - Adding manifest in the RAR
+  Adding Manifest File
   ------
   Allan Ramirez
   ------

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt Tue Jul 18 03:47:20 2006
@@ -1,5 +1,5 @@
   ------
-  Maven 2 RAR Plugin - Custom location of the Resource Adapter Descriptor
+  Custom location of the Resource Adapter Descriptor
   ------
   Stephane Nicoll
   Allan Ramirez

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt Tue Jul 18 03:47:20 2006
@@ -1,12 +1,12 @@
   ------
-  Maven 2 RAR Plugin
+  Introduction
   ------
   Allan Ramirez
   ------
   July 2006
   ------
 
-Maven 2 RAR Plugin - Introduction
+Introduction
 
   A resource adapter is a system-level software driver that a Java application
   uses to connect to an enterprise information system (EIS). The RAR plugin

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt Tue Jul 18 03:47:20 2006
@@ -1,5 +1,5 @@
   ------
-  Maven 2 RAR Plugin
+  Usage
   ------
   Allan Ramirez
   ------
@@ -8,7 +8,7 @@
 
 Usage
 
-  The RAR plugin is binded to the <<<package>>> phase of the build lifecycle.
+  The RAR plugin is bound to the <<<package>>> phase of the build lifecycle.
   To be able to generate the RAR as part of the lifecycle, the plugin should
   be declared at the \<build\> section of the pom.
 

Added: maven/plugins/trunk/maven-rar-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/fml/faq.fml?rev=423044&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/fml/faq.fml Tue Jul 18 03:47:20 2006
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+   <faq id="question">
+     <question>Is the rar file generated by the maven-rar-plugin is the same with the rar file(compressed file) of WinRar?</question>
+     <answer>
+       <p>
+            No. They are entirely different from each other.
+       </p>
+       <p>
+            A Resource Adapter Archive (RAR) file is a Java archive (JAR) file used to package a resource adapter for the Java 2 Connector (J2C) Architecture
+            <br/>
+            A RAR file can contain the following:
+            <br/>
+              <ul>
+                <li>Enterprise information system (EIS) supplied resource adapter implementation code in the form of JAR files or other runnable components, such as dynamic link lists.</li>
+                <li>Utility classes.</li>
+                <li>Static documents, such as HTML files, images, and sound files.</li>
+              </ul>
+       </p>
+       <p>
+            While RAR(Roshal ARchive) is the native format of WinRAR archiver. Like other archives, RAR files
+            are data containers, they store one or several files in the compressed form.
+            After you downloaded RAR file from Internet, you need to unpack its contents in order to use it.
+       </p>
+     </answer>
+   </faq>
+ </part>
+</faqs>
\ No newline at end of file

Modified: maven/plugins/trunk/maven-rar-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/site.xml?rev=423044&r1=423043&r2=423044&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/site.xml Tue Jul 18 03:47:20 2006
@@ -35,6 +35,7 @@
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>
       <item name="Usage" href="usage.html"/>
+      <item name="Goals" href="plugin-info.html" />
       <item name="FAQ" href="faq.html"/>
     </menu>
     <menu name="Examples">