You are viewing a plain text version of this content. The canonical link for it is here.
Posted to wsrp4j-dev@portals.apache.org by jm...@apache.org on 2004/03/02 17:18:11 UTC
cvs commit: ws-wsrp4j/site/src/documentation/content/xdocs config.xml faq.xml site.xml
jmacna 2004/03/02 08:18:11
Modified: site/src/documentation/content/xdocs faq.xml site.xml
Added: site/src/documentation/content/xdocs config.xml
Log:
Web site updates to add documentation about how to add portlets
Revision Changes Path
1.2 +21 -5 ws-wsrp4j/site/src/documentation/content/xdocs/faq.xml
Index: faq.xml
===================================================================
RCS file: /home/cvs/ws-wsrp4j/site/src/documentation/content/xdocs/faq.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- faq.xml 13 Nov 2003 01:04:26 -0000 1.1
+++ faq.xml 2 Mar 2004 16:18:10 -0000 1.2
@@ -3,9 +3,7 @@
<faqs title="Frequently Asked Questions">
- <part id="docs">
- <title>Documentation</title>
- <faq id="wsrp4j">
+ <faq id="name1">
<question>
How can I help write documentation?
</question>
@@ -17,10 +15,28 @@
href="ext:forrest/validation">validate</link>, <link
href="ext:forrest/webapp">develop</link> and render a
project site.
+
+ </p>
+ <p>
+ The source for the site is in the WSRP4J CVS tree under site/build/src/content/xdocs.
+ </p>
+ <p>
+ Whenever the site is changed, forrest is executed to generate it.
+ The output of the forrest build is committed to the
+ ws-site/targets/wsrp4j CVS tree. Every 24 hours, the contents
+ of ws-site gets published to the web.
+ </p>
+ </answer>
+ </faq>
+ <!-- More faqs or parts here WRT documentation-->
+ <faq id="name2">
+ <question>How can I configure my own portlets?
+ </question>
+ <answer>
+ <p>
+ Please refer to <link href="config.html">Configuring Portlets</link> for directions.
</p>
</answer>
</faq>
- <!-- More faqs or parts here -->
- </part>
<!-- More faqs or parts here -->
</faqs>
1.3 +7 -3 ws-wsrp4j/site/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
RCS file: /home/cvs/ws-wsrp4j/site/src/documentation/content/xdocs/site.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- site.xml 8 Dec 2003 22:03:02 -0000 1.2
+++ site.xml 2 Mar 2004 16:18:10 -0000 1.3
@@ -25,6 +25,7 @@
<mail label="Mailing Lists" href="mail.html" description="Mailing Lists"/>
<link5 label="WSRP4J Wiki Pages" href="ext:wiki"/>
<link4 label="WSRP4J TODO Wiki" href="ext:todo"/>
+ <link6 label="WSRP4J Incubator Status" href="ext:incubator-wsrp4j"/>
</about>
<architecture label="Architecture" href="arch/" tab="architecture">
@@ -37,8 +38,7 @@
<cvs label="CVS Repository" href="cvs.html" description="How to see source"/>
<installation label="Installation" href="installation.html" description="Installation Instructions"/>
<execution label="Execution" href="execution.html" description="Execution Instructions"/>
- <!-- the following configuration file will explain how to add portlets to the producer -->
- <!--<configuration label="Configuration" href="configuration.html" description="Configuration Instructions"/>-->
+ <configuration label="Configuration" href="config.html" description="Configuration Instructions"/>
<!-- we need a FAQ -->
<faq label="FAQ" href="faq.html" description="Frequently Asked Questions"/>
</gettingStarted>
@@ -47,10 +47,11 @@
<link1 label="OASIS WSRP" href="ext:oasis-wsrp"/>
<link2 label="Pluto" href="ext:pluto"/>
<link3 label="Tomcat" href="ext:tomcat"/>
+ <link4 label="Incubator" href="ext:incubator"/>
</linksToRelated>
- <all>
+ <all>
<whole_site_html label="Whole Site HTML" href="site.html"/>
<whole_site_html label="Whole Site PDF" href="site.pdf"/>
</all>
@@ -67,6 +68,9 @@
<ws href="http://ws.apache.org/">
<ws-wsrp4j href="wsrp4j/"/>
</ws>
+ <incubator href="http://incubator.apache.org/">
+ <incubator-wsrp4j href="projects/wsrp4j.html"/>
+ </incubator>
<xml.apache.org href="http://xml.apache.org/">
<forrest href="forrest/">
<validation href="validation.html"/>
1.1 ws-wsrp4j/site/src/documentation/content/xdocs/config.xml
Index: config.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
<title>Configuring Portlets</title>
</header>
<body>
<ol>
<li>Edit the portletentityregistry.xml file.
(e.g. c:/Tomcat4.1/webapps/wsrp/WEB-INF/data/portletentityregistry.xml)
<p> Add a new application element for your webapp.</p>
<p> The definition ID has to match the webapp name, so for the sample, this is wsrptest.</p>
<p> The portlet id will map to its handle, so make up a number.</p>
<p> The definition id maps to it's name in the portlet.xml file like
so: <webapp-name>.<portlet-name></p>
</li>
<li>Create a portlet.xml file in your webapps/webapp-name/WEB-INF/ directory.
<p>Use webapps/wsrptest/WEB-INF/portlet.xml as a reference.</p>
<p>The portlet name must match the second part of the definition id above.</p>
</li>
<!--<note>WRT to handles. It looks like the handle looked for by the Consumer is
0.1, but the portlet ID is 1. So if your new portlet has an ID of 3, then it's handle will be 0.3.
</note>-->
<li>To add the portlet to the Consumer, you will need to create an xml file
in driver/SwingConsumer/persistence/portlets.
<p> Use the existing files as a guide.</p>
</li>
</ol>
</body>
</document>