[Lipog-commit] net.heilancoo.portal.documentation/doc getting-ready.html, 1.6, 1.7
Status: Beta
Brought to you by:
jbu
Menu
▾
▴
[Lipog-commit] net.heilancoo.portal.documentation/doc getting-ready.html, 1.6, 1.7
|
From: Jörg B. <jb...@us...> - 2009-05-04 19:51:49
|
Update of /cvsroot/lipog/net.heilancoo.portal.documentation/doc In directory ddv4jf1.ch3.sourceforge.com:/tmp/cvs-serv1249/doc Modified Files: getting-ready.html Log Message: added examples plug-in Index: getting-ready.html =================================================================== RCS file: /cvsroot/lipog/net.heilancoo.portal.documentation/doc/getting-ready.html,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** getting-ready.html 7 Apr 2009 16:27:09 -0000 1.6 --- getting-ready.html 4 May 2009 19:51:32 -0000 1.7 *************** *** 9,97 **** <p><a href="index.html">Home of Little Portal Gizmo</a></p> <h1>Getting Ready for Development with the Gizmo</h1> ! <p>Developing web apps with the Gizmo means developing one or more Eclipse plug-ins, ! based on the Gizmo base plug-ins. You need to set up an Eclipse workspace containing the Gizmo base ! plug-ins to start with. Here are the plug-ins making up the project with a bit of a (very brief) description of what they do.</p> <table> ! <tr> ! <th>Plug-in</th><th>Description</th> ! </tr> ! <tr> ! <td>net.heilancoo.portal</td><td>The core portal code. The web server/web application container.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.test</td><td>JUnit tests for net.heilancoo.portal.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.admin</td><td>A mini web app (actually a "request handler") that shows a directory ! of all web apps installed. You get this, when requesting the root URI ("/").</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.freemarker</td><td>A response generator using the Freemarker template engine.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.json</td><td>A response generator for generating JSON responses.</td> ! </tr> ! <tr> ! <td>net.heilancoo.utils</td><td>Utility classes not strictly related to the portal related functionality.</td> ! </tr> ! <tr> ! <td>org.apache.httpcore</td><td>The Apache HttpComponents jar files, just packaged up as an Eclipse plug-in.</td> ! </tr> ! <tr> ! <td>org.dojotoolkit</td><td>The Dojo JavaScript library files packaged in an Eclipse plug-in. ! This is not necessary on a technical level for the Gizmo to work. I have used it in a web app I have written ! in the Gizmo. So I just include it here. It also gives an example of how non-Java (static) content can ! be packaged in an Eclipse plug-in to be used with (or served from) the Gizmo.</td> ! </tr> ! <tr> ! <td>org.freemarker</td><td>The Freemarker template engine jar file, just packaged up as an Eclipse plug-in.</td> ! </tr> ! <tr> ! <td>org.json</td><td>The JSON Java sources (as taken from the JSON web site), just packaged up as an Eclipse plug-in.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.documentation</td><td>The project documentation, including this file here. When installed ! along with the rest of the portal, it should be reachable via the URI "/portaldocs". Strictly speaking, not ! technically needed for development.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.bingo</td><td>The bingo web app used as example in the tutorials. Not needed for development.</td> ! </tr> </table> <h2>Checking Out Gizmo Plug-ins From CVS</h2> ! <p>There is standard SF <a href="http://sourceforge.net/scm/?type=cvs&group_id=257822">info on CVS access</a> ! telling you how to connect to the Gizmo CVS repository. Create a new empty workspace and check out the plug-ins ! above.</p> <p>An empty workspace:</p> ! <img src="snaps/cvs-checkout-1.png"> <p>Use the import "Projects from CVS" option:</p> ! <img src="snaps/cvs-checkout-2.png"> <p>Connect as anonymous user to the Gizmo repository:</p> ! <img src="snaps/cvs-checkout-3.png"> ! <p>Click the "configure connection preferences..." link to enable connection compression. Don't forget ! to click OK.</p> ! <img src="snaps/cvs-checkout-4.png"> ! <p>In the "Select Module" dialog, click the "User existing module" radio button. This will bring up ! the list of existing modules. Select all but the "CVSROOT" one. Then click "Finish" to kick off the ! checkout.</p> ! <img src="snaps/cvs-checkout-5.png"> ! <p>Your workspace will be populated with the Gizmo plug-ins. It should then look a bit like this here:</p> ! <img src="snaps/cvs-checkout-6.png"> <p>That's it, you're ready to go.</p> <h2>Downloading a Packaged Gizmo Release</h2> ! <p>Go to the Gizmo downloads page and get the packages of the release you want to use.</p> <p>Unpack the packages to a temporary location.</p> ! <p>In Eclipse, create a new empty workspace and import the plug-ins using the Eclipse import ! "Existing Projects into Workspace" function.</p> ! <p class="revinfo"> <div id="rev">$Revision$</div> <div id="date">$Date$</div> <div id="auth">$Author$</div> ! </p> ! <a href="http://sourceforge.net/projects/lipog"> ! <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=257822&type=16" ! border="0" width="150" height="40" ! alt="Get Little Portal Gizmo at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a> </body> </html> \ No newline at end of file --- 9,129 ---- <p><a href="index.html">Home of Little Portal Gizmo</a></p> <h1>Getting Ready for Development with the Gizmo</h1> ! <p>Developing web apps with the Gizmo means developing one or more ! Eclipse plug-ins, based on the Gizmo base plug-ins. You need to set up ! an Eclipse workspace containing the Gizmo base plug-ins to start with. ! Here are the plug-ins making up the project with a bit of a (very brief) description of what they do.</p> <table> ! <tr> ! <th>Plug-in</th> ! <th>Description</th> ! </tr> ! <tr> ! <td>net.heilancoo.portal</td> ! <td>The core portal code. The web server/web application ! container.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.test</td> ! <td>JUnit tests for net.heilancoo.portal.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.admin</td> ! <td>A mini web app (actually a "request handler") that shows a ! directory of all web apps installed. You get this, when requesting the ! root URI ("/").</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.freemarker</td> ! <td>A response generator using the Freemarker template engine.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.json</td> ! <td>A response generator for generating JSON responses.</td> ! </tr> ! <tr> ! <td>net.heilancoo.utils</td> ! <td>Utility classes not strictly related to the portal related ! functionality.</td> ! </tr> ! <tr> ! <td>org.apache.httpcore</td> ! <td>The Apache HttpComponents jar files, just packaged up as an ! Eclipse plug-in.</td> ! </tr> ! <tr> ! <td>org.dojotoolkit</td> ! <td>The Dojo JavaScript library files packaged in an Eclipse ! plug-in. This is not necessary on a technical level for the Gizmo to ! work. I have used it in a web app I have written in the Gizmo. So I ! just include it here. It also gives an example of how non-Java ! (static) content can be packaged in an Eclipse plug-in to be used with ! (or served from) the Gizmo.</td> ! </tr> ! <tr> ! <td>org.freemarker</td> ! <td>The Freemarker template engine jar file, just packaged up as ! an Eclipse plug-in.</td> ! </tr> ! <tr> ! <td>org.json</td> ! <td>The JSON Java sources (as taken from the JSON web site), just ! packaged up as an Eclipse plug-in.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.documentation</td> ! <td>The project documentation, including this file here. When ! installed along with the rest of the portal, it should be reachable ! via the URI "/portaldocs". Strictly speaking, not technically needed ! for development.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.examples</td> ! <td>A number of examples. Useful to see how things are intended ! to be used. Not needed for development.</td> ! </tr> ! <tr> ! <td>net.heilancoo.portal.bingo</td> ! <td>The bingo web app used as example in the tutorials. Not ! needed for development.</td> ! </tr> </table> <h2>Checking Out Gizmo Plug-ins From CVS</h2> ! <p>There is standard SF <a ! href="http://sourceforge.net/scm/?type=cvs&group_id=257822">info ! on CVS access</a> telling you how to connect to the Gizmo CVS repository. ! Create a new empty workspace and check out the plug-ins above.</p> <p>An empty workspace:</p> ! <img src="snaps/cvs-checkout-1.png" alt=""> <p>Use the import "Projects from CVS" option:</p> ! <img src="snaps/cvs-checkout-2.png" alt=""> <p>Connect as anonymous user to the Gizmo repository:</p> ! <img src="snaps/cvs-checkout-3.png" alt=""> ! <p>Click the "configure connection preferences..." link to enable ! connection compression. Don't forget to click OK.</p> ! <img src="snaps/cvs-checkout-4.png" alt=""> ! <p>In the "Select Module" dialog, click the "User existing module" ! radio button. This will bring up the list of existing modules. Select ! all but the "CVSROOT" one. Then click "Finish" to kick off the checkout.</p> ! <img src="snaps/cvs-checkout-5.png" alt=""> ! <p>Your workspace will be populated with the Gizmo plug-ins. It ! should then look a bit like this here:</p> ! <img src="snaps/cvs-checkout-6.png" alt=""> <p>That's it, you're ready to go.</p> <h2>Downloading a Packaged Gizmo Release</h2> ! <p>Go to the Gizmo downloads page and get the packages of the ! release you want to use.</p> <p>Unpack the packages to a temporary location.</p> ! <p>In Eclipse, create a new empty workspace and import the plug-ins ! using the Eclipse import "Existing Projects into Workspace" function.</p> ! <p class="revinfo"></p> <div id="rev">$Revision$</div> <div id="date">$Date$</div> <div id="auth">$Author$</div> ! <p></p> ! <a href="http://sourceforge.net/projects/lipog"> <img ! src="http://sflogo.sourceforge.net/sflogo.php?group_id=257822&type=16" ! border="0" width="150" height="40" ! alt="Get Little Portal Gizmo at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a> </body> </html> \ No newline at end of file |
