source: trunk/doc/src/docbook/developerdoc/core_ref.xml @ 3315

Last change on this file since 3315 was 3315, checked in by Nicklas Nordborg, 16 years ago

Synchronized table of contents for developer documentation with the draft.
Added links to the old documentation for all sections where this was possible.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 6.5 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter 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: core_ref.xml 3315 2007-05-09 12:35:11Z 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<chapter id="core_ref" chunked="0">
30  <?dbhtml dir="core_ref"?>
31  <title>Core developer reference</title>
32
33  <sect1 id="core_ref.procedures">
34    <title>Important procedures</title>
35    <para>
36      This documentation is only available in the old format.
37      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/index.html#rules"
38        >http://base.thep.lu.se/chrome/site/doc/development/index.html#rules</ulink>
39    </para>
40  </sect1>
41 
42  <sect1 id="core_ref.release">
43    <title>Publishing a new release</title>
44    <para>
45      This documentation is only available in the old format.
46      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/index.html#newrelease"
47        >http://base.thep.lu.se/chrome/site/doc/development/index.html#newrelease</ulink>
48    </para>
49  </sect1>
50 
51  <sect1 id="core_ref.build">
52    <title>Subversion / building BASE</title>
53    <para>
54      This documentation is only available in the old format.
55      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/build.html"
56        >http://base.thep.lu.se/chrome/site/doc/development/build.html</ulink>
57    </para>
58  </sect1>
59
60  <sect1 id="core_ref.rules">
61    <title>Coding rules and guidelines</title>
62   
63    <sect2 id="core_ref.rules.devprocess">
64      <title>Development process</title>
65      <para>
66        This documentation is only available in the old format.
67        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/process.html"
68          >http://base.thep.lu.se/chrome/site/doc/development/coding/process.html</ulink>
69      </para>
70    </sect2>
71    <sect2 id="core_ref.rules.style">
72      <title>General coding style guidelines</title>
73      <para>
74        This documentation is only available in the old format.
75        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/generic.html"
76          >http://base.thep.lu.se/chrome/site/doc/development/coding/generic.html</ulink>
77      </para>
78    </sect2>   
79    <sect2 id="core_ref.rules.compatibility">
80      <title>API changes and backwards compatibility</title>
81      <para>
82        TODO
83      </para>
84    </sect2>   
85    <sect2 id="core_ref.rules.datalayer">
86      <title>Data-layer rules</title>
87      <para>
88        This documentation is only available in the old format.
89        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/data/index.html"
90          >http://base.thep.lu.se/chrome/site/doc/development/coding/data/index.html</ulink>
91      </para>
92    </sect2>   
93    <sect2 id="core_ref.rules.itemclass">
94      <title>Item-class rules</title>
95      <para>
96        This documentation is only available in the old format.
97        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/coding/item/index.html"
98          >http://base.thep.lu.se/chrome/site/doc/development/coding/item/index.html</ulink>
99      </para>
100    </sect2>   
101    <sect2 id="core_ref.rules.batchclass">
102      <title>Batch-class rules</title>
103      <para>
104        TODO
105      </para>
106    </sect2>   
107    <sect2 id="core_ref.rules.testclass">
108      <title>Test-class rules</title>
109      <para>
110        TODO
111      </para>
112    </sect2>   
113  </sect1>
114 
115  <sect1 id="core_ref.coreinternals">
116    <title>Internals of the Core API</title>
117    <para>
118      This documentation is only available in the old format.
119      See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/index.html"
120        >http://base.thep.lu.se/chrome/site/doc/development/overview/core/index.html</ulink>
121    </para>
122    <sect2 id="core_ref.authentication">
123      <title>Authentication and sessions</title>
124      <para>
125        This documentation is only available in the old format.
126        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/authentication.html"
127          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/authentication.html</ulink>
128      </para>
129    </sect2>   
130    <sect2 id="core_ref.accesspermissions">
131      <title>Access permissions</title>
132      <para>
133        This documentation is only available in the old format.
134        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/accesspermissions.html"
135          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/accesspermissions.html</ulink>
136      </para>
137    </sect2>   
138    <sect2 id="core_ref.datavalidation">
139      <title>Data validation</title>
140      <para>
141        TODO
142      </para>
143    </sect2>   
144    <sect2 id="core_ref.transactions">
145      <title>Transaction handling</title>
146      <para>
147        TODO
148      </para>
149    </sect2>   
150    <sect2 id="core_ref.crwd">
151      <title>Create/read/write/delete operations</title>
152      <para>
153        This documentation is only available in the old format.
154        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/itemhandling.html"
155          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/itemhandling.html</ulink>
156      </para>
157    </sect2>   
158    <sect2 id="core_ref.batch">
159      <title>Batch operations</title>
160      <para>
161        This documentation is only available in the old format.
162        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/batchprocessing.html"
163          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/batchprocessing.html</ulink>
164      </para>
165    </sect2>   
166    <sect2 id="core_ref.quota">
167      <title>Quota</title>
168      <para>
169        TODO
170      </para>
171    </sect2>   
172    <sect2 id="core_ref.pluginexecution">
173      <title>Plugin execution / job queue</title>
174      <para>
175        This documentation is only available in the old format.
176        See <ulink url="http://base.thep.lu.se/chrome/site/doc/development/overview/core/plugins.html"
177          >http://base.thep.lu.se/chrome/site/doc/development/overview/core/plugins.html</ulink>
178      </para>
179    </sect2>   
180  </sect1>
181
182</chapter>
Note: See TracBrowser for help on using the repository browser.