You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2018/09/23 16:51:49 UTC
[maven-remote-resources-plugin] branch master updated: improved
documentation
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-remote-resources-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 483bd9a improved documentation
483bd9a is described below
commit 483bd9a99b6577820c57ebe0fac7bd557f6e156e
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Sep 23 18:51:48 2018 +0200
improved documentation
---
src/main/mdo/remote-resources.mdo | 8 ++++----
src/main/mdo/supplemental-model.mdo | 6 +++---
src/site/apt/index.apt.vm | 9 ++++-----
src/site/apt/supplemental-models.apt.vm | 10 ++++------
src/site/apt/usage.apt.vm | 12 ++++++------
src/site/fml/faq.fml | 5 ++---
src/site/site.xml | 4 ++++
7 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/src/main/mdo/remote-resources.mdo b/src/main/mdo/remote-resources.mdo
index 971b8c5..b8f63bd 100644
--- a/src/main/mdo/remote-resources.mdo
+++ b/src/main/mdo/remote-resources.mdo
@@ -17,15 +17,15 @@ specific language governing permissions and limitations
under the License.
-->
-<model xmlns="https://codehaus-plexus.github.io/MODELLO/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="https://codehaus-plexus.github.io/MODELLO/1.1.0 https://codehaus-plexus.github.io/modello/xsd/modello-1.1.0.xsd"
+<model xmlns="https://codehaus-plexus.github.io/MODELLO/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="https://codehaus-plexus.github.io/MODELLO/1.8.0 https://codehaus-plexus.github.io/modello/xsd/modello-1.8.0.xsd"
xml.namespace="http://maven.apache.org/remote-resources/${version}"
- xml.schemaLocation="http://maven.apache.org/xsd/remote-resources-${version}.xsd">
+ xml.schemaLocation="https://maven.apache.org/xsd/remote-resources-${version}.xsd">
<id>remote-resources</id>
<name>RemoteResourcesBundle</name>
<description><![CDATA[
A bundle of remote resources.
- This is the model specification for remote-resources.xml.
+ This is the model specification for <code>META-INF/maven/remote-resources.xml</code>.
]]></description>
<defaults>
<default>
diff --git a/src/main/mdo/supplemental-model.mdo b/src/main/mdo/supplemental-model.mdo
index 9d10b97..6b6e74a 100644
--- a/src/main/mdo/supplemental-model.mdo
+++ b/src/main/mdo/supplemental-model.mdo
@@ -17,10 +17,10 @@ specific language governing permissions and limitations
under the License.
-->
-<model xmlns="https://codehaus-plexus.github.io/MODELLO/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="https://codehaus-plexus.github.io/MODELLO/1.1.0 https://codehaus-plexus.github.io/modello/xsd/modello-1.1.0.xsd"
+<model xmlns="https://codehaus-plexus.github.io/MODELLO/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="https://codehaus-plexus.github.io/MODELLO/1.8.0 https://codehaus-plexus.github.io/modello/xsd/modello-1.8.0.xsd"
xml.namespace="http://maven.apache.org/supplemental-model/${version}"
- xml.schemaLocation="http://maven.apache.org/xsd/supplemental-model-${version}.xsd">
+ xml.schemaLocation="https://maven.apache.org/xsd/supplemental-model-${version}.xsd">
<id>supplemental-model</id>
<name>SupplementalDataModel</name>
<description>Provides access to supplemental POM data models.</description>
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index b080f07..d40c19a 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -35,21 +35,20 @@ ${project.name}
* Goals Overview
* {{{./bundle-mojo.html}remote-resources:bundle}} creates the resource bundle manifest required
- by the remote resource bundle processing. The manifest file,
+ by the remote resource bundle processing. The {{{./remote-resources.html}manifest file}},
<<<$\{basedir\}/target/classes/META-INF/maven/remote-resources.xml>>>, is created from the contents of the
<<<src/main/resources>>> directory.
* {{{./process-mojo.html}remote-resources:process}} retrieves the specified
remote resource bundles, processes them and makes them available to the
- process-resources phase.
+ <<<process-resources>>> phase.
[]
* Usage
General instructions on how to use the Remote Resources Plugin can be found on the {{{./usage.html}usage page}}.
- Occasionally, users also contribute their own examples, tips or errata to the
- {{{http://docs.codehaus.org/display/MAVENUSER/Remote+Resources+Plugin}plugin's wiki page}}.
+ Some more specific use cases are described in the examples given below.
If you need help using some of the more advanced features of the plugin, check out the advanced help pages:
@@ -68,7 +67,7 @@ ${project.name}
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
+ {{{/guides/development/guide-helping.html}guide to helping with Maven}}.
* Examples
diff --git a/src/site/apt/supplemental-models.apt.vm b/src/site/apt/supplemental-models.apt.vm
index 4088de9..7607fb6 100644
--- a/src/site/apt/supplemental-models.apt.vm
+++ b/src/site/apt/supplemental-models.apt.vm
@@ -93,9 +93,8 @@ From: Apache Software Foundation (http://www.apache.org/)
+---+
<?xml version="1.0" encoding="UTF-8"?>
-<supplementalDataModels xmlns="http://maven.apache.org/supplemental-model/1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/supplemental-model/1.0.0 http://maven.apache.org/xsd/supplemental-model-1.0.0.xsd">
+<supplementalDataModels xmlns="http://maven.apache.org/supplemental-model/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/supplemental-model/1.0.0 https://maven.apache.org/xsd/supplemental-model-1.0.0.xsd">
<supplement>
<project>
<groupId>org.foo</groupId>
@@ -162,9 +161,8 @@ From: Apache Software Foundation (http://www.apache.org/)
+---+
<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.myco</groupId>
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index d12e868..fcc721b 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -27,7 +27,7 @@
Usage
To handle filtering this version of Maven Remote Resources Plugin uses
- {{{http://maven.apache.org/shared/maven-filtering/index.html}Maven Filtering}} ${mavenFilteringVersion}.
+ {{{/shared/maven-filtering/index.html}Maven Filtering}} ${mavenFilteringVersion}.
* How to Create a Resource Bundle
@@ -57,11 +57,11 @@ Usage
</project>
-------------------
- This will trigger the scanning of that project's <<<${basedir}/src/main/resources>>> directory and create the
- <<<${basedir}/target/classes/META-INF/maven/remote-resources.xml>>> manifest file.
+ This will trigger the scanning of that project's <<<$\{basedir}/src/main/resources>>> directory and create the
+ <<<$\{basedir}/target/classes/META-INF/maven/remote-resources.xml>>> manifest file.
- <<Note:>> The files have to be named like <<<*.vm>>> to let them velocity macro files which will
- be filtered by the <<process>> goal. If you don't name the files according to this
+ <<Note:>> The files have to be named like <<<*.vm>>> to mark them as {{{htps://velocity.apache.org}Velocity}} macro files which will
+ be filtered by the <<process>> goal. If you don't name the files according to this,
they will not been filtered.
@@ -100,7 +100,7 @@ Usage
This will retrieve the <<<apache-jar-resource-bundle-1.0.jar>>> from the remote repositories
specified in your POM, process each resource in the bundle and deposit them in your projects
- <<<${basedir}/target/classes>>> directory.
+ <<<$\{basedir}/target/classes>>> directory.
* Running Once in a Multi-Module Build
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index c6493b6..31e0c35 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -19,9 +19,8 @@ specific language governing permissions and limitations
under the License.
-->
-<faqs xmlns="http://maven.apache.org/FML/1.0.1"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
+<faqs xmlns="http://maven.apache.org/FML/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 https://maven.apache.org/xsd/fml-1.0.1.xsd"
id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="question1">
diff --git a/src/site/site.xml b/src/site/site.xml
index 269e9db..7095471 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -38,5 +38,9 @@ under the License.
<menu name="Advanced Usage">
<item name="Supplemental Models" href="supplemental-models.html"/>
</menu>
+ <menu name="Descriptors Reference">
+ <item name="Remote Resources" href="remote-resources.html"/>
+ <item name="Supplemental Model" href="supplemental-model.html"/>
+ </menu>
</body>
</project>