jspwiki-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r826347 - in /websites/staging/jspwiki/trunk/content: ./ jspwiki/development/building.html
Date Thu, 19 Jul 2012 18:57:37 GMT
Author: buildbot
Date: Thu Jul 19 18:57:37 2012
New Revision: 826347

Staging update by buildbot for jspwiki

    websites/staging/jspwiki/trunk/content/   (props changed)

Propchange: websites/staging/jspwiki/trunk/content/
--- cms:source-revision (original)
+++ cms:source-revision Thu Jul 19 18:57:37 2012
@@ -1 +1 @@

Added: websites/staging/jspwiki/trunk/content/jspwiki/development/building.html
--- websites/staging/jspwiki/trunk/content/jspwiki/development/building.html (added)
+++ websites/staging/jspwiki/trunk/content/jspwiki/development/building.html Thu Jul 19 18:57:37
@@ -0,0 +1,216 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html id="top" xmlns="http://www.w3.org/1999/xhtml" xmlns:jspwiki="http://www.jspwiki.org"><head>
+  <title>Building Source
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  <link rel="stylesheet" type="text/css" media="screen, projection, print" href="/jspwiki/css/jspwiki.css">
+  <link rel="stylesheet" type="text/css" media="print" href="/jspwiki/css/jspwiki_print.css">
+  <link rel="alternate stylesheet" type="text/css" href="/jspwiki/css/jspwiki_print.css"
title="Print friendly">
+  <link rel="alternate stylesheet" type="text/css" href="/jspwiki/css/jspwiki.css" title="Standard">
+  <link rel="shortcut icon" type="image/x-icon" href="/jspwiki/images/favicon.ico">
+  <link rel="icon" type="image/x-icon" href="/jspwiki/images/favicon.ico">
+<body class="view">
+<div id="wikibody" class="fav-left">
+  <div id="header">
+    <!-- <div class="titlebox"></div> -->
+    <div class="applicationlogo"> 
+      <a href="">Main</a>
+    </div>
+    <div class="companylogo"></div>
+    <div class="userbox">
+      <a href="http://incubator.apache.org" alt="Apache Incubator">
+        <img src="/jspwiki/images/apache_incubator_logo.png" alt="Apache Incubator" id="asf-logo"
style="width: 180px; height: 45px;">
+      </a>
+      <div class="clearbox"></div>
+    </div>
+    <div class="pagename">
+      Building Source

+    </div>
+    <div class="breadcrumbs"><a href="/">Incubator</a>&nbsp;&raquo&nbsp;<a
href="/jspwiki/">Jspwiki</a>&nbsp;&raquo&nbsp;<a href="/jspwiki/development/">Development</a></div>
+  </div>
+  <div id="content">
+    <div id="page">
+      <div id="actionsTop" class="pageactions"> 
+      <ul>
+        <li>
+          <a href="http://www.apache.org/foundation/" class="action edit" accesskey="f"
title="The Foundation [f]">
+            <span class="accesskey">F</span>oundation
+          </a>
+        </li>
+        <li>
+          <a href="http://projects.apache.org" class="action edit" accesskey="p" title="The
Projects [p]">
+            <span class="accesskey">P</span>rojects
+          </a>
+        </li>
+        <li>
+          <a href="http://people.apache.org" class="action edit" accesskey="e" title="The
People [e]">
+            P<span class="accesskey">e</span>ople
+          </a>
+        </li>
+        <li>
+          <a href="http://www.apache.org/foundation/getinvolved.html" class="action edit"
accesskey="i" title="Get Involved [i]">
+            Get <span class="accesskey">I</span>nvolved
+          </a>
+        </li>
+        <li>
+          <a title="Download [ d ]" class="action edit" accesskey="d" href="http://www.apache.org/dyn/closer.cgi">
+            <span class="accesskey">D</span>ownload
+          </a>
+        </li>
+        <li href="#" id="morebutton">
+          <a href="http://www.apache.org/foundation/sponsorship.html" accesskey="s" class="action
edit" title="Support Apache [ s ]">
+            <span class="accesskey">S</span>upport Apache&nbsp;
+          </a>
+        </li>
+      </ul>
+      </div>
+      <div class="tabmenu">
+        <a class="activetab" id="menu-pagecontent" accesskey="J" href="/jspwiki/index.html">
+          <span class="accesskey">J</span>SPWiki&nbsp;
+        </a>
+        <!-- <a id="menu-attach" accesskey="a"><span class="accesskey">A</span>ttach</a>
+        <a id="menu-info" href="http://www.jspwiki.org/PageInfo.jsp?page=Main" accesskey="i"><span
class="accesskey">I</span>nfo</a> -->
+      </div>
+      <div class="tabs">
+        <div id="pagecontent">
+          <p>Since you have the source, you'll probably want to know how to compile
it. </p>
+<p>Some of JSPWiki is in the form of JSP pages, so you don't need to compile them:

