This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-htl-maven-plugin.git
commit 9f5e7f5be53172dd2206bf236c49e36657b78d35 Author: Stefan Seifert <[email protected]> AuthorDate: Thu Mar 9 23:17:46 2017 +0000 link to generated docs git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1786256 13f79535-47bb-0310-9956-ffa450edef68 --- README.md | 84 ++------------------------------------------------------------- 1 file changed, 2 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index ec8fd1b..1e93dd5 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,6 @@ Apache Sling HTL Maven Plugin ==== -The Apache Sling HTL Maven Plugin, M2Eclipse compatible, provides support for validating HTML Template Language scripts from projects during build time. - -## Goals overview - -* [`htl:validate`](#htlvalidate) - validate the scripts from the build directory (`${project.build.sourceDirectory}`) - -## Usage -```xml -<build> - <plugins> - <plugin> - <groupId>org.apache.sling</groupId> - <artifactId>htl-maven-plugin</artifactId> - <version>1.0.0</version> - <executions> - <execution> - <id>validate-scripts</id> - <goals> - <goal>validate</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> -</build> -``` - -## `htl:validate` -**Full name:** `org.apache.sling:htl-maven-plugin:1.0.0:validate` - -**Description:** -Validates HTL scripts syntax during the build process. - -### Optional Parameters - -|Name |Type |Since |Description | -|---------------------------------------------|------------|---------|--------------------------------------------------------------------------------------------------| -| [`sourceDirectory`](#param-sourceDirectory) | `String` | `1.0.0` | Defines the root folder where this goal expects to find Sightly scripts to validate. | -| [`includes`](#param-includes) | `String[]` | `1.0.0` | List of files to include, specified as fileset patterns which are relative to `sourceDirectory`. | -| [`excludes`](#param-excludes) | `String[]` | `1.0.0` | List of files to exclude, specified as fileset patterns which are relative to `sourceDirectory`. | -| [`failOnWarnings`](#param-failOnWarnings) | `boolean` | `1.0.0` | If set to `true` it will fail the build on compiler warnings. | -| [`skip`](#param-skip) | `boolean` | `1.0.2` | If set to `true` the validation will be skipped. | - -### Parameter Details - -<a name="param-sourceDirectory"><code>sourceDirectory</code></a>: -Defines the root folder where this goal expects to find Sightly scripts to validate. -* **Type:** `java.lang.String` -* **Required:** No -* **User Property:** `sourceDirectory` -* **Default:** `${project.build.sourceDirectory}` - -<a name="param-includes"><code>includes</code></a>: - -List of files to include, specified as fileset patterns which are relative to `sourceDirectory`. -* **Type:** `java.lang.String[]` -* **Required:** No -* **User Property:** `includes` -* **Default:** `**/*.html` - -<a name="param-excludes"><code>excludes</code></a>: - -List of files to exclude, specified as fileset patterns which are relative to `sourceDirectory`. -* **Type:** `java.lang.String[]` -* **Required:** No -* **User Property:** `excludes` - -<a name="param-failOnWarnings"><code>failOnWarnings</code></a>: - -If set to `true` it will fail the build on compiler warnings. -* **Type:** `boolean` -* **Required:** No -* **User Property:** `failOnWarnings` -* **Default:** `false` - -<a name="param-skip"><code>skip</code></a>: - -If set to `true` the validation will be skipped. -* **Type:** `boolean` -* **Required:** No -* **User Property** `htl.skip` -* **Default:** `false` +The Apache Sling HTL Maven Plugin, M2Eclipse compatible, provides support for validating HTML Template Language scripts from projects during build time. +See [Apache Sling HTL Maven Plugin documentation](http://sling.apache.org/components/htl-maven-plugin/plugin-info.html) for a list of supported goals. -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
