From 1914124791cc4a931b61bfeaa2f571e1178cae71 Mon Sep 17 00:00:00 2001
From: Matthew Jason Benson <mbenson@apache.org>
Date: Tue, 1 Jul 2008 23:02:29 +0000
Subject: [PATCH] propertyhelper stab

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@673225 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/manual/CoreTasks/propertyhelper.html | 67 +++++++++++++++++++++++
 docs/manual/coretasklist.html             |  1 +
 2 files changed, 68 insertions(+)
 create mode 100755 docs/manual/CoreTasks/propertyhelper.html
diff --git a/docs/manual/CoreTasks/propertyhelper.html b/docs/manual/CoreTasks/propertyhelper.html
new file mode 100755
index 000000000..63b6325b7
--- /dev/null
+++ b/docs/manual/CoreTasks/propertyhelper.html
@@ -0,0 +1,67 @@
+<!--
+   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.
+-->
+<html>
+
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
+<title>PropertyHelper Task</title>
+</head>
+
+<body>
+
+<h2>PropertyHelper</h2>
+<h3>Description</h3>
+<p>This task is provided for the purpose of allowing the user to
+<b>(a)</b> install a different PropertyHelper at runtime, or
+<b>(b)</b> (hopefully more often) install one or more PropertyHelper Delegates into the
+PropertyHelper active on the current Project. This is somewhat advanced Ant usage and
+assumes a working familiarity with the modern Ant APIs.
+<b>Since Ant 1.8</b></p>
+
+<h3>Parameters specified as nested elements</h3>
+
+<h4>PropertyHelper</h4>
+You may specify exactly one configured <code>org.apache.tools.ant.PropertyHelper</code> instance.
+
+<h4>PropertyHelper.Delegate</h4>
+You may specify, either in conjunction with a new <code>PropertyHelper</code> or not, one or
+more configured implementations of the <code>org.apache.tools.ant.PropertyHelper.Delegate</code>
+interface. A deeper understanding of the API is required here, however, as <code>Delegate</code>
+is a marker interface only: the nested arguments must implement a <code>Delegate</code>
+subinterface in order to do anything meaningful.
+
+<h4>delegate</h4>
+A generic &lt;delegate&gt; element is also provided:
+
+<h5>Parameters</h5>
+<table border="1" cellpadding="2" cellspacing="0"> 
+  <tr>
+    <td valign="top"><b>Attribute</b></td>
+    <td valign="top"><b>Description</b></td>
+    <td align="center" valign="top"><b>Required</b></td>
+  </tr>
+  <tr>
+    <td valign="top">refid</td>
+    <td valign="top">The <i>id</i> of a <code>PropertyHelper.Delegate</code> to install.</td>
+    <td valign="top" align="center">Yes</td>
+  </tr>
+</table>
+
+</body>
+</html>
+
diff --git a/docs/manual/coretasklist.html b/docs/manual/coretasklist.html
index 2d2338919..670e724d4 100644
--- a/docs/manual/coretasklist.html
+++ b/docs/manual/coretasklist.html
@@ -99,6 +99,7 @@
 <a href="CoreTasks/pathconvert.html">PathConvert</a><br/>
 <a href="CoreTasks/presetdef.html">PreSetDef</a><br/>
 <a href="CoreTasks/property.html">Property</a><br/>
+<a href="CoreTasks/propertyhelper.html">PropertyHelper</a><br/>
 <a href="CoreTasks/recorder.html">Record</a><br/>
 <a href="CoreTasks/rename.html"><i>Rename</i></a><br/>
 <a href="CoreTasks/replace.html">Replace</a><br/>

Attribute	Description	Required
refid	The id of a `PropertyHelper.Delegate` to install.	Yes