+the JSP container will take care of that.  However, there are a bunch of Java 
+files, which you'll want to compile.</p>
+<h2 id="requirements">Requirements</h2>
+<p>You'll need the following programs:</p>
+<li>J2SDK 5.0 (I use the one from Sun Microsystems; I haven't tested any others.)</li>
+<li>Apache Ant 1.6 (available from http://ant.apache.org)</li>
+<li>Servlet API 2.4 (servlet-api.jar, available from Sun Microsystems.)</li>
+<li>JUnit 3.8.2 (from www.junit.org, required for running tests)</li>
+<p>You'll also need Internet access in order to download JSPWiki's dependencies.</p>
+<h2 id="building">Building</h2>
+<p>Ant is the build system.</p>
+<p>Everything should Just Compile, when you say '<code>ant</code>', assuming
you have 
+everything in your path. </p>
+<p>There are few targets:</p>
+<div class="codehilite"><pre><span class="n">ant</span> <span
class="n">dist</span>   <span class="p">:</span> <span class="n">builds</span>
<span class="n">a</span> <span class="n">full</span> <span class="n">distribution</span><span
+<span class="n">ant</span> <span class="n">javadoc:</span> <span
class="n">builds</span> <span class="n">the</span> <span class="n">javadocs</span>
<span class="n">into</span> <span class="n">doc</span><span class="o">/</span><span
+<span class="n">ant</span> <span class="n">compile:</span> <span
class="n">just</span> <span class="n">the</span> <span class="n">basic</span>
<span class="n">compile</span><span class="p">,</span> <span class="n">thankyouverymuch</span>
+<span class="n">ant</span> <span class="n">tests</span>  <span
class="p">:</span> <span class="n">runs</span> <span class="n">JUnit</span>
<span class="n">tests</span><span class="o">.</span>
+<span class="n">ant</span> <span class="n">jar</span>    <span
class="p">:</span> <span class="n">builds</span> <span class="n">the</span>
<span class="n">JSPWiki</span><span class="o">.</span><span class="n">jar</span>
<span class="n">into</span> <span class="n">build</span><span class="o">/</span>
+<span class="n">ant</span> <span class="n">war</span>    <span
class="p">:</span> <span class="n">builds</span> <span class="n">the</span>
<span class="n">JSPWiki</span><span class="o">.</span><span class="n">war</span>
<span class="n">that</span> <span class="n">can</span> <span class="n">be</span>
<span class="n">deployed</span> <span class="n">to</span> <span
class="n">your</span> <span class="n">webcontainer</span>
+<p>You can customize your compilation by changing the contents of the 
+<code>build.properties</code> file, or better yet, make your own compilation
script where 
+you override the <code>build.properties-property</code>.  For example, to use
your own 
+<code>build.properties-file</code> called "<code>my.properties</code>",
make a small shell script and 
+call it "<code>my_build.sh</code>":</p>
+<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre>1
+2</pre></div></td><td class="code"><div class="codehilite"><pre><span
+ant -Dbuild.properties<span class="o">=</span>/path/to/my.properties
+<p>To be a little bit more productive you probably want to use Eclipse.
+To get JSPWiki build from within Eclipse, here are a few guidelines:
+  * first install the SVN Eclipse Plugin (the JSPWiki sources are in <code>svn.(eu.)apache.org</code>)
+  * create a new SVN Project and check out the trunk (<code>(incubator/)jspwiki/trunk</code>)
+  * the only thing you probably have to change is the buildpath (see properties of the project)
+  * then the sources should be compiled correctly
+  * to run a build, switch to the Ant View and add the build.xml buildfile
+  * then you can choose the Ant target by double clicking on it
+  ** the Ant <code>init</code> target must be called at least once in order to
download the required dependencies</p>
+<h1 id="directory-structure">Directory structure</h1>
+<p><code>src</code> contains the source code (under <code>org/apache/wiki</code>).</p>
+<p><code>src/webdocs</code> contains all the files that are published in
the final webapps 
+directory, including all of the deployment files under WEB-INF.</p>
+<p><code>src/wikipages</code> contains a number of ready-made Wikipages
called the core 
+pages. There is a subdirectory for each language that is supported. Feel free 
+to use them.</p>
+<p><code>tests</code> contains a number of tests which you can run by saying
<code>ant tests</code>.<br />
+If any of them fail, you know you've broken something.</p>
+<p><code>etc</code> contains all configuration files.</p>
+<p><code>lib</code> and <code>tests/lib</code> contains all
libraries that are required to run and test 
+JSPWiki.  Note, however, that they aren't included in the source distribution.<br />
+They're automatically downloaded from <code>init</code> target.</p>
+        </div>
+        <div style="clear:both;"></div>
+      </div>
+      <div id="actionsBottom" class="pageactions"> 
+        <a href="#top" class="action quick2top" title="Ir al principio">«</a>
+      </div>
+    </div>
+    <div id="favorites">
+      <div class="leftmenu">
+      <p><strong>General</strong></p>
+<li><a href="/jspwiki/index.html">Home</a></li>
+<li><a href="/jspwiki/general/downloads.html">Downloads</a></li>
+<li><a href="/jspwiki/general/history.html">History</a></li>
+<li><a href="http://www.apache.org/licenses/" class="external">License</a></li>
+<li><a href="http://doc.jspwiki.org" class="external">Doc Wiki</a></li>
+<li><a href="/jspwiki/documentation/javadoc.html">Javadoc</a></li>
+<li><a href="/jspwiki/community/get_involved.html">Get Involved</a></li>
+<li><a href="/jspwiki/community/mailing_lists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/JSPWIKI" class="external">Issues</a></li>
+<li><a href="http://www.jspwiki.org" class="external">Main Wiki</a></li>
+<li><a href="http://sandbox.jspwiki.org" class="external">Sandbox Wiki</a></li>
+<li><a href="/jspwiki/community/people.html">People</a></li>
+<li><a href="/jspwiki/development/source_and_guide.html">Source and Guide</a></li>
+<li><a href="/jspwiki/development/building.html">Building</a></li>
+<li><a href="https://issues.apache.org/jira/browse/JSPWIKI#selectedTab=com.atlassian.jira.plugin.system.project%3Aroadmap*panel"
class="external">Road Map</a></li>
+<li><a href="/jspwiki/development/edit_website.html">Edit Website</a></li>
+<li><a href="http://incubator.apache.org/projects/jspwiki.html" class="external">Incubation
+<li><a href="/jspwiki/ppmc/how_to_release.html">How to Release</a></li>
+<li><a href="/jspwiki/ppmc/incubator_reports.html">Incubator Reports</a></li>
+<li><a href="http://www.apache.org" class="external">Website</a></li>
+<li><a href="http://www.apache.org/foundation/contributing.html" class="external">Donations</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html" class="external">Sponsorship</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html" class="external">Thanks</a></li>
+      </div>
+      <div class="leftmenufooter">
+        <br /><hr>
+      </div>
+      <div class="wikiversion">JSPWiki v2.9.0-incubating-4</div>  
+    </div>
+	<div class="clearbox"></div>
+  </div>
+  <div id="footer">
+    <div class="copyright">
+      Copyright &copy; 2011 The Apache Software Foundation, Licensed under 
+      the <a href="http://www.apache.org/licenses/LICENSE-2.0" class="external">Apache
License, Version 2.0</a>.
+      <br />Apache and the Apache feather logo are trademarks of The Apache Software
+    </div>
+  </div>
\ No newline at end of file

View raw message