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 2017/08/08 10:35:35 UTC
svn commit: r1016532 [11/11] - in /websites/staging/sling/trunk/content: ./
components/htl-maven-plugin-archives/htl-maven-plugin-1.0.8/
components/htl-maven-plugin-archives/htl-maven-plugin-1.0.8/apidocs/
components/htl-maven-plugin-archives/htl-maven...
Added: websites/staging/sling/trunk/content/components/htl-maven-plugin-archives/htl-maven-plugin-1.0.8/validate-mojo.html
==============================================================================
--- websites/staging/sling/trunk/content/components/htl-maven-plugin-archives/htl-maven-plugin-1.0.8/validate-mojo.html (added)
+++ websites/staging/sling/trunk/content/components/htl-maven-plugin-archives/htl-maven-plugin-1.0.8/validate-mojo.html Tue Aug 8 10:35:33 2017
@@ -0,0 +1,250 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2017-08-07
+ | Rendered using Apache Maven Fluido Skin 1.6
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170807" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Sling HTL Maven Plugin – htl:validate</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Sling HTL Maven Plugin</h2>
+</div>
+</div>
+ <div class="pull-right"></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li id="publishDate">Last Published: 2017-08-07<span class="divider">|</span>
+</li>
+ <li id="projectVersion">Version: 1.0.8</li>
+ </ul>
+ </div>
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+<ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a> </li>
+ <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a> </li>
+ <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a> </li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a> </li>
+ </ul>
+ <hr />
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </div>
+ <div id="bodyColumn" class="span10" >
+
+
+ <div class="section">
+<h2><a name="htl:validate"></a>htl:validate</h2>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.sling:htl-maven-plugin:1.0.8:validate</p>
+
+<p><b>Description</b>:</p>
+
+<div>Validates HTL scripts.</div>
+
+<p><b>Attributes</b>:</p>
+
+<ul>
+
+<li>Requires a Maven project to be executed.</li>
+
+<li>The goal is thread-safe and supports parallel builds.</li>
+
+<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>compile</tt>.</li>
+ </ul>
+
+<div class="section">
+<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
+
+<table class="table table-striped" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#excludes">excludes</a></b></td>
+
+<td><tt>String[]</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>List of files to exclude. Specified as fileset patterns which are
+relative to the input directory whose contents will be scanned (see
+the sourceDirectory configuration option).<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#failOnWarnings">failOnWarnings</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>If set to "true" it will fail the build on compiler warnings.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>htl.failOnWarnings</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#includes">includes</a></b></td>
+
+<td><tt>String[]</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>List of files to include. Specified as fileset patterns which are
+relative to the input directory whose contents will be scanned (see
+the sourceDirectory configuration option).<br /><b>Default value is</b>: <tt>**/*.html</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#skip">skip</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>If set to "true" the validation will be skipped.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>htl.skip</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Defines the root folder where this Mojo expects to find Sightly
+scripts to validate.<br /><b>Default value is</b>: <tt>${project.build.sourceDirectory}</tt>.<br /><b>User property is</b>: <tt>htl.sourceDirectory</tt>.</td>
+ </tr>
+ </table>
+ </div>
+
+<div class="section">
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
+
+<p><b><a name="excludes">excludes</a>:</b></p>
+
+<div>List of files to exclude. Specified as fileset patterns which are
+relative to the input directory whose contents will be scanned (see
+the sourceDirectory configuration option).</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String[]</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="failOnWarnings">failOnWarnings</a>:</b></p>
+
+<div>If set to "true" it will fail the build on compiler warnings.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>htl.failOnWarnings</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="includes">includes</a>:</b></p>
+
+<div>List of files to include. Specified as fileset patterns which are
+relative to the input directory whose contents will be scanned (see
+the sourceDirectory configuration option).</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String[]</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>**/*.html</tt></li>
+ </ul><hr />
+<p><b><a name="skip">skip</a>:</b></p>
+
+<div>If set to "true" the validation will be skipped.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>htl.skip</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+
+<div>Defines the root folder where this Mojo expects to find Sightly
+scripts to validate.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>htl.sourceDirectory</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.sourceDirectory}</tt></li>
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2007–2017
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/sling/trunk/content/components/htl-maven-plugin/usage.html
==============================================================================
--- websites/staging/sling/trunk/content/components/htl-maven-plugin/usage.html (added)
+++ websites/staging/sling/trunk/content/components/htl-maven-plugin/usage.html Tue Aug 8 10:35:33 2017
@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2017-08-07
+ | Rendered using Apache Maven Fluido Skin 1.6
+
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170807" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Sling HTL Maven Plugin – Usage</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Sling HTL Maven Plugin</h2>
+</div>
+</div>
+ <div class="pull-right"></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li id="publishDate">Last Published: 2017-08-07<span class="divider">|</span>
+</li>
+ <li id="projectVersion">Version: 1.0.8</li>
+ </ul>
+ </div>
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+<ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a> </li>
+ <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a> </li>
+ <li class="active"><a href="#"><span class="none"></span>Usage</a>
+ </li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a> </li>
+ </ul>
+ <hr />
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </div>
+ <div id="bodyColumn" class="span10" >
+<div class="section">
+<h2><a name="Usage"></a>Usage</h2>
+<div class="section">
+<h3><a name="Validating_your_HTL_Scripts"></a>Validating your HTL Scripts</h3>
+<p>To validate your HTL Scripts you can run the following command:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">mvn org.apache.sling:htl-maven-plugin:validate
+</pre></div></div>
+<p>This assumes you’ve configured the <tt>${project.build.sourceDirectory}</tt> setting.</p>
+<p>The command can be simplified to</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums">mvn htl:validate
+</pre></div></div>
+<p>if your Maven user settings file provides the following configuration</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums"><pluginGroups>
+ <pluginGroup>org.apache.sling</pluginGroup>
+</pluginGroups>
+</pre></div></div></div>
+<div class="section">
+<h3><a name="Configuring_Your_HTL_Maven_Plugin"></a>Configuring Your HTL Maven Plugin</h3>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums"><project>
+ ...
+ <build>
+ <pluginManagement>
+ <plugin>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>htl-maven-plugin</artifactId>
+ <version>1.0.8/version>
+ <configuration>
+ <!-- put your configurations here -->
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>validate</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </pluginManagement>
+ </build>
+ ...
+</project>
+</pre></div></div></div></div>
+ </div>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2007–2017
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file