mvnForum Developer Documentation

Cord Thomas

Software Architect
Lupine Information Systems

18 April 2004

Revision History
Revision v0.0.1018 April 2004cat
Prepared documentation for RC3.

Table of Contents

  1. Foreward
  2. 1. Developer Documentation
    1. Getting Started
    2. Overview
      1. myvietnam
      2. mvnForum
    3. Admin development
      1. myvietnam
      2. mvnForum
    4. User development
      1. myvietnam
      2. mvnForum

Foreward

mvnForum, developed by MyVietnam, based on their java framework for web development. This document focuses on the implementation of the framework with respect to mvnForum. It also touches on the framework where necessary.

Chapter 1. Developer Documentation

Getting Started

Follow these steps to access mvnForum source code and build mvnForum binaries from source code. To access the source code, use CVS to checkout the latest files from the shared project repository maintained on SourceForge. There are currently 2 modules, myvietnam and mvnforum.

Anonymous CVS Access

  • The project's Sourceforge.net CVS repository can be checked out through anonymous (pserver) CVS with the following instructions

  • The module you wish to check out muts be specified as the modulename.

  • When prompted for a password for the anonymous user, press the ENTER key.

  • cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/mvnforum login

  • cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/mvnforum co modulename

  • Updates from within the module's directory do not need the -d parameter

Developer CVS Access via SSH

  • Only project developers can access the CVS tree via this method. SSH1 must be installed on your client machine. Substitute modulename and developername with the proper values. Enter your site password when prompted.

  • export CVS_RSH=ssh

  • cvs -z3 -d:ext:<developername>@cvs.sourceforge.net:/cvsroot/mvnforum co modulename

  • Please mail the Project Administrators (found at www.sourceforge.net/projects/mvnforum) to include your Sourceforge User ID (in other words you need to be a registered user on SourceForge) to the MvnForum project. You cannot commit your changes until your SourceForge user ID has been assigned to the project.

  • The Eclipse V2.1 Java Development Environment (www.eclipse.org) has a very intuitive GUI for CVS access, using the extssh protocol in combination with the Sourceforge user ID and password. With a few clicks you have checked out the mvnForum project and are ready to participate in mvnForum development!

Build the source code

  1. Get the source code, if you have the source package, just extract it to a folder. If you don't have the source package or you would like to build the newest development source code, check out from CVS. See the CVS.txt for detailed information.

  2. Download ant build tool from http://jakarta.apache.org, then config it (please see the document from the ant package)

  3. cd to folder myvietnam, then type ant

  4. cd to folder mvnforum, then type ant

  5. the mvnForum webapp is created in folder mvnforum/build/webapp

Overview

The overview....

myvietnam

Introduction to myvietnam...

mvnForum

Introduction to mvnforum.

Admin development

The overview....

myvietnam

Introduction to myvietnam...

mvnForum

Introduction to mvnforum.

User development

The overview....

myvietnam

Introduction to myvietnam...

mvnForum

Introduction to mvnforum.

mvnForum documentation created using docbook.