[{TableOfContents}]
\\
This guide tells you how to set up a JSPWiki Development Environment.

It assumes you are using a Windows based environment

See also [HowToWriteAPlugin]

!!Prerequisites

!Install Java
* [http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html]
!Install Eclipse
* [http://www.eclipse.org/]
!Install Tomcat (optional)
* [http://tomcat.apache.org/]
!Install Maven
* [http://maven.apache.org/]

!!Source Code
The source code is in git: 
* [browse online|https://git-wip-us.apache.org/repos/asf?p=jspwiki.git;a=summary] 
* [clone|https://git-wip-us.apache.org/repos/asf/jspwiki.git]
* [github mirror|https://github.com/apache/jspwiki] \\
See [http://jspwiki.apache.org/development/source_and_guide.html]

!!Process

JSPWiki source is organized as a standard maven project so it can be easily imported out of the box by your favourite IDE.

To compile the code run:
{{{
mvn package
}}}

To compile the code without running all the tests:
{{{
mvn -Dmaven.test.skip=true package
}}}

To start jspwiki run:
{{{
cd jspwiki-war
mvn org.codehaus.cargo:cargo-maven2-plugin:run
}}}

Once this completes go to [http://localhost:8080/JSPWiki] and you should see an empty wiki.

!! Remote Debugging

The cargo plugin is configured to attach a remote debugger on port 5005.

If using an external tomcat, open the {{<tomcat>/bin/startup.bat}} (or {{.sh}}) and add __jpda__ before start on the following line:
{{{
call "%EXECUTABLE%" jpda start %CMD_LINE_ARGS%
}}}

!!Configuration
The default configuration file is found at {{<jspwiki.dir>/jspwiki-war/src/main/resources/ini/__jspwiki.properties__}}
\\
For more information see [Documentation].

%%information
It is recommended not to change the above file, but rather create a custom file here:
\\
{{<jspwiki.dir>/jspwiki-war/src/main/resources/__jspwiki-custom.properties__}}
%%

One of the important properties in the jspwiki.properties file is the below:
* {{jspwiki.fileSystemProvider.__pageDir__ = C:/Data/jspwiki }}

By default this line is commented out so it will go to the Java __{{<user.home>/jspwiki-files}}__ directory.
For Example:
* {{C:/Users/<username>/jspwiki-files}}
* {{C:/Documents and Settings/<username>/jspwiki-files}}
* {{/home/<username>/jspwiki-files}}

In there will be all the content files for the wiki pages.

----
[Category.Documentation]

[{PageViewPlugin}]