doc/src/docbook/overview/resources.xml

Code
Comments
Other
Rev Date Author Line
3251 18 Apr 07 martin 1 <?xml version="1.0" encoding="UTF-8"?>
3251 18 Apr 07 martin 2 <!DOCTYPE chapter PUBLIC 
3251 18 Apr 07 martin 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3251 18 Apr 07 martin 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3251 18 Apr 07 martin 5 <!--
3251 18 Apr 07 martin 6   $Id$
3251 18 Apr 07 martin 7   
4889 06 Apr 09 nicklas 8   Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Nicklas Nordborg, Martin Svensson
3251 18 Apr 07 martin 9   
3251 18 Apr 07 martin 10   This file is part of BASE - BioArray Software Environment.
3251 18 Apr 07 martin 11   Available at http://base.thep.lu.se/
3251 18 Apr 07 martin 12   
3251 18 Apr 07 martin 13   BASE is free software; you can redistribute it and/or
3251 18 Apr 07 martin 14   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
3251 18 Apr 07 martin 16   of the License, or (at your option) any later version.
3251 18 Apr 07 martin 17   
3251 18 Apr 07 martin 18   BASE is distributed in the hope that it will be useful,
3251 18 Apr 07 martin 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3251 18 Apr 07 martin 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3251 18 Apr 07 martin 21   GNU General Public License for more details.
3251 18 Apr 07 martin 22   
3251 18 Apr 07 martin 23   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3251 18 Apr 07 martin 25 -->
3251 18 Apr 07 martin 26
3301 08 May 07 nicklas 27 <chapter id="resources" chunked="0">
5782 04 Oct 11 nicklas 28   <?dbhtml filename="resources.html"?>
3251 18 Apr 07 martin 29   <title>Resources</title>
3251 18 Apr 07 martin 30   <para>
4487 08 Sep 08 jari 31     There are several resources available for those who are using BASE
4487 08 Sep 08 jari 32     or have some other kind of interested in the BASE project. This
4487 08 Sep 08 jari 33     chapter contains information about those resources and also some
4487 08 Sep 08 jari 34     short instructions on how to use each one of them.
3251 18 Apr 07 martin 35   </para>
3255 19 Apr 07 martin 36   <sect1 id="resources.home_page">
3291 07 May 07 jari 37     <title>BASE project site</title>
3255 19 Apr 07 martin 38     <para>
3291 07 May 07 jari 39       The BASE project site is located at
7982 14 Jun 21 nicklas 40       <ulink url='https://base.thep.lu.se'>https://base.thep.lu.se</ulink>.
3291 07 May 07 jari 41       Here is a lot of useful information about the project and the program, e.g.
3255 19 Apr 07 martin 42       documentation/manuals, download-pages, contact information and much more. The most
3255 19 Apr 07 martin 43       important parts of the page are covered in this section.
3255 19 Apr 07 martin 44     </para>
3255 19 Apr 07 martin 45     <sect2 id="resources.home_page.download">
3251 18 Apr 07 martin 46       <title>Download</title>
3255 19 Apr 07 martin 47       <para>
3255 19 Apr 07 martin 48         The download page is accessed from the download section, on the home page, by
3255 19 Apr 07 martin 49         following the link to
7982 14 Jun 21 nicklas 50         <guilabel><ulink url='https://base.thep.lu.se/wiki/DownloadPage'
3304 08 May 07 nicklas 51           >Download Page</ulink></guilabel>. 
4487 08 Sep 08 jari 52         From this page you can download BASE releases as packaged tar.gz
3304 08 May 07 nicklas 53         files or checkout the source code directly from the Subversion repository. 
3304 08 May 07 nicklas 54         See the separate parts on the web page to get more information how to 
3304 08 May 07 nicklas 55         proceed with each one of them.
3304 08 May 07 nicklas 56         
3255 19 Apr 07 martin 57         <variablelist>
3255 19 Apr 07 martin 58           <varlistentry>
4487 08 Sep 08 jari 59             <term>Packaged BASE releases</term>
3304 08 May 07 nicklas 60             <listitem>
3304 08 May 07 nicklas 61               <para>
3304 08 May 07 nicklas 62                 Both source-packages and binary-packages are available for each release
3304 08 May 07 nicklas 63                 of the program.
3304 08 May 07 nicklas 64               </para>
3304 08 May 07 nicklas 65             </listitem>
3304 08 May 07 nicklas 66           </varlistentry>
3304 08 May 07 nicklas 67           <varlistentry>
3255 19 Apr 07 martin 68             <term>Repository access</term>
3255 19 Apr 07 martin 69             <listitem>
3255 19 Apr 07 martin 70               <para>
3255 19 Apr 07 martin 71                 With this option the visitor can get the source code directly from
3255 19 Apr 07 martin 72                 Subversion. There are at least three different version that are
3257 20 Apr 07 martin 73                 available to checkout from the repository.
3255 19 Apr 07 martin 74                 <itemizedlist>
3255 19 Apr 07 martin 75                   <listitem>
3255 19 Apr 07 martin 76                     <para>
3304 08 May 07 nicklas 77                       The latest production release. This will give you
3304 08 May 07 nicklas 78                       the same source code as one of the packaged
3304 08 May 07 nicklas 79                       releases.
3255 19 Apr 07 martin 80                     </para>
3255 19 Apr 07 martin 81                   </listitem>
3255 19 Apr 07 martin 82                   <listitem>
3255 19 Apr 07 martin 83                     <para>
3304 08 May 07 nicklas 84                       The latest non-released bugfix branch. Use this if
3304 08 May 07 nicklas 85                       you are affected by a bug that has been fixed but not
3304 08 May 07 nicklas 86                       yet released. 
3255 19 Apr 07 martin 87                     </para>
3255 19 Apr 07 martin 88                   </listitem>
3255 19 Apr 07 martin 89                   <listitem>
3255 19 Apr 07 martin 90                     <para>
3304 08 May 07 nicklas 91                       Bleeding edge of the software, which is the latest
3304 08 May 07 nicklas 92                       revision of the program. The code is not guaranteed to
3304 08 May 07 nicklas 93                       work correctly and it is recommended to backup important
3304 08 May 07 nicklas 94                       data in the database before updating. Use this at your own
3487 13 Jun 07 peter 95                       risk, we cannot guarantee that you will be able to upgrade
3304 08 May 07 nicklas 96                       the installation to another version or release.
3255 19 Apr 07 martin 97                     </para>
3255 19 Apr 07 martin 98                   </listitem>
3255 19 Apr 07 martin 99                 </itemizedlist>
3255 19 Apr 07 martin 100               </para>
3255 19 Apr 07 martin 101             </listitem>
3255 19 Apr 07 martin 102           </varlistentry>
3255 19 Apr 07 martin 103         </variablelist>
3255 19 Apr 07 martin 104       </para>
3251 18 Apr 07 martin 105     </sect2>
3255 19 Apr 07 martin 106     <sect2 id="resources.home_page.tickets">
3251 18 Apr 07 martin 107       <title>Ticket system</title>
3304 08 May 07 nicklas 108
3255 19 Apr 07 martin 109       <para>
3304 08 May 07 nicklas 110         A ticket is a note about a bug or a new feature that has not yet been
3304 08 May 07 nicklas 111         implemented. To show the list of outstanding tickets use the
7982 14 Jun 21 nicklas 112         <guibutton><ulink url="https://base.thep.lu.se/query"
4487 08 Sep 08 jari 113           >View Tickets</ulink></guibutton> button on BASE web site. 
3304 08 May 07 nicklas 114         It is a good idea to have a look at this list before reporting a bug
3257 20 Apr 07 martin 115         or requesting a new feature. Perhaps someone has registered the issue as a ticket
4487 08 Sep 08 jari 116         already. This list can also be used to see how the BASE development is proceeding
3577 19 Jul 07 peter 117         and when some particular request is planned to be fixed.
3255 19 Apr 07 martin 118       </para>
3255 19 Apr 07 martin 119
3255 19 Apr 07 martin 120       <para>
3304 08 May 07 nicklas 121         To report bugs, add feature requests, and comment an existing ticket, you needs to
3304 08 May 07 nicklas 122         be logged in to the trac environment. This is done by clicking on the 
3304 08 May 07 nicklas 123         <guilabel>login</guilabel>-link to
3304 08 May 07 nicklas 124         the right in the upper corner on the home page. The <guilabel>Feedback</guilabel>-section, 
3304 08 May 07 nicklas 125         also on the home page, contains more information how to proceed.
3255 19 Apr 07 martin 126       </para>
3304 08 May 07 nicklas 127     </sect2>
3304 08 May 07 nicklas 128     <sect2 id="resources.home_page.roadmap">
3304 08 May 07 nicklas 129       <title>Roadmap</title>
3255 19 Apr 07 martin 130
3255 19 Apr 07 martin 131       <para>
4487 08 Sep 08 jari 132         The roadmap of BASE is accessed from the 
7982 14 Jun 21 nicklas 133         <guibutton><ulink url="https://base.thep.lu.se/roadmap"
3304 08 May 07 nicklas 134           >Roadmap</ulink></guibutton> button on the home page. This page 
3304 08 May 07 nicklas 135         contains information about the plans for future development, including
3304 08 May 07 nicklas 136         the tickets that should be fixed for each milestone. Usually, only
5864 10 Nov 11 nicklas 137         the next upcoming release has a date set. The <guilabel>BASE Future Release</guilabel>
3304 08 May 07 nicklas 138         milestone is used to collected tickets that we think should be fixed
3304 08 May 07 nicklas 139         but are less important or require too much work. Contributions are welcome.
3255 19 Apr 07 martin 140       </para>
3255 19 Apr 07 martin 141
3251 18 Apr 07 martin 142     </sect2>
3255 19 Apr 07 martin 143     <sect2 id="resources.home_page.documentation">
3251 18 Apr 07 martin 144       <title>Documentation</title>
3255 19 Apr 07 martin 145       <para>
3255 19 Apr 07 martin 146         All documentation that are associated with the project can be found in the
3255 19 Apr 07 martin 147         Documentation-section on the start page.
3255 19 Apr 07 martin 148         <variablelist>
3255 19 Apr 07 martin 149           <varlistentry>
3255 19 Apr 07 martin 150             <term>Manuals</term>
3255 19 Apr 07 martin 151             <listitem>
3255 19 Apr 07 martin 152               <para>
3257 20 Apr 07 martin 153                 Useful information for the common user and the administrator, like
3255 19 Apr 07 martin 154                 user documentation, installation instructions and administration
3257 20 Apr 07 martin 155                 guide. These different documents will eventually be replaced with
3257 20 Apr 07 martin 156                 this document when it includes the corresponding texts.
3255 19 Apr 07 martin 157               </para>
3255 19 Apr 07 martin 158             </listitem>
3255 19 Apr 07 martin 159           </varlistentry>
3255 19 Apr 07 martin 160           <varlistentry>
3255 19 Apr 07 martin 161             <term>Specifications</term>
3255 19 Apr 07 martin 162             <listitem>
3255 19 Apr 07 martin 163               <para>
3257 20 Apr 07 martin 164                 This part contains specification for the separate divisions of the
3255 19 Apr 07 martin 165                 project, such as core specification, web-client specification and
3255 19 Apr 07 martin 166                 more.
3255 19 Apr 07 martin 167               </para>
3255 19 Apr 07 martin 168             </listitem>
3255 19 Apr 07 martin 169           </varlistentry>
3255 19 Apr 07 martin 170           <varlistentry>
3255 19 Apr 07 martin 171             <term>Developer information</term>
3255 19 Apr 07 martin 172             <listitem>
3255 19 Apr 07 martin 173               <para>
3255 19 Apr 07 martin 174                 Information for those who are interested to be involved in the
4487 08 Sep 08 jari 175                 development of BASE.
3255 19 Apr 07 martin 176               </para>
3255 19 Apr 07 martin 177             </listitem>
3255 19 Apr 07 martin 178           </varlistentry>
3257 20 Apr 07 martin 179           <varlistentry>
3257 20 Apr 07 martin 180             <term>Future development</term>
3257 20 Apr 07 martin 181             <listitem>
3257 20 Apr 07 martin 182               <para>
3487 13 Jun 07 peter 183                 Link to a list of ideas for future development that are not covered
3257 20 Apr 07 martin 184                 and monitored in the milestones on the road map page. In other words
3257 20 Apr 07 martin 185                 - ideas that are not planned to be done within nearest 6 to 12
3257 20 Apr 07 martin 186                 month.
3257 20 Apr 07 martin 187               </para>
3257 20 Apr 07 martin 188             </listitem>
3257 20 Apr 07 martin 189           </varlistentry>
3255 19 Apr 07 martin 190         </variablelist>
3255 19 Apr 07 martin 191       </para>
3251 18 Apr 07 martin 192     </sect2>
3251 18 Apr 07 martin 193   </sect1>
3255 19 Apr 07 martin 194   <sect1 id="resources.plugins">
3255 19 Apr 07 martin 195     <title>BASE plug-ins site</title>
3257 20 Apr 07 martin 196     <para>
4487 08 Sep 08 jari 197       Plug-ins which are not included in the installation of BASE, have their own site,
3257 20 Apr 07 martin 198       called
7982 14 Jun 21 nicklas 199       <ulink url="https://baseplugins.thep.lu.se/">BASE plug-ins web site</ulink>
4218 11 Apr 08 nicklas 200       which includes a download page for submitted none-core plug-ins.       
4218 11 Apr 08 nicklas 201       Here is also information how to become a plug-in developer, with 
4218 11 Apr 08 nicklas 202       commit access to the repository, and how to submit a plug-in to the 
4218 11 Apr 08 nicklas 203       download page. You will also be able to find example
6465 04 Jun 14 nicklas 204       code for plug-ins, extensions, etc.
3257 20 Apr 07 martin 205     </para>
3255 19 Apr 07 martin 206   </sect1>
3255 19 Apr 07 martin 207   <sect1 id="resources.demo_server">
3251 18 Apr 07 martin 208     <title>Demo server</title>
3257 20 Apr 07 martin 209     <para>
4487 08 Sep 08 jari 210       There is a demo server up running for anyone who wants to
4487 08 Sep 08 jari 211       explore BASE without having to install it. Follow the link on
4487 08 Sep 08 jari 212       BASE web site to the demo server or go directly to
7982 14 Jun 21 nicklas 213       <ulink url="https://base.onk.lu.se/demo/">
7982 14 Jun 21 nicklas 214         https://base.onk.lu.se/demo/
6576 22 Oct 14 nicklas 215       </ulink>. NOTE! The demo server is currently down!
3257 20 Apr 07 martin 216     </para>
3257 20 Apr 07 martin 217     <para>
3699 22 Aug 07 jari 218       Use <userinput>base2</userinput> as login
3699 22 Aug 07 jari 219       and <userinput>base2</userinput> as password to login to the
3699 22 Aug 07 jari 220       demo server. The base2 user account has read privileges to all
3699 22 Aug 07 jari 221       data on the demo server and can view almost every list page. If
3699 22 Aug 07 jari 222       extended privileges are wanted, please contact the administrator
3699 22 Aug 07 jari 223       of the demo server (see the bottom of the browser when visiting
3699 22 Aug 07 jari 224       the demo server).
3257 20 Apr 07 martin 225     </para>
3251 18 Apr 07 martin 226   </sect1>
3255 19 Apr 07 martin 227   <sect1 id="resources.mailing_lists">
3251 18 Apr 07 martin 228     <title>Mailing lists</title>
3257 20 Apr 07 martin 229     <para>
3257 20 Apr 07 martin 230       BASE project has three different mailing lists available for subscription. Visit the
7982 14 Jun 21 nicklas 231       <ulink url="https://base.thep.lu.se/wiki/MailingLists">mailing list page</ulink>
3257 20 Apr 07 martin 232       to get more information about each one of the mailing lists. All posted mails are saved
3257 20 Apr 07 martin 233       in an archive for each list, it can therefore be a good idea to have a look here before
3257 20 Apr 07 martin 234       posting a new thread.
3257 20 Apr 07 martin 235     </para>
3257 20 Apr 07 martin 236     <para>
3257 20 Apr 07 martin 237       These are the available mailing lists, more details about each one of them can be found
3257 20 Apr 07 martin 238       on the mailing list page.
3257 20 Apr 07 martin 239       <itemizedlist>
3257 20 Apr 07 martin 240         <listitem>
3257 20 Apr 07 martin 241           <para>basedb-users</para>
3257 20 Apr 07 martin 242         </listitem>
3257 20 Apr 07 martin 243         <listitem>
3257 20 Apr 07 martin 244           <para>basedb-devel</para>
3257 20 Apr 07 martin 245         </listitem>
3257 20 Apr 07 martin 246         <listitem>
3257 20 Apr 07 martin 247           <para>basedb-announce</para>
3257 20 Apr 07 martin 248         </listitem>
3257 20 Apr 07 martin 249       </itemizedlist>
3257 20 Apr 07 martin 250     </para>
3251 18 Apr 07 martin 251   </sect1>
3775 25 Sep 07 enell 252
3775 25 Sep 07 enell 253   <sect1 id="resources.basehacks">
3775 25 Sep 07 enell 254     <title>BASE-hacks</title>
3775 25 Sep 07 enell 255     <para>
3775 25 Sep 07 enell 256       There is a trac/subversion server keeping track of changes made
3775 25 Sep 07 enell 257       to third party projects that are changed to make them work with
3775 25 Sep 07 enell 258       BASE. Open source project usually have a requirement that
3775 25 Sep 07 enell 259       changes are made public. On
3775 25 Sep 07 enell 260       the <ulink
4150 20 Feb 08 martin 261       url='http://dev.thep.lu.se/basehacks'>BASE-hacks web
3775 25 Sep 07 enell 262       site</ulink> you will find a list of modified packages and
3775 25 Sep 07 enell 263       information about the changes performed.
3775 25 Sep 07 enell 264     </para>
3775 25 Sep 07 enell 265   </sect1>
3775 25 Sep 07 enell 266
3291 07 May 07 jari 267 </chapter>

Generated on Sat Oct  7 02:27:24 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)