Author: woonsan
Date: Tue Sep 29 14:37:51 2009
New Revision: 819968
URL: http://svn.apache.org/viewvc?rev=819968&view=rev
Log:
JS2-1071: Adding information on predefined variables to be expanded for SRC,
PROXYREMOTEURL and PROXYLOCALPATH preference values.
Modified:
portals/site/applications/src/site/xdoc/webcontent/index.xml
Modified: portals/site/applications/src/site/xdoc/webcontent/index.xml
URL:
http://svn.apache.org/viewvc/portals/site/applications/src/site/xdoc/webcontent/index.xml?rev=819968&r1=819967&r2=819968&view=diff
==============================================================================
--- portals/site/applications/src/site/xdoc/webcontent/index.xml (original)
+++ portals/site/applications/src/site/xdoc/webcontent/index.xml Tue Sep 29
14:37:51 2009
@@ -116,7 +116,81 @@
</tr>
</table>
</subsection>
- <subsection name='IFrame or ReverseProxyIFrame Portlet Preferences'>
+ <subsection name='IFrame Portlet Preferences'>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Example Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>SRC</td>
+ <td>
+ http://portals.apache.org/index.html<br/>
+ </td>
+ <td>
+ The URL of the remote or local site to be hosted.
+ <br/>
+ <p>
+ You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
+ So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>http://localhost:8080/webcontent/index.html</li>
+ <li>http://localhost:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
+ </ul>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>AUTORESIZE</td>
+ <td>true</td>
+ <td>
+ If this preference value is set to true, then
+ this portlet tries to resize the height of the IFRAME tag based
on the rendered content.
+ However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
+ </td>
+ </tr>
+ <tr>
+ <td>VISITLASTPAGE</td>
+ <td>true</td>
+ <td>
+ If this preference value is set to true, then
+ this last visited page in this portlet is stored in the session
and the page will be revisited
+ when the portlet is rendered again.
+ However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
+ </td>
+ </tr>
+ <tr>
+ <td>HEIGHT</td>
+ <td>300</td>
+ <td>The height of the IFrame window when in Normal Window
State</td>
+ </tr>
+ <tr>
+ <td>WIDTH</td>
+ <td>100%</td>
+ <td>The width of the IFrame window when in Normal Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
+ </tr>
+ <tr>
+ <td>MAX-HEIGHT</td>
+ <td>800</td>
+ <td>The height of the IFrame window when in Maximized Window
State</td>
+ </tr>
+ <tr>
+ <td>MAX-WIDTH</td>
+ <td>100%</td>
+ <td>The width of the IFrame window when in Maximized Window State.
Can be a percentage of available space to the portlet, or a constant value</td>
+ </tr>
+ <tr>
+ <td>SCROLLING</td>
+ <td>AUTO | YES | NO</td>
+ <td>Specifies whether or not to display scrollbars in an
iframe</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name='ReverseProxyIFrame Portlet Preferences'>
<table>
<tr>
<th>Name</th>
@@ -126,7 +200,21 @@
<tr>
<td>SRC</td>
<td>http://portals.apache.org/index.html</td>
- <td>The URL of the remote or local site to be hosted.</td>
+ <td>
+ The URL of the remote or local site to be hosted.
+ <br/>
+ <p>
+ You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
+ So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>http://localhost:8080/webcontent/index.html</li>
+ <li>http://localhost:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
+ </ul>
+ </p>
+ </td>
</tr>
<tr>
<td>PROXYREMOTEURL</td>
@@ -138,11 +226,23 @@
by replacing the value of 'PROXYREMOTEURL' by the value of
'PROXYLOCALPATH'.
If you use the default reverse proxy component, then you should
configure
the path mappings in the configuration file. (e.g.,
/WEB-INF/conf/reverseproxy.properties)
+ <br/>
+ <p>
+ You can use predefined variables, ${serverName}, ${serverPort}
or ${contextPath}, to set local URLs.<br/>
+ So, if the requested server name is 'localhost', the requested
server port is '8080' and the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>http://localhost:8080/webcontent/index.html</li>
+ <li>http://localhost:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/webcontent/index.html</li>
+
<li>http://${serverName}:${serverPort}/${contextPath}/index.html</li>
+ </ul>
+ </p>
</td>
</tr>
<tr>
<td>PROXYLOCALPATH</td>
- <td>rproxy/portals/</td>
+ <td>${contextPath}/rproxy/portals/</td>
<td>
The base URL of the local proxy URL.
If the value of 'PROXYLOCALPATH' doesn't starts with '/', then
@@ -152,6 +252,16 @@
or absolute url such as '/apache' or
'http://www.localhost.com/apache'.
If you use the default reverse proxy component, then you should
configure
the path mappings in the configuration file. (e.g.,
/WEB-INF/conf/reverseproxy.properties)
+ <br/>
+ <p>
+ You can use the predefined variable, ${contextPath}, to set
local paths.<br/>
+ So, if the request context path is '/webcontent', then
+ the following configurations are equivalent:<br/>
+ <ul>
+ <li>/webcontent/rproxy/portals</li>
+ <li>${contextPath}/rproxy/portals</li>
+ </ul>
+ </p>
</td>
</tr>
<tr>
@@ -162,7 +272,7 @@
this portlet tries to resize the height of the IFRAME tag based
on the rendered content.
However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
Also, if 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set to use a
proxy url in the same domain,
- then this option is applied as well.
+ then this option can be applied as well.
</td>
</tr>
<tr>
@@ -174,7 +284,7 @@
when the portlet is rendered again.
However, this option is applied only when the 'SRC' url is in
the same domain of the portal URL.
Also, if 'PROXYREMOTEURL' and 'PROXYLOCALPATH' are set to use a
proxy url in the same domain,
- then this option is applied as well.
+ then this option can be applied as well.
</td>
</tr>
<tr>
