doc/index.html

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