Table of Contents
In this chapter, we will discuss the subjects on which contributions from advanced users are encouraged, and the hooks YaTiSeWoBe offers to ease those contributions. This section supposes that you have at least some knowledge in computer programming, and more specifically with the Java language. Many tools and tutorials are available for free on the web to learn and help Java development skills. This document is by no means and introduction to those subjects. FIXME: add references
![[Warning]](images/warning.png) | Warning |
|---|---|
missing procedure | |
| Warning |
|---|---|
missing procedure | |
FIXME: organization of directories
YaTiSeWoBe development is automatized through an Ant v1.6+ [13] build script build.xml located in the YaTiSeWoBe source directory. We will discuss in the following section the details and requirements to compile the executable and the documentation from the source code.
You can obtain the list of available targets by issuing in the source directory:
example$ ant -projecthelp
Buildfile: build.xml
Use this file to build YaTiSeWoBe from source files.
Type "ant -projecthelp" for help.
Main targets:
clean Remove any build generated files.
release Prepare a complete release.
doc Produce the project documentation in all formats.
doc-check Check that the manual is a valid DocBook-XML document.
doc-collect Collect link destinations from the document.
doc.api Produce the API documentation in javadoc format.
doc.html Produce the documentation in HTML format.
doc.jhelp Produce the documentation in Java Help format.
doc.man Produce the documentation in manpage format.
doc.pdf Produce the documentation in PDF format.
jar Produce the project runtime.
macosx Produce a MacOS X native application.
pack Produce all the packs for the application.
pack.javaws Produce a pack archive for the Java WebStart platform.
pack.linux Produce a pack archive for the GNU/Linux platform.
pack.macosx Produce a pack archive for the Apple MacOS X platform.
pack.macosx.dmg Produce a MacOS X native installer. Requires DropDMG.
pack.source Produce a pack archive containing the source files.
pack.windows Produce a pack archive for the Windows platform.
test Run JUnit unit tests for the complete source tree.
Default target: jar
example$
All the files generated by the ant command go in the directory named build that will be created when the first command is typed.
FIXME: add requirements section
FIXME: add procedure "compile src"
| Warning |
|---|---|
missing console output | |
Documentation is composed of the JavaDoc API description of the Java source code, and the "YaTiSeWoBe: User's and Contributor's Guide" you are currently reading. Both documents can be generated with the help of ant. The Guide can be produced in HTML, JavaHelp, and PDF formats if you have the proper tools installed and available on your computer.
FIXME: add requirements section, details on local configuration
example$ ant doc # generate all documentation formats example$ ant doc.api # generate javadoc API documentation example$ ant doc.html # generate guide in HTML format example$ ant doc.jhelp # generate guide in JavaHelp format example$ ant doc.pdf # generate guide in PDF format