JaxoDraw - A Feynman diagram plotting tool

(c)2003-2011 Daniele Binosi and Lukas Theussl
(c)2007-2009 Daniele Binosi,Lukas Theussl and Christian Kaufhold

Current version: 2.1-0


TABLE OF CONTENTS
*****************

1. Disclaimer
2. What is it?
   2.1 Features
   2.2 History
   2.3 Changes
3. Installation
   3.1 Requirements
   3.2 Compiling from Source
   3.3 Binaries
4. Getting Help
   4.1 Documentation
   4.2 Support
5. Obtaining JaxoDraw
6. Misc
   6.1 Tips and tricks
   6.2 Showcase
7. License
8. Contact Email
9. Credits




1. Disclaimer
-------------
  We are not liable for any damage caused by the use of this program.
  Please read the file LICENSE for detailed information on copyright issues.



2. What is it?
--------------
  JaxoDraw is Feynman graph plotting tool written in Java. It has a complete
  graphical user interface that allows all actions to be carried
  out via mouse click-and-drag operations. Graphs may be
  exported to a variety of formats and can be saved in XML files to be
  used for later sessions. One of JaxoDraw's main features is the
  possibility to create LaTeX files which make use of J. Vermaserens
  axodraw package to create a Feynman diagram via LaTeX and dvips. It was
  in fact the main motivation for writing JaxoDraw, to create a graphical
  user interface for the axodraw package.

2.1  Features
------------
  o Platform independent
  o Easy to compile/install, no external dependencies
  o Complete point-and-click graphical user interface
  o Pre-defined line styles for common particle representations
  o Saving and reading of graphs in XML format
  o Export to PostScript, EPS and Latex format
  o Setting of permanent preferences
  o Internationalized: currently it comes in English, German, French,
           Italian and Spanish (the User Guide is only available in English)
  o Working with several graphs at a time
  o Editing groups of objects
  o Importing existing Latex files
  o Grid with customizable Size
  o Look-and-Feel: All Swing pluggable Look-and-Feels

2.2 History
-----------
  o (September 1, 2003)
     Released JaxoDraw-1.0
  o (September 12, 2003)
     Released JaxoDraw-1.0-1
  o (March 15, 2004)
     Released JaxoDraw-1.1-0
  o (July 21, 2004)
     Released JaxoDraw-1.2-0
  o (June 20, 2005)
     Released JaxoDraw-1.3-0
  o (June 29, 2005)
     Released JaxoDraw-1.3-1
  o (March 24, 2006)
     Released JaxoDraw-1.3-2
  o (November 20, 2008)
     Released JaxoDraw-2.0-0
  o (July 26, 2009)
     Released JaxoDraw-2.0-1
  o (October 7, 2011)
     Released JaxoDraw-2.1-0

2.3 Changes
-----------
See the file CHANGELOG



3. Installation
---------------

3.1 Requirements
----------------
  JaxoDraw requires a Java 5 or later compatible virtual machine for
  your operating system. The most recent version of Java can be obtained from

      http://www.oracle.com/technetwork/java/javase/overview/index.html

  Please refer to the Oracle web pages for information on how to
  install Java on your system. We only support the official java from Oracle.
  Please only report problems if you encounter them with an official java version.

  NOTE in particular that JaxoDraw does not run or compile with GNU's java
  compiler gcj which is installed by default on many Linux distributions.

  The program runs on any platform that has a Java virtual machine installed,
  however, in the present version, there are a number of known bugs and
  limitations specific to certain operating systems.
  See the files TODO and BUGS for more information.

