UniMoDoc Files

#-------------------------------------------------------------------------------
# UniMoDoc - The Universal Module Documenter v0.0.5
#-------------------------------------------------------------------------------
# Copyright 2014 Ivan Bogicevic
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#   http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#-------------------------------------------------------------------------------

UniMoDoc comes along in two versions:

1. UniMoDoc.jar - This is a standalone-version. You can run the jar-file simply without any installation.
2. UniMoDoc.war - This is the main actual version as deployable web-archive. See below for installation instructions.

The standalone-version is no longer maintained. Better use the war-version because the versions differ quite a lot.

=============================
=======  Users Guide  =======
=============================

1. Install Tomcat v7.0
2. Get the latest UniMoDoc_x.war-file from https://sourceforge.net/projects/unimodoc/
3. Rename the file to "UniMoDoc.war"
4. Deploy war-file on Tomcat
5. Check Installation under http://localhost:8080/UniMoDoc/index.xhtml

The documentation content and documentation structure is stored in one file at "$home/.unimodoc/specification.xml" when the app-context is shut down. During startup UniMoDoc will try to load the data from this file. If the import fails, the default data from "src/main/resources/projects/empty.xml" is loaded.

==================================
=======  Developers Guide  =======
==================================

 1. Install Subversion
 2. Checkout project, e. g. with "svn checkout --username=alice svn+ssh://alice@svn.code.sf.net/p/unimodoc/code/trunk /Users/alice/UniMoDoc"
 3. Install JDK 1.7+, caution: JDK 1.8+ will result in XML-parsing problems (uses newer JAXB spec, no list setter is used-> module prop maps will fail to load)
 4. Install Eclipse IDE for Java EE Developers (Luna or newer recommended)
 5. Start Eclipe and select workspace, e. g. "/Users/alice/UniMoDoc"
 6. Install Eclipse Checkstyle Plugin [update-site: http://eclipse-cs.sf.net/update]
 7. Install Eclipse PMD Plugin [update-site: http://www.acanda.ch/eclipse-pmd/release/latest]
 8. Install Tomcat v7.0
 9. Install Maven
10. In Eclipse:
	a) New - Server - Apache - Tomcat v7.0 Server
	b) Import - Maven - Existing Maven Projects - select checkout location - follow wizard
	c) UniMoDoc - Properties - Targeted Runtimes - Add the created tomcat server
    d) UniMoDoc - Properties - Java Build Path - Order and Export: JRE Library must be before Maven Dependencies
    e) Java - Compiler - Errors/Warnings - Annotations - Unhandled token in '@SuppressWarnings' - Ignore
	f) Run src/main/webapp/index.xhtml
11. To export .war:
    a) UniMoDoc - Run As - Maven build... - type text "package" in field "Goals" - Run
    b) Maven will run all test cases under "src/test/..." and the build will fail if any of the tests fail
    c) result will be in /target
=======================================
=======  Third Party Artefacts  =======
=======================================

UniMoDoc uses Icons from the "Font Awesome"-Package by Dave Gandy (http://www.flaticon.com/authors/dave-gandy) released under the CC BY 3.0 Licence (http://creativecommons.org/licenses/by/3.0/)