doc/index.html

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