source: trunk/doc/src/docbook/appendix/incompatible.xml @ 3415

Last change on this file since 3415 was 3415, checked in by Nicklas Nordborg, 14 years ago

References #552, #553, #554: More information about backwards compatibility and Public vs. Internal
API.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 3.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE appendix PUBLIC
3    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN"
4    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
5<!--
6  $Id: incompatible.xml 3415 2007-05-31 07:33:52Z nicklas $
7 
8  Copyright (C) Authors contributing to this file.
9 
10  This file is part of BASE - BioArray Software Environment.
11  Available at http://base.thep.lu.se/
12 
13  BASE is free software; you can redistribute it and/or
14  modify it under the terms of the GNU General Public License
15  as published by the Free Software Foundation; either version 2
16  of the License, or (at your option) any later version.
17 
18  BASE is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  GNU General Public License for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with this program; if not, write to the Free Software
25  Foundation, Inc., 59 Temple Place - Suite 330,
26  Boston, MA  02111-1307, USA.
27-->
28
29<appendix id="appendix.incompatible">
30  <title>API changes that may affect backwards compatibility</title>
31  <para>
32    In this document we list all changes to code in the <emphasis>Public API</emphasis>
33    that may be backwards incompatible with existing client applications
34    and or plug-ins. See <xref linkend="api_overview.public_api" /> for more
35    information about what we mean with the <emphasis>Public API</emphasis>
36    and backwards compatible.
37  </para>
38 
39  <note>
40    <para>
41    There is no history for releases prior to BASE 2.2 because
42    we didn't actively keep track of them. We believe that if such
43    changes exists, they are minor and doesn't affect many plug-ins
44    since in those days very few 3rd-party plug-ins existed.
45    </para>
46  </note>
47 
48  <sect1 id="appendix.incompatible.2.3">
49    <title>BASE 2.3 release</title>
50   
51    <bridgehead>BASE 1 Plug-in executer</bridgehead>
52   
53    <para>
54      Changed to store information about plug-in parameters as XML in the
55      database instead of in the orignal BASE 1 plug-in definition file.
56      Existing BASE 1 plug-ins must be re-configured before they can be
57      used. To do this:
58    </para>
59   
60    <orderedlist>
61    <listitem>
62      <para>
63      Go to
64      <menuchoice>
65        <guimenu>Administrate</guimenu>
66        <guisubmenu>Plugins</guisubmenu>
67        <guimenuitem>Configurations</guimenuitem>
68      </menuchoice>
69      </para>
70    </listitem>
71    <listitem>
72      <para>
73      Step through the configuration wizard for all BASE 1 plug-in
74      configurations. You don't need to change any parameters.
75      Just click on the <guibutton>Next</guibutton> button
76      until the configuration is complete.
77      </para>
78    </listitem>
79    </orderedlist>
80  </sect1>
81
82  <sect1 id="appendix.incompatible.2.2">
83    <title>BASE 2.2 release</title>
84   
85    <bridgehead>BASE 1 Plug-in executer</bridgehead>
86   
87    <para>
88      No longer provides a default mapping between BASE 1 and BASE 2
89      raw data columns. To solve this add a <guilabel>Formula</guilabel>
90      item with the same name as the BASE 1 column name and an expression
91      that picks the BASE 2 raw data property. For example:
92    </para>
93   
94<literallayout>
95<guilabel>Name</guilabel>          BCh1Mean
96<guilabel>Type</guilabel>          Column expression
97<guilabel>Raw data type</guilabel> GenePix
98<guilabel>Channels</guilabel>      2
99<guilabel>Expressions</guilabel>   1: raw('ch1BgMean')
100</literallayout>
101
102  </sect1>
103
104</appendix>
105
Note: See TracBrowser for help on using the repository browser.