RefactorWiki - 0.2 - Installation instructions

Before using the RefactorWiki-component, please read the disclaimer.

Prerequisites

RefactorWiki and its Web-layer were developed using the following software stack:

• Java 5.0
• MySql-4.0.18
• Apache Tomcat v5.5.4 WebContainer
• A working installation of WackoWiki v4 or WikkaWiki v1.1.6.0

Web use

To configure the RefactorWiki-component for use in a WebContainer:

1. Configure your database(s) as datasource(s) in %TOMCAT_HOME%/conf/server.xml following this example:
<Resource name="jdbc/wikka" type="javax.sql.DataSource" driverClassName="com.mysql.jdbc.Driver"password="root"
maxIdle="2" maxWait="5000" username="root" url="jdbc:mysql://localhost/wikka" maxActive="4"/>
2. Create a resource-link in the application's configuration-file (e.g. %TOMCAT_HOME%/conf/Catalina/localhost/RefactorWiki.xml):
<ResourceLink global="jdbc/wikka" name="jdbc/wikka" type="java.sql.Connection"/>
3. Copy your MySql Connector jar to %TOMCAT_HOME%/common/lib
4. Deploy RefactorWiki-0.2.war to the server
5. Enter the application at: http://[hostname]/RefactorWiki/databaseSelection.do
   Find the homepage at: http://[hostname]/RefactorWiki/index.html

Standalone use

To experiment with RefactorWiki as a standalone component, the following steps are suggested:

1. Load RefactorWiki-0.2-src.zip and RefactorWiki-0.2-src_test.zip in your favorite IDE
2. Depending on what you would like to test, make sure the following components are on the classpath:
cglib-full-2.0.2.jar, commons-beanutils-1.7.jar, commons-collections-3.1.jar, commons-configuration-1.0.jar,
commons-digester-1.6.jar, commons-lang-2.0.jar, commons-logging-1.0.4.jar, dom4j-1.4.jar, ehcache-0.9.jar,
hibernate-2.1.7c-src.zip, hibernate-tools.jar, hibernate2.1.7c.jar, jdom.jar, jta.jar, log4j-1.2.9.jar,
middlegen-2.1.jar, middlegen-hibernate-plugin-2.1.jar, mysql-connector-java-3.0.14-production-bin.jar,
xdoclet-1.2.2-RC1.jar, xdoclet-hibernate-module-1.2.2-RC1.jar

3. Open JUnit-testcase nl.mhm.wiki.refactor.Wacko4PageRefactorerTest or nl.mhm.wiki.refactor.Wikka1160PageRefactorerTest
4. Replace the fromPage and toPage in the code with your own pagenames
5. Run the testcase (notice it will try to re-initialize your database)

Disclaimer

RefactorWiki is beta-software. You're free to experiment with it at your own risk.
As with all beta-software, don't deploy to or test on your production system. Keep the following in mind:

• Make a backup of your MySql-database before refactoring.
• Bring down or lock your Wiki-engine before refactoring.
• The author cannot accept ANY responsibility for negative consequences, including but not limited to loss of Wiki-pages, which result of the use of this component.

Please post a bug-report should you find an issue.

Back to the HomePage.