This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-site.git
commit f3f37282fb6b55c18a5639505a0a6bf9e81a2be9 Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Sat Feb 18 21:31:10 2023 +0100 Revert "(doc) added snippet types" This reverts commit d7db85d39f794e361af3736a613515d32aeba551. --- content/markdown/developers/committer-settings.md | 4 +-- content/markdown/developers/conventions/code.md | 8 ++--- content/markdown/developers/conventions/git.md | 4 +-- content/markdown/docs/3.2.2/release-notes.md | 4 +-- content/markdown/docs/3.3.1/release-notes.md | 6 ++-- content/markdown/docs/3.6.1/release-notes.md | 2 +- .../examples/injecting-properties-via-settings.md | 4 +-- .../development/guide-documentation-style.md | 2 +- .../development/guide-plugin-documentation.md | 24 ++++++------- .../guide-testing-development-plugins.md | 6 ++-- .../guides/development/guide-testing-releases.md | 6 ++-- content/markdown/guides/getting-started/index.md | 34 +++++++++--------- .../getting-started/maven-in-five-minutes.md | 4 +-- .../introduction-to-dependency-mechanism.md | 34 +++++++++--------- ...uction-to-optional-and-excludes-dependencies.md | 10 +++--- .../introduction-to-plugin-prefix-mapping.md | 4 +-- .../introduction/introduction-to-profiles.md | 32 ++++++++--------- .../introduction/introduction-to-repositories.md | 2 +- .../introduction/introduction-to-the-lifecycle.md | 4 +-- .../guides/introduction/introduction-to-the-pom.md | 32 ++++++++--------- .../guides/mini/guide-archive-configuration.md | 2 +- content/markdown/guides/mini/guide-assemblies.md | 8 ++--- .../markdown/guides/mini/guide-attached-tests.md | 4 +-- .../guide-building-for-different-environments.md | 2 +- .../guides/mini/guide-configuring-maven.md | 4 +-- .../guides/mini/guide-configuring-plugins.md | 42 +++++++++++----------- .../guides/mini/guide-creating-archetypes.md | 8 ++--- .../guides/mini/guide-default-execution-ids.md | 6 ++-- .../mini/guide-deployment-security-settings.md | 2 +- content/markdown/guides/mini/guide-encryption.md | 10 +++--- .../guides/mini/guide-generating-sources.md | 2 +- .../markdown/guides/mini/guide-http-settings.md | 24 ++++++------- .../guide-large-scale-centralized-deployments.md | 4 +-- .../guides/mini/guide-maven-classloading.md | 2 +- .../markdown/guides/mini/guide-mirror-settings.md | 6 ++-- .../guides/mini/guide-multiple-repositories.md | 4 +-- content/markdown/guides/mini/guide-proxies.md | 2 +- content/markdown/guides/mini/guide-releasing.md | 6 ++-- content/markdown/guides/mini/guide-relocation.md | 2 +- .../markdown/guides/mini/guide-repository-ssl.md | 4 +-- .../guides/mini/guide-reproducible-builds.md | 2 +- content/markdown/guides/mini/guide-site.md | 10 +++--- .../markdown/guides/mini/guide-snippet-macro.md | 4 +-- content/markdown/guides/mini/guide-using-ant.md | 4 +-- .../markdown/guides/mini/guide-using-extensions.md | 4 +-- .../markdown/guides/mini/guide-wagon-providers.md | 4 +-- .../guides/plugin/guide-java-plugin-development.md | 16 ++++----- .../plugin/guide-java-report-plugin-development.md | 14 ++++---- content/markdown/plugin-developers/common-bugs.md | 24 ++++++------- .../cookbook/plexus-plugin-upgrade.md | 10 +++--- .../markdown/plugin-developers/plugin-testing.md | 6 ++-- content/markdown/plugins/localization.md | 2 +- content/markdown/repository/central-index.md | 2 +- .../repository/guide-central-repository-upload.md | 2 +- content/markdown/skins/index.md | 2 +- 55 files changed, 238 insertions(+), 238 deletions(-) diff --git a/content/markdown/developers/committer-settings.md b/content/markdown/developers/committer-settings.md index 417a8adc..54d00842 100644 --- a/content/markdown/developers/committer-settings.md +++ b/content/markdown/developers/committer-settings.md @@ -31,7 +31,7 @@ under the License. **It is highly recommended to use Maven's [password encryption capabilities](../guides/mini/guide-encryption.html) for your passwords**. -```xml +``` <settings> ... <servers> @@ -56,7 +56,7 @@ under the License. To be able to send out announcements of Maven releases you need to add a couple of properties to the `apache-release` profile. -```xml +``` <settings> ... <profiles> diff --git a/content/markdown/developers/conventions/code.md b/content/markdown/developers/conventions/code.md index d00ce056..3f96f8a9 100644 --- a/content/markdown/developers/conventions/code.md +++ b/content/markdown/developers/conventions/code.md @@ -120,7 +120,7 @@ under the License. - **Line Breaks**: Always use a new line with indentation for complex XML types and no line break for simple XML types. Always use a new line to separate XML sections or blocks, for instance: -```xml +``` <aTag> <simpleType>This is a simple type</simpleType> @@ -132,13 +132,13 @@ under the License. In some cases, adding comments could improve the readability of blocks, for instance: -```xml +``` <!-- Simple XML documentation --> ``` or -```xml +``` <!-- ====================================================================== --> <!-- Block documentation --> <!-- ====================================================================== --> @@ -154,7 +154,7 @@ under the License. The following is the recommended ordering for all Maven POM files: -```xml +``` <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/> diff --git a/content/markdown/developers/conventions/git.md b/content/markdown/developers/conventions/git.md index de3b0191..ef568786 100644 --- a/content/markdown/developers/conventions/git.md +++ b/content/markdown/developers/conventions/git.md @@ -101,7 +101,7 @@ git commit --amend -m "new comment" Workflow for svn folks is something like : -```bash +``` $ git pull $ hack hack hack $ git push @@ -113,7 +113,7 @@ git commit --amend -m "new comment" A more quiet workflow : -```bash +``` $ git pull $ hack hack hack $ git push diff --git a/content/markdown/docs/3.2.2/release-notes.md b/content/markdown/docs/3.2.2/release-notes.md index 347381bd..d5814845 100644 --- a/content/markdown/docs/3.2.2/release-notes.md +++ b/content/markdown/docs/3.2.2/release-notes.md @@ -47,7 +47,7 @@ The full list of changes can be found in our [issue management system][4]. Parent elements can now use bounded ranges in the version specification. You can now consistently use ranges for all intra-project dependencies, of which parents are a special case but still considered a dependency of projects that inherit from them. The following is now permissible: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> <parent> @@ -77,7 +77,7 @@ This feature helps support the pattern where many streams of development are set Now when you use create plugins that strictly use annotation processing to generate the descriptor, you can avoid the confusing configuration previously required. This is what you typically needed to include in order to run the descriptor generator on compiled classes and avoid errors. -```xml +``` <pluginManagement> <plugins> <plugin> diff --git a/content/markdown/docs/3.3.1/release-notes.md b/content/markdown/docs/3.3.1/release-notes.md index e1dd1324..918c407b 100644 --- a/content/markdown/docs/3.3.1/release-notes.md +++ b/content/markdown/docs/3.3.1/release-notes.md @@ -86,7 +86,7 @@ The new [Maven 3.3.1 Release is just out](http://mail-archives.apache.org/mod_mb you can define an `${maven.projectBasedir}/.mvn/extensions.xml` file which looks like the following: -```xml +``` xml <extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd";> <extension> @@ -161,7 +161,7 @@ mvn exec:java The configuration which is used here can be defined in your pom by using an execution id `default-cli`. -```xml +``` <project...> <build> @@ -187,7 +187,7 @@ The configuration which is used here can be defined in your pom by using an exec Starting with this Maven release you can now define several configuration for different executions on command like the following: -```xml +``` <project...> <build> diff --git a/content/markdown/docs/3.6.1/release-notes.md b/content/markdown/docs/3.6.1/release-notes.md index ab9ccf2a..f7bce3be 100644 --- a/content/markdown/docs/3.6.1/release-notes.md +++ b/content/markdown/docs/3.6.1/release-notes.md @@ -164,7 +164,7 @@ mvn -ntp ... .... URL's etc. within `project`, `distributionManagement` and `scm` part in the pom for multi module builds like this: -```xml +``` <project child.project.url.inherit.append.path="false"> <url>...</url> diff --git a/content/markdown/examples/injecting-properties-via-settings.md b/content/markdown/examples/injecting-properties-via-settings.md index 5a96daac..51aef3de 100644 --- a/content/markdown/examples/injecting-properties-via-settings.md +++ b/content/markdown/examples/injecting-properties-via-settings.md @@ -28,7 +28,7 @@ under the License. ### Plugin Configuration -```xml +``` <project> [...] <build> @@ -47,7 +47,7 @@ under the License. ### `settings.xml` -```xml +``` <settings> [...] <profiles> diff --git a/content/markdown/guides/development/guide-documentation-style.md b/content/markdown/guides/development/guide-documentation-style.md index dc66732a..62813733 100644 --- a/content/markdown/guides/development/guide-documentation-style.md +++ b/content/markdown/guides/development/guide-documentation-style.md @@ -73,7 +73,7 @@ under the License. The following is an example of how the distribution management of the Maven site is configured. -```xml +``` <project> ... <distributionManagement> diff --git a/content/markdown/guides/development/guide-plugin-documentation.md b/content/markdown/guides/development/guide-plugin-documentation.md index af884a96..8c3d1e7a 100644 --- a/content/markdown/guides/development/guide-plugin-documentation.md +++ b/content/markdown/guides/development/guide-plugin-documentation.md @@ -74,7 +74,7 @@ mvn site - `<issueManagement>` - describes the system used for reporting problems and modification requests -```xml +``` <project> [...] <issueManagement> @@ -89,7 +89,7 @@ mvn site - `<mailingLists>` - lists where other users or the developers can be contacted for help and discussions -```xml +``` <project> [...] <mailingLists> @@ -110,7 +110,7 @@ mvn site - `<licenses>` - plugin license -```xml +``` <project> [...] <licenses> @@ -126,7 +126,7 @@ mvn site - `<scm>` - the source code management configuration - a plugin without this would raise suspicion, might not be OSS -```xml +``` <project> [...] <scm> @@ -140,7 +140,7 @@ mvn site - `<organization>` - the organization maintaining the plugin, just in case we need someone to blame -```xml +``` <project> [...] <organization> @@ -155,7 +155,7 @@ mvn site The Maven Plugin Plugin is responsible for generating the Plugin Info site and needs to be added to the `<reporting>` section unless it is already inherited from a parent POM: -```xml +``` <project> [...] <reporting> @@ -175,7 +175,7 @@ mvn site - all `@parameter` fields should have a descriptive comment, informative enough that even a regular user can understand -```java +``` [...] /** * Put something informative here that a regular user can understand. @@ -188,7 +188,7 @@ mvn site - class level comment should explain what the goal does -```java +``` [...] /** * Everything here will show up on the top of the generated plugin info page. @@ -215,7 +215,7 @@ public class ExampleMojo The site descriptor describes the navigation links and can be found in `src/site/site.xml`. Below is the suggested site descriptor template. -```xml +``` <?xml version="1.0" encoding="UTF-8"?> <project> <body> @@ -303,7 +303,7 @@ Plugin Name A well documented project always collates frequently asked questions which are usually located in `src/site/fml/faq.fml`. The example below provides a template for your FAQ: -```xml +``` <?xml version="1.0" encoding="UTF-8"?> <faqs id="FAQ" title="Frequently Asked Questions"> <part id="General"> @@ -339,7 +339,7 @@ Plugin Name To enable javadoc for your plugin add the following to your `pom.xml` -```xml +``` <project> [...] <build> @@ -372,7 +372,7 @@ Plugin Name To enable source code cross-references add the following to your `pom.xml` -```xml +``` <project> [...] <build> diff --git a/content/markdown/guides/development/guide-testing-development-plugins.md b/content/markdown/guides/development/guide-testing-development-plugins.md index 4636d43b..3ec34daf 100644 --- a/content/markdown/guides/development/guide-testing-development-plugins.md +++ b/content/markdown/guides/development/guide-testing-development-plugins.md @@ -40,7 +40,7 @@ under the License. The first step is to include this in your project: -```xml +``` <project> ... <pluginRepositories> @@ -61,7 +61,7 @@ under the License. - You can have Maven automatically check for updates on a given interval, for example: -```xml +``` <project> ... <pluginRepositories> @@ -84,7 +84,7 @@ under the License. You need to modify your `${user.home}/.m2/settings.xml` file to include two new profiles and then when you need access to the plugin snapshots use `-Papache`. The profile only needs to be enabled once so that the plugins can be downloaded into you local repository. Once in your local repository Maven can successfully resolve the dependencies and the profile no longer needs to be activated. -```xml +``` <settings> ... <profiles> diff --git a/content/markdown/guides/development/guide-testing-releases.md b/content/markdown/guides/development/guide-testing-releases.md index 0d700cd7..8273de10 100644 --- a/content/markdown/guides/development/guide-testing-releases.md +++ b/content/markdown/guides/development/guide-testing-releases.md @@ -38,7 +38,7 @@ under the License. The repository configuration for testing a plugin will typically look something like this (it will be provided in the vote email): -```xml +``` ... <pluginRepositories> <pluginRepository> @@ -93,7 +93,7 @@ under the License. If you are using the repository mirroring technique to lock down to the repository manager in your environment, you would add an additional mirror to correspond to the additional repository in the POM, such as: -```xml +``` ... <mirror> <id>staged-releases-mirror</id> @@ -107,7 +107,7 @@ under the License. If you regularly test staged releases and want to have a more convenient way to add the repository to a build without modifying your POM, you may add a profile to your `\~/.m2/settings.xml`: -```xml +``` ... <profiles> <profile> diff --git a/content/markdown/guides/getting-started/index.md b/content/markdown/guides/getting-started/index.md index b877af8b..fb0c5d20 100644 --- a/content/markdown/guides/getting-started/index.md +++ b/content/markdown/guides/getting-started/index.md @@ -102,7 +102,7 @@ mvn -B archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -Darch Once you have executed this command, you will notice a few things have happened. First, you will notice that a directory named `my-app` has been created for the new project, and this directory contains a file named `pom.xml` that should look like this: -```xml +``` <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";> <modelVersion>4.0.0</modelVersion> @@ -394,7 +394,7 @@ mvn clean Notice the value of the **version** tag in the `pom.xml` file shown below has the suffix: `-SNAPSHOT`. -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0"; ... <groupId>...</groupId> @@ -417,7 +417,7 @@ mvn clean For this example, we will configure the Java compiler to allow JDK 5.0 sources. This is as simple as adding this to your POM: -```xml +``` ... <build> <plugins> @@ -522,7 +522,7 @@ my-app In a unit test you could use a simple snippet of code like the following to access the resource required for testing: -```java +``` ... // Retrieve resource @@ -539,7 +539,7 @@ InputStream is = getClass().getResourceAsStream( "/test.properties" ); To have Maven filter resources when copying, simply set `filtering` to true for the resource directory in your `pom.xml`: -```xml +``` <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> @@ -607,7 +607,7 @@ my.filter.value=hello! Next, we'll add a reference to this new file in the `pom.xml`: -```xml +``` <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> @@ -654,7 +654,7 @@ message=${my.filter.value} the next execution of the `mvn process-resources` command will put our new property value into `application.properties`. As an alternative to defining the my.filter.value property in an external file, you could also have defined it in the `properties` section of your `pom.xml` and you'd get the same effect (notice I don't need the references to `src/main/filters/filter.properties` either): -```xml +``` <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> @@ -711,7 +711,7 @@ mvn process-resources "-Dcommand.line.prop=hello again" The `dependencies` section of the pom.xml lists all of the external dependencies that our project needs in order to build (whether it needs that dependency at compile time, test time, run time, or whatever). Right now, our project is depending on JUnit only (I took out all of the resource filtering stuff for clarity): -```xml +``` <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> @@ -742,7 +742,7 @@ mvn process-resources "-Dcommand.line.prop=hello again" With this information about a dependency, Maven will be able to reference the dependency when it builds the project. Where does Maven reference the dependency from? Maven looks in your local repository (`${user.home}/.m2/repository` is the default location) to find all dependencies. In a [previous section](#how-do-i-create-a-jar-and-install-it-in-my-local-repository), we installed the artifact from our project (my-app-1.0-SNAPSHOT.jar) into the local repository. Once it's installed ther [...] -```xml +``` <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";> <groupId>com.mycompany.app</groupId> @@ -764,7 +764,7 @@ mvn process-resources "-Dcommand.line.prop=hello again" Let's add another dependency to our project. Let's say we've added some logging to the code and need to add log4j as a dependency. First, we need to know what the groupId, artifactId, and version are for log4j. The appropriate directory on Maven Central is called [/maven2/log4j/log4j](https://repo.maven.apache.org/maven2/log4j/log4j/). In that directory is a file called maven-metadata.xml. Here's what the maven-metadata.xml for log4j looks like: -```xml +``` <metadata> <groupId>log4j</groupId> <artifactId>log4j</artifactId> @@ -789,7 +789,7 @@ mvn process-resources "-Dcommand.line.prop=hello again" Now that we know the information we need, we can add the dependency to our pom.xml: -```xml +``` <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> @@ -829,7 +829,7 @@ mvn process-resources "-Dcommand.line.prop=hello again" Here is an example using scp and username/password authentication: -```xml +``` <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> @@ -882,7 +882,7 @@ mvn process-resources "-Dcommand.line.prop=hello again" </project> ``` -```xml +``` <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd";> ... @@ -931,7 +931,7 @@ mvn archetype:generate \ Note that these must all be on a single line. This will create a directory called `my-webapp` containing the following project descriptor: -```xml +``` <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> @@ -986,7 +986,7 @@ mvn package The POM file you'll create should contain the following: -```xml +``` <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> @@ -1005,7 +1005,7 @@ mvn package We'll need a dependency on the JAR from the webapp, so add this to `my-webapp/pom.xml`: -```xml +``` ... <dependencies> <dependency> @@ -1019,7 +1019,7 @@ mvn package Finally, add the following `<parent>` element to both of the other `pom.xml` files in the subdirectories: -```xml +``` <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";> <parent> diff --git a/content/markdown/guides/getting-started/maven-in-five-minutes.md b/content/markdown/guides/getting-started/maven-in-five-minutes.md index 3a8f93d8..2e2bc8ce 100644 --- a/content/markdown/guides/getting-started/maven-in-five-minutes.md +++ b/content/markdown/guides/getting-started/maven-in-five-minutes.md @@ -92,7 +92,7 @@ my-app The `pom.xml` file is the core of a project's configuration in Maven. It is a single configuration file that contains the majority of information required to build a project in just the way you want. The POM is huge and can be daunting in its complexity, but it is not necessary to understand all of the intricacies just yet to use it effectively. This project's POM is: -```xml +``` <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";> <modelVersion>4.0.0</modelVersion> @@ -171,7 +171,7 @@ Hello World! In the following example, we have configured our Maven project to use version 3.8.1 of `maven-compiler-plugin` and target Java 11: -```xml +``` <properties> <maven.compiler.release>11</maven.compiler.release> </properties> diff --git a/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md b/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md index 39b0f0f6..8d79efe5 100644 --- a/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md +++ b/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md @@ -133,7 +133,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project A: -```xml +``` <project> ... @@ -163,7 +163,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project B: -```xml +``` <project> ... @@ -189,7 +189,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa These two example POMs share a common dependency and each has one non-trivial dependency. This information can be put in the parent POM like this: -```xml +``` <project> ... @@ -232,7 +232,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Then the two child POMs become much simpler: -```xml +``` <project> ... @@ -253,7 +253,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa ``` -```xml +``` <project> ... @@ -282,7 +282,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project A: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -323,7 +323,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project B: -```xml +``` <project> <parent> @@ -381,7 +381,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project B: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -429,7 +429,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project X: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -460,7 +460,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project Y: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -491,7 +491,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Project Z: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -533,7 +533,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa The root of the project is the BOM POM. It defines the versions of all the artifacts that will be created in the library. Other projects that wish to use the library should import this POM into the dependencyManagement section of their POM. -```xml +``` <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";> @@ -571,7 +571,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa The parent subproject has the BOM POM as its parent. It is a normal multiproject pom. -```xml +``` <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";> @@ -611,7 +611,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa Next are the actual project POMs. -```xml +``` <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";> @@ -659,7 +659,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa The project that follows shows how the library can now be used in another project without having to specify the dependent project's versions. -```xml +``` <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";> <modelVersion>4.0.0</modelVersion> @@ -709,7 +709,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa A simple example would be: -```xml +``` <project> ... @@ -729,7 +729,7 @@ This scope is only supported on a dependency of type `pom` in the `<dependencyMa If your artifact is provided by the JDK's `tools.jar`, the system path would be defined as follows: -```xml +``` <project> ... <dependencies> diff --git a/content/markdown/guides/introduction/introduction-to-optional-and-excludes-dependencies.md b/content/markdown/guides/introduction/introduction-to-optional-and-excludes-dependencies.md index 93475d85..862c6aac 100644 --- a/content/markdown/guides/introduction/introduction-to-optional-and-excludes-dependencies.md +++ b/content/markdown/guides/introduction/introduction-to-optional-and-excludes-dependencies.md @@ -38,7 +38,7 @@ under the License. A dependency is declared optional by setting the `<optional>` element to true in its dependency declaration: -```xml +``` <project> ... @@ -86,7 +86,7 @@ Project-X -> Project-A Add an `<exclusions>` element in the `<dependency>` element by which the problematic jar is included. -```xml +``` <project> ... @@ -129,7 +129,7 @@ B, C, D, E, F Suppose you don't want project D and its dependencies to be added to Project A's classpath because some of Project-D's dependencies are missing from the repository, and you don't need the functionality in Project-B that depends on Project-D anyway. Project-B's developers could have marked the dependency on Project-D `<optional>true</optional>`: -```xml +``` <dependency> <groupId>sample.ProjectD</groupId> <artifactId>ProjectD</artifactId> @@ -140,7 +140,7 @@ B, C, D, E, F Unfortunately, they didn't. As a last resort, you can exclude it on your own POM for Project-A like this: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -204,7 +204,7 @@ Project-A Exclusions work on the entire dependency graph below the point where they are declared. If you want to exclude Project-E instead of Project-D, simply change the exclusion to point at Project-E, but you don't move the exclusion down to Project-D. You cannot change Project-D's POM. If you could, you would use optional dependencies instead of exclusions, or split Project-D up into multiple subprojects, each with nothing but normal dependencies. -```xml +``` <project> <modelVersion>4.0.0</modelVersion> diff --git a/content/markdown/guides/introduction/introduction-to-plugin-prefix-mapping.md b/content/markdown/guides/introduction/introduction-to-plugin-prefix-mapping.md index 0c394da8..41e21074 100644 --- a/content/markdown/guides/introduction/introduction-to-plugin-prefix-mapping.md +++ b/content/markdown/guides/introduction/introduction-to-plugin-prefix-mapping.md @@ -38,7 +38,7 @@ under the License. If your plugin's artifactId fits this pattern, Maven will automatically map your plugin to the correct prefix in the metadata stored within your plugin's groupId path on the repository. However, if you want to customize the prefix used to reference your plugin, you can specify the prefix directly through a configuration parameter on the `maven-plugin-plugin` in your plugin's POM: -```xml +``` <project> ... <build> @@ -82,7 +82,7 @@ mvn somePrefix:goal As it turns out, this is simple. In the Maven settings file (per-user: `${user.home}/.m2/settings.xml`; global: `${maven.home}/conf/settings.xml`), you can provide a custom **pluginGroups** section, listing the plugin groupIds you want to search (each groupId goes in its own **pluginGroup** sub-element). For example, if my project uses a Modello model file, I might have the following in my settings: -```xml +``` <pluginGroups> <pluginGroup>org.codehaus.modello</pluginGroup> </pluginGroups> diff --git a/content/markdown/guides/introduction/introduction-to-profiles.md b/content/markdown/guides/introduction/introduction-to-profiles.md index ea6cc806..7b0e9d94 100644 --- a/content/markdown/guides/introduction/introduction-to-profiles.md +++ b/content/markdown/guides/introduction/introduction-to-profiles.md @@ -117,7 +117,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 Profiles can be activated in the Maven settings, via the `<activeProfiles>` section. This section takes a list of `<activeProfile>` elements, each containing a profile-id inside. -```xml +``` <settings> ... <activeProfiles> @@ -137,7 +137,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 The following configuration will trigger the profile when the JDK's version _starts with_ "1.4" (eg. "1.4.0_08", "1.4.2_07", "1.4"), in particular it _won't be active_ for **newer** versions like "1.8" or "11": -```xml +``` <profiles> <profile> <activation> @@ -150,7 +150,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 Ranges can also be used as of Maven 2.1 (refer to the [Enforcer Version Range Syntax](/enforcer/enforcer-rules/versionRanges.html) for more information). Range values must start with either `\[` or `(` otherwise the value is interpreted as prefix. The following honours versions 1.3, 1.4 and 1.5. -```xml +``` <profiles> <profile> <activation> @@ -167,7 +167,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 This next one will activate based on the detected operating system. See the [Maven Enforcer Plugin](/enforcer/enforcer-rules/requireOS.html) for more details about OS values. -```xml +``` <profiles> <profile> <activation> @@ -187,7 +187,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 The profile below will be activated when the system property "debug" is specified with any value: -```xml +``` <profiles> <profile> <activation> @@ -202,7 +202,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 The following profile will be activated when the system property "debug" is not defined at all: -```xml +``` <profiles> <profile> <activation> @@ -217,7 +217,7 @@ mvn groupId:artifactId:goal -P profile-1,profile-2,?profile-3 The following profile will be activated when the system property "debug" is not defined, or is defined with a value which is not "true". -```xml +``` <profiles> <profile> <activation> @@ -240,7 +240,7 @@ mvn groupId:artifactId:goal -Ddebug=false The next example will trigger the profile when the system property "environment" is specified with the value "test": -```xml +``` <profiles> <profile> <activation> @@ -266,7 +266,7 @@ mvn groupId:artifactId:goal -Denvironment=test Since Maven 3.9.0 one can also evaluate the POM's packaging value by referencing property `packaging`. This is only useful where the profile activation is defined in a common parent POM which is reused among multiple Maven projects. The next example will trigger the profile when a project with packaging `war` is built: -```xml +``` <profiles> <profile> <activation> @@ -284,7 +284,7 @@ mvn groupId:artifactId:goal -Denvironment=test This example will trigger the profile when the generated file `target/generated-sources/axistools/wsdl2java/org/apache/maven` is missing. -```xml +``` <profiles> <profile> <activation> @@ -301,7 +301,7 @@ mvn groupId:artifactId:goal -Denvironment=test Profiles can also be active by default using a configuration like the following: -```xml +``` <profiles> <profile> <id>profile-1</id> @@ -399,7 +399,7 @@ mvn groupId:artifactId:goal -P -profile-1,-profile-2,-?profile-3 Example: -```xml +``` <project> ... <repositories> @@ -452,7 +452,7 @@ mvn groupId:artifactId:goal -P -profile-1,-profile-2,-?profile-3 External property definition concerns any property value defined outside the `pom.xml` but not defined in a corresponding profile inside it. The most obvious usage of properties in the POM is in plugin configuration. While it is certainly possible to break project portability without properties, these critters can have subtle effects that cause builds to fail. For example, specifying appserver paths in a profile that is specified in the `settings.xml` may cause your integration test plu [...] -```xml +``` <project> ... <build> @@ -474,7 +474,7 @@ mvn groupId:artifactId:goal -P -profile-1,-profile-2,-?profile-3 Now, in your local `${user.home}/.m2/settings.xml`, you have: -```xml +``` <settings> ... <profiles> @@ -505,7 +505,7 @@ mvn groupId:artifactId:goal -P -profile-1,-profile-2,-?profile-3 In addition to the above portability-breaker, it's easy to fail to cover all cases with your profiles. When you do this, you're usually leaving one of your target environments high and dry. Let's take the example `pom.xml` snippet from above one more time: -```xml +``` <project> ... <build> @@ -527,7 +527,7 @@ mvn groupId:artifactId:goal -P -profile-1,-profile-2,-?profile-3 Now, consider the following profile, which would be specified inline in the `pom.xml`: -```xml +``` <project> ... <profiles> diff --git a/content/markdown/guides/introduction/introduction-to-repositories.md b/content/markdown/guides/introduction/introduction-to-repositories.md index 9867640d..1451569a 100644 --- a/content/markdown/guides/introduction/introduction-to-repositories.md +++ b/content/markdown/guides/introduction/introduction-to-repositories.md @@ -93,7 +93,7 @@ under the License. Using the internal repository is quite simple. Simply make a change to add a `repositories` element: -```xml +``` <project> ... diff --git a/content/markdown/guides/introduction/introduction-to-the-lifecycle.md b/content/markdown/guides/introduction/introduction-to-the-lifecycle.md index 11f6ad50..7c3fdbdd 100644 --- a/content/markdown/guides/introduction/introduction-to-the-lifecycle.md +++ b/content/markdown/guides/introduction/introduction-to-the-lifecycle.md @@ -161,7 +161,7 @@ mvn clean dependency:copy-dependencies package For example, the Modello plugin binds by default its goal `modello:java` to the `generate-sources` phase (Note: The `modello:java` goal generates Java source codes). So to use the Modello plugin and have it generate sources from a model and incorporate that into the build, you would add the following to your POM in the `<plugins>` section of `<build>`: -```xml +``` <plugin> <groupId>org.codehaus.modello</groupId> <artifactId>modello-maven-plugin</artifactId> @@ -188,7 +188,7 @@ mvn clean dependency:copy-dependencies package Now, in the case of `modello:java`, it only makes sense in the `generate-sources` phase. But some goals can be used in more than one phase, and there may not be a sensible default. For those, you can specify the phase yourself. For example, let's say you have a goal `display:time` that echos the current time to the commandline, and you want it to run in the `process-test-resources` phase to indicate when the tests were started. This would be configured like so: -```xml +``` <plugin> <groupId>com.mycompany.example</groupId> <artifactId>display-maven-plugin</artifactId> diff --git a/content/markdown/guides/introduction/introduction-to-the-pom.md b/content/markdown/guides/introduction/introduction-to-the-pom.md index ddc941e1..1d930325 100644 --- a/content/markdown/guides/introduction/introduction-to-the-pom.md +++ b/content/markdown/guides/introduction/introduction-to-the-pom.md @@ -83,7 +83,7 @@ under the License. Here's an example: -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -125,7 +125,7 @@ under the License. As an example, let us reuse our previous artifact, com.mycompany.app:my-app:1. And let us introduce another artifact, com.mycompany.app:my-module:1. -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -152,7 +152,7 @@ under the License. **com.mycompany.app:my-module:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -172,7 +172,7 @@ under the License. Alternatively, if you want the groupId or the version of your modules to be the same as their parents, you can remove the groupId or the version identity of your module in its POM. -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -210,7 +210,7 @@ under the License. To address this directory structure (or any other directory structure), we would have to add the `<relativePath>` element to our parent section. -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -245,7 +245,7 @@ under the License. **com.mycompany.app:my-app:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -257,7 +257,7 @@ under the License. **com.mycompany.app:my-module:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -280,7 +280,7 @@ under the License. If we are to aggregate my-module into my-app, we would only have to modify my-app. -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -321,7 +321,7 @@ under the License. The answer? - the same way as Example 3, by specifying the path to the module. -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -360,7 +360,7 @@ under the License. **com.mycompany.app:my-app:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -372,7 +372,7 @@ under the License. **com.mycompany.app:my-module:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -398,7 +398,7 @@ under the License. **com.mycompany.app:my-app:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -415,7 +415,7 @@ under the License. **com.mycompany.app:my-module:1's POM** -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> <modelVersion>4.0.0</modelVersion> @@ -440,7 +440,7 @@ under the License. For example, to access the `project.version` variable, you would reference it like so: -```xml +``` <version>${project.version}</version> ``` @@ -463,7 +463,7 @@ under the License. The format of the build timestamp can be customized by declaring the property `maven.build.timestamp.format` as shown in the example below: -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> ... <properties> @@ -479,7 +479,7 @@ under the License. You are also able to reference any properties defined in the project as a variable. Consider the following example: -```xml +``` <project xmlns="http://maven.apache.org/POM/4.0.0";> ... <properties> diff --git a/content/markdown/guides/mini/guide-archive-configuration.md b/content/markdown/guides/mini/guide-archive-configuration.md index ac5052b8..82c41b4c 100644 --- a/content/markdown/guides/mini/guide-archive-configuration.md +++ b/content/markdown/guides/mini/guide-archive-configuration.md @@ -31,7 +31,7 @@ under the License. To disable the generation of these files, include the following configuration for your plugin (in this example, the WAR plugin is used): -```xml +``` <project> ... <build> diff --git a/content/markdown/guides/mini/guide-assemblies.md b/content/markdown/guides/mini/guide-assemblies.md index b9ff862e..bf424d8b 100644 --- a/content/markdown/guides/mini/guide-assemblies.md +++ b/content/markdown/guides/mini/guide-assemblies.md @@ -25,7 +25,7 @@ under the License. The assembly mechanism in Maven provides an easy way to create distributions using a assembly descriptor and dependency information found in you POM. In order to use the assembly plug-in you need to configure the assembly plug-in in your POM and it might look like the following: -```xml +``` <project> <parent> <artifactId>maven</artifactId> @@ -69,7 +69,7 @@ under the License. This is the most typical usage of the assembly plugin where you are creating a distribution for standard use. -```xml +``` <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd";> <id>bin</id> @@ -107,7 +107,7 @@ under the License. How to use such pre-defined assembly descriptors is described in the [documentation of maven-assembly-plugin](/plugins/maven-assembly-plugin/usage.html#configuration). -```xml +``` <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 @@ -147,7 +147,7 @@ under the License. If you like to create a source distribution package the best solution is to use the [pre-defined assembly descriptor src](/plugins/maven-assembly-plugin/descriptor-refs.html#src) for such purposes. -```xml +``` <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd";> <id>src</id> diff --git a/content/markdown/guides/mini/guide-attached-tests.md b/content/markdown/guides/mini/guide-attached-tests.md index f5176b88..070b0c41 100644 --- a/content/markdown/guides/mini/guide-attached-tests.md +++ b/content/markdown/guides/mini/guide-attached-tests.md @@ -25,7 +25,7 @@ under the License. You can reuse the tests that you have created for one project in another. For example, suppose `foo-core` contains test code in the `${basedir}/src/test/java`. To package up those compiled tests in a JAR and deploy them for general reuse, configure the `maven-jar-plugin` as follows: -```xml +``` <project> <build> @@ -52,7 +52,7 @@ under the License. To use the attached test JAR, specify a dependency on the main artifact with a specified type of `test-jar` and the `classifier`. -```xml +``` <project> ... diff --git a/content/markdown/guides/mini/guide-building-for-different-environments.md b/content/markdown/guides/mini/guide-building-for-different-environments.md index 420cc17d..2a34d7b9 100644 --- a/content/markdown/guides/mini/guide-building-for-different-environments.md +++ b/content/markdown/guides/mini/guide-building-for-different-environments.md @@ -53,7 +53,7 @@ src/ In the project descriptor, you need to configure the different profiles. Only the test profile is showed here. -```xml +``` <profiles> <profile> <id>test</id> diff --git a/content/markdown/guides/mini/guide-configuring-maven.md b/content/markdown/guides/mini/guide-configuring-maven.md index c3ee5ed9..11c35d27 100644 --- a/content/markdown/guides/mini/guide-configuring-maven.md +++ b/content/markdown/guides/mini/guide-configuring-maven.md @@ -44,7 +44,7 @@ under the License. The location of your local repository can be changed in your user configuration. The default value is `${user.home}/.m2/repository/`. -```xml +``` <settings> ... <localRepository>/path/to/local/repo/</localRepository> @@ -82,7 +82,7 @@ export MAVEN_OPTS=-Dmaven.artifact.threads=3 Which settings are required will depend on the type of repository you are deploying to. As of the first release, only SCP deployments and file deployments are supported by default, so only the following SCP configuration is needed: -```xml +``` <settings> ... <servers> diff --git a/content/markdown/guides/mini/guide-configuring-plugins.md b/content/markdown/guides/mini/guide-configuring-plugins.md index 80886d7f..5cde7b6e 100644 --- a/content/markdown/guides/mini/guide-configuring-plugins.md +++ b/content/markdown/guides/mini/guide-configuring-plugins.md @@ -75,7 +75,7 @@ under the License. Maven plugins (build and reporting) are configured by specifying a `<configuration>` element where the child elements of the `<configuration>` element are mapped to fields, or setters, inside your Mojo. (Remember that a plug-in consists of one or more Mojos where a Mojo maps to a goal.) Say, for example, you have a Mojo that performs a query against a particular URL, with a specified timeout and list of options. The Mojo might look like the following: -```java +``` @Mojo( name = "query" ) public class MyQueryMojo extends AbstractMojo @@ -99,7 +99,7 @@ public class MyQueryMojo To configure the Mojo from your POM with the desired URL, timeout and options you might have something like the following: -```xml +``` <project> ... <build> @@ -151,7 +151,7 @@ mvn javadoc:help -Ddetail -Dgoal=javadoc Mapping value types, like Boolean or Integer, is very simple. The `<configuration>` element might look like the following: -```xml +``` <project> ... <configuration> @@ -192,7 +192,7 @@ mvn javadoc:help -Ddetail -Dgoal=javadoc Mapping complex types is also fairly straight forward. Let's look at a simple example where we are trying to map a configuration for Person object. The `<configuration>` element might look like the following: -```xml +``` <project> ... <configuration> @@ -213,7 +213,7 @@ mvn javadoc:help -Ddetail -Dgoal=javadoc - If you wish to have the object to be instantiated live in a different package or have a more complicated name, specify this using an `implementation` attribute like the following: -```xml +``` <project> ... <configuration> @@ -234,7 +234,7 @@ mvn javadoc:help -Ddetail -Dgoal=javadoc Mapping to collections works in much the same way as mapping to arrays. Each item is given in the XML as dedicated element. The element name does not matter in that case. So if you have a mojo like the following: -```java +``` public class MyAnimalMojo extends AbstractMojo { @@ -251,7 +251,7 @@ public class MyAnimalMojo where you have a field named `animals` then your configuration for the plug-in would look like the following: -```xml +``` <project> ... <build> @@ -287,7 +287,7 @@ public class MyAnimalMojo Since Maven 3.3.9 ([MNG-5440](https://issues.apache.org/jira/browse/MNG-5440)), you can list individual items alternatively as comma-separated list in the XML value of animals directly. This approach is also used if configuring collection/array parameters via command line The following example is equivalent to the example above: -```xml +``` <project> ... <build> @@ -311,14 +311,14 @@ public class MyAnimalMojo In the same way, you could define maps like the following: -```java +``` ... @Parameter private Map<String,String> myMap; ... ``` -```xml +``` <project> ... <configuration> @@ -339,14 +339,14 @@ public class MyAnimalMojo Properties should be defined like the following: -```java +``` ... @Parameter private Properties myProperties; ... ``` -```xml +``` <project> ... <configuration> @@ -375,7 +375,7 @@ public class MyAnimalMojo You can also configure a mojo using the `<executions>` tag. This is most commonly used for mojos that are intended to participate in some phases of the [build lifecycle](../introduction/introduction-to-the-lifecycle.html). Using `MyQueryMojo` as an example, you may have something that will look like: -```xml +``` <project> ... <build> @@ -429,7 +429,7 @@ public class MyAnimalMojo How about if we have a multiple executions with different phases bound to it? How do you think will it behave? Let us use the example POM above again, but this time we shall bind `execution2` to a phase. -```xml +``` <project> ... <build> @@ -470,7 +470,7 @@ public class MyAnimalMojo Now, let us have another mojo example which shows a default lifecycle phase binding. -```java +``` @Mojo( name = "query", defaultPhase = LifecyclePhase.PACKAGE ) public class MyBoundQueryMojo extends AbstractMojo @@ -494,7 +494,7 @@ public class MyBoundQueryMojo From the above mojo example, `MyBoundQueryMojo` is by default bound to the package phase (see the `@phase` notation). But if we want to execute this mojo during the install phase and not with package we can rebind this mojo into a new lifecycle phase using the `<phase>` tag under `<execution>`. -```xml +``` <project> ... <build> @@ -541,7 +541,7 @@ mvn myquery:query@execution1 For instance, the Maven Antrun Plugin version 1.2 uses Ant version 1.6.5, if you want to use the latest Ant version when running this plugin, you need to add `<dependencies>` element like the following: -```xml +``` <project> ... <build> @@ -574,7 +574,7 @@ mvn myquery:query@execution1 By default, plugin configuration should be propagated to child POMs, so to break the inheritance, you could use the `<inherited>` tag: -```xml +``` <project> ... <build> @@ -608,7 +608,7 @@ mvn myquery:query@execution1 You can configure a reporting plugin using the `<reportSets>` tag. This is most commonly used to generate reports selectively when running `mvn site`. The following will generate only the project team report. -```xml +``` <project> ... <reporting> @@ -635,7 +635,7 @@ mvn myquery:query@execution1 1 To exclude all reports, you need to use: -```xml +``` <reportSets> <reportSet> <reports/> @@ -649,7 +649,7 @@ mvn myquery:query@execution1 Similar to the build plugins, to break the inheritance, you can use the `<inherited>` tag: -```xml +``` <project> ... <reporting> diff --git a/content/markdown/guides/mini/guide-creating-archetypes.md b/content/markdown/guides/mini/guide-creating-archetypes.md index 08facb30..a63bc0be 100644 --- a/content/markdown/guides/mini/guide-creating-archetypes.md +++ b/content/markdown/guides/mini/guide-creating-archetypes.md @@ -39,7 +39,7 @@ under the License. An example `pom.xml` for an archetype artifact looks as follows: -```xml +``` <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";> @@ -69,7 +69,7 @@ under the License. The [archetype descriptor](/archetype/archetype-models/archetype-descriptor/archetype-descriptor.html) is a file called `archetype-metadata.xml` which must be located in the `src/main/resources/META-INF/maven/` directory. An example of an archetype descriptor can be found in the quickstart archetype: -```xml +``` <archetype-descriptor xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.1.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; @@ -103,7 +103,7 @@ under the License. Thus the quickstart archetype shown above defines the following directory structure: -```xml +``` archetype |-- pom.xml @@ -131,7 +131,7 @@ archetype An example for a prototype `pom.xml` is: -```xml +``` <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";> diff --git a/content/markdown/guides/mini/guide-default-execution-ids.md b/content/markdown/guides/mini/guide-default-execution-ids.md index 25f33f6e..cb7990fc 100644 --- a/content/markdown/guides/mini/guide-default-execution-ids.md +++ b/content/markdown/guides/mini/guide-default-execution-ids.md @@ -45,7 +45,7 @@ under the License. In this case, the assembly-plugin configuration might look like this: -```xml +``` <plugin> <artifactId>maven-assembly-plugin</artifactId> <configuration> @@ -90,7 +90,7 @@ under the License. The resulting configuration might look something like this: -```xml +``` <plugin> <artifactId>maven-compiler-plugin</artifactId> <configuration> @@ -138,7 +138,7 @@ under the License. The resulting compiler-plugin configuration might look something like the following: -```xml +``` <plugin> <artifactId>maven-compiler-plugin</artifactId> <executions> diff --git a/content/markdown/guides/mini/guide-deployment-security-settings.md b/content/markdown/guides/mini/guide-deployment-security-settings.md index 02a23375..11f3c306 100644 --- a/content/markdown/guides/mini/guide-deployment-security-settings.md +++ b/content/markdown/guides/mini/guide-deployment-security-settings.md @@ -29,7 +29,7 @@ under the License. Which settings are required will depend on the type of repository you are deploying to. As of the first release, only SCP deployments and file deployments are supported by default, so only the following SCP configuration is needed: -```xml +``` <settings> . diff --git a/content/markdown/guides/mini/guide-encryption.md b/content/markdown/guides/mini/guide-encryption.md index 01bc4260..68587a3d 100644 --- a/content/markdown/guides/mini/guide-encryption.md +++ b/content/markdown/guides/mini/guide-encryption.md @@ -77,7 +77,7 @@ mvn --encrypt-master-password <password> Store this password in the `${user.home}/.m2/settings-security.xml`; it should look like -```xml +``` <settingsSecurity> <master>{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}</master> </settingsSecurity> @@ -103,7 +103,7 @@ mvn --encrypt-password <password> Copy and paste it into the servers section of your `settings.xml` file. This will look like: -```xml +``` <settings> ... <servers> @@ -121,7 +121,7 @@ mvn --encrypt-password <password> Please note that password can contain any information outside of the curly brackets, so that the following will still work: -```xml +``` <settings> ... <servers> @@ -149,7 +149,7 @@ mvn deploy:deploy-file -Durl=https://maven.corp.com/repo \ Create the master password exactly as described above, and store it on a removable drive, for instance on OSX, my USB drive mounts as `/Volumes/mySecureUsb`, so I store -```xml +``` <settingsSecurity> <master>{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}</master> </settingsSecurity> @@ -159,7 +159,7 @@ mvn deploy:deploy-file -Durl=https://maven.corp.com/repo \ And then I create `${user.home}/.m2/settings-security.xml` with the following content: -```xml +``` <settingsSecurity> <relocation>/Volumes/mySecureUsb/secure/settings-security.xml</relocation> </settingsSecurity> diff --git a/content/markdown/guides/mini/guide-generating-sources.md b/content/markdown/guides/mini/guide-generating-sources.md index 6d547035..606198c9 100644 --- a/content/markdown/guides/mini/guide-generating-sources.md +++ b/content/markdown/guides/mini/guide-generating-sources.md @@ -27,7 +27,7 @@ under the License. So this is all fine and dandy, we have a plugin that wants to generate some sources from a Antlr4 grammar but how do we use it. You need to specify that you want to use it in your POM: -```xml +``` <project> ... diff --git a/content/markdown/guides/mini/guide-http-settings.md b/content/markdown/guides/mini/guide-http-settings.md index 85319b5a..a8f04fe3 100644 --- a/content/markdown/guides/mini/guide-http-settings.md +++ b/content/markdown/guides/mini/guide-http-settings.md @@ -73,7 +73,7 @@ under the License. In all HTTP transports, you can add your custom HTTP headers like this: -```xml +``` <settings> <servers> <server> @@ -97,7 +97,7 @@ under the License. All transport implementations that perform some network access allow the configuration of a several timeouts, for example to allow the user to tell Maven how long to wait before giving up on a connection that has not responded. -```xml +``` <settings> <servers> <server> @@ -174,7 +174,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. In all of the examples below, it's important to understand that you can configure the HTTP settings for all requests made to a given server, or for only one method. To configure all methods for a server, use the following section of the `settings.xml` file: -```xml +``` <settings> [...] <servers> @@ -194,7 +194,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. On the other hand, if you can live with the default configuration for most requests - say, HEAD and GET requests, which are used to check for the existence of a file and retrieve a file respectively - maybe you only need to configure the PUT method: -```xml +``` <settings> [...] <servers> @@ -220,7 +220,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. To turn off this default behavior, simply disable the default headers. Then, respecify the other headers that you are still interested in, like this: -```xml +``` <settings> [...] <servers> @@ -294,7 +294,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. Using the above syntax, you can configure preemptive authentication for PUT requests using the boolean HttpClient parameter `http.authentication.preemptive`, like this: -```xml +``` <settings> <servers> <server> @@ -318,7 +318,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. Another option is to make write it like this: -```xml +``` <settings> <servers> <server> @@ -343,7 +343,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. Like the example above, telling the HttpClient to ignore cookies for all methods of request is a simple matter of configuring the `http.protocol.cookie-policy` parameter (it uses a regular string value, so no special syntax is required): -```xml +``` <settings> <servers> <server> @@ -375,7 +375,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. In all HTTP Wagon implementations, you can add your own HTTP headers like this: -```xml +``` <settings> <servers> <server> @@ -399,7 +399,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. All wagon implementations that extend the `AbstractWagon` class, including those for SCP, HTTP, FTP, and more, allow the configuration of a connection timeout, to allow the user to tell Maven how long to wait before giving up on a connection that has not responded. This option is preserved in the HttpClient-based wagon, but this wagon also provides a fine-grained alternative configuration that can allow you to specify timeouts per-method for a given server. The old configuration option [...] -```xml +``` <settings> <servers> <server> @@ -414,7 +414,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. ...while the new configuration option looks more like this: -```xml +``` <settings> <servers> <server> @@ -437,7 +437,7 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. With Wagon 2.0 and Apache Maven 3.0.4, a default timeout of 30 minutes comes by default. If you want to change this value, you can add the following setup in your settings: -```xml +``` <settings> <servers> <server> diff --git a/content/markdown/guides/mini/guide-large-scale-centralized-deployments.md b/content/markdown/guides/mini/guide-large-scale-centralized-deployments.md index 3cdbb86a..d2a00dab 100644 --- a/content/markdown/guides/mini/guide-large-scale-centralized-deployments.md +++ b/content/markdown/guides/mini/guide-large-scale-centralized-deployments.md @@ -73,7 +73,7 @@ under the License. Example: To download artifacts from the corporate repository manager's `maven-virtual` repository: -```xml +``` <settings> ... <mirrors> @@ -103,7 +103,7 @@ under the License. Example: To upload artifacts to one of the corporate repository manager's hosted repositories: -```xml +``` <settings> ... <profiles> diff --git a/content/markdown/guides/mini/guide-maven-classloading.md b/content/markdown/guides/mini/guide-maven-classloading.md index cd3cdaea..5d852ce7 100644 --- a/content/markdown/guides/mini/guide-maven-classloading.md +++ b/content/markdown/guides/mini/guide-maven-classloading.md @@ -96,7 +96,7 @@ under the License. Users can add dependencies to this classloader by adding dependencies to a plugin in the `[plugins/plugin](/ref/current/maven-model/maven.html#class_plugin)` section of their project `pom.xml`. Here is a sample of adding `ant-nodeps` to the plugin classloader of the Antrun Plugin and hereby enabling the use of additional/optional Ant tasks: -```xml +``` <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-antrun-plugin</artifactId> diff --git a/content/markdown/guides/mini/guide-mirror-settings.md b/content/markdown/guides/mini/guide-mirror-settings.md index 2500aa4d..edf960ce 100644 --- a/content/markdown/guides/mini/guide-mirror-settings.md +++ b/content/markdown/guides/mini/guide-mirror-settings.md @@ -34,7 +34,7 @@ under the License. To configure a mirror of a given repository, you provide it in your settings file (`${user.home}/.m2/settings.xml`), giving the new repository its own `id` and `url`, and specify the `mirrorOf` setting that is the ID of the repository you are using a mirror of. For example, the ID of the main Maven Central repository included by default is `central`, so to use the different mirror instance, you would configure the following: -```xml +``` <settings> ... <mirrors> @@ -65,7 +65,7 @@ under the License. **Note:** This feature is only available in Maven 2.0.5+. -```xml +``` <settings> ... <mirrors> @@ -112,7 +112,7 @@ under the License. - `*,!repo1` = everything except repo1 -```xml +``` <settings> ... <mirrors> diff --git a/content/markdown/guides/mini/guide-multiple-repositories.md b/content/markdown/guides/mini/guide-multiple-repositories.md index 09e3f2f1..28788183 100644 --- a/content/markdown/guides/mini/guide-multiple-repositories.md +++ b/content/markdown/guides/mini/guide-multiple-repositories.md @@ -24,7 +24,7 @@ under the License. There are two different ways that you can specify the use of multiple repositories. The first way is to specify in a POM which repositories you want to use. That is supported both inside and outside of build profiles: -```xml +``` <project> ... @@ -49,7 +49,7 @@ under the License. The other way you can specify multiple repositories is by creating a profile in the `${user.home}/.m2/settings.xml` or `${maven.home}/conf/settings.xml` file like the following: -```xml +``` <settings> ... diff --git a/content/markdown/guides/mini/guide-proxies.md b/content/markdown/guides/mini/guide-proxies.md index 1b8e7451..ce5da3ac 100644 --- a/content/markdown/guides/mini/guide-proxies.md +++ b/content/markdown/guides/mini/guide-proxies.md @@ -26,7 +26,7 @@ under the License. The `nonProxyHosts` setting accepts wild cards, and each host not to proxy is separated by the | character. This matches the JDK configuration equivalent. -```xml +``` <settings> . diff --git a/content/markdown/guides/mini/guide-releasing.md b/content/markdown/guides/mini/guide-releasing.md index db680e95..b48cf04f 100644 --- a/content/markdown/guides/mini/guide-releasing.md +++ b/content/markdown/guides/mini/guide-releasing.md @@ -66,7 +66,7 @@ mvn release:prepare \ The previous goal parameters can be supplied while executing maven on the commandline, (as shown in the previous example) or they can be defined and maintained within the project's _pom.xml_ file. The location of the current development trunk is defined within the _pom.xml_ file in the following form: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> <groupId>com.mycompany.app</groupId> @@ -103,7 +103,7 @@ mvn release:prepare \ To define the tagBase parameter within the _pom.xml_ file a tagBase element must be defined within a _plugins/plugin/configuration_ element. The following example shows how this would look within the _pom.xml_ file. -```xml +``` <project> <modelVersion>4.0.0</modelVersion> <groupId>com.mycompany.app</groupId> @@ -199,7 +199,7 @@ checkpoint.check-in-development-version=OK The following is an example of how a distributionManagement element can be configured within a project _pom.xml_ file. -```xml +``` <project> <modelVersion>4.0.0</modelVersion> <groupId>com.mycompany.app</groupId> diff --git a/content/markdown/guides/mini/guide-relocation.md b/content/markdown/guides/mini/guide-relocation.md index 7c352245..4c6f3506 100644 --- a/content/markdown/guides/mini/guide-relocation.md +++ b/content/markdown/guides/mini/guide-relocation.md @@ -46,7 +46,7 @@ under the License. The minimal POM file might look like this for version 1.0 of `foo`: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> <groupId>bar</groupId> diff --git a/content/markdown/guides/mini/guide-repository-ssl.md b/content/markdown/guides/mini/guide-repository-ssl.md index aa458174..df8a9f06 100644 --- a/content/markdown/guides/mini/guide-repository-ssl.md +++ b/content/markdown/guides/mini/guide-repository-ssl.md @@ -64,7 +64,7 @@ maven.repo.remote=https://my.server.com/maven,http://www.ibiblio.org/maven The following command line imports the certififcate authority's certificate into a JKS formatted key store named `trust.jks`, the _trust store_. -```bash +``` $> keytool -v -alias mavensrv -import \ -file /somewhere/in/filesystem/CACert.cert\ -keystore trust.jks @@ -104,7 +104,7 @@ $> They may be set either on maven's command-line, in `.mavenrc` file or in `MAVEN_OPTS` environment variable. For the setting defined in this document, here is an example `.mavenrc` file: -```bash +``` MAVEN_OPTS="-Xmx512m -Djavax.net.ssl.trustStore=trust.jks \ -Djavax.net.ssl.trustStorePassword= \ -Djavax.net.ssl.keyStore=/home/directory/mycertificate.p12 \ diff --git a/content/markdown/guides/mini/guide-reproducible-builds.md b/content/markdown/guides/mini/guide-reproducible-builds.md index 57d66a52..d67bba5e 100644 --- a/content/markdown/guides/mini/guide-reproducible-builds.md +++ b/content/markdown/guides/mini/guide-reproducible-builds.md @@ -40,7 +40,7 @@ mvn artifact:check-buildplan 1 Enable Reproducible Builds mode for plugins, by adding [`project.build.outputTimestamp` property](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=74682318#Reproducible/VerifiableBuilds-OutputArchiveEntriesTimestamp) to the project's `pom.xml`: -```xml +``` <properties> <project.build.outputTimestamp>2023-01-01T00:00:00Z</project.build.outputTimestamp> </properties> diff --git a/content/markdown/guides/mini/guide-site.md b/content/markdown/guides/mini/guide-site.md index 2fafdea2..854310e6 100644 --- a/content/markdown/guides/mini/guide-site.md +++ b/content/markdown/guides/mini/guide-site.md @@ -91,7 +91,7 @@ mvn site To be able to deploy the site with a classical network protocol (ftp, scp, webdav), you must first declare a location to distribute to in your `pom.xml`, similar to the repository for deployment: -```xml +``` <project> ... <distributionManagement> @@ -120,7 +120,7 @@ mvn site-deploy For example with a project hosted on GitHub and using GitHub Pages for its site publication: -```xml +``` <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-scm-publish-plugin</artifactId> @@ -142,7 +142,7 @@ mvn site-deploy The `site.xml` file is used to describe the structure of the site. A sample is given below: -```xml +``` <?xml version="1.0" encoding="ISO-8859-1"?> <project xmlns="http://maven.apache.org/DECORATION/1.8.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd"; @@ -227,7 +227,7 @@ mvn site-deploy To add these reports to your site, you must add the Project Info Reports plugin to a special `<reporting>` section in the POM. The following example shows how to configure the standard project information reports that display information from the POM in a friendly format: -```xml +``` <project> ... <reporting> @@ -257,7 +257,7 @@ mvn site-deploy To enable multiple locales, add a configuration similar to the following to your POM: -```xml +``` <project> ... <build> diff --git a/content/markdown/guides/mini/guide-snippet-macro.md b/content/markdown/guides/mini/guide-snippet-macro.md index 3b1aa2c5..5fe0828a 100644 --- a/content/markdown/guides/mini/guide-snippet-macro.md +++ b/content/markdown/guides/mini/guide-snippet-macro.md @@ -39,7 +39,7 @@ under the License. #### Java -```java +``` // START SNIPPET: snip-id public static void main( String[] args ) { @@ -50,7 +50,7 @@ under the License. #### XML -```xml +``` <!-- START SNIPPET: snip-id --> <navigation-rule> <from-view-id>/logon.jsp</from-view-id> diff --git a/content/markdown/guides/mini/guide-using-ant.md b/content/markdown/guides/mini/guide-using-ant.md index 447b1d3b..4b09e3ad 100644 --- a/content/markdown/guides/mini/guide-using-ant.md +++ b/content/markdown/guides/mini/guide-using-ant.md @@ -24,7 +24,7 @@ under the License. The example above illustrates how to bind an ant script to a lifecycle phase. You can add a script to each lifecycle phase, by duplicating the _execution/_ section and specifying a new phase. -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -64,7 +64,7 @@ under the License. So a concrete example would be something like the following: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> diff --git a/content/markdown/guides/mini/guide-using-extensions.md b/content/markdown/guides/mini/guide-using-extensions.md index 80205c53..388624f5 100644 --- a/content/markdown/guides/mini/guide-using-extensions.md +++ b/content/markdown/guides/mini/guide-using-extensions.md @@ -46,7 +46,7 @@ under the License. Example: -```xml +``` <project> ... @@ -71,7 +71,7 @@ under the License. Example: -```xml +``` <project> ... diff --git a/content/markdown/guides/mini/guide-wagon-providers.md b/content/markdown/guides/mini/guide-wagon-providers.md index aadf492c..4231f535 100644 --- a/content/markdown/guides/mini/guide-wagon-providers.md +++ b/content/markdown/guides/mini/guide-wagon-providers.md @@ -44,7 +44,7 @@ mvn -Dmaven.wagon.provider.http=httpclient clean install To specify which Wagon provider to use for a particular server, modify your `settings.xml` file to add the `<wagonProvider>` configuration to your `<server>` entry, like the following: -```xml +``` <settings> [...] <servers> @@ -61,7 +61,7 @@ mvn -Dmaven.wagon.provider.http=httpclient clean install Maven 2.2.1 provides two providers for HTTP/HTTPS Wagons: `lightweight` and `httpclient`. If you add a new HTTP Wagon implementation via build extension, you'll need to make sure the extension binds its Wagon components to role-hints of the form `<protocol>-<provider>` in order to allow users to specify your alternative Wagon provider. For instance, the HttpClient HTTP Wagon component definition looks like this: -```xml +``` <component> <role>org.apache.maven.wagon.Wagon</role> <role-hint>http-httpclient</role-hint> diff --git a/content/markdown/guides/plugin/guide-java-plugin-development.md b/content/markdown/guides/plugin/guide-java-plugin-development.md index 45acfc5e..3b84d309 100644 --- a/content/markdown/guides/plugin/guide-java-plugin-development.md +++ b/content/markdown/guides/plugin/guide-java-plugin-development.md @@ -73,7 +73,7 @@ Any class with this annotation are included in the plugin configuration file. Listed below is a simple mojo class which has no parameters. This is about as simple as a mojo can be. After the listing is a description of the various parts of the source. -```java +``` package sample.plugin; import org.apache.maven.plugin.AbstractMojo; @@ -116,7 +116,7 @@ Once the mojos have been written for the plugin, it is time to build the plugin. Listed below is an illustration of the sample mojo project's pom with the parameters set as described in the above table: -```xml +``` <project> <modelVersion>4.0.0</modelVersion> @@ -189,7 +189,7 @@ For more details, you can look at [detailed bindings for `maven-plugin` packagin The most direct means of executing your new plugin is to specify the plugin goal directly on the command line. To do this, you need to configure the `hello-maven-plugin` plugin in you project: -```xml +``` <project> ... <build> @@ -230,7 +230,7 @@ There are several ways to reduce the amount of required typing: - Finally, you can also add your plugin's groupId to the list of groupIds searched by default. To do this, you need to add the following to your `${user.home}/.m2/settings.xml` file: -```xml +``` <pluginGroups> <pluginGroup>sample.plugin</pluginGroup> </pluginGroups> @@ -242,7 +242,7 @@ At this point, you can run the mojo with `mvn hello:sayhi`. You can also configure your plugin to attach specific goals to a particular phase of the build lifecycle. Here is an example: -```xml +``` <build> <pluginManagement> <plugins> @@ -296,7 +296,7 @@ It is unlikely that a mojo will be very useful without parameters. Parameters pr Defining a parameter is as simple as creating an instance variable in the mojo and adding the proper annotations. Listed below is an example of a parameter for the simple mojo: -```java +``` /** * The greeting to display. */ @@ -319,7 +319,7 @@ The `property` parameter can be used to allow configuration of the mojo paramete Configuring the parameter values for a plugin is done in a Maven project within the `pom.xml` file as part of defining the plugin in the project. An example of configuring a plugin: -```xml +``` <plugin> <groupId>sample.plugin</groupId> <artifactId>hello-maven-plugin</artifactId> @@ -344,7 +344,7 @@ You can also add `@Parameter` annotation on setter method (from version 3.7.0 of So our Mojo would look like the following: -```java +``` public class MyQueryMojo extends AbstractMojo { diff --git a/content/markdown/guides/plugin/guide-java-report-plugin-development.md b/content/markdown/guides/plugin/guide-java-report-plugin-development.md index 1e3a6de5..35bb90dc 100644 --- a/content/markdown/guides/plugin/guide-java-report-plugin-development.md +++ b/content/markdown/guides/plugin/guide-java-report-plugin-development.md @@ -34,7 +34,7 @@ under the License. 1 A regular Maven project usually invokes _reporting goals_ of a plugin by declaring such plugin in the [`<reporting>`](/plugins/maven-site-plugin/examples/configuring-reports.html) section of its `pom.xml` as in the example below: -```xml +``` <project> ... <reporting> @@ -103,7 +103,7 @@ under the License. #### ./pom.xml -```xml +``` <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";> @@ -207,7 +207,7 @@ under the License. #### ./src/main/java/com/mycompany/maven/SimpleReport.java -```java +``` package com.mycompany.maven; import java.util.Locale; @@ -326,7 +326,7 @@ mvn install To make sure everything went well and is properly declared, you can now execute the below command in any other Maven project directory: -```bash +``` $ mvn com.mycompany.maven:simple-maven-plugin:1.0-SNAPSHOT:help [INFO] --- simple-maven-plugin:1.0-SNAPSHOT:help (default-cli) @ hardware-connectors --- @@ -355,7 +355,7 @@ simple:simple To invoke the _report Mojo_ of our plugin in another Maven project, we just need to declare the plugin in the [`<reporting>`](/plugins/maven-site-plugin/examples/configuring-reports.html) section of its `pom.xml` as in the example below: -```xml +``` <project> ... <reporting> @@ -381,7 +381,7 @@ simple:simple You will use the [`Sink`](/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html) object associated to the report: -```java +``` Sink sink = getSink(); ``` @@ -417,7 +417,7 @@ Sink sink = getSink(); You may need to create not just one HTML file, but several of them (like Javadoc produces one HTML file for each Java class). To do so, you will need to get a new _Sink_ for each HTML file you need to produce. This is achieved by using the [`SinkFactory`](/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/SinkFactory.html) object that you can easily obtain with the [`getSinkFactory()`](/shared/maven-reporting-impl/apidocs/org/apache/maven/reporting/AbstractMavenReport.html# [...] -```java +``` public class SimpleReport extends AbstractMavenReport { ... diff --git a/content/markdown/plugin-developers/common-bugs.md b/content/markdown/plugin-developers/common-bugs.md index d0d344a0..42ae60fa 100644 --- a/content/markdown/plugin-developers/common-bugs.md +++ b/content/markdown/plugin-developers/common-bugs.md @@ -53,7 +53,7 @@ under the License. Therefore, developers should avoid any direct or indirect usage of the classes/methods that simply employ the platform's default encoding. For instance, `FileWriter` and `FileReader` should usually be avoided: -```java +``` /* * FIXME: This assumes the source file is using the platform's default encoding. */ @@ -70,7 +70,7 @@ Reader reader = new FileReader( javaFile ); Finally note that XML files require special handling because they are equipped with an encoding declaration in the XML prolog. Reading or writing XML files with an encoding that does not match their XML prolog's `encoding` attribute is a bad idea: -```java +``` /* * FIXME: This assumes the XML encoding declaration matches the platform's default encoding. */ @@ -84,7 +84,7 @@ writer.write( xmlContent ); URLs and filesystem paths are really two different things and converting between them is not trivial. The main source of problems is that different encoding rules apply for the strings that make up a URL or filesystem path. For example, consider the following code snippet and its associated console output: -```java +``` File file = new File( "foo bar+foo" ); URL url = file.toURI().toURL(); @@ -105,7 +105,7 @@ System.out.println( URLDecoder.decode( url.getPath(), "UTF-8" ) ); Next, `[URL.getPath()](http://java.sun.com/javase/6/docs/api/java/net/URL.html#getPath())` does in general not return a string that can be used as a filesystem path. It returns a substring of the URL and as such can contain escape sequences. The prominent example is the space character which will show up as "%20". People sometimes hack around this by means of `replace("%20", " ")` but that does simply not cover all cases. It's worth to mention that on the other hand the related method ` [...] -```java +``` URL url = new URL( "file:/C:/Program%20Files/Java/bin/java.exe" ); /* @@ -118,7 +118,7 @@ File path = new File( url.getPath() ); In an ideal world, code targetting JRE 1.4+ could easily avoid these problems by using the constructor `[File(URI)](http://java.sun.com/javase/6/docs/api/java/io/File.html#File(java.net.URI))` as suggested by the following snippet: -```java +``` URL url = new URL( "file:/C:/Documents and Settings/user/.m2/settings.xml" ); /* @@ -137,7 +137,7 @@ File path = new File( new URI( url.toExternalForm() ) ); The gotcha with the arg-less methods is that their output depends on the default locale of the JVM but the default locale is out of control of the developer. That means the string expected by the developer (who runs/tests his code in a JVM using locale `xy`) does not necessarily match the string seen by another user (that runs a JVM with locale `ab`). For example, the comparison shown in the next code snippet is likely to fail for systems with default locale Turkish because Turkish has [...] -```java +``` /* * FIXME: This assumes the casing rules of the current platform * match the rules for the English locale. @@ -173,7 +173,7 @@ src/ Maven's command line supports the definition of system properties via arguments of the form `-D key=value`. While these properties are called system properties, plugins should never use `[System.getProperty()](http://java.sun.com/javase/6/docs/api/java/lang/System.html#getProperty(java.lang.String))` and related methods to query these properties. For example, the following code snippet will not work reliably when Maven is embedded, say into an IDE or a CI server: -```java +``` public MyMojo extends AbstractMojo { public void execute() @@ -192,7 +192,7 @@ public MyMojo extends AbstractMojo People occasionally employ shutdown hooks to perform cleanup tasks, e.g. to delete temporary files as shown in the example below: -```java +``` public MyMojo extends AbstractMojo { public void execute() @@ -233,7 +233,7 @@ public MyMojo extends AbstractMojo Hence this example code is prone to misbehave: -```java +``` public MyMojo extends AbstractMojo { /** @@ -254,7 +254,7 @@ public MyMojo extends AbstractMojo In order to guarantee reliable builds, Maven and its plugins must manually resolve relative paths against the project's base directory. A simple idiom like the following will do just fine: -```java +``` File file = new File( path ); if ( !file.isAbsolute() ) { @@ -270,7 +270,7 @@ if ( !file.isAbsolute() ) Now, some plugins need to create additional files in the report output directory that accompany the report generated via the sink interface. While it is tempting to use either the method `getOutputDirectory()` or the field `outputDirectory` directly in order to setup a path for the output files, this leads most likely to a bug. More precisely, those plugins will not properly output files when run by the Maven Site Plugin as part of the site lifecycle. This is best noticed when the outpu [...] -```java +``` public MyReportMojo extends AbstractMavenReport { /** @@ -304,7 +304,7 @@ public MyReportMojo extends AbstractMavenReport For example, the next snippet tries to retrieve the mojo logger during construction time but the mojo logger is an injected component and as such has not been properly initialized yet: -```java +``` public MyMojo extends AbstractMojo { /* diff --git a/content/markdown/plugin-developers/cookbook/plexus-plugin-upgrade.md b/content/markdown/plugin-developers/cookbook/plexus-plugin-upgrade.md index 37139c5a..6fb725d1 100644 --- a/content/markdown/plugin-developers/cookbook/plexus-plugin-upgrade.md +++ b/content/markdown/plugin-developers/cookbook/plexus-plugin-upgrade.md @@ -67,7 +67,7 @@ default: `${basedir}/src/test/resources/META-INF/plexus`| In your `pom.xml`, replace `plexus-maven-plugin` configuration: -```xml +``` <project> <build> <plugins> @@ -89,7 +89,7 @@ default: `${basedir}/src/test/resources/META-INF/plexus`| with corresponding `plexus-component-metadata` configuration: -```xml +``` <project> <build> <plugins> @@ -115,7 +115,7 @@ default: `${basedir}/src/test/resources/META-INF/plexus`| In your `pom.xml`, add `plexus-component-annotations` dependency: -```xml +``` <project> <dependencies> <dependency> @@ -129,7 +129,7 @@ default: `${basedir}/src/test/resources/META-INF/plexus`| In your java sources, replace javadoc tags: -```java +``` /** * @plexus.component role="foo.MyComponent" role-hint="hint-value" */ @@ -145,7 +145,7 @@ public class MyComponentImplementation with corresponding Java 5 annotations -```java +``` import org.codehaus.plexus.component.annotations.Component; import org.codehaus.plexus.component.annotations.Requirement; diff --git a/content/markdown/plugin-developers/plugin-testing.md b/content/markdown/plugin-developers/plugin-testing.md index 389f0a78..a0f97e87 100644 --- a/content/markdown/plugin-developers/plugin-testing.md +++ b/content/markdown/plugin-developers/plugin-testing.md @@ -56,7 +56,7 @@ under the License. In general, you need to include `maven-plugin-testing-harness` as a dependency, and create a \*MojoTest (by convention) class which `extends AbstractMojoTestCase`. -```xml +``` ... <dependencies> ... @@ -71,7 +71,7 @@ under the License. ... ``` -```java +``` public class YourMojoTest extends AbstractMojoTestCase { @@ -117,7 +117,7 @@ public class YourMojoTest You can take a look at the [maven-install-plugin](https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-install-plugin/src/it/) how there are integration tests are written. -```xml +``` <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";> ... diff --git a/content/markdown/plugins/localization.md b/content/markdown/plugins/localization.md index d32cea26..0c27bc7c 100644 --- a/content/markdown/plugins/localization.md +++ b/content/markdown/plugins/localization.md @@ -64,7 +64,7 @@ under the License. - Configure a project to use the latest SNAPSHOT version of the plugin you are working on. Also configure the project to produce a site in the language you are adding a translation for. For Spanish, as we used in the example above, it would look like this: -```xml +``` <build> <plugins> <plugin> diff --git a/content/markdown/repository/central-index.md b/content/markdown/repository/central-index.md index 2c4341a8..f7da9a80 100644 --- a/content/markdown/repository/central-index.md +++ b/content/markdown/repository/central-index.md @@ -40,7 +40,7 @@ java -jar indexer-cli-5.1.1.jar --unpack nexus-maven-repository-index.gz --desti - download and extract [Luke binary tarball](https://github.com/DmitryKey/luke/releases/download/luke-4.10.4/luke-with-deps.tar.gz) and launch it on the Central index with Lucene format: -```bash +``` luke.sh -ro -index central-lucene-index ``` diff --git a/content/markdown/repository/guide-central-repository-upload.md b/content/markdown/repository/guide-central-repository-upload.md index 520be3d0..266b4581 100644 --- a/content/markdown/repository/guide-central-repository-upload.md +++ b/content/markdown/repository/guide-central-repository-upload.md @@ -48,7 +48,7 @@ under the License. ### A basic sample -```xml +``` <project> <modelVersion>4.0.0</modelVersion> diff --git a/content/markdown/skins/index.md b/content/markdown/skins/index.md index ce1ef828..8e374907 100644 --- a/content/markdown/skins/index.md +++ b/content/markdown/skins/index.md @@ -52,7 +52,7 @@ under the License. To use one of these skins in your project, you use the `skin` element of the [site descriptor](/plugins/maven-site-plugin/examples/sitedescriptor.html). This is a regular artifact or dependency-like element. For example, to use the Maven Fluido Skin, you would include the this in your `site.xml` file: -```xml +``` <project> ... <skin>
