| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2018-02-01 |
| | 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="20180201" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Apache Sling HTL Maven Plugin – htl:help</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: 2018-02-01<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.1.4-1.3.1</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:help"></a>htl:help</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.apache.sling:htl-maven-plugin:1.1.4-1.3.1:help</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Display help information on htl-maven-plugin.<br /> |
| Call <tt>mvn htl:help -Ddetail=true |
| -Dgoal=<goal-name></tt> to display parameter details.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>The goal is thread-safe and supports parallel builds.</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="#detail">detail</a></b></td> |
| |
| <td><tt>boolean</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>If <tt>true</tt>, display all settable properties for each |
| goal.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>detail</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#goal">goal</a></b></td> |
| |
| <td><tt>String</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>The name of the goal for which to show help. If unspecified, all |
| goals will be displayed.<br /><b>User property is</b>: <tt>goal</tt>.</td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><b><a href="#indentSize">indentSize</a></b></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>The number of spaces per indentation level, should be positive.<br /><b>Default value is</b>: <tt>2</tt>.<br /><b>User property is</b>: <tt>indentSize</tt>.</td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><b><a href="#lineLength">lineLength</a></b></td> |
| |
| <td><tt>int</tt></td> |
| |
| <td><tt>-</tt></td> |
| |
| <td>The maximum length of a display line, should be positive.<br /><b>Default value is</b>: <tt>80</tt>.<br /><b>User property is</b>: <tt>lineLength</tt>.</td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="section"> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| |
| <p><b><a name="detail">detail</a>:</b></p> |
| |
| <div>If <tt>true</tt>, display all settable properties for each |
| goal.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>detail</tt></li> |
| |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /> |
| <p><b><a name="goal">goal</a>:</b></p> |
| |
| <div>The name of the goal for which to show help. If unspecified, all |
| goals will be displayed.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>goal</tt></li> |
| </ul><hr /> |
| <p><b><a name="indentSize">indentSize</a>:</b></p> |
| |
| <div>The number of spaces per indentation level, should be positive.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>int</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>indentSize</tt></li> |
| |
| <li><b>Default</b>: <tt>2</tt></li> |
| </ul><hr /> |
| <p><b><a name="lineLength">lineLength</a>:</b></p> |
| |
| <div>The maximum length of a display line, should be positive.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <tt>int</tt></li> |
| |
| <li><b>Required</b>: <tt>No</tt></li> |
| |
| <li><b>User Property</b>: <tt>lineLength</tt></li> |
| |
| <li><b>Default</b>: <tt>80</tt></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2007–2018 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |