doc/src/docbook/user/file_system.xml

Code
Comments
Other
Rev Date Author Line
3157 05 Mar 07 martin 1 <?xml version="1.0" encoding="UTF-8"?>
3159 05 Mar 07 martin 2 <!DOCTYPE chapter PUBLIC 
3159 05 Mar 07 martin 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3192 13 Mar 07 martin 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3157 05 Mar 07 martin 5 <!--
3192 13 Mar 07 martin 6   $Id$
3203 22 Mar 07 martin 7   
3675 16 Aug 07 jari 8   Copyright (C) 2007 Peter Johansson, Nicklas Nordborg, Martin Svensson
3203 22 Mar 07 martin 9   
3157 05 Mar 07 martin 10   This file is part of BASE - BioArray Software Environment.
3157 05 Mar 07 martin 11   Available at http://base.thep.lu.se/
3203 22 Mar 07 martin 12   
3157 05 Mar 07 martin 13   BASE is free software; you can redistribute it and/or
3157 05 Mar 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
3157 05 Mar 07 martin 16   of the License, or (at your option) any later version.
3203 22 Mar 07 martin 17   
3157 05 Mar 07 martin 18   BASE is distributed in the hope that it will be useful,
3157 05 Mar 07 martin 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3157 05 Mar 07 martin 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3157 05 Mar 07 martin 21   GNU General Public License for more details.
3203 22 Mar 07 martin 22   
3157 05 Mar 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/>.
3157 05 Mar 07 martin 25 -->
3157 05 Mar 07 martin 26
3161 06 Mar 07 martin 27 <chapter id="file_system">
5782 04 Oct 11 nicklas 28   <?dbhtml dir="files" filename="index.html" ?>
3203 22 Mar 07 martin 29   <title>File management</title>
3215 26 Mar 07 martin 30   <sect1 id="file_system.system">
5782 04 Oct 11 nicklas 31     <?dbhtml filename="filesystem.html" ?>
3203 22 Mar 07 martin 32     <title>File system</title>
3215 26 Mar 07 martin 33     <para>
4487 08 Sep 08 jari 34       Files in BASE are managed from the page at
3215 26 Mar 07 martin 35       <menuchoice>
3215 26 Mar 07 martin 36         <guimenu>View</guimenu>
3215 26 Mar 07 martin 37         <guimenuitem>Files</guimenuitem>
3343 16 May 07 nicklas 38       </menuchoice>. The basic layout on the page is the same as for all the other list pages 
4487 08 Sep 08 jari 39       in BASE but
3218 28 Mar 07 martin 40       there are some differences e.g. there is a navigation tree to the left, used to browse
3218 28 Mar 07 martin 41       the directory structure, and there are some buttons in the toolbar, that are special for
3218 28 Mar 07 martin 42       files and directories. The figure below is a representation of the files and
3218 28 Mar 07 martin 43       directories-page and is followed with a short description to some of the special
3224 02 Apr 07 martin 44       functions.
3215 26 Mar 07 martin 45     </para>
3215 26 Mar 07 martin 46     <figure id="file.system.figures.filepage">
3215 26 Mar 07 martin 47       <title>The file page</title>
3215 26 Mar 07 martin 48       <screenshot>
3215 26 Mar 07 martin 49         <mediaobject>
3215 26 Mar 07 martin 50           <imageobject>
3405 29 May 07 nicklas 51             <imagedata fileref="figures/filepage.png" format="PNG" 
3405 29 May 07 nicklas 52             scalefit="1" width="100%" />
3215 26 Mar 07 martin 53           </imageobject>
3215 26 Mar 07 martin 54         </mediaobject>
3215 26 Mar 07 martin 55       </screenshot>
3215 26 Mar 07 martin 56     </figure>
3215 26 Mar 07 martin 57     <variablelist>
3215 26 Mar 07 martin 58       <varlistentry>
3215 26 Mar 07 martin 59         <term>
3224 02 Apr 07 martin 60           <interface>1. Home directory for current user</interface>
3215 26 Mar 07 martin 61         </term>
3215 26 Mar 07 martin 62         <listitem>
3215 26 Mar 07 martin 63           <para>
3218 28 Mar 07 martin 64             This is the logged in user's home directory with sub directories. It is
3343 16 May 07 nicklas 65             visible if the current user has a home directory and is then always located at
5794 07 Oct 11 nicklas 66             the top of the navigation tree. Click on a directory to display it's contents to the right
3343 16 May 07 nicklas 67             or click on the plus sign to expand the directory and view the
5794 07 Oct 11 nicklas 68             sub directories. Note that the directory tree is lazily loaded. Subdirectories
5794 07 Oct 11 nicklas 69             that hasn't yet been opened have light gray icon which is removed if they
5794 07 Oct 11 nicklas 70             turn out to be empty.
3215 26 Mar 07 martin 71           </para>
5794 07 Oct 11 nicklas 72           
5794 07 Oct 11 nicklas 73           <note>
5794 07 Oct 11 nicklas 74             <para>
5794 07 Oct 11 nicklas 75               A directory can only be opened from the navigation tree or from the directory
5794 07 Oct 11 nicklas 76               icon in the list. A click on a directory's name in the list will open the 
5794 07 Oct 11 nicklas 77               directory's edit window.
5794 07 Oct 11 nicklas 78             </para>
5794 07 Oct 11 nicklas 79           </note>
5794 07 Oct 11 nicklas 80           
3215 26 Mar 07 martin 81         </listitem>
3215 26 Mar 07 martin 82       </varlistentry>
3215 26 Mar 07 martin 83
3215 26 Mar 07 martin 84       <varlistentry>
3215 26 Mar 07 martin 85         <term>
3218 28 Mar 07 martin 86           <interface>2. Other users</interface>
3215 26 Mar 07 martin 87         </term>
3215 26 Mar 07 martin 88         <listitem>
3218 28 Mar 07 martin 89           <para>
3343 16 May 07 nicklas 90             The other users' home directories that the current user has permission
5794 07 Oct 11 nicklas 91             to read are listed here.
3218 28 Mar 07 martin 92           </para>
5794 07 Oct 11 nicklas 93           <note>
5794 07 Oct 11 nicklas 94             <title>Missing directory?</title>
5794 07 Oct 11 nicklas 95             <para>
5794 07 Oct 11 nicklas 96               Not all users have a home directory connected to their accounts. If
5794 07 Oct 11 nicklas 97               a user is missing, it most certainly depends on that the user account
5794 07 Oct 11 nicklas 98               have not got a home directory. Home directories are managed by the 
5794 07 Oct 11 nicklas 99               administrator of the BASE server.
5794 07 Oct 11 nicklas 100             </para>
5794 07 Oct 11 nicklas 101           </note>
3215 26 Mar 07 martin 102         </listitem>
3215 26 Mar 07 martin 103       </varlistentry>
3215 26 Mar 07 martin 104
3215 26 Mar 07 martin 105       <varlistentry>
3215 26 Mar 07 martin 106         <term>
5179 04 Nov 09 nicklas 107           <interface>3. Button toolbar</interface>
3215 26 Mar 07 martin 108         </term>
3215 26 Mar 07 martin 109         <listitem>
3218 28 Mar 07 martin 110           <para>
5179 04 Nov 09 nicklas 111             The button toolbar contains functions that are relevent for the 
5179 04 Nov 09 nicklas 112             navigation tree. Use the <guibutton>Refresh</guibutton> button
5179 04 Nov 09 nicklas 113             to update the directory tree, for example, after creating a new
5179 04 Nov 09 nicklas 114             subdirectory. Use the <guibutton>Search</guibutton> button to
5179 04 Nov 09 nicklas 115             search for files and directories no matter where they are located.
5179 04 Nov 09 nicklas 116             The search form is displayed to the right and is the same as the
5179 04 Nov 09 nicklas 117             usual file and directory listing, except that it will not show
5179 04 Nov 09 nicklas 118             any files if there is no filter.
3218 28 Mar 07 martin 119           </para>
3215 26 Mar 07 martin 120         </listitem>
3215 26 Mar 07 martin 121       </varlistentry>
3215 26 Mar 07 martin 122
3215 26 Mar 07 martin 123       <varlistentry>
3215 26 Mar 07 martin 124         <term>
3215 26 Mar 07 martin 125           <interface>4. Current directory</interface>
3215 26 Mar 07 martin 126         </term>
3215 26 Mar 07 martin 127         <listitem>
4487 08 Sep 08 jari 128           <para>Shows the full BASE path to current directory.</para>
3215 26 Mar 07 martin 129         </listitem>
3215 26 Mar 07 martin 130       </varlistentry>
3215 26 Mar 07 martin 131
3215 26 Mar 07 martin 132       <varlistentry>
3215 26 Mar 07 martin 133         <term>
3218 28 Mar 07 martin 134           <interface>5. View a file's contents</interface>
3215 26 Mar 07 martin 135         </term>
3215 26 Mar 07 martin 136         <listitem>
3218 28 Mar 07 martin 137           <para>
3218 28 Mar 07 martin 138             A click on this icon will open the file's contents in a new window. If the
3487 13 Jun 07 peter 139             browser does not has support to view the file there will be a dialog window
3224 02 Apr 07 martin 140             to download the file instead.
3218 28 Mar 07 martin 141           </para>
3215 26 Mar 07 martin 142         </listitem>
3215 26 Mar 07 martin 143       </varlistentry>
3215 26 Mar 07 martin 144
3215 26 Mar 07 martin 145       <varlistentry>
3215 26 Mar 07 martin 146         <term>
3215 26 Mar 07 martin 147           <interface>6. Download file</interface>
3215 26 Mar 07 martin 148         </term>
3215 26 Mar 07 martin 149         <listitem>
3218 28 Mar 07 martin 150           <para>
3224 02 Apr 07 martin 151             Download the file to a local computer with this icon. The download will
3224 02 Apr 07 martin 152             start in a new dialog window.
3218 28 Mar 07 martin 153           </para>
3215 26 Mar 07 martin 154         </listitem>
3215 26 Mar 07 martin 155       </varlistentry>
3215 26 Mar 07 martin 156
3215 26 Mar 07 martin 157       <varlistentry>
3215 26 Mar 07 martin 158         <term>
3218 28 Mar 07 martin 159           <interface>7. Re-upload a file</interface>
3215 26 Mar 07 martin 160         </term>
3215 26 Mar 07 martin 161         <listitem>
3218 28 Mar 07 martin 162           <para>
3218 28 Mar 07 martin 163             This icon is only visible for those files that have been moved offline and
5794 07 Oct 11 nicklas 164             can be used to re-upload the file to the BASE. Start to
3224 02 Apr 07 martin 165             upload the file to the same position by clicking on the icon.
3218 28 Mar 07 martin 166           </para>
3343 16 May 07 nicklas 167           
3343 16 May 07 nicklas 168           <note>
3343 16 May 07 nicklas 169             <title>Replace an existing file</title>
3343 16 May 07 nicklas 170             <para>
4487 08 Sep 08 jari 171               It is possible to re-upload file that are on-line, but this
3343 16 May 07 nicklas 172               has to be done from the single-item view.
3343 16 May 07 nicklas 173             </para>
3343 16 May 07 nicklas 174           </note>
3215 26 Mar 07 martin 175         </listitem>
3215 26 Mar 07 martin 176       </varlistentry>
3215 26 Mar 07 martin 177     </variablelist>
3215 26 Mar 07 martin 178
3255 19 Apr 07 martin 179     <sect2 id="file_system.system.quota">
3218 28 Mar 07 martin 180       <title>Disk space quota</title>
3218 28 Mar 07 martin 181       <para>
4487 08 Sep 08 jari 182         Normally, a user is assigned limited disk space for files. 
3224 02 Apr 07 martin 183         More information about how much quota the current account has and how much of it
3224 02 Apr 07 martin 184         that is occupied can be found at the account's home page, described in
3343 16 May 07 nicklas 185         <xref linkend="webclient.intro.homepage" />.
5794 07 Oct 11 nicklas 186         See also <xref linkend="accounts.quota" /> for more information about 
3343 16 May 07 nicklas 187         the quota system.
3343 16 May 07 nicklas 188       </para>
3203 22 Mar 07 martin 189     </sect2>
3203 22 Mar 07 martin 190   </sect1>
3203 22 Mar 07 martin 191
3215 26 Mar 07 martin 192   <sect1 id="file_system.handling">
5782 04 Oct 11 nicklas 193     <?dbhtml filename="files.html" ?>
3203 22 Mar 07 martin 194     <title>Handling files</title>
3343 16 May 07 nicklas 195     
3215 26 Mar 07 martin 196     <sect2 id="file_system.handling.upload">
3343 16 May 07 nicklas 197       <title>Upload a new file</title>
3224 02 Apr 07 martin 198       <para>
3252 18 Apr 07 martin 199         Uploading a file is started by clicking on
3224 02 Apr 07 martin 200         <guibutton>Upload file&hellip;</guibutton>
3224 02 Apr 07 martin 201         in the toolbar. The uploaded file will be placed in current directory.
3224 02 Apr 07 martin 202       </para>
3343 16 May 07 nicklas 203       
3343 16 May 07 nicklas 204       <figure id="file_system.figures.upload">
3343 16 May 07 nicklas 205         <title>Upload new file</title>
3343 16 May 07 nicklas 206         <screenshot>
3343 16 May 07 nicklas 207           <mediaobject>
3343 16 May 07 nicklas 208             <imageobject><imagedata 
3343 16 May 07 nicklas 209               fileref="figures/upload_file.png" format="PNG"
3343 16 May 07 nicklas 210               /></imageobject>
3343 16 May 07 nicklas 211           </mediaobject>
3343 16 May 07 nicklas 212         </screenshot>
3343 16 May 07 nicklas 213       </figure>
3343 16 May 07 nicklas 214       
3208 23 Mar 07 martin 215       <helptext external_id="file.upload" title="Upload a file">
3224 02 Apr 07 martin 216         <para>
3224 02 Apr 07 martin 217           <variablelist>
3224 02 Apr 07 martin 218             <varlistentry>
3224 02 Apr 07 martin 219               <term>
3224 02 Apr 07 martin 220                 <guilabel>Directory</guilabel>
3224 02 Apr 07 martin 221               </term>
3224 02 Apr 07 martin 222               <listitem>
3224 02 Apr 07 martin 223                 <para>
3224 02 Apr 07 martin 224                   Shows the current directory, where the file will be uploaded.
3487 13 Jun 07 peter 225                   This property cannot be changed and is only for information.
3224 02 Apr 07 martin 226                 </para>
3224 02 Apr 07 martin 227               </listitem>
3224 02 Apr 07 martin 228             </varlistentry>
3224 02 Apr 07 martin 229             <varlistentry>
3224 02 Apr 07 martin 230               <term>
3224 02 Apr 07 martin 231                 <guilabel>File</guilabel>
3224 02 Apr 07 martin 232               </term>
3224 02 Apr 07 martin 233               <listitem>
3224 02 Apr 07 martin 234                 <para>
3224 02 Apr 07 martin 235                   This field is required and needs to have a valid file path for
3224 02 Apr 07 martin 236                   the local computer before the upload is started. Use
3224 02 Apr 07 martin 237                   <guibutton>Browse&hellip;</guibutton>
3224 02 Apr 07 martin 238                   to choose which file to upload.
3224 02 Apr 07 martin 239                 </para>
3224 02 Apr 07 martin 240               </listitem>
3224 02 Apr 07 martin 241             </varlistentry>
3224 02 Apr 07 martin 242             <varlistentry>
3224 02 Apr 07 martin 243               <term>
4570 08 Oct 08 martin 244                 <guilabel>Replace existing</guilabel>
4570 08 Oct 08 martin 245               </term>
4570 08 Oct 08 martin 246               <listitem>
4570 08 Oct 08 martin 247                 <para>
4570 08 Oct 08 martin 248                   Tick this checkbox if you want to overwrite an existing file
4570 08 Oct 08 martin 249                   that has the same name as the one you are going to upload.
5794 07 Oct 11 nicklas 250                   In contrast with other items, file names must be unique since
5794 07 Oct 11 nicklas 251                   they are often referenced by name.
4570 08 Oct 08 martin 252                 </para>
4570 08 Oct 08 martin 253               </listitem>
4570 08 Oct 08 martin 254             </varlistentry>
4570 08 Oct 08 martin 255             <varlistentry>
4570 08 Oct 08 martin 256               <term>
3463 07 Jun 07 nicklas 257                 <guilabel>Write protected</guilabel>
3463 07 Jun 07 nicklas 258               </term>
3463 07 Jun 07 nicklas 259               <listitem>
3463 07 Jun 07 nicklas 260                 <para>
3463 07 Jun 07 nicklas 261                   Mark this checkbox if you want the file to be write 
3487 13 Jun 07 peter 262                   protected. A write protected file cannot be deleted,
3463 07 Jun 07 nicklas 263                   moved offline or replaced with another file. It is
3463 07 Jun 07 nicklas 264                   still possible to change other metadata, such as
3463 07 Jun 07 nicklas 265                   the name, description, file type, MIME type, etc.
3463 07 Jun 07 nicklas 266                 </para>
3463 07 Jun 07 nicklas 267               </listitem>
3463 07 Jun 07 nicklas 268             </varlistentry>
3463 07 Jun 07 nicklas 269             <varlistentry>
3463 07 Jun 07 nicklas 270               <term>
3719 12 Sep 07 nicklas 271                 <guilabel>Store compressed</guilabel>
3719 12 Sep 07 nicklas 272               </term>
3719 12 Sep 07 nicklas 273               <listitem>
3719 12 Sep 07 nicklas 274                 <para>
3719 12 Sep 07 nicklas 275                   You can select if you want BASE to store your file in a 
3719 12 Sep 07 nicklas 276                   compressed format or in it's normal format. Compressing
3719 12 Sep 07 nicklas 277                   the file may save a lot of disk space and it also uses
3719 12 Sep 07 nicklas 278                   less quota. There are three options:
3719 12 Sep 07 nicklas 279                   <itemizedlist>
3719 12 Sep 07 nicklas 280                   <listitem>
3719 12 Sep 07 nicklas 281                     <para>
3719 12 Sep 07 nicklas 282                       <guilabel>auto</guilabel>: Let BASE automatically
3719 12 Sep 07 nicklas 283                       decide if the file should be compressed or not. The file
3719 12 Sep 07 nicklas 284                       is compressed if (1): it is uploaded to a directory that
3719 12 Sep 07 nicklas 285                       has the <emphasis>compress files</emphasis> flag set
3719 12 Sep 07 nicklas 286                       or (2): if the matching MIME type has the 
3719 12 Sep 07 nicklas 287                       <emphasis>compress files</emphasis> flag set.
3719 12 Sep 07 nicklas 288                     </para>
3719 12 Sep 07 nicklas 289                   </listitem>
3719 12 Sep 07 nicklas 290                   <listitem>
3719 12 Sep 07 nicklas 291                     <para>
3719 12 Sep 07 nicklas 292                       <guilabel>yes</guilabel>: Store the file in a compressed
3719 12 Sep 07 nicklas 293                       format.
3719 12 Sep 07 nicklas 294                     </para>
3719 12 Sep 07 nicklas 295                   </listitem>
3719 12 Sep 07 nicklas 296                   <listitem>
3719 12 Sep 07 nicklas 297                     <para>
3719 12 Sep 07 nicklas 298                       <guilabel>no</guilabel>: Store the file in it's normal format.
3719 12 Sep 07 nicklas 299                     </para>
3719 12 Sep 07 nicklas 300                   </listitem>
3719 12 Sep 07 nicklas 301                   </itemizedlist>
3719 12 Sep 07 nicklas 302                   
3719 12 Sep 07 nicklas 303                 </para>
3719 12 Sep 07 nicklas 304               </listitem>
3719 12 Sep 07 nicklas 305             </varlistentry>
3719 12 Sep 07 nicklas 306             <varlistentry>
3719 12 Sep 07 nicklas 307               <term>
3224 02 Apr 07 martin 308                 <guilabel>Type</guilabel>
3224 02 Apr 07 martin 309               </term>
3224 02 Apr 07 martin 310               <listitem>
3224 02 Apr 07 martin 311                 <para>
3489 13 Jun 07 nicklas 312                   This is the file-type that the uploaded file should get. 
5705 22 Aug 11 nicklas 313                   Select <userinput>- none -</userinput>
3487 13 Jun 07 peter 314                   if the file should not be associated with any file type.
3224 02 Apr 07 martin 315                 </para>
3224 02 Apr 07 martin 316               </listitem>
3224 02 Apr 07 martin 317             </varlistentry>
3224 02 Apr 07 martin 318             <varlistentry>
3224 02 Apr 07 martin 319               <term>
5794 07 Oct 11 nicklas 320                 <guilabel>Character set</guilabel>
5794 07 Oct 11 nicklas 321               </term>
5794 07 Oct 11 nicklas 322               <listitem>
5794 07 Oct 11 nicklas 323                 <para>
5794 07 Oct 11 nicklas 324                   If you are uploading a text file, it may be a good idea to select the
5794 07 Oct 11 nicklas 325                   character set used for the file. The most common character set is
5794 07 Oct 11 nicklas 326                   UTF-8 or ISO-8859-1. It may be important to get this setting correct if
5794 07 Oct 11 nicklas 327                   you are going to import data from the file later.
5794 07 Oct 11 nicklas 328                 </para>
5794 07 Oct 11 nicklas 329               </listitem>
5794 07 Oct 11 nicklas 330             </varlistentry>
5794 07 Oct 11 nicklas 331             <varlistentry>
5794 07 Oct 11 nicklas 332               <term>
3224 02 Apr 07 martin 333                 <guilabel>Description</guilabel>
3224 02 Apr 07 martin 334               </term>
3224 02 Apr 07 martin 335               <listitem>
3224 02 Apr 07 martin 336                 <para>
3224 02 Apr 07 martin 337                   A description about the uploaded file can be put into this text
3224 02 Apr 07 martin 338                   area. Use the magnifying glass to edit the text in a pop-up
3224 02 Apr 07 martin 339                   window with a larger text area.
3224 02 Apr 07 martin 340                 </para>
3224 02 Apr 07 martin 341               </listitem>
3224 02 Apr 07 martin 342             </varlistentry>
3224 02 Apr 07 martin 343             <varlistentry>
3224 02 Apr 07 martin 344               <term>
3224 02 Apr 07 martin 345                 <guilabel>Max transfer rate</guilabel>
3224 02 Apr 07 martin 346               </term>
3224 02 Apr 07 martin 347               <listitem>
3224 02 Apr 07 martin 348                 <para>
3224 02 Apr 07 martin 349                   This shows the maximum transfer rate that the upload will
3343 16 May 07 nicklas 350                   approximately reach. The transfer rate is set by the
3487 13 Jun 07 peter 351                   server admin and cannot be changed.
3224 02 Apr 07 martin 352                 </para>
3224 02 Apr 07 martin 353               </listitem>
3224 02 Apr 07 martin 354             </varlistentry>
3224 02 Apr 07 martin 355             <varlistentry>
3224 02 Apr 07 martin 356               <term>
3224 02 Apr 07 martin 357                 <guilabel>Compressed file</guilabel>
3224 02 Apr 07 martin 358               </term>
3224 02 Apr 07 martin 359               <listitem>
3224 02 Apr 07 martin 360                 <para>
3343 16 May 07 nicklas 361                   These settings are only active if you select
3343 16 May 07 nicklas 362                   a compressed file format that BASE knows how to
3563 16 Jul 07 nicklas 363                   unpack. BASE ships with support for some of the most common
3563 16 Jul 07 nicklas 364                   compressed file formats, such as zip and tar,
3343 16 May 07 nicklas 365                   but this can be extended by the use of plug-ins. 
3343 16 May 07 nicklas 366                   <nohelp>See <xref linkend="plugin_developer.other.unpacker" 
3343 16 May 07 nicklas 367                     /> for more information.</nohelp>
3343 16 May 07 nicklas 368                     
3343 16 May 07 nicklas 369                   <itemizedlist>
3343 16 May 07 nicklas 370                     <listitem>
3343 16 May 07 nicklas 371                       <para>
3343 16 May 07 nicklas 372                         <guilabel>Unpack file</guilabel>:
3343 16 May 07 nicklas 373                         Mark this checkbox if the compressed file should
3343 16 May 07 nicklas 374                         be unpacked after it had been uploaded. The
4487 08 Sep 08 jari 375                         files will be unpacked with the same sub-directory
3343 16 May 07 nicklas 376                         structure as in the compressed file.
3343 16 May 07 nicklas 377                       </para>
3343 16 May 07 nicklas 378                     </listitem>
3343 16 May 07 nicklas 379                     
3343 16 May 07 nicklas 380                     <listitem>
3343 16 May 07 nicklas 381                       <para>
3343 16 May 07 nicklas 382                         <guilabel>Overwrite existing files</guilabel>:
3343 16 May 07 nicklas 383                         Mark this checkbox if the unpacking is allowed
3343 16 May 07 nicklas 384                         to overwrite existing files.
3343 16 May 07 nicklas 385                       </para>
3343 16 May 07 nicklas 386                     </listitem>
3343 16 May 07 nicklas 387                     <listitem>
3343 16 May 07 nicklas 388                       <para>
3343 16 May 07 nicklas 389                         <guilabel>Keep the compressed file</guilabel>:
3343 16 May 07 nicklas 390                         Mark this checkbox if you want to keep the
3343 16 May 07 nicklas 391                         compressed file after upload. Otherwise, only
3343 16 May 07 nicklas 392                         the unpacked files are kept.
3343 16 May 07 nicklas 393                       </para>
3343 16 May 07 nicklas 394                     </listitem>
3343 16 May 07 nicklas 395                   </itemizedlist>
3224 02 Apr 07 martin 396                 </para>
3224 02 Apr 07 martin 397               </listitem>
3224 02 Apr 07 martin 398             </varlistentry>
3224 02 Apr 07 martin 399           </variablelist>
3224 02 Apr 07 martin 400         </para>
3224 02 Apr 07 martin 401         <para>
3224 02 Apr 07 martin 402           Finish the configuration by clicking on either
3343 16 May 07 nicklas 403           <guibutton>Upload</guibutton>, which will start uploading the selected file, or
3394 28 May 07 martin 404           &gbCancel; to abort the upload procedure.
3224 02 Apr 07 martin 405         </para>
3208 23 Mar 07 martin 406       </helptext>
3343 16 May 07 nicklas 407       
3343 16 May 07 nicklas 408       <sect3 id="file_system.handling.actions.reupload">
3343 16 May 07 nicklas 409         <title>Replace an existing file</title>
3343 16 May 07 nicklas 410         <para>
3343 16 May 07 nicklas 411           It is possible to replace an existing file. This is done by clicking
3343 16 May 07 nicklas 412           on the <guilabel>replace</guilabel> link on the single-item view
3343 16 May 07 nicklas 413           for the file you want to replace. If the file has been moved offline,
3343 16 May 07 nicklas 414           you can also use the icon
3343 16 May 07 nicklas 415           in the actions-column, see number 7 in
3343 16 May 07 nicklas 416           <xref linkend="file.system.figures.filepage" />.
3343 16 May 07 nicklas 417           The procedure to upload the file is the same as when uploading a new file,
3487 13 Jun 07 peter 418           except that compressed files cannot be unpacked. There is also an
3343 16 May 07 nicklas 419           extra option, <guilabel>Validate MD5</guilabel>, that tells BASE to 
3343 16 May 07 nicklas 420           check that the file is the same as the one it is replacing. This option
3343 16 May 07 nicklas 421           is useful when you are re-uploading a file that has been moved offline
3343 16 May 07 nicklas 422           and want to be certain that it is the same file as the original.
3343 16 May 07 nicklas 423         </para>
3463 07 Jun 07 nicklas 424         
5794 07 Oct 11 nicklas 425         <note>
3487 13 Jun 07 peter 426           You cannot replace a file which has been marked as 
3463 07 Jun 07 nicklas 427           <emphasis>write protected</emphasis>.
5794 07 Oct 11 nicklas 428         </note>
3343 16 May 07 nicklas 429       </sect3>
3343 16 May 07 nicklas 430       
3203 22 Mar 07 martin 431     </sect2>
5361 14 Jun 10 nicklas 432     
5361 14 Jun 10 nicklas 433     <sect2 id="file_system.handling.external">
5361 14 Jun 10 nicklas 434       <title>External files</title>
5361 14 Jun 10 nicklas 435       <para>
5361 14 Jun 10 nicklas 436       Files doesn't have to be stored on the BASE server. It is possible to register
5361 14 Jun 10 nicklas 437       an external file by giving the URL to it. In most cases, BASE will be able to 
5361 14 Jun 10 nicklas 438       use the external file in the same way as a file that has been uploaded to the
5361 14 Jun 10 nicklas 439       BASE server. To create an external file reference, use the 
5361 14 Jun 10 nicklas 440       <guibutton>New URL...</guibutton> button.
5361 14 Jun 10 nicklas 441       </para>
5361 14 Jun 10 nicklas 442       
5361 14 Jun 10 nicklas 443       <figure id="file_system.figures.external">
5361 14 Jun 10 nicklas 444         <title>Create external file</title>
5361 14 Jun 10 nicklas 445         <screenshot>
5361 14 Jun 10 nicklas 446           <mediaobject>
5361 14 Jun 10 nicklas 447             <imageobject><imagedata 
5361 14 Jun 10 nicklas 448               fileref="figures/external_file.png" format="PNG"
5361 14 Jun 10 nicklas 449               /></imageobject>
5361 14 Jun 10 nicklas 450           </mediaobject>
5361 14 Jun 10 nicklas 451         </screenshot>
5361 14 Jun 10 nicklas 452       </figure>
5361 14 Jun 10 nicklas 453       
5361 14 Jun 10 nicklas 454       <para>
5361 14 Jun 10 nicklas 455         The dialog is more or less the same as the <guilabel>Edit file</guilabel> dialog,
5362 16 Jun 10 nicklas 456         but has additional fields for the <guilabel>URL</guilabel> and an optional 
5362 16 Jun 10 nicklas 457         <guilabel>File server</guilabel>.
5361 14 Jun 10 nicklas 458       </para>
5361 14 Jun 10 nicklas 459       
5361 14 Jun 10 nicklas 460       <helptext external_id="file.external" title="External file properties">
5361 14 Jun 10 nicklas 461         <variablelist>
5361 14 Jun 10 nicklas 462           <varlistentry>
5361 14 Jun 10 nicklas 463             <term>
5361 14 Jun 10 nicklas 464               <guilabel>URL</guilabel>
5361 14 Jun 10 nicklas 465             </term>
5361 14 Jun 10 nicklas 466             <listitem>
5361 14 Jun 10 nicklas 467               <para>
5705 22 Aug 11 nicklas 468                 The full URL to the referenced file. BASE
5705 22 Aug 11 nicklas 469                 ships with support <emphasis>http</emphasis> and 
5705 22 Aug 11 nicklas 470                 <emphasis>https</emphasis> URLs, but the administrator may have 
5705 22 Aug 11 nicklas 471                 installed support for other protocols.
5361 14 Jun 10 nicklas 472               </para>
5361 14 Jun 10 nicklas 473             </listitem>
5361 14 Jun 10 nicklas 474           </varlistentry>
5361 14 Jun 10 nicklas 475           <varlistentry>
5361 14 Jun 10 nicklas 476             <term>
5361 14 Jun 10 nicklas 477               <guilabel>Load metadata</guilabel>
5361 14 Jun 10 nicklas 478             </term>
5361 14 Jun 10 nicklas 479             <listitem>
5361 14 Jun 10 nicklas 480               <para>
5361 14 Jun 10 nicklas 481                 Check this box if you want BASE to try to load metadata such
5361 14 Jun 10 nicklas 482                 as MIME type, size, last modification date etc. for the file.
5361 14 Jun 10 nicklas 483                 This will also verify that the file actually exists.
5361 14 Jun 10 nicklas 484               </para>
5361 14 Jun 10 nicklas 485             </listitem>
5361 14 Jun 10 nicklas 486           </varlistentry>
5361 14 Jun 10 nicklas 487           <varlistentry>
5361 14 Jun 10 nicklas 488             <term>
5361 14 Jun 10 nicklas 489               <guilabel>Server</guilabel>
5361 14 Jun 10 nicklas 490             </term>
5361 14 Jun 10 nicklas 491             <listitem>
5361 14 Jun 10 nicklas 492               <para>
5361 14 Jun 10 nicklas 493                 Select a file server for this file. This is optional, but is
5362 16 Jun 10 nicklas 494                 needed to access password-protected files or for some https 
5362 16 Jun 10 nicklas 495                 connections.
5361 14 Jun 10 nicklas 496               </para>
5361 14 Jun 10 nicklas 497             </listitem>
5361 14 Jun 10 nicklas 498           </varlistentry>
5361 14 Jun 10 nicklas 499         </variablelist>
5361 14 Jun 10 nicklas 500         <seeother>
5361 14 Jun 10 nicklas 501           <other external_id="fileserver.edit">File servers</other>
5361 14 Jun 10 nicklas 502           <other external_id="file.edit">Other file properties</other>
5361 14 Jun 10 nicklas 503         </seeother>
5361 14 Jun 10 nicklas 504       </helptext>
5794 07 Oct 11 nicklas 505     </sect2>
5794 07 Oct 11 nicklas 506     
5794 07 Oct 11 nicklas 507     <sect2 id="file_system.handling.fileservers">
5361 14 Jun 10 nicklas 508         <title>File servers</title>
5794 07 Oct 11 nicklas 509         
5794 07 Oct 11 nicklas 510         <figure id="file_system.figures.fileserver">
5794 07 Oct 11 nicklas 511           <title>Fileserver properties</title>
5794 07 Oct 11 nicklas 512           <screenshot>
5794 07 Oct 11 nicklas 513             <mediaobject>
5794 07 Oct 11 nicklas 514               <imageobject><imagedata 
5794 07 Oct 11 nicklas 515                 fileref="figures/edit_fileserver.png" format="PNG"
5794 07 Oct 11 nicklas 516                 /></imageobject>
5794 07 Oct 11 nicklas 517             </mediaobject>
5794 07 Oct 11 nicklas 518           </screenshot>
5794 07 Oct 11 nicklas 519         </figure>
5361 14 Jun 10 nicklas 520       
5361 14 Jun 10 nicklas 521         <helptext external_id="fileserver.edit" title="Edit file server">
5361 14 Jun 10 nicklas 522           <para>
5361 14 Jun 10 nicklas 523             File server are used for external files that are password
5362 16 Jun 10 nicklas 524             protected and for files that are using the https protocol and
5362 16 Jun 10 nicklas 525             require certificates to connect to the server.
5361 14 Jun 10 nicklas 526           </para>
5361 14 Jun 10 nicklas 527           <variablelist>
5361 14 Jun 10 nicklas 528           <varlistentry>
5361 14 Jun 10 nicklas 529             <term>
5361 14 Jun 10 nicklas 530               <guilabel>Name</guilabel>
5361 14 Jun 10 nicklas 531             </term>
5361 14 Jun 10 nicklas 532             <listitem>
5361 14 Jun 10 nicklas 533               <para>
5361 14 Jun 10 nicklas 534                 The name of the file server.
5361 14 Jun 10 nicklas 535               </para>
5361 14 Jun 10 nicklas 536             </listitem>
5361 14 Jun 10 nicklas 537           </varlistentry>
5361 14 Jun 10 nicklas 538           <varlistentry>
5361 14 Jun 10 nicklas 539             <term>
5794 07 Oct 11 nicklas 540               <guilabel>Connection manager</guilabel>
5794 07 Oct 11 nicklas 541             </term>
5794 07 Oct 11 nicklas 542             <listitem>
5794 07 Oct 11 nicklas 543               <para>
5794 07 Oct 11 nicklas 544                 The <guilabel>auto</guilabel> setting allows BASE to automatically
5794 07 Oct 11 nicklas 545                 select a manager based on the file URL. It is possible to force a
5794 07 Oct 11 nicklas 546                 specific connection manager from this list. The list of available
5794 07 Oct 11 nicklas 547                 connection managers can be extended by plug-ins.
5794 07 Oct 11 nicklas 548                 <nohelp>See 
5794 07 Oct 11 nicklas 549                 <xref linkend="extensions_developer.connection_manager"/> for more information.
5794 07 Oct 11 nicklas 550                 </nohelp>
5794 07 Oct 11 nicklas 551               </para>
5794 07 Oct 11 nicklas 552             </listitem>
5794 07 Oct 11 nicklas 553           </varlistentry>
5794 07 Oct 11 nicklas 554           <varlistentry>
5794 07 Oct 11 nicklas 555             <term>
5705 22 Aug 11 nicklas 556               <guilabel>Host</guilabel>
5705 22 Aug 11 nicklas 557             </term>
5705 22 Aug 11 nicklas 558             <listitem>
5705 22 Aug 11 nicklas 559               <para>
5705 22 Aug 11 nicklas 560                 If specified, overrides the host (and/or port) part of the file URL with the
5705 22 Aug 11 nicklas 561                 value in this field. This is useful, if for example, a file can be 
5705 22 Aug 11 nicklas 562                 accessed using a "public" path that is entered as the URL for the file and
5705 22 Aug 11 nicklas 563                 an "internal" path that is used from the BASE server.
5705 22 Aug 11 nicklas 564               </para>
5705 22 Aug 11 nicklas 565             </listitem>
5705 22 Aug 11 nicklas 566           </varlistentry>
5705 22 Aug 11 nicklas 567           <varlistentry>
5705 22 Aug 11 nicklas 568             <term>
5361 14 Jun 10 nicklas 569               <guilabel>Username/password</guilabel>
5361 14 Jun 10 nicklas 570             </term>
5361 14 Jun 10 nicklas 571             <listitem>
5361 14 Jun 10 nicklas 572               <para>
5361 14 Jun 10 nicklas 573                 If the file server requires authorization to access the files
5361 14 Jun 10 nicklas 574                 you should add a username and password. This will be used by
7480 17 Apr 18 nicklas 575                 BASE to access the files. Currently, BASE has built-in support
7480 17 Apr 18 nicklas 576                 for <emphasis>Basic</emphasis> and <emphasis>Digest</emphasis>
7480 17 Apr 18 nicklas 577                 authentication, but extensions may provide more options.
5361 14 Jun 10 nicklas 578               </para>
5361 14 Jun 10 nicklas 579             </listitem>
5361 14 Jun 10 nicklas 580           </varlistentry>
5361 14 Jun 10 nicklas 581           <varlistentry>
5361 14 Jun 10 nicklas 582             <term>
7480 17 Apr 18 nicklas 583               <guilabel>Root path</guilabel>
7480 17 Apr 18 nicklas 584             </term>
7480 17 Apr 18 nicklas 585             <listitem>
7480 17 Apr 18 nicklas 586               <para>
7480 17 Apr 18 nicklas 587                 An optional absolute path to the directory on
7480 17 Apr 18 nicklas 588                 the file server that should be accesible. The root path is
7480 17 Apr 18 nicklas 589                 prepended to the file URL before accessing the file on the 
7480 17 Apr 18 nicklas 590                 server.
7480 17 Apr 18 nicklas 591               </para>
7480 17 Apr 18 nicklas 592             </listitem>
7480 17 Apr 18 nicklas 593           </varlistentry>
7480 17 Apr 18 nicklas 594           <varlistentry>
7480 17 Apr 18 nicklas 595             <term>
5361 14 Jun 10 nicklas 596               <guilabel>Description</guilabel>
5361 14 Jun 10 nicklas 597             </term>
5361 14 Jun 10 nicklas 598             <listitem>
5361 14 Jun 10 nicklas 599               <para>
5361 14 Jun 10 nicklas 600                 Enter a description of the file server.
5361 14 Jun 10 nicklas 601               </para>
5361 14 Jun 10 nicklas 602             </listitem>
5361 14 Jun 10 nicklas 603           </varlistentry>
5362 16 Jun 10 nicklas 604           <varlistentry>
5362 16 Jun 10 nicklas 605             <term>
7480 17 Apr 18 nicklas 606               <guilabel>HTTPS options</guilabel>
5362 16 Jun 10 nicklas 607             </term>
5362 16 Jun 10 nicklas 608             <listitem>
5362 16 Jun 10 nicklas 609               <para>
7480 17 Apr 18 nicklas 610                 On this tab you may specify server and client certificates for HTTPS
7480 17 Apr 18 nicklas 611                 connections. A <guilabel>server certificate</guilabel> may be needed to access files 
7480 17 Apr 18 nicklas 612                 on servers that use certificates that can't automatically be trusted,
5362 16 Jun 10 nicklas 613                 for example, a self-signed certificate. The server certificate is uploaded
5362 16 Jun 10 nicklas 614                 as a file and must be a X.509 certificate in either binary or base64-encoded DER format.
5362 16 Jun 10 nicklas 615               </para>
5362 16 Jun 10 nicklas 616               <para>
7480 17 Apr 18 nicklas 617                 A <guilabel>client certificate</guilabel> may be needed to access files with the HTTPS 
5362 16 Jun 10 nicklas 618                 protocol on servers that require that clients authenticate themselves with a certificate.
5362 16 Jun 10 nicklas 619                 The certificate is typically issued by the owner of the server and may be
5362 16 Jun 10 nicklas 620                 password-protected. The client certificate is uploaded as a file and must be in
5362 16 Jun 10 nicklas 621                 PKCS #12 format.
5362 16 Jun 10 nicklas 622               </para>
5362 16 Jun 10 nicklas 623               <para>
5362 16 Jun 10 nicklas 624                 Use the <guilabel>Remove existing...</guilabel> checkboxes to remove previously
5362 16 Jun 10 nicklas 625                 uploaded certificates. Leave everything empty to keep things as they are.
5362 16 Jun 10 nicklas 626               </para>
7480 17 Apr 18 nicklas 627             </listitem>
7480 17 Apr 18 nicklas 628           </varlistentry>
7480 17 Apr 18 nicklas 629           <varlistentry>
7480 17 Apr 18 nicklas 630             <term>
7480 17 Apr 18 nicklas 631               <guilabel>SSH options</guilabel>
7480 17 Apr 18 nicklas 632             </term>
7480 17 Apr 18 nicklas 633             <listitem>
7343 18 Apr 17 nicklas 634               <para>
7480 17 Apr 18 nicklas 635                 On this tab you may specify options for SSH connections. BASE has not
7480 17 Apr 18 nicklas 636                 built-in support for SSH but this can be enabled via plug-ins. 
7982 14 Jun 21 nicklas 637                 See the <ulink url="https://baseplugins.thep.lu.se/wiki/net.sf.basedb.xfiles">External
7480 17 Apr 18 nicklas 638                 files support</ulink> extension package.
7480 17 Apr 18 nicklas 639               </para>
7480 17 Apr 18 nicklas 640               <para>
7343 18 Apr 17 nicklas 641                 A <guilabel>SSH fingerprint</guilabel> is needed to be able
7343 18 Apr 17 nicklas 642                 to access a remote server via SSH. If the fingerprint doesn't match
7480 17 Apr 18 nicklas 643                 access is denied. BASE can store MD5 and SHA-256 fingerprints.
7343 18 Apr 17 nicklas 644               </para>
7480 17 Apr 18 nicklas 645               <para>
7480 17 Apr 18 nicklas 646                 SSH connections typically need a username and password for logging in, but it
7480 17 Apr 18 nicklas 647                 is also possible to specify a <guilabel>SSH private key</guilabel>. Auto-detection
7480 17 Apr 18 nicklas 648                 of the key <guilabel>format</guilabel> should work in most cases. If not, it
7480 17 Apr 18 nicklas 649                 can be manually specified. 
7480 17 Apr 18 nicklas 650               </para>
7480 17 Apr 18 nicklas 651               <para>
7480 17 Apr 18 nicklas 652                 Use the <guilabel>Remove existing private key...</guilabel> checkbox to remove a previously
7480 17 Apr 18 nicklas 653                 uploaded private key.
7480 17 Apr 18 nicklas 654               </para>
5362 16 Jun 10 nicklas 655             </listitem>
5362 16 Jun 10 nicklas 656           </varlistentry>
5361 14 Jun 10 nicklas 657           </variablelist>
5361 14 Jun 10 nicklas 658         <seeother>
5361 14 Jun 10 nicklas 659           <other external_id="file.external">External files</other>
5361 14 Jun 10 nicklas 660         </seeother>
5361 14 Jun 10 nicklas 661         </helptext>
5361 14 Jun 10 nicklas 662       
5361 14 Jun 10 nicklas 663     </sect2>
5361 14 Jun 10 nicklas 664     
3215 26 Mar 07 martin 665     <sect2 id="file_system.handling.edit">
3203 22 Mar 07 martin 666       <title>Edit a file</title>
3218 28 Mar 07 martin 667       <para>
3218 28 Mar 07 martin 668         The edit window to set a file's property in can either be open with
3394 28 May 07 martin 669         &gbEdit;
3224 02 Apr 07 martin 670         that is located in the toolbar at the file's view page or by holding down
3343 16 May 07 nicklas 671         <keycap>CTRL</keycap>, <keycap>ALT</keycap>
3343 16 May 07 nicklas 672         or <keycap>SHIFT</keycap>
3224 02 Apr 07 martin 673         when clicking on the file's name in the list. It requires that the current user has
3224 02 Apr 07 martin 674         write permission on the file to be able to edit and set the properties.
3218 28 Mar 07 martin 675       </para>
3218 28 Mar 07 martin 676
3218 28 Mar 07 martin 677       <helptext external_id="file.edit" title="Edit file properties">
3218 28 Mar 07 martin 678         <variablelist>
3218 28 Mar 07 martin 679           <varlistentry>
3218 28 Mar 07 martin 680             <term>
3218 28 Mar 07 martin 681               <guilabel>Path</guilabel>
3218 28 Mar 07 martin 682             </term>
3218 28 Mar 07 martin 683             <listitem>
3218 28 Mar 07 martin 684               <para>
3224 02 Apr 07 martin 685                 This is the path where the file is located. This can only be changed
3343 16 May 07 nicklas 686                 by moving the file.
3343 16 May 07 nicklas 687                 <nohelp>Read more about how this is done in
3343 16 May 07 nicklas 688                 <xref linkend="file_system.handling.move" /></nohelp>.
3218 28 Mar 07 martin 689               </para>
3218 28 Mar 07 martin 690             </listitem>
3218 28 Mar 07 martin 691           </varlistentry>
3218 28 Mar 07 martin 692           <varlistentry>
3218 28 Mar 07 martin 693             <term>
5361 14 Jun 10 nicklas 694               <guilabel>URL, Server</guilabel>
5361 14 Jun 10 nicklas 695             </term>
5361 14 Jun 10 nicklas 696             <listitem>
5361 14 Jun 10 nicklas 697               <para>
5705 22 Aug 11 nicklas 698                 See <emphasis>External files</emphasis> above.
5361 14 Jun 10 nicklas 699               </para>
5361 14 Jun 10 nicklas 700             </listitem>
5361 14 Jun 10 nicklas 701           </varlistentry>
5361 14 Jun 10 nicklas 702           
5361 14 Jun 10 nicklas 703           <varlistentry>
5361 14 Jun 10 nicklas 704             <term>
3218 28 Mar 07 martin 705               <guilabel>Name</guilabel>
3218 28 Mar 07 martin 706             </term>
3218 28 Mar 07 martin 707             <listitem>
3218 28 Mar 07 martin 708               <para>
3487 13 Jun 07 peter 709                 The file's name, which cannot be left empty and must be unique in
3219 30 Mar 07 martin 710                 current directory. The maximum length of the file name is 255
3224 02 Apr 07 martin 711                 characters and it can contain blank spaces but not any of
3343 16 May 07 nicklas 712                 <keycap>~</keycap>,
3343 16 May 07 nicklas 713                 <keycap>\</keycap>,
3343 16 May 07 nicklas 714                 <keycap>/</keycap>,
3343 16 May 07 nicklas 715                 <keycap>:</keycap>,
3343 16 May 07 nicklas 716                 <keycap>;</keycap>,
3343 16 May 07 nicklas 717                 <keycap>*</keycap>,
3343 16 May 07 nicklas 718                 <keycap>&#63;</keycap>,
3343 16 May 07 nicklas 719                 <keycap>&lt;</keycap>,
3219 30 Mar 07 martin 720                 <keycap>&gt;</keycap>
3219 30 Mar 07 martin 721                 or
3343 16 May 07 nicklas 722                 <keycap>|</keycap>.
3218 28 Mar 07 martin 723               </para>
3218 28 Mar 07 martin 724             </listitem>
3218 28 Mar 07 martin 725           </varlistentry>
3218 28 Mar 07 martin 726           <varlistentry>
3218 28 Mar 07 martin 727             <term>
3463 07 Jun 07 nicklas 728               <guilabel>Write protected</guilabel>
3463 07 Jun 07 nicklas 729             </term>
3463 07 Jun 07 nicklas 730             <listitem>
3463 07 Jun 07 nicklas 731               <para>
3463 07 Jun 07 nicklas 732                 Mark this checkbox if you want the file to be write 
3487 13 Jun 07 peter 733                 protected. A write protected file cannot be deleted,
3463 07 Jun 07 nicklas 734                 moved offline or replaced with another file. It is
3463 07 Jun 07 nicklas 735                 still possible to change other metadata, such as
3463 07 Jun 07 nicklas 736                 the name, description, file type, MIME type, etc.
3463 07 Jun 07 nicklas 737               </para>
3463 07 Jun 07 nicklas 738             </listitem>
3463 07 Jun 07 nicklas 739           </varlistentry>
3463 07 Jun 07 nicklas 740           <varlistentry>
3463 07 Jun 07 nicklas 741             <term>
3218 28 Mar 07 martin 742               <guilabel>Type</guilabel>
3218 28 Mar 07 martin 743             </term>
3218 28 Mar 07 martin 744             <listitem>
3218 28 Mar 07 martin 745               <para>
3224 02 Apr 07 martin 746                 Sets which kind of type the file is. Select the file type to use
3219 30 Mar 07 martin 747                 from the drop down list with available types. The option
3218 28 Mar 07 martin 748                 <guilabel>-none-</guilabel>
3487 13 Jun 07 peter 749                 should be used if the file should not be associated with any kind of
3219 30 Mar 07 martin 750                 file type.
3218 28 Mar 07 martin 751               </para>
3218 28 Mar 07 martin 752             </listitem>
3218 28 Mar 07 martin 753           </varlistentry>
3218 28 Mar 07 martin 754           <varlistentry>
3218 28 Mar 07 martin 755             <term>
3218 28 Mar 07 martin 756               <guilabel>MIME type</guilabel>
3218 28 Mar 07 martin 757             </term>
3218 28 Mar 07 martin 758             <listitem>
3219 30 Mar 07 martin 759               <para>
3219 30 Mar 07 martin 760                 The file's content/media type. This is normally set automatically
3343 16 May 07 nicklas 761                 when uploading the file into BASE but it can be changed by an user,
3219 30 Mar 07 martin 762                 that has write permissions, at any time.
3219 30 Mar 07 martin 763               </para>
3218 28 Mar 07 martin 764             </listitem>
3218 28 Mar 07 martin 765           </varlistentry>
3218 28 Mar 07 martin 766           <varlistentry>
3218 28 Mar 07 martin 767             <term>
3218 28 Mar 07 martin 768               <guilabel>Description</guilabel>
3218 28 Mar 07 martin 769             </term>
3218 28 Mar 07 martin 770             <listitem>
3219 30 Mar 07 martin 771               <para>
3219 30 Mar 07 martin 772                 This text area can be used to store relevant information about file
3219 30 Mar 07 martin 773                 and it's contents. Use the magnifying glass, located to the right
3219 30 Mar 07 martin 774                 under the text area, to edit the text in a larger window.
3219 30 Mar 07 martin 775               </para>
3218 28 Mar 07 martin 776             </listitem>
3218 28 Mar 07 martin 777           </varlistentry>
3218 28 Mar 07 martin 778         </variablelist>
3218 28 Mar 07 martin 779         <para>
3219 30 Mar 07 martin 780           Finish the editing process by pressing either
3394 28 May 07 martin 781           &gbSave;
3219 30 Mar 07 martin 782           to save the properties to the database or
3394 28 May 07 martin 783           &gbCancel;
3218 28 Mar 07 martin 784           to abort and discard the changes.
3218 28 Mar 07 martin 785         </para>
5361 14 Jun 10 nicklas 786         
5361 14 Jun 10 nicklas 787         <seeother>
5361 14 Jun 10 nicklas 788           <other external_id="file.external">External files</other>
5361 14 Jun 10 nicklas 789           <other external_id="fileserver.edit">File servers</other>
5361 14 Jun 10 nicklas 790         </seeother>
3218 28 Mar 07 martin 791       </helptext>
3218 28 Mar 07 martin 792
3203 22 Mar 07 martin 793     </sect2>
3343 16 May 07 nicklas 794     <sect2 id="file_system.handling.move">
3343 16 May 07 nicklas 795       <title>Move files</title>
3343 16 May 07 nicklas 796       
3219 30 Mar 07 martin 797       <para>
3343 16 May 07 nicklas 798         These functions are used to manage the location of the files on the
3343 16 May 07 nicklas 799         server. They are all accessed from the <guibutton>Move</guibutton>
3343 16 May 07 nicklas 800         button on the list view of from the single-item view. On the list view,
3343 16 May 07 nicklas 801         you must first select one or more files / directories.
3219 30 Mar 07 martin 802       </para>
3343 16 May 07 nicklas 803       
3463 07 Jun 07 nicklas 804       <tip>
3463 07 Jun 07 nicklas 805         <title>Write protect your files!</title>
3463 07 Jun 07 nicklas 806         <para>
3463 07 Jun 07 nicklas 807         If you mark a file as <emphasis>write protected</emphasis> it will
3463 07 Jun 07 nicklas 808         not be possible to delete, move or replace the file. Use this options
3487 13 Jun 07 peter 809         for important data files that you do not want to loose by accident.
3463 07 Jun 07 nicklas 810         </para>
3463 07 Jun 07 nicklas 811       </tip>
3463 07 Jun 07 nicklas 812       
3343 16 May 07 nicklas 813       <sect3 id="file_system.handling.move.directory">
3343 16 May 07 nicklas 814         <title>To another directory</title>
3219 30 Mar 07 martin 815         <para>
3343 16 May 07 nicklas 816           Files and directories can be moved to other directories for re-organization. The
3343 16 May 07 nicklas 817           user need write permission on the target directory to be able to move the
3343 16 May 07 nicklas 818           files/directories to it.
3219 30 Mar 07 martin 819         </para>
3219 30 Mar 07 martin 820         <para>
3343 16 May 07 nicklas 821           First, select all files and directories in the current path that should be moved
3343 16 May 07 nicklas 822           and then click on
3343 16 May 07 nicklas 823           <menuchoice>
3343 16 May 07 nicklas 824             <guibutton>Move&hellip;</guibutton>
3343 16 May 07 nicklas 825             <guisubmenu>To another directory</guisubmenu>
3343 16 May 07 nicklas 826           </menuchoice>
3343 16 May 07 nicklas 827           in the toolbar to open a window with the directory tree where the target directory
3343 16 May 07 nicklas 828           can be picked.
3219 30 Mar 07 martin 829         </para>
3219 30 Mar 07 martin 830         <para>
3343 16 May 07 nicklas 831           Choose a directory which the selected items should be moved to. It
4487 08 Sep 08 jari 832           is possible to create new sub-directories with the 
3394 28 May 07 martin 833           &gbNew; button.
3219 30 Mar 07 martin 834         </para>
3343 16 May 07 nicklas 835         <para>
3343 16 May 07 nicklas 836           Click on
3394 28 May 07 martin 837           &gbOk;
3343 16 May 07 nicklas 838           to carry out the move or
3394 28 May 07 martin 839           &gbCancel;
3343 16 May 07 nicklas 840           to abort.
3343 16 May 07 nicklas 841         </para>
3219 30 Mar 07 martin 842       </sect3>
3343 16 May 07 nicklas 843       
3343 16 May 07 nicklas 844       <sect3 id="file_system.handling.move.offline">
3343 16 May 07 nicklas 845         <title>Offline</title>
3219 30 Mar 07 martin 846         <para>
3343 16 May 07 nicklas 847           Moving a file offline means that the actual file contents is deleted from the 
3343 16 May 07 nicklas 848           server's disk space but information about the file will still exist as an item 
3343 16 May 07 nicklas 849           in the database. This makes it possible to save disk space but still be 
3343 16 May 07 nicklas 850           able to associated the file with other items in BASE.
3219 30 Mar 07 martin 851         </para>
3219 30 Mar 07 martin 852         <para>
3343 16 May 07 nicklas 853           First, select all files in current path that should be moved offline
3343 16 May 07 nicklas 854           and then click on
3343 16 May 07 nicklas 855           <menuchoice>
3343 16 May 07 nicklas 856             <guibutton>Move&hellip;</guibutton>
3343 16 May 07 nicklas 857             <guisubmenu>Offline</guisubmenu>
3343 16 May 07 nicklas 858           </menuchoice>
3343 16 May 07 nicklas 859           in the toolbar. 
3343 16 May 07 nicklas 860         </para>  
3464 07 Jun 07 nicklas 861         <warning>
3464 07 Jun 07 nicklas 862           <para>
3464 07 Jun 07 nicklas 863           Be careful! The selected files will be removed from the server. 
3464 07 Jun 07 nicklas 864           The only way to recover the contents again is to re-upload the files.
3464 07 Jun 07 nicklas 865           </para>
3464 07 Jun 07 nicklas 866         </warning>
3219 30 Mar 07 martin 867       </sect3>
3203 22 Mar 07 martin 868     </sect2>
3343 16 May 07 nicklas 869
3224 02 Apr 07 martin 870     <sect2 id="file_system.handling.actions">
3343 16 May 07 nicklas 871       <title>Viewing and downloading files</title>
3224 02 Apr 07 martin 872       <para>
3343 16 May 07 nicklas 873         In <guilabel>Actions</guilabel> column in the list view there
3343 16 May 07 nicklas 874         are icons you can click on to perform different kinds of actions on a
3343 16 May 07 nicklas 875         file, like downloading the file and viewing the file. The same icons appear
3343 16 May 07 nicklas 876         on the single-item view and in most other places where files are used.
7598 22 Feb 19 nicklas 877         You cannot view or download files that have been moved offline.
3224 02 Apr 07 martin 878       </para>
3224 02 Apr 07 martin 879       <sect3 id="file_system.handling.actions.download">
3343 16 May 07 nicklas 880         <title>Download a file</title>
3224 02 Apr 07 martin 881         <para>
3224 02 Apr 07 martin 882           This will let the user to download the contents of a file to a path on a local
3224 02 Apr 07 martin 883           computer. The window that opens contains the selected file's name, size e.t.c.
3224 02 Apr 07 martin 884           and it will also open a download dialog window where the user can choose what to
3224 02 Apr 07 martin 885           do with the file locally.
3224 02 Apr 07 martin 886           <tip>
3487 13 Jun 07 peter 887             <title>Download does not start</title>
3224 02 Apr 07 martin 888             <para>
3224 02 Apr 07 martin 889               Click on the file's path name in the pop-up window if the download
3487 13 Jun 07 peter 890               dialog window does not appears.
3224 02 Apr 07 martin 891             </para>
3224 02 Apr 07 martin 892           </tip>
3224 02 Apr 07 martin 893         </para>
3224 02 Apr 07 martin 894         <para>
3224 02 Apr 07 martin 895           Close the pop-up window and return to file page with
3394 28 May 07 martin 896           &gbClose;.
3224 02 Apr 07 martin 897         </para>
3224 02 Apr 07 martin 898       </sect3>
3224 02 Apr 07 martin 899       <sect3 id="file_system.handling.actions.view">
3343 16 May 07 nicklas 900         <title>View the contents of file</title>
3224 02 Apr 07 martin 901         <para>
3343 16 May 07 nicklas 902           A file's contents can be displayed directly in the web browser if the
3343 16 May 07 nicklas 903           browser supports displaying that kind of files. Typically all HTML, text
3343 16 May 07 nicklas 904           files and images are supported. Click on the icon to view the contents
3487 13 Jun 07 peter 905           in a new window. If the type is not supported by the browser there will be
3343 16 May 07 nicklas 906           a dialog-window to download the file instead.
3224 02 Apr 07 martin 907         </para>
3224 02 Apr 07 martin 908       </sect3>
3643 08 Aug 07 nicklas 909       <sect3 id="file_system.handling.actions.zippeddownload">
3643 08 Aug 07 nicklas 910         <title>Download/compress multiple files</title>
3643 08 Aug 07 nicklas 911         
3643 08 Aug 07 nicklas 912         <para>
3643 08 Aug 07 nicklas 913         You can download multiple files/directories at the same time. First,
3643 08 Aug 07 nicklas 914         from the file browser, select one or more files/directories. Then, click
3643 08 Aug 07 nicklas 915         on the &gbExport; button. Select the <userinput>Packed file exporter</userinput>
3643 08 Aug 07 nicklas 916         plug-in and choose one of the file formats below it. On the &gbNext;
3643 08 Aug 07 nicklas 917         page you can specify other options for the download:
3643 08 Aug 07 nicklas 918         </para>
3643 08 Aug 07 nicklas 919         
3643 08 Aug 07 nicklas 920         <itemizedlist>
3643 08 Aug 07 nicklas 921         <listitem>
3643 08 Aug 07 nicklas 922           <para>
3643 08 Aug 07 nicklas 923             <guilabel>Save as</guilabel>: The path to a file on the BASE file system
3643 08 Aug 07 nicklas 924             where the selected files and directories should be packed. Leave this 
3643 08 Aug 07 nicklas 925             field empty to download the files to your own computer.
3643 08 Aug 07 nicklas 926           </para>
3643 08 Aug 07 nicklas 927         </listitem>
3643 08 Aug 07 nicklas 928         <listitem>
3643 08 Aug 07 nicklas 929           <para>
3643 08 Aug 07 nicklas 930             <guilabel>Overwrite</guilabel>: If you are saving to the BASE file system
3643 08 Aug 07 nicklas 931             you may select if it is allowed to overwrite an existing file or not.
3643 08 Aug 07 nicklas 932           </para>
3643 08 Aug 07 nicklas 933         </listitem>
3643 08 Aug 07 nicklas 934         <listitem>
3643 08 Aug 07 nicklas 935           <para>
3643 08 Aug 07 nicklas 936             <guilabel>Remove files/directories</guilabel>: If you select this option
3643 08 Aug 07 nicklas 937             the selected files and directories will be marked as removed. You must still
3643 08 Aug 07 nicklas 938             go to the <guilabel>Trashcan</guilabel> and remove the items permanently.
3643 08 Aug 07 nicklas 939           </para>
3643 08 Aug 07 nicklas 940         </listitem>
3643 08 Aug 07 nicklas 941         </itemizedlist>
3643 08 Aug 07 nicklas 942         
3643 08 Aug 07 nicklas 943       </sect3>
3224 02 Apr 07 martin 944     </sect2>
3215 26 Mar 07 martin 945     <sect2 id="file_system.handling.directories">
3208 23 Mar 07 martin 946       <title>Directories</title>
3219 30 Mar 07 martin 947       <para>
3343 16 May 07 nicklas 948         Directories in BASE are folders where files can be organized into. Click on
3219 30 Mar 07 martin 949         <guibutton>New directory&hellip;</guibutton>
3219 30 Mar 07 martin 950         in the toolbar to create a directory in current path and edit the properties as
3219 30 Mar 07 martin 951         described below.
3219 30 Mar 07 martin 952       </para>
5794 07 Oct 11 nicklas 953
5794 07 Oct 11 nicklas 954         <figure id="file_system.figures.directory">
5794 07 Oct 11 nicklas 955           <title>Directory properties</title>
5794 07 Oct 11 nicklas 956           <screenshot>
5794 07 Oct 11 nicklas 957             <mediaobject>
5794 07 Oct 11 nicklas 958               <imageobject><imagedata 
5794 07 Oct 11 nicklas 959                 fileref="figures/edit_directory.png" format="PNG"
5794 07 Oct 11 nicklas 960                 /></imageobject>
5794 07 Oct 11 nicklas 961             </mediaobject>
5794 07 Oct 11 nicklas 962           </screenshot>
5794 07 Oct 11 nicklas 963         </figure>
5794 07 Oct 11 nicklas 964         
3208 23 Mar 07 martin 965         <helptext external_id="directory.edit" title="Edit directory">
3219 30 Mar 07 martin 966           <para>
3219 30 Mar 07 martin 967             <variablelist>
3219 30 Mar 07 martin 968               <title>Properties</title>
3219 30 Mar 07 martin 969               <varlistentry>
3219 30 Mar 07 martin 970                 <term>
3219 30 Mar 07 martin 971                   <guilabel>Path</guilabel>
3219 30 Mar 07 martin 972                 </term>
3219 30 Mar 07 martin 973                 <listitem>
3219 30 Mar 07 martin 974                   <para>
3219 30 Mar 07 martin 975                     This property is read-only in the edit window but can be
3489 13 Jun 07 nicklas 976                     changed by moving the directory<nohelp>, described in
3489 13 Jun 07 nicklas 977                     <xref linkend="file_system.handling.move" /></nohelp>.
3219 30 Mar 07 martin 978                   </para>
3219 30 Mar 07 martin 979                 </listitem>
3219 30 Mar 07 martin 980               </varlistentry>
3219 30 Mar 07 martin 981               <varlistentry>
3219 30 Mar 07 martin 982                 <term>
3219 30 Mar 07 martin 983                   <guilabel>Name</guilabel>
3219 30 Mar 07 martin 984                 </term>
3219 30 Mar 07 martin 985                 <listitem>
3219 30 Mar 07 martin 986                   <para>
3219 30 Mar 07 martin 987                     The directory's name to identify it with in the list. This
3224 02 Apr 07 martin 988                     field must have a value and it has to be an unique name for
3224 02 Apr 07 martin 989                     the current directory.
3219 30 Mar 07 martin 990                   </para>
3219 30 Mar 07 martin 991                 </listitem>
3219 30 Mar 07 martin 992               </varlistentry>
3219 30 Mar 07 martin 993               <varlistentry>
3219 30 Mar 07 martin 994                 <term>
5705 22 Aug 11 nicklas 995                   <guilabel>Compress new files</guilabel>
3719 12 Sep 07 nicklas 996                 </term>
3719 12 Sep 07 nicklas 997                 <listitem>
3719 12 Sep 07 nicklas 998                   <para>
3719 12 Sep 07 nicklas 999                     Enable this option to let BASE store files that
3719 12 Sep 07 nicklas 1000                     are uploaded to this directory in a compressed format. 
3719 12 Sep 07 nicklas 1001                     This option only affect  files that are uploaded later, 
3719 12 Sep 07 nicklas 1002                     it doesn't affect already existing files or files that
5794 07 Oct 11 nicklas 1003                     are moved between directories. Check the <guilabel>Recursive</guilabel>
5794 07 Oct 11 nicklas 1004                     button to apply this setting to all subdirectories.
3719 12 Sep 07 nicklas 1005                   </para>
3719 12 Sep 07 nicklas 1006                 </listitem>
3719 12 Sep 07 nicklas 1007               </varlistentry>
3719 12 Sep 07 nicklas 1008               <varlistentry>
3719 12 Sep 07 nicklas 1009                 <term>
4487 08 Sep 08 jari 1010                   <guilabel>Share new files and sub-directories automatically</guilabel>
4314 26 May 08 nicklas 1011                 </term>
4314 26 May 08 nicklas 1012                 <listitem>
4314 26 May 08 nicklas 1013                   <para>
4314 26 May 08 nicklas 1014                     Enable this option to let BASE automatically share
4314 26 May 08 nicklas 1015                     new files and directories with the same permissions
4314 26 May 08 nicklas 1016                     as have been specified on this directory. This
4314 26 May 08 nicklas 1017                     option is useful when you have assigned a specific 
4314 26 May 08 nicklas 1018                     directory as a common area for a group of users and
4314 26 May 08 nicklas 1019                     you want to make sure that all users has access to
4314 26 May 08 nicklas 1020                     all files. Some restrictions apply:
4314 26 May 08 nicklas 1021                   </para>
4314 26 May 08 nicklas 1022                   <itemizedlist>
4314 26 May 08 nicklas 1023                   <listitem>
4314 26 May 08 nicklas 1024                     <para>
4314 26 May 08 nicklas 1025                     Permissions for the <emphasis>Everyone</emphasis>
4314 26 May 08 nicklas 1026                     group are not inherited if the logged in user doesn't
4314 26 May 08 nicklas 1027                     have the <emphasis>SHARE_TO_EVERYONE</emphasis> permission. 
4314 26 May 08 nicklas 1028                     </para>
4314 26 May 08 nicklas 1029                   </listitem>
4314 26 May 08 nicklas 1030                   <listitem>
4314 26 May 08 nicklas 1031                     <para>
4314 26 May 08 nicklas 1032                     If a project is active the new file/directory will be shared
4314 26 May 08 nicklas 1033                     to the active project as well.
4314 26 May 08 nicklas 1034                     </para>
4314 26 May 08 nicklas 1035                   </listitem>
4314 26 May 08 nicklas 1036                   </itemizedlist>
5794 07 Oct 11 nicklas 1037                   <para>
5794 07 Oct 11 nicklas 1038                   Check the <guilabel>Recursive</guilabel>
5794 07 Oct 11 nicklas 1039                   button to apply this setting to all subdirectories.
5794 07 Oct 11 nicklas 1040                   </para>
4314 26 May 08 nicklas 1041                 </listitem>
4314 26 May 08 nicklas 1042               </varlistentry>
4314 26 May 08 nicklas 1043               <varlistentry>
4314 26 May 08 nicklas 1044                 <term>
3219 30 Mar 07 martin 1045                   <guilabel>Description</guilabel>
3219 30 Mar 07 martin 1046                 </term>
3219 30 Mar 07 martin 1047                 <listitem>
3219 30 Mar 07 martin 1048                   <para>
3219 30 Mar 07 martin 1049                     Any relevant information about the directory can be written
3219 30 Mar 07 martin 1050                     in this text area. The magnifying glass down to the right
3219 30 Mar 07 martin 1051                     can be used to edit the description text in a larger text
3219 30 Mar 07 martin 1052                     area, just click on the icon to open it in a separate pop-up
3219 30 Mar 07 martin 1053                     window.
3219 30 Mar 07 martin 1054                   </para>
3219 30 Mar 07 martin 1055                 </listitem>
3219 30 Mar 07 martin 1056               </varlistentry>
3219 30 Mar 07 martin 1057             </variablelist>
3219 30 Mar 07 martin 1058           </para>
3219 30 Mar 07 martin 1059           <para>
3219 30 Mar 07 martin 1060             The editing process is completed with either
3394 28 May 07 martin 1061             &gbSave;, to save the properties into the database, or with
3394 28 May 07 martin 1062             &gbCancel;
3219 30 Mar 07 martin 1063             to discard the changes. Both of the buttons will close the edit window and
3219 30 Mar 07 martin 1064             if the directory is updated the list will be reloaded with the directory's
3219 30 Mar 07 martin 1065             new properties.
3219 30 Mar 07 martin 1066           </para>
3343 16 May 07 nicklas 1067           
3343 16 May 07 nicklas 1068           <note>
3487 13 Jun 07 peter 1069             The new directory does not appear in the navigation tree
3343 16 May 07 nicklas 1070             to the left automatically. You must click on the 
3343 16 May 07 nicklas 1071             <guibutton>Refresh</guibutton> button.
3343 16 May 07 nicklas 1072           </note>
3343 16 May 07 nicklas 1073           
3208 23 Mar 07 martin 1074         </helptext>
3203 22 Mar 07 martin 1075     </sect2>
3203 22 Mar 07 martin 1076   </sect1>
3203 22 Mar 07 martin 1077
3675 16 Aug 07 jari 1078 </chapter>

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