Google Git
Sign in
apache / sling-site / refs/heads/master / . / src / main / jbake / assets / components / scriptingbundle-maven-plugin / metadata-mojo.html
blob: 2de63ad0884beb412e824653f2be6eac31a4e48a [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/metadata-mojo.xml at 2021-09-28
| Rendered using Apache Maven Fluido Skin 1.9
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
<title>Scripting Bundle Maven Plugin &#x2013; scriptingbundle:metadata</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-1.9.min.js"></script>
</head>
<body class="topBarDisabled">
<a href="https://github.com/apache/sling-scriptingbundle-maven-plugin">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
alt="Fork me on GitHub">
</a>
<div class="container-fluid">
<header>
<div id="banner">
<div class="pull-left"><a href="https://sling.apache.org/" id="bannerLeft"><img src="https://sling.apache.org/res/logos/sling.svg" alt="Apache Sling" width="123" height="63"/></a></div>
<div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="https://sling.apache.org/res/logos/apache.png" alt="Apache"/></a></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class=""><a href="https://sling.apache.org/" class="externalLink" title="Apache Sling">Apache Sling</a><span class="divider">/</span></li>
<li class=""><a href="https://sling.apache.org/components/" class="externalLink" title="Maven Plugins">Maven Plugins</a><span class="divider">/</span></li>
<li class=""><a href="index.html" title="Scripting Bundle Maven Plugin">Scripting Bundle Maven Plugin</a><span class="divider">/</span></li>
<li class="active ">scriptingbundle:metadata</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2021-09-28</li>
<li id="projectVersion" class="pull-right">Version: 0.5.0</li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav 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><a href="bnd.html" title="Bnd Plugin"><span class="none"></span>Bnd Plugin</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>
</nav>
<div class="well sidebar-nav">
<hr />
<div id="poweredBy">
<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>
</header>
<main id="bodyColumn" class="span10" >
<section>
<h2><a name="scriptingbundle:metadata"></a>scriptingbundle:metadata</h2>
<p><b>Full name</b>:</p>
<p>org.apache.sling:scriptingbundle-maven-plugin:0.5.0:metadata</p>
<p><b>Description</b>:</p>
<div>The <code>metadata</code> goal will generate two Maven project
properties, namely
<code>org.apache.sling.scriptingbundle.maven.plugin.Require-Capability</code>
and
<code>org.apache.sling.scriptingbundle.maven.plugin.Provide-Capability</code>
which can be used to generate the corresponding OSGi bundle headers
for bundles providing scripts executable by a
<code>ScriptEngine</code>.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>prepare-package</code>.</li>
</ul>
<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><code><a href="#excludes">&lt;excludes&gt;</a></code></td>
<td><code>String[]</code></td>
<td><code>0.2.0</code></td>
<td>Allows defining a list of excluded files and folders or patterns to
filter which files should be excluded in the analysis for
generating capabilities.
<p>The following list provides the default excluded files and
patterns:</p>
<dl>
<dt>Miscellaneous typical temporary files</dt>
<dd>**/*~, **/#*#, **/.#*, **/%*%, **/._*</dd>
<dt>CVS</dt>
<dd>**/CVS, **/CVS/**, **/.cvsignore</dd>
<dt>Subversion</dt>
<dd>**/.svn, **/.svn/**</dd>
<dt>Bazaar</dt>
<dd>**/.bzr, **/.bzr/**</dd>
<dt>Mac</dt>
<dd>**/.DS_Store</dd>
<dt>Mercurial</dt>
<dd>**/.hg, **/.hg/**</dd>
<dt>git</dt>
<dd>**/.git, **/.git/**</dd>
</dl><br /><b>User property is</b>: <code>scriptingbundle.excludes</code>.<br /></td>
</tr>
<tr class="a">
<td><code><a href="#includes">&lt;includes&gt;</a></code></td>
<td><code>String[]</code></td>
<td><code>0.2.0</code></td>
<td>Allows defining a list of included files and folders or patterns to
filter which files should be included in the analysis for
generating capabilities. By default all files are included.<br /><b>Default value is</b>: <code>**</code>.<br /><b>User property is</b>: <code>scriptingbundle.includes</code>.<br /></td>
</tr>
<tr class="b">
<td><code><a href="#missingRequirementsOptional">&lt;missingRequirementsOptional&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>0.5.0</code></td>
<td>When set to &quot;true&quot;, the requirements which are not satisfied
directly by this project will be marked as optional.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>scriptingbundle.missingRequirementsOptional</code>.<br /></td>
</tr>
<tr class="a">
<td><code><a href="#scriptEngineMappings">&lt;scriptEngineMappings&gt;</a></code></td>
<td><code>Map</code></td>
<td><code>0.2.0</code></td>
<td>Allows overriding the default extension to script engine mapping,
in order to correctly generate the
<code>sling.resourceType;scriptEngine</code>
<code>Provide-Capability</code> attribute value. When configuring
this mapping, please make sure to use the script extension as the
key and one of the Script Engine's names (obtained from
<code>ScriptEngineFactory.getNames()</code>) as the value.
<p>The following list represents the default extension to Script
Engine mapping:</p>
<dl>
<dt>ftl</dt>
<dd>freemarker</dd>
<dt>gst</dt>
<dd>gstring</dd>
<dt>html</dt>
<dd>htl</dd>
<dt>java</dt>
<dd>java</dd>
<dt>esp, ecma</dt>
<dd>rhino</dd>
<dt>jsp, jspf, jspx</dt>
<dd>jsp</dd>
</dl><br /></td>
</tr>
<tr class="b">
<td><code><a href="#searchPaths">&lt;searchPaths&gt;</a></code></td>
<td><code>Set</code></td>
<td><code>0.2.0</code></td>
<td>Allows overriding the default search paths (<code>/apps</code> and
<code>/libs</code>). When scripts are organised in folders which
follow the search path structure, the Mojo will generate two
resource types for each resource type folder. For example:
<div>
<pre>
src/main/scripts/apps/org/apache/sling/example/example.html
</pre></div>
will generate the following two resource types
<div>
<pre>
org/apache/sling/example
/apps/org/apache/sling/example
</pre></div>
However, the following script
<div>
<pre>
src/main/scripts/org/apache/sling/example/example.html
</pre></div>
will generate only one resource type
<div>
<pre>
org/apache/sling/example
</pre></div><br /><b>User property is</b>: <code>scriptingbundle.searchPaths</code>.<br /></td>
</tr>
<tr class="a">
<td><code><a href="#sourceDirectories">&lt;sourceDirectories&gt;</a></code></td>
<td><code>Set</code></td>
<td><code>0.2.0</code></td>
<td>Defines where this goal will look for scripts in the project. By
default the <code>src/main/scripts</code> and
<code>src/main/resources/javax.script</code> folders will be
considered.<br /><b>User property is</b>: <code>scriptingbundle.sourceDirectories</code>.<br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<section>
<h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes">&lt;excludes&gt;</a></b></h4>
<div>Allows defining a list of excluded files and folders or patterns to
filter which files should be excluded in the analysis for
generating capabilities.
<p>The following list provides the default excluded files and
patterns:</p>
<dl>
<dt>Miscellaneous typical temporary files</dt>
<dd>**/*~, **/#*#, **/.#*, **/%*%, **/._*</dd>
<dt>CVS</dt>
<dd>**/CVS, **/CVS/**, **/.cvsignore</dd>
<dt>Subversion</dt>
<dd>**/.svn, **/.svn/**</dd>
<dt>Bazaar</dt>
<dd>**/.bzr, **/.bzr/**</dd>
<dt>Mac</dt>
<dd>**/.DS_Store</dd>
<dt>Mercurial</dt>
<dd>**/.hg, **/.hg/**</dd>
<dt>git</dt>
<dd>**/.git, **/.git/**</dd>
</dl></div>
<ul>
<li><b>Type</b>: <code>java.lang.String[]</code></li>
<li><b>Since</b>: <code>0.2.0</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>scriptingbundle.excludes</code></li>
</ul><hr /></section><section>
<h4><a name="a.3Cincludes.3E"></a><b><a name="includes">&lt;includes&gt;</a></b></h4>
<div>Allows defining a list of included files and folders or patterns to
filter which files should be included in the analysis for
generating capabilities. By default all files are included.</div>
<ul>
<li><b>Type</b>: <code>java.lang.String[]</code></li>
<li><b>Since</b>: <code>0.2.0</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>scriptingbundle.includes</code></li>
<li><b>Default</b>: <code>**</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CmissingRequirementsOptional.3E"></a><b><a name="missingRequirementsOptional">&lt;missingRequirementsOptional&gt;</a></b></h4>
<div>When set to &quot;true&quot;, the requirements which are not satisfied
directly by this project will be marked as optional.</div>
<ul>
<li><b>Type</b>: <code>boolean</code></li>
<li><b>Since</b>: <code>0.5.0</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>scriptingbundle.missingRequirementsOptional</code></li>
<li><b>Default</b>: <code>true</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CscriptEngineMappings.3E"></a><b><a name="scriptEngineMappings">&lt;scriptEngineMappings&gt;</a></b></h4>
<div>Allows overriding the default extension to script engine mapping,
in order to correctly generate the
<code>sling.resourceType;scriptEngine</code>
<code>Provide-Capability</code> attribute value. When configuring
this mapping, please make sure to use the script extension as the
key and one of the Script Engine's names (obtained from
<code>ScriptEngineFactory.getNames()</code>) as the value.
<p>The following list represents the default extension to Script
Engine mapping:</p>
<dl>
<dt>ftl</dt>
<dd>freemarker</dd>
<dt>gst</dt>
<dd>gstring</dd>
<dt>html</dt>
<dd>htl</dd>
<dt>java</dt>
<dd>java</dd>
<dt>esp, ecma</dt>
<dd>rhino</dd>
<dt>jsp, jspf, jspx</dt>
<dd>jsp</dd>
</dl></div>
<ul>
<li><b>Type</b>: <code>java.util.Map</code></li>
<li><b>Since</b>: <code>0.2.0</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CsearchPaths.3E"></a><b><a name="searchPaths">&lt;searchPaths&gt;</a></b></h4>
<div>Allows overriding the default search paths (<code>/apps</code> and
<code>/libs</code>). When scripts are organised in folders which
follow the search path structure, the Mojo will generate two
resource types for each resource type folder. For example:
<div>
<pre>
src/main/scripts/apps/org/apache/sling/example/example.html
</pre></div>
will generate the following two resource types
<div>
<pre>
org/apache/sling/example
/apps/org/apache/sling/example
</pre></div>
However, the following script
<div>
<pre>
src/main/scripts/org/apache/sling/example/example.html
</pre></div>
will generate only one resource type
<div>
<pre>
org/apache/sling/example
</pre></div></div>
<ul>
<li><b>Type</b>: <code>java.util.Set</code></li>
<li><b>Since</b>: <code>0.2.0</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>scriptingbundle.searchPaths</code></li>
</ul><hr /></section><section>
<h4><a name="a.3CsourceDirectories.3E"></a><b><a name="sourceDirectories">&lt;sourceDirectories&gt;</a></b></h4>
<div>Defines where this goal will look for scripts in the project. By
default the <code>src/main/scripts</code> and
<code>src/main/resources/javax.script</code> folders will be
considered.</div>
<ul>
<li><b>Type</b>: <code>java.util.Set</code></li>
<li><b>Since</b>: <code>0.2.0</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>User Property</b>: <code>scriptingbundle.sourceDirectories</code></li>
</ul>
</section></section>
</section>
</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>&#169; 2007&#x2013;2021
<a href="https://www.apache.org/">The Apache Software Foundation</a>
</p>
</div>
</div>
</footer>
</body>
</html>