You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2016/09/06 12:10:44 UTC
svn commit: r996783 - in /websites/staging/sling/trunk/content: ./
documentation/development/htl-maven-plugin.html
Author: buildbot
Date: Tue Sep 6 12:10:44 2016
New Revision: 996783
Log:
Staging update by buildbot for sling
Added:
websites/staging/sling/trunk/content/documentation/development/htl-maven-plugin.html
Modified:
websites/staging/sling/trunk/content/ (props changed)
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Sep 6 12:10:44 2016
@@ -1 +1 @@
-1759408
+1759416
Added: websites/staging/sling/trunk/content/documentation/development/htl-maven-plugin.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/htl-maven-plugin.html (added)
+++ websites/staging/sling/trunk/content/documentation/development/htl-maven-plugin.html Tue Sep 6 12:10:44 2016
@@ -0,0 +1,218 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Apache Sling - HTL Maven Plugin</title>
+ <link rel="icon" href="/res/favicon.ico">
+ <link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
+ <link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
+ </head>
+ <body>
+ <div class="title">
+ <div class="logo">
+ <a href="//sling.apache.org/">
+ <img border="0" alt="Apache Sling" src="/res/logo.png">
+ </a>
+ </div>
+ <div class="header">
+ <a href="//www.apache.org/">
+ <img border="0" alt="Apache" src="/res/apache.png">
+ </a>
+ </div>
+ </div>
+
+ <div class="menu">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+<a href="/documentation/getting-started.html">Getting Started</a> <br />
+<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
+<a href="/documentation/development.html">Development</a> <br />
+<a href="/documentation/bundles.html">Bundles</a> <br />
+<a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a> <br />
+<a href="/documentation/configuration.html">Configuration</a> </p>
+<p><a href="http://s.apache.org/sling.wiki">Wiki</a> <br />
+<a href="http://s.apache.org/sling.faq">FAQ</a> </p>
+<p><strong>API Docs</strong> <br />
+<a href="/apidocs/sling8/index.html">Sling 8</a> <br />
+<a href="/apidocs/sling7/index.html">Sling 7</a> <br />
+<a href="/apidocs/sling6/index.html">Sling 6</a> <br />
+<a href="/apidocs/sling5/index.html">Sling 5</a> <br />
+<a href="/javadoc-io.html">Archive at javadoc.io</a> </p>
+<p><strong>Project info</strong> <br />
+<a href="/downloads.cgi">Downloads</a> <br />
+<a href="http://www.apache.org/licenses/">License</a> <br />
+<a href="/contributing.html">Contributing</a> <br />
+<a href="/news.html">News</a> <br />
+<a href="/links.html">Links</a> <br />
+<a href="/project-information.html">Project Information</a> <br />
+<a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a> <br />
+<a href="http://ci.apache.org/builders/sling-trunk">Build Server</a> <br />
+<a href="/project-information/security.html">Security</a> </p>
+<p><strong>Source</strong> <br />
+<a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a> <br />
+<a href="git://git.apache.org/sling.git">Git</a> <br />
+<a href="https://github.com/apache/sling">Github Mirror</a> </p>
+<p><strong>Sponsorship</strong> <br />
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a> <br />
+<a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a> <br />
+<a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a> </p>
+<p><strong><a href="/sitemap.html">Site Map</a></strong></p>
+<!-- no valid ads for now, we'll reactivate this when needed
+<iframe
+ src="http://www.apache.org/ads/button.html"
+ style="border-width:0; float: left" frameborder="0"
+ scrolling="no"
+ width="135"
+ height="135">
+</iframe>
+-->
+ </div>
+
+ <div class="main">
+ <div class="breadcrump" style="font-size: 80%;">
+ <a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/development.html">Development</a>
+ </div>
+
+
+
+ <h1>HTL Maven Plugin</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>The <a href="https://github.com/apache/sling/tree/trunk/tooling/maven/htl-maven-plugin">Apache Sling HTL Maven Plugin</a>, M2Eclipse compatible,
+provides support for validating HTML Template Language scripts from projects during build time.</p>
+<h2 id="goals-overview">Goals overview<a class="headerlink" href="#goals-overview" title="Permanent link">¶</a></h2>
+<ul>
+<li><a href="#htlvalidate"><code>htl:validate</code></a> - validate the scripts from the build directory (<code>${project.build.sourceDirectory}</code>)</li>
+</ul>
+<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
+<p><code>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>
+ <phase>compile</phase>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build></code></p>
+<h2 id="htlvalidate"><code>htl:validate</code><a class="headerlink" href="#htlvalidate" title="Permanent link">¶</a></h2>
+<p><strong>Full name:</strong> <code>org.apache.sling:htl-maven-plugin:1.0.0:validate</code></p>
+<p><strong>Description:</strong>
+Validates HTL scripts syntax during the build process.</p>
+<h3 id="optional-parameters">Optional Parameters<a class="headerlink" href="#optional-parameters" title="Permanent link">¶</a></h3>
+<table class="table">
+<thead>
+<tr>
+<th>Name</th>
+<th>Type</th>
+<th>Since</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="#param-sourceDirectory"><code>sourceDirectory</code></a></td>
+<td><code>String</code></td>
+<td><code>1.0.0</code></td>
+<td>Defines the root folder where this goal expects to find Sightly scripts to validate.</td>
+</tr>
+<tr>
+<td><a href="#param-includes"><code>includes</code></a></td>
+<td><code>String[]</code></td>
+<td><code>1.0.0</code></td>
+<td>List of files to include, specified as fileset patterns which are relative to <code>sourceDirectory</code>.</td>
+</tr>
+<tr>
+<td><a href="#param-excludes"><code>excludes</code></a></td>
+<td><code>String[]</code></td>
+<td><code>1.0.0</code></td>
+<td>List of files to exclude, specified as fileset patterns which are relative to <code>sourceDirectory</code>.</td>
+</tr>
+<tr>
+<td><a href="#param-failOnWarnings"><code>failOnWarnings</code></a></td>
+<td><code>boolean</code></td>
+<td><code>1.0.0</code></td>
+<td>If set to <code>true</code> it will fail the build on compiler warnings.</td>
+</tr>
+</tbody>
+</table>
+<h3 id="parameter-details">Parameter Details<a class="headerlink" href="#parameter-details" title="Permanent link">¶</a></h3>
+<p><a name="param-sourceDirectory"><code>sourceDirectory</code></a>:</p>
+<p>Defines the root folder where this goal expects to find Sightly scripts to validate.
+<em> <strong>Type:</strong> <code>java.lang.String</code>
+</em> <strong>Required:</strong> No
+<em> <strong>User Property:</strong> <code>sourceDirectory</code>
+</em> <strong>Default:</strong> <code>${project.build.sourceDirectory}</code></p>
+<p><a name="param-includes"><code>includes</code></a>:</p>
+<p>List of files to include, specified as fileset patterns which are relative to <code>sourceDirectory</code>.
+<em> <strong>Type:</strong> <code>java.lang.String[]</code>
+</em> <strong>Required:</strong> No
+<em> <strong>User Property:</strong> <code>includes</code>
+</em> <strong>Default:</strong> <code>**/*.html</code></p>
+<p><a name="param-excludes"><code>excludes</code></a>:</p>
+<p>List of files to exclude, specified as fileset patterns which are relative to <code>sourceDirectory</code>.
+<em> <strong>Type:</strong> <code>java.lang.String[]</code>
+</em> <strong>Required:</strong> No
+* <strong>User Property:</strong> <code>excludes</code></p>
+<p><a name="param-failOnWarnings"><code>failOnWarnings</code></a>:</p>
+<p>If set to <code>true</code> it will fail the build on compiler warnings.
+<em> <strong>Type:</strong> <code>boolean</code>
+</em> <strong>Required:</strong> No
+<em> <strong>User Property:</strong> <code>failOnWarnings</code>
+</em> <strong>Default:</strong> <code>false</code></p>
+ <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
+ Rev. 1759416 by radu on Tue, 6 Sep 2016 12:10:30 +0000
+ </div>
+ <div class="trademarkFooter">
+ Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project
+ logo are trademarks of The Apache Software Foundation. All other marks mentioned
+ may be trademarks or registered trademarks of their respective owners.
+ </div>
+ </div>
+ </body>
+</html>