Index: src/site/site.xml =================================================================== --- src/site/site.xml (revision 427015) +++ src/site/site.xml (working copy) @@ -1,53 +1,51 @@ - - - - - - - Maven Rar Plugin - http://maven.apache.org/images/apache-maven-project.png - http://maven.apache.org/ - - - http://maven.apache.org/images/maven-small.gif - - - - - - - - - - - - - - - - - - - - - - - ${reports} - - + + + + + + + Maven Rar Plugin + http://maven.apache.org/images/apache-maven-project.png + http://maven.apache.org/ + + + http://maven.apache.org/images/maven-small.gif + + + + + + + + + + + + + + + + + + + + + + + ${reports} + + Index: src/site/apt/usage.apt =================================================================== --- src/site/apt/usage.apt (revision 427015) +++ src/site/apt/usage.apt (working copy) @@ -1,52 +1,69 @@ - ------ - Usage - ------ - Allan Ramirez - ------ - July 2006 - ------ - -Usage - - The RAR plugin is bound to the <<>> phase of the build lifecycle. - To be able to generate the RAR as part of the lifecycle, the plugin should - be declared at the \ section of the pom. - -+---+ - - [...] - - - org.apache.maven.plugins - maven-rar-plugin - - - test - - rar - - - - - - - - [...] - -+---+ - - then invoke the <<>> phase. - -+---+ -mvn package -+---+ - - Another way to execute the plugin is to call the <<>> goal. - -+---+ -mvn rar:rar -+---+ - - By default, the generated archive(RAR) can be located at the project's target - directory. - + ------ + Usage + ------ + Allan Ramirez + ------ + July 2006 + ------ + +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Usage + + The RAR plugin is bound to the <<>> phase of the build lifecycle. + To be able to generate the RAR as part of the lifecycle, the plugin should + be declared at the \ section of the pom. + ++---+ + + [...] + + + org.apache.maven.plugins + maven-rar-plugin + + + test + + rar + + + + + + + + [...] + ++---+ + + then invoke the <<>> phase. + ++---+ +mvn package ++---+ + + Another way to execute the plugin is to call the <<>> goal. + ++---+ +mvn rar:rar ++---+ + + By default, the generated archive(RAR) can be located at the project's target + directory. + Index: src/site/apt/index.apt =================================================================== --- src/site/apt/index.apt (revision 427015) +++ src/site/apt/index.apt (working copy) @@ -1,42 +1,68 @@ - ------ - Introduction - ------ - Allan Ramirez - ------ - July 2006 - ------ - -Maven RAR Plugin - - 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 - has the capability to store these resource adapters to an archive (Resource - Adapter Archive or RAR) which can be deployed to a J2EE server. - -* Goals Overview - - The RAR plugin has only one goal: - - * {{{rar-mojo.html}rar:rar}} used to package the Resource Adapter Archive - (RAR) files. - - [] - -* How to Use - - Instructions on how to use the RAR plugin can be found {{{usage.html}here}}. - -* Examples - - Sample use-cases for the plugin are available under the Examples menu. - - -* Resources - - Here are some references you can use to know more about Resource Adapter Archive. - - * {{{http://java.sun.com/j2ee/connector/}J2EE Connector API specification}} - - * {{{http://docs.sun.com/source/817-2254-10/Ch_04_sm.html}Resource Adapter Archive Descriptor Sample}} - + ------ + Introduction + ------ + Allan Ramirez + ------ + July 2006 + ------ + +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Maven RAR Plugin + + 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 + has the capability to store these resource adapters to an archive (Resource + Adapter Archive or RAR) which can be deployed to a J2EE server. + +* Goals Overview + + The RAR plugin has only one goal: + + * {{{rar-mojo.html}rar:rar}} used to package the Resource Adapter Archive + (RAR) files. + + [] + +* How to Use + + Instructions on how to use the RAR plugin can be found {{{usage.html}here}}. + +* Examples + + To provide you with better understanding on some usages of the Plugin Name, + you can take a look into the following examples: + + * {{{examples/exclude-project-jar.html}Exclude the project jar from the rar}} + + * {{{examples/ra-custom-location.html}Custom location of Resource Adapter Descriptor}} + + * {{{examples/include-extra-files.html}Include extra files in RAR}} + + * {{{examples/manifest.html}Adding Manifest File}} + + +* Resources + + Here are some references you can use to know more about Resource Adapter Archive. + + * {{{http://java.sun.com/j2ee/connector/}J2EE Connector API specification}} + + * {{{http://docs.sun.com/source/817-2254-10/Ch_04_sm.html}Resource Adapter Archive Descriptor Sample}} + [] \ No newline at end of file Index: src/site/apt/examples/ra-custom-location.apt =================================================================== --- src/site/apt/examples/ra-custom-location.apt (revision 427015) +++ src/site/apt/examples/ra-custom-location.apt (working copy) @@ -1,38 +1,55 @@ - ------ - Custom location of the Resource Adapter Descriptor - ------ - Stephane Nicoll - Allan Ramirez - ------ - July 2006 - ------ - -Custom location of the Resource Adapter Descriptor - - It is also possible to specify a custom location for the ra.xml file. For - instance to use the file located in <<>>, configure your - project as follows: - -+---+ - - [...] - - - - org.apache.maven.plugins - maven-rar-plugin - - src/resources/ra.xml - - - - - [...] - -+----+ - - Then execute the plugin by invoking the <<>> goal. - -+----+ -mvn rar:rar + ------ + Custom location of the Resource Adapter Descriptor + ------ + Stephane Nicoll + Allan Ramirez + ------ + July 2006 + ------ + +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Custom location of the Resource Adapter Descriptor + + It is also possible to specify a custom location for the ra.xml file. For + instance to use the file located in <<>>, configure your + project as follows: + ++---+ + + [...] + + + + org.apache.maven.plugins + maven-rar-plugin + + src/resources/ra.xml + + + + + [...] + ++----+ + + Then execute the plugin by invoking the <<>> goal. + ++----+ +mvn rar:rar +----+ \ No newline at end of file Index: src/site/apt/examples/include-extra-files.apt =================================================================== --- src/site/apt/examples/include-extra-files.apt (revision 427015) +++ src/site/apt/examples/include-extra-files.apt (working copy) @@ -1,54 +1,71 @@ - ------ - Include extra files in the RAR - ------ - Allan Ramirez - ------ - July 2006 - ------ - -Include extra files in the RAR - - Extra files may also be included in the generated archive(rar). By default, - all files placed inside the <<>> will be included. - -+---+ -project -|--pom.xml -|--src - `--main - |--rar - | `-- - |--java - [...] -+---+ - - Then execute the plugin by invoking the <<>> goal. - -+---+ -mvn rar:rar -+---+ - - To be able to change the location of the directory, configure the - <<>> property and set a path for it. - -+---+ - - [...] - - - - org.apache.maven.plugins - maven-rar-plugin - - some-path - - - - - [...] - -+----+ - - - - + ------ + Include extra files in the RAR + ------ + Allan Ramirez + ------ + July 2006 + ------ + +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Include extra files in the RAR + + Extra files may also be included in the generated archive(rar). By default, + all files placed inside the <<>> will be included. + ++---+ +project +|--pom.xml +|--src + `--main + |--rar + | `-- + |--java + [...] ++---+ + + Then execute the plugin by invoking the <<>> goal. + ++---+ +mvn rar:rar ++---+ + + To be able to change the location of the directory, configure the + <<>> property and set a path for it. + ++---+ + + [...] + + + + org.apache.maven.plugins + maven-rar-plugin + + some-path + + + + + [...] + ++----+ + + + + Index: src/site/apt/examples/manifest.apt =================================================================== --- src/site/apt/examples/manifest.apt (revision 427015) +++ src/site/apt/examples/manifest.apt (working copy) @@ -1,32 +1,49 @@ - ------ - Adding Manifest File - ------ - Allan Ramirez - ------ - July 2006 - ------ - -Adding Manifest File - - By default, The RAR plugin retrieves the manifest file to use in this - location <<<${basedir}/src/main/rar/META-INF/MANIFEST.MF>>>. To be able to - change the location, configure the <> property and set the - value to the new location. - -+---+ - - [...] - - - - org.apache.maven.plugins - maven-rar-plugin - - src/resources/META-INF/MANIFEST.MF - - - - - [...] - + ------ + Adding Manifest File + ------ + Allan Ramirez + ------ + July 2006 + ------ + +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Adding Manifest File + + By default, The RAR plugin retrieves the manifest file to use in this + location <<<${basedir}/src/main/rar/META-INF/MANIFEST.MF>>>. To be able to + change the location, configure the <> property and set the + value to the new location. + ++---+ + + [...] + + + + org.apache.maven.plugins + maven-rar-plugin + + src/resources/META-INF/MANIFEST.MF + + + + + [...] + +----+ \ No newline at end of file Index: src/site/apt/examples/exclude-project-jar.apt =================================================================== --- src/site/apt/examples/exclude-project-jar.apt (revision 427015) +++ src/site/apt/examples/exclude-project-jar.apt (working copy) @@ -1,36 +1,53 @@ - ------ - Exclude the project jar in the RAR - ------ - Stephane Nicoll - Allan Ramirez - ------ - July 2006 - ------ - -Exclude the project jar in the RAR - - By default, the generated JAR file is included in the RAR file. This behavior - is controlled by the <> property. For instance, to exclude the generated - JAR file from the RAR, set the <> property to <>. - -+---+ -[...] - - - - org.apache.maven.plugins - maven-rar-plugin - - false - - - - -[...] -+----+ - - Then execute the plugin by invoking the <<>> goal. - -+----+ -mvn rar:rar -+----+ + ------ + Exclude the project jar in the RAR + ------ + Stephane Nicoll + Allan Ramirez + ------ + July 2006 + ------ + +~~ Copyright 2006 The Apache Software Foundation. +~~ +~~ Licensed 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Exclude the project jar in the RAR + + By default, the generated JAR file is included in the RAR file. This behavior + is controlled by the <> property. For instance, to exclude the generated + JAR file from the RAR, set the <> property to <>. + ++---+ +[...] + + + + org.apache.maven.plugins + maven-rar-plugin + + false + + + + +[...] ++----+ + + Then execute the plugin by invoking the <<>> goal. + ++----+ +mvn rar:rar ++----+ Index: src/site/fml/faq.fml =================================================================== --- src/site/fml/faq.fml (revision 427015) +++ src/site/fml/faq.fml (working copy) @@ -1,30 +1,47 @@ - - - - - Is the rar file generated by the maven-rar-plugin is the same with the rar file(compressed file) of WinRar? - -

- No. They are entirely different from each other. -

-

- 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 -
-
- A RAR file can contain the following: -
-

    -
  • Enterprise information system (EIS) supplied resource adapter implementation code in the form of JAR files or other runnable components, such as dynamic link lists.
    • -
  • Utility classes.
    • -
  • Static documents, such as HTML files, images, and sound files.
    • -
-

-

- 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. -

- - - + + + + + + + + Is the rar file generated by the maven-rar-plugin is the same with the rar file(compressed file) of WinRar? + +

+ No. They are entirely different from each other. +

+

+ 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 +
+
+ A RAR file can contain the following: +
+

    +
  • Enterprise information system (EIS) supplied resource adapter implementation code in the form of JAR files or other runnable components, such as dynamic link lists.
    • +
  • Utility classes.
    • +
  • Static documents, such as HTML files, images, and sound files.
    • +
+

+

+ 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. +

+ + + \ No newline at end of file