doc/index.html

   1 <!DOCTYPE html SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   4  * Copyright (C) 2015 The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18  * The Jalview Authors are detailed in the 'AUTHORS' file.
  19 -->
  20 <html xmlns="http://www.w3.org/1999/xhtml">
  21 <head>
  22 Jalview Source Documentation
  23 </head>
  24 <body>
  25 <h1>Jalview Source Documentation</h1>
  26 <p>The file structure of the Jalview Source tree is as follows:
  27 <ul>
  28         <li>README - basic info for getting started with the source tree.</li>
  29         <li>LICENCE - the GPL Licence</li>
  30         <li>RELEASE - contains the name of the tag for the latest
  31         'official' Jalview release associated with the source.</li>
  32         <li>build.xml - ant build for jalview - the 'help' task gives
  33         information about each task, and there's lots of comments too.</li>
  34         <li></li>
  35         <li>src - all jalview source packages, including any specially
  36         adapted code from other GPL programs. See <a href="developing.html">Jalview
  37         Development</a> for more info.</li>
  38         <li>lib - All the libraries that Jalview depends on. Every jar
  39         file in this directory should be added to the classpath when building
  40         or running the jalview application.</li>
  41         <li>appletlib - Any libraries that are specifically required for compiling and/or running the jalviewLite applet (e.g. an applet build of Jmol).
  42         <li>help - the jalview JavaHelp documents<br>
  43         <ul>
  44                 <li>help.hs - the main index page. This is generated by the
  45                 jhindexer program run by the 'buildindices' task in build.xml</li>
  46                 <li>help.jhm - helpTOC map - an XML document listing simple names
  47                 for each html page that is linked to in the help contents structure.</li>
  48                 <li>helpTOC.xml - the table of contents presented to the user
  49                 when the help is opened.</li>
  50                 <li>icons - widgets needed for the help system GUI</li>
  51                 <li>html - the help documentation. It loosely follows the
  52                 following structure: <br>
  53                 <ul>
  54                         <li>calculations - pages concerning the calculations menu</li>
  55                         <li>webServices - pages describing web services</li>
  56                         <li>colourSchemes - the ways amino acids can be coloured and the
  57                         user interface for defining them</li>
  58                         <li>editing - mechanisms and interfaces for editing alignments</li>
  59                         <li>features - used to be the sequence features documentation,
  60                         but now contains all sorts of jalview 'features'.</li>
  61                         <li>io - getting data in and out of jalview</li>
  62                         <li>menus - all the menus in Jalview (and the applet)</li>
  63                         <li>misc - useful info</li>
  64                         <li>By convention, we try to maintain the whatsNew.html document
  65                         with each release and complete the releases.html matrix to detail
  66                         what has changed from one version to another.</li>
  67                         <li>keys.html contains all the keystrokes in Jalview - please
  68                         keep this up to date.</li>
  69                 </ul>
  70                 </li>
  71         </ul>
  72         </li>
  73         <li>resources - files needed at run-time for jalview execution.<br>
  74         <ul>
  75                 <li>images - icons used by jalview</li>
  76                 <li>log4j and commons-logging.properties - configure default
  77                 appenders and logging for Jalview, castor.</li>
  78                 <li>embl_mapping.xml - castor mapping file for the EMBL XML
  79                 Schema.</li>
  80                 .
  81                 <li>uniprot_mapping.xml - castor mapping file for the Uniprot XML
  82                 Schema.</li>
  83         </ul>
  84         </li>
  85         <li>schemas - XML schema definitions used or understood by
  86         Jalview.<br>
  87         Jalview uses castor to bind java to XML - either using mapping files
  88         hand-crafted from a schema in this directory, or from java objects
  89         generated from the schema and an associated set of properties. <br>
  90         See the castorbinding task in the ant build.xml file for more info.
  91         <ul>
  92                 <li>Jalview Project Archive XML Version 1<br>
  93                 vamsasJvV1.xsd<br>
  94                 jalviewJvV1.xsd<br>
  95                 jalview.nodesc.properties - sourcegenerator properties file</li>
  96                 <li>jalview Project Archive XML Version 2<br>
  97                 Jalview works out which version a project is by first trying
  98                 to parse XML with these schema definitions, and then if there are
  99                 problems, falls back to the V1 schema classes.
 100                 <ul>
 101                         <li>vamsas.xsd<br>
 102                         jalview.xsd<br>
 103                         jalview.properties - sourcegenerator properties file</li>
 104                 </ul></li>
 105                 <li>JalviewUserColours.xsd is used by both V1 and V2 project XML
 106                 definitions. This schema is also used to store user colour schemes
 107                 externally from the project file.</li>
 108         </ul>
 109         </li>
 110         <li>utils - various resources needed when building or deploying
 111         jalview.
 112         <ul>
 113                 <li>InstallAnywhere
 114                 <ul>
 115                         <li>Jalview.iap_xml is the InstallAnywhere XML project used to
 116                         create the Jalview InstallAnywhere distribution.</li>
 117                         <li>All the other files are bundled into this for installer
 118                         displays. The README_IA appears in the installation directory.</li>
 119                 </ul>
 120                 <li>jalopy<br>
 121                 This is a legacy directory - we intended to use jalopy for
 122                 standardising the jalview source formatting, but found it had a number
 123                 of bugs.</li>
 124                 <li>axis-ant.jar - tasks for constructing client skeletons from
 125                 WSDL documents.</li>
 126                 <li>roxes-ant-tasks-1.2-2004-01-30.jar - conditionals and other
 127                 useful ant tasks.</li>
 128                 <li>castor-*-codegen.jar and castor-*-anttask.jar - codegenerator
 129                 task and library for regenerating the Java classes from schemas. It is
 130                 important to update these and rebuild the source if the version of
 131                 castor that Jalview uses is updated.</li>
 132                 <li>gff2annot.pl - useful script to translate gff to jalview
 133                 features file format - although its not needed since Jalview can parse
 134                 GFF natively (normally at least).</li>
 135                 <li>jhall.jar, jhindexer.jar - the java help system and indexer
 136                 code to build the jalview help in the help directory.</li>
 137                 <li>proguard.jar - obfuscator used when creating
 138                 jalviewApplet.jar. See the build.xml file and the building jalview
 139                 documentation.</li>
 140         </ul>
 141         </li>
 142         <li>installAnywhere - where the installAnywhere build is generated</li>
 143         <li><em>keys</em> - you might not have this - see <a
 144                 href="building.html">building</a> for info on how to create it.</li>
 145 <li>dist - where the Jars and JNLP file for the java webstart distribution is generated, and where a copy of the examples directory is created complete with jalviewApplet.jar and the contents of appletlib/*.jar.</li>
 146 <li>examples - a set of example jalview projects and web pages demonstrating the jalviewLite applet. This is essentially mirrors the <a href="http://www.jalview.org/examples/">www.jalview.org/examples</a> directory on Jalview's website.</li>
 147 <li>nbbuild.xml - custom config used by the vanilla netbeans project in nbproject</li>
 148 <li>nbproject - vanilla netbeans project</li>
 149 <li>JalviewApplet.jpx, JalviewX.jpx - old JBuilder project files</li>
 150 <li>.project - eclipse .project definition</li>
 151 </ul>
 152
 153 </body>
 154 </html>