You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2021/10/18 07:02:40 UTC
svn commit: r1894343 [5/12] - in
/jackrabbit/site/live/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT:
./ css/ fonts/ images/ images/logos/ images/profiles/ img/ js/
Added: jackrabbit/site/live/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT/format-xml-mojo.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT/format-xml-mojo.html?rev=1894343&view=auto
==============================================================================
--- jackrabbit/site/live/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT/format-xml-mojo.html (added)
+++ jackrabbit/site/live/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT/format-xml-mojo.html Mon Oct 18 07:02:39 2021
@@ -0,0 +1,408 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/format-xml-mojo.xml at 2021-10-18
+ | 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>Jackrabbit FileVault Package Maven Plugin – filevault-package:format-xml</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="topBarEnabled">
+ <a href="https://github.com/apache/jackrabbit-filevault-package-maven-plugin">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+ <header id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="index.html" title="Introduction">Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals">Goals</a></li>
+ <li><a href="dev.html" title="Developing">Developing</a></li>
+ <li><a href="howto_release.html" title="Releasing">Releasing</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="import_package.html" title="Import-package Generation">Import-package Generation</a></li>
+ <li><a href="migrating.html" title="Migration from Adobe's Plugin">Migration from Adobe's Plugin</a></li>
+ <li><a href="validators.html" title="Validators">Validators</a></li>
+ <li><a href="classifiers.html" title="Classifier Support">Classifier Support</a></li>
+ <li><a href="filtering.html" title="Filtering">Filtering</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="dropdown-submenu">
+<a href="project-info.html" title="Project Information">Project Information</a>
+ <ul class="dropdown-menu">
+ <li><a href="ci-management.html" title="CI Management">CI Management</a></li>
+ <li><a href="dependencies.html" title="Dependencies">Dependencies</a></li>
+ <li><a href="dependency-info.html" title="Dependency Information">Dependency Information</a></li>
+ <li><a href="dependency-management.html" title="Dependency Management">Dependency Management</a></li>
+ <li><a href="distribution-management.html" title="Distribution Management">Distribution Management</a></li>
+ <li><a href="index.html" title="About">About</a></li>
+ <li><a href="issue-management.html" title="Issue Management">Issue Management</a></li>
+ <li><a href="licenses.html" title="Licenses">Licenses</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
+ <li><a href="plugin-management.html" title="Plugin Management">Plugin Management</a></li>
+ <li><a href="plugins.html" title="Plugins">Plugins</a></li>
+ <li><a href="scm.html" title="Source Code Management">Source Code Management</a></li>
+ <li><a href="summary.html" title="Summary">Summary</a></li>
+ </ul>
+ </li>
+ <li class="dropdown-submenu">
+<a href="project-reports.html" title="Project Reports">Project Reports</a>
+ <ul class="dropdown-menu">
+ <li><a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://jackrabbit.apache.org/filevault/" title="Apache Jackrabbit FileVault">Apache Jackrabbit FileVault</a></li>
+ <li><a href="https://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Site Versions <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT" title="1.2.3-SNAPSHOT">1.2.3-SNAPSHOT</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" title="1.2.2">1.2.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.8" title="1.1.8">1.1.8</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" title="1.1.6">1.1.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" title="1.1.4">1.1.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" title="1.1.2">1.1.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" title="1.1.0">1.1.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" title="1.0.4">1.0.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" title="1.0.3">1.0.3</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" title="1.0.1">1.0.1</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.0" title="1.0.0">1.0.0</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </header>
+ <div class="container-fluid">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><a href="https://jackrabbit.apache.org/" id="bannerLeft"><img src="jackrabbit.png" alt="Apache Jackrabbit"/></a></div>
+ <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="asf_logo.png" alt="Apache"/></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="https://jackrabbit.apache.org/" class="externalLink" title="Jackrabbit">Jackrabbit</a><span class="divider">/</span></li>
+ <li class=""><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="Jackrabbit FileVault Package Maven Plugin">Jackrabbit FileVault Package Maven Plugin</a><span class="divider">/</span></li>
+ <li class="active ">filevault-package:format-xml</li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2021-10-18</li>
+ <li id="projectVersion" class="pull-right">Version: 1.2.3-SNAPSHOT</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="dev.html" title="Developing"><span class="none"></span>Developing</a></li>
+ <li><a href="howto_release.html" title="Releasing"><span class="none"></span>Releasing</a></li>
+ <li class="nav-header">Documentation</li>
+ <li><a href="import_package.html" title="Import-package Generation"><span class="none"></span>Import-package Generation</a></li>
+ <li><a href="migrating.html" title="Migration from Adobe's Plugin"><span class="none"></span>Migration from Adobe's Plugin</a></li>
+ <li><a href="validators.html" title="Validators"><span class="none"></span>Validators</a></li>
+ <li><a href="classifiers.html" title="Classifier Support"><span class="none"></span>Classifier Support</a></li>
+ <li><a href="filtering.html" title="Filtering"><span class="none"></span>Filtering</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>
+ <li class="nav-header">Links</li>
+ <li><a href="https://jackrabbit.apache.org/filevault/" class="externalLink" title="Apache Jackrabbit FileVault"><span class="none"></span>Apache Jackrabbit FileVault</a></li>
+ <li><a href="https://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit"><span class="none"></span>Apache Jackrabbit</a></li>
+ <li class="nav-header">Site Versions</li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.2.3-SNAPSHOT" class="externalLink" title="1.2.3-SNAPSHOT"><span class="none"></span>1.2.3-SNAPSHOT</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="1.2.2"><span class="none"></span>1.2.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.8" class="externalLink" title="1.1.8"><span class="none"></span>1.1.8</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" class="externalLink" title="1.1.6"><span class="none"></span>1.1.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" class="externalLink" title="1.1.4"><span class="none"></span>1.1.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" class="externalLink" title="1.1.2"><span class="none"></span>1.1.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" class="externalLink" title="1.1.0"><span class="none"></span>1.1.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" class="externalLink" title="1.0.4"><span class="none"></span>1.0.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" class="externalLink" title="1.0.3"><span class="none"></span>1.0.3</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" class="externalLink" title="1.0.1"><span class="none"></span>1.0.1</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.0" class="externalLink" title="1.0.0"><span class="none"></span>1.0.0</a></li>
+ </ul>
+ </nav>
+ <div class="well sidebar-nav">
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="jackrabbit.apache.org/filevault-package-maven-plugin/" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <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="filevault-package:format-xml"></a>filevault-package:format-xml</h2>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.jackrabbit:filevault-package-maven-plugin:1.2.3-SNAPSHOT:format-xml</p>
+
+<p><b>Description</b>:</p>
+
+<div>Either checks only the formatting of the Docview XML files to
+comply with the formatting rules from FileVault or also reformats
+those files.</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>process-sources</code>.</li>
+ </ul>
+ <section>
+<h3><a name="Required_Parameters"></a>Required 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="#jcrRootSourceDirectory"><jcrRootSourceDirectory></a></code></td>
+
+<td><code>File[]</code></td>
+
+<td><code>-</code></td>
+
+<td>The directory that contains the jcr_root of the content. Multiple
+directories can be specified as a comma separated list, which will
+act as a search path and cause the plugin to look for the first
+existing directory.<br /><b>Default value is</b>: <code>${project.basedir}/jcr_root,${project.basedir}/src/main/jcr_root,${project.basedir}/src/main/content/jcr_root,${project.basedir}/src/content/jcr_root,${project.build.outputDirectory}</code>.<br /><b>User property is</b>: <code>vault.jcrRootSourceDirectory</code>.<br /></td>
+ </tr>
+ </table>
+ </section>
+ <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="#enableForIncrementalBuild"><enableForIncrementalBuild></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>-</code></td>
+
+<td>If set to <code>true</code> will also run on incremental builds
+(i.e. within Eclipse with m2e). Otherwise this goal is skipped in
+incremental builds and only runs on full builds.<br /><b>Default value is</b>: <code>false</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><code><a href="#excludes"><excludes></a></code></td>
+
+<td><code>Set</code></td>
+
+<td><code>-</code></td>
+
+<td>Exclude patterns for files to exclude. If not set defaults to [].
+
+<p>Note: includes have precedences over excludes. Each pattern can
+either be an <a class="externalLink" href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant-like
+pattern</a> or a regular expression if it is starting with
+<code>%regex[</code> and ending with <code>]</code>.</p><br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><code><a href="#includes"><includes></a></code></td>
+
+<td><code>Set</code></td>
+
+<td><code>-</code></td>
+
+<td>Include patterns for files to include. If not set defaults to
+[**\/*.xml].
+
+<p>Note: includes have precedences over excludes. Each pattern can
+either be an <a class="externalLink" href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant-like
+pattern</a> or a regular expression if it is starting with
+<code>%regex[</code> and ending with <code>]</code>.</p><br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><code><a href="#validateOnly"><validateOnly></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>-</code></td>
+
+<td>If set to <code>true</code> then fails the build if it encounters
+XML files which don't follow the formatting rules for XML Docview
+files. If set to <code>false</code> will reformat all XML Docview
+files.<br /><b>Default value is</b>: <code>false</code>.<br /></td>
+ </tr>
+ </table>
+ </section>
+ <section>
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
+ <section>
+<h4><a name="a.3CenableForIncrementalBuild.3E"></a><b><a name="enableForIncrementalBuild"><enableForIncrementalBuild></a></b></h4>
+
+<div>If set to <code>true</code> will also run on incremental builds
+(i.e. within Eclipse with m2e). Otherwise this goal is skipped in
+incremental builds and only runs on full builds.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4>
+
+<div>Exclude patterns for files to exclude. If not set defaults to [].
+
+<p>Note: includes have precedences over excludes. Each pattern can
+either be an <a class="externalLink" href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant-like
+pattern</a> or a regular expression if it is starting with
+<code>%regex[</code> and ending with <code>]</code>.</p></div>
+
+<ul>
+
+<li><b>Type</b>: <code>java.util.Set</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4>
+
+<div>Include patterns for files to include. If not set defaults to
+[**\/*.xml].
+
+<p>Note: includes have precedences over excludes. Each pattern can
+either be an <a class="externalLink" href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant-like
+pattern</a> or a regular expression if it is starting with
+<code>%regex[</code> and ending with <code>]</code>.</p></div>
+
+<ul>
+
+<li><b>Type</b>: <code>java.util.Set</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CjcrRootSourceDirectory.3E"></a><b><a name="jcrRootSourceDirectory"><jcrRootSourceDirectory></a></b></h4>
+
+<div>The directory that contains the jcr_root of the content. Multiple
+directories can be specified as a comma separated list, which will
+act as a search path and cause the plugin to look for the first
+existing directory.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>java.io.File[]</code></li>
+
+<li><b>Required</b>: <code>Yes</code></li>
+
+<li><b>User Property</b>: <code>vault.jcrRootSourceDirectory</code></li>
+
+<li><b>Default</b>: <code>${project.basedir}/jcr_root,${project.basedir}/src/main/jcr_root,${project.basedir}/src/main/content/jcr_root,${project.basedir}/src/content/jcr_root,${project.build.outputDirectory}</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CvalidateOnly.3E"></a><b><a name="validateOnly"><validateOnly></a></b></h4>
+
+<div>If set to <code>true</code> then fails the build if it encounters
+XML files which don't follow the formatting rules for XML Docview
+files. If set to <code>false</code> will reformat all XML Docview
+files.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>Default</b>: <code>false</code></li>
+ </ul>
+ </section></section>
+ </section>
+
+
+ </main>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>© 2021
+<a href="https://www.apache.org/">The Apache Software Foundation</a>
+</p>
+ </div>
+ <div id="ohloh" class="pull-right">
+ <script src="https://www.ohloh.net/p/jackrabbit-filevault-package-maven-plugin/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file