3.2 Compiling from Source
-------------------------
  The source distribution has the following directory structure:

    src/
        assembly/       Configuration files for the Maven assemby plugin
        changes/        Configuration files for the Maven changes plugin
        doc/            Documentation files
            colors/     Some notes on the use of colors in JaxoDraw
            legal/      License files
        main/
            java/       Java source files for JaxoDraw
            resources/  Various resources, icons, User Guide, etc.
        site/           The JaxoDraw web site (XML sources)
        test/
            java/       JUnit test files for JaxoDraw
            resources/  Test resources


  The following directories are not present in the original source distribution,
  they are generated by maven or have to be created manually:

    target/                 Compiled class files and resources
    target/site/apidocs/    API specification

  To build JaxoDraw you have to use Maven 2 (http://maven.apache.org/).
  Maven 3 can be used as well except for building the site,
  unless the maven 3 version of the site plugin is used.

  To compile JaxoDraw use
    mvn compile

  Then you run JaxoDraw with:
    java -cp target/classes/ net.sf.jaxodraw.JaxoDraw

  To create the jar executable:
    mvn package

  which can be executed with
    java -jar target/jaxodraw-xxx.jar


  To create the javadocs:
    javadoc -d target/site/apidocs/ [-link http://download.oracle.com/javase/1.5.0/docs/api/] -link . -sourcepath src/main/java/ -subpackages net.sf.jaxodraw

  where the link parameter in square brackets is optional and is used
  in this case to link against the online java documentation from Oracle.

  In any case, the command has to be run twice in order to get the
  cross-references right.

  Alternatively, you may use maven:
    mvn javadoc:javadoc

3.3 Binaries
--------------

  The binary JaxoDraw.jar file may be executed with
    java -jar jaxodraw-xxx.jar

  or, depending on your operating system and setup,
  by simply double clicking on the .jar file icon.



4. Getting Help
---------------
  The JaxoDraw home page is at
    http://jaxodraw.sourceforge.net/

  We have two mailing lists:
    http://jaxodraw.sourceforge.net/mail-lists.html

  Bugs and feature requests should be submitted to the SourceForge Tracker:
    http://sourceforge.net/tracker/?group_id=142124

4.1 Documentation
-----------------
  Most of the documentation for JaxoDraw
  is in an HTML-based reference guide that is available via the Help menu
  of the graphical user interface of JaxoDraw or from our Web page:
      http://jaxodraw.sourceforge.net/

  The src/main/resources/usrGuide/ subdirectory of the source distribution
  contains the XML source code of the JaxoDraw user guide (in the xdocs/
  directory), the HTML version may be created by compiling and executing the
  file UserGuide2HTML.java).

  The API specification for JaxoDraw may be created from
  the sources as described in sec. 3.2.

4.2 Support
-----------
  No support is provided via e-mail, use the tracker system provided by
  SourceForge ( http://sourceforge.net/tracker/?group_id=142124 )
  to submit bugs, feature requests and patches.

  General inquiries, questions or dicussion should be sent to the mailing
  list ( https://lists.sourceforge.net/lists/listinfo/jaxodraw-discuss ).

  Please review the FAQ and documentation sections of our home page
    http://jaxodraw.sourceforge.net/
  before submitting any requests.



5. Obtaining JaxoDraw
---------------------
  JaxoDraw sources and binaries may be downloaded from the home page
    http://jaxodraw.sourceforge.net/

  The sources of JaxoDraw are published under the GNU General Public License,
  please read the file LICENSE for detailed information.



6. Misc
-------

6.1 Tips and Tricks
-------------------
  Check the corresponding section of the User Guide for a list of practical
  information when using JaxoDraw.

6.2 Showcase
------------
  Please send screenshots to

    lukas_theussl@users.sourceforge.net
    binosi@users.sourceforge.net



7. License
----------
  For legal and licensing issues, please read the LICENSE file in src/doc/legal.



8. Contact Email
----------------
  No support is provided via e-mail, see sec. 4.2.

  For more information please visit
    http://jaxodraw.sourceforge.net/



9. Credits
----------------
  We are grateful to Prof. Arcadi Santamaria for numerous helpful remarks and
  moral support during the development of JaxoDraw.

  We also acknowledge Prof. Jos Vermaseren for his kind permission to use and
  distribute a modified version of his axodraw style file along with earlier
  versions of JaxoDraw.
