Changeset 3343
- Timestamp:
- May 16, 2007, 8:57:38 AM (16 years ago)
- Location:
- trunk/doc/src/docbook
- Files:
-
- 1 added
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/src/docbook/userdoc/file_system.xml
r3255 r3343 33 33 <title>File system</title> 34 34 <para> 35 Files in BASE 2 are managed from the page at35 Files in BASE 2 are managed from the page at 36 36 <menuchoice> 37 37 <guimenu>View</guimenu> 38 38 <guimenuitem>Files</guimenuitem> 39 </menuchoice> 40 . The basic layout on the page is the same as for all the other list pages in BASE2 but39 </menuchoice>. The basic layout on the page is the same as for all the other list pages 40 in BASE 2 but 41 41 there are some differences e.g. there is a navigation tree to the left, used to browse 42 42 the directory structure, and there are some buttons in the toolbar, that are special for … … 63 63 <para> 64 64 This is the logged in user's home directory with sub directories. It is 65 visible if current user has a home directory and is then always located at65 visible if the current user has a home directory and is then always located at 66 66 the top of the navigation tree. More about this can be read in 67 <xref linkend="file_system.system.browse.tree.home" /> 67 <xref linkend="file_system.system.browse.tree.home" />. 68 Click on a directory to display it's contents to the right 69 or click on the plus sign to expand the directory and view the 70 sub directories (no plus sign = no sub directories). 68 71 </para> 69 72 </listitem> … … 76 79 <listitem> 77 80 <para> 78 The other users' home directories that the current user has readpermission79 onare listed here, including his/her own.81 The other users' home directories that the current user has permission 82 to read are listed here, including his/her own. 80 83 </para> 81 84 </listitem> … … 100 103 </term> 101 104 <listitem> 102 <para>Shows the full BASE 2-path to current directory.</para>105 <para>Shows the full BASE 2 path to current directory.</para> 103 106 </listitem> 104 107 </varlistentry> … … 136 139 <para> 137 140 This icon is only visible for those files that have been moved offline and 138 it can be used to re-upload the file into BASE2's file system. Start to141 it can be used to re-upload the file to the BASE. Start to 139 142 upload the file to the same position by clicking on the icon. 140 143 </para> 141 </listitem> 142 </varlistentry> 143 144 <varlistentry> 145 <term> 146 <interface>8. Contents in current directory</interface> 147 </term> 148 <listitem> 149 <para> 150 This area contains files and sub directories that are located in the current 151 directory in the navigation tree. 152 </para> 153 </listitem> 154 </varlistentry> 155 156 <varlistentry> 157 <term> 158 <interface>9. Navigation tree</interface> 159 </term> 160 <listitem> 161 <para> 162 This sidebar displays the tree of directories that the current user has 163 permission to read. Click on a directory to display it's contents in the 164 list or click on the plus sign to the left to expand directory and view the 165 sub directories (no plus sign - no sub directories). 166 </para> 144 145 <note> 146 <title>Replace an existing file</title> 147 <para> 148 It is possible to re-upload file that are online, but this 149 has to be done from the single-item view. 150 </para> 151 </note> 167 152 </listitem> 168 153 </varlistentry> … … 172 157 <title>Browse the file system</title> 173 158 <para> 174 Browsing BASE2'sfile system is done from the navigation bar by clicking on a159 Browsing thr BASE 2 file system is done from the navigation bar by clicking on a 175 160 directory in the tree to view it's contents. Both sub directories and files in the 176 161 selected directory are showed. A directory with sub directories can be expand with a … … 202 187 home directory is located at the top of the navigation tree under the 203 188 <interface>My home</interface> 204 folder 189 folder. 205 190 </para> 206 191 <note> … … 210 195 <interface>My home</interface> 211 196 is missing, it most certainly depends on that the current user account 212 haven't got a home directory. Home directories are managed by the user213 administrator o n the BASE2server.197 haven't got a home directory. Home directories are managed by the 198 administrator of the BASE server. 214 199 </para> 215 200 </note> … … 220 205 <title>Disk space quota</title> 221 206 <para> 222 Normally the user accounts is assigned with limited quota of disk space used to 223 store files, raw data or experiments on. The three categories have, in case of disk 224 quota, a total limit of space to use and it's also possible for them to have a limit 225 by their own too. 226 <example id="file_system.examples.quota"> 227 <title>Disk quota</title> 228 <para> 229 The user account has a total quota of 1GB but there is also a limitation of 230 raw data to be at maximum 500MB. This will prevent the raw data to take more 231 then 500 MB of the total quota. 232 </para> 233 </example> 207 Normally, a user is assigned limited disk spacefor files. 234 208 More information about how much quota the current account has and how much of it 235 209 that is occupied can be found at the account's home page, described in 236 <xref linkend="webclient.intro.homepage" /> 237 . 210 <xref linkend="webclient.intro.homepage" />. 211 </para> 212 213 <para> 214 See <xref linkend="user_administration.quota" /> for more information about 215 the quota system. 238 216 </para> 239 217 </sect2> … … 242 220 <sect1 id="file_system.handling"> 243 221 <title>Handling files</title> 244 <para></para>222 245 223 <sect2 id="file_system.handling.upload"> 246 <title>Upload a file</title>224 <title>Upload a new file</title> 247 225 <para> 248 226 Uploading a file is started by clicking on … … 250 228 in the toolbar. The uploaded file will be placed in current directory. 251 229 </para> 230 231 <figure id="file_system.figures.upload"> 232 <title>Upload new file</title> 233 <screenshot> 234 <mediaobject> 235 <imageobject><imagedata 236 fileref="figures/upload_file.png" format="PNG" 237 /></imageobject> 238 </mediaobject> 239 </screenshot> 240 </figure> 241 252 242 <helptext external_id="file.upload" title="Upload a file"> 253 243 <para> 254 A couple of parameters need to be configured before uploading the file.255 244 <variablelist> 256 <title>Parameters</title>257 245 <varlistentry> 258 246 <term> … … 288 276 file-types to choose between from the drop-down list are 289 277 described in 290 <xref linkend="file_system.filetypes" /> 291 .Select278 <xref linkend="file_system.filetypes" />. 279 Select 292 280 <userinput>- none -</userinput> 293 if the file shouldn't be associated with any BASE2file type.281 if the file shouldn't be associated with any file type. 294 282 </para> 295 283 </listitem> … … 314 302 <para> 315 303 This shows the maximum transfer rate that the upload will 316 approximately reach. It's not editable. 304 approximately reach. The transfer rate is set by the 305 server admin and can't be changed. 317 306 </para> 318 307 </listitem> … … 324 313 <listitem> 325 314 <para> 326 These settings only intends zip-files or other compressed files. 327 <variablelist> 328 <varlistentry> 329 <term>File extension</term> 330 <listitem> 331 <para> 332 The kind of compressed file that is selected in 333 <guilabel>File</guilabel> 334 . 335 </para> 336 </listitem> 337 </varlistentry> 338 <varlistentry> 339 <term>Unpack file</term> 340 <listitem> 341 <para> 342 Tick off this box if the compressed file should 343 be unpacked after it had been uploaded. 344 </para> 345 </listitem> 346 </varlistentry> 347 <varlistentry> 348 <term>Overwrite existing files</term> 349 <listitem> 350 <para> 351 This check-box is only available when the 352 uploaded file should be unpacked. It should be 353 ticked off if any existing files with the same 354 name should be overwritten when unpacking the 355 uploaded compressed file. 356 </para> 357 </listitem> 358 </varlistentry> 359 <varlistentry> 360 <term>Keep the compressed file</term> 361 <listitem> 362 <para> 363 This check-box is only available when the 364 uploaded file should be unpacked. Use this 365 check-box if the compressed file should be kept 366 after it has been unpacked. 367 </para> 368 </listitem> 369 </varlistentry> 370 </variablelist> 315 These settings are only active if you select 316 a compressed file format that BASE knows how to 317 unpack. Currently, BASE ships with support for zip-files, 318 but this can be extended by the use of plug-ins. 319 <nohelp>See <xref linkend="plugin_developer.other.unpacker" 320 /> for more information.</nohelp> 321 322 <itemizedlist> 323 <listitem> 324 <para> 325 <guilabel>Unpack file</guilabel>: 326 Mark this checkbox if the compressed file should 327 be unpacked after it had been uploaded. The 328 files will be unpacked with the same subdirectory 329 structure as in the compressed file. 330 </para> 331 </listitem> 332 333 <listitem> 334 <para> 335 <guilabel>Overwrite existing files</guilabel>: 336 Mark this checkbox if the unpacking is allowed 337 to overwrite existing files. 338 </para> 339 </listitem> 340 <listitem> 341 <para> 342 <guilabel>Keep the compressed file</guilabel>: 343 Mark this checkbox if you want to keep the 344 compressed file after upload. Otherwise, only 345 the unpacked files are kept. 346 </para> 347 </listitem> 348 </itemizedlist> 371 349 </para> 372 350 </listitem> … … 376 354 <para> 377 355 Finish the configuration by clicking on either 378 <guibutton>Upload</guibutton> 379 , which will start uploading the selected file, or 380 <guibutton>Cancel</guibutton> 381 to abort the upload procedure. 356 <guibutton>Upload</guibutton>, which will start uploading the selected file, or 357 <guibutton>Cancel</guibutton> to abort the upload procedure. 382 358 </para> 383 359 </helptext> 360 361 <sect3 id="file_system.handling.actions.reupload"> 362 <title>Replace an existing file</title> 363 <para> 364 It is possible to replace an existing file. This is done by clicking 365 on the <guilabel>replace</guilabel> link on the single-item view 366 for the file you want to replace. If the file has been moved offline, 367 you can also use the icon 368 in the actions-column, see number 7 in 369 <xref linkend="file.system.figures.filepage" />. 370 The procedure to upload the file is the same as when uploading a new file, 371 except that compressed files can't be unpacked. There is also an 372 extra option, <guilabel>Validate MD5</guilabel>, that tells BASE to 373 check that the file is the same as the one it is replacing. This option 374 is useful when you are re-uploading a file that has been moved offline 375 and want to be certain that it is the same file as the original. 376 </para> 377 </sect3> 378 384 379 </sect2> 385 380 <sect2 id="file_system.handling.edit"> … … 389 384 <guibutton>Edit…</guibutton> 390 385 that is located in the toolbar at the file's view page or by holding down 391 <keycap>ctrl</keycap> 392 , 393 <keycap>alt</keycap> 394 or 395 <keycap>shift</keycap> 386 <keycap>CTRL</keycap>, <keycap>ALT</keycap> 387 or <keycap>SHIFT</keycap> 396 388 when clicking on the file's name in the list. It requires that the current user has 397 389 write permission on the file to be able to edit and set the properties. … … 400 392 <helptext external_id="file.edit" title="Edit file properties"> 401 393 <variablelist> 402 <title>Properties</title>403 <para>404 These are the file's properties that are displayed in the pop-up window.405 </para>406 394 <varlistentry> 407 395 <term> … … 411 399 <para> 412 400 This is the path where the file is located. This can only be changed 413 by moving the file , read more about how this is done in414 < xref linkend="file_system.handling.move" />415 .401 by moving the file. 402 <nohelp>Read more about how this is done in 403 <xref linkend="file_system.handling.move" /></nohelp>. 416 404 </para> 417 405 </listitem> … … 426 414 current directory. The maximum length of the file name is 255 427 415 characters and it can contain blank spaces but not any of 428 <keycap>~</keycap> 429 , 430 <keycap>\</keycap> 431 , 432 <keycap>/</keycap> 433 , 434 <keycap>:</keycap> 435 , 436 <keycap>;</keycap> 437 , 438 <keycap>*</keycap> 439 , 440 <keycap>?</keycap> 441 , 442 <keycap><</keycap> 443 , 416 <keycap>~</keycap>, 417 <keycap>\</keycap>, 418 <keycap>/</keycap>, 419 <keycap>:</keycap>, 420 <keycap>;</keycap>, 421 <keycap>*</keycap>, 422 <keycap>?</keycap>, 423 <keycap><</keycap>, 444 424 <keycap>></keycap> 445 425 or 446 <keycap>|</keycap> 447 . 426 <keycap>|</keycap>. 448 427 </para> 449 428 </listitem> … … 470 449 <para> 471 450 The file's content/media type. This is normally set automatically 472 when uploading the file into BASE 2but it can be changed by an user,451 when uploading the file into BASE but it can be changed by an user, 473 452 that has write permissions, at any time. 474 453 </para> … … 498 477 499 478 </sect2> 500 <sect2 id="file_system.handling.remove"> 501 <title>Delete, restore and move offline</title> 479 <sect2 id="file_system.handling.move"> 480 <title>Move files</title> 481 502 482 <para> 503 These functions are used to manage the directories and files' existence on the 504 server, to keep the list of files and directories up-to-date and release disk space 505 on server. 483 These functions are used to manage the location of the files on the 484 server. They are all accessed from the <guibutton>Move</guibutton> 485 button on the list view of from the single-item view. On the list view, 486 you must first select one or more files / directories. 506 487 </para> 507 <sect3 id="file_system.handling.remove.delete"> 508 <title>Delete</title> 509 <para> 510 A deleted file/directory is moved to the account's trash can and is marked to be 511 removed. Those items that have been marked as deleted can't be used in analysis 512 or other activities in BASE2 but they are not removed from the server and can be 513 restored again by the users that have write permission on the items. 514 </para> 515 <para> 516 Before a file or directory can be deleted it first has to be selected, this is 517 done by ticking off the check-box in front of it's name in list. Click then on 518 <guibutton>Delete</guibutton> 519 to mark the item as deleted. 520 </para> 521 <tip> 522 <title>Delete many directories/files</title> 523 <para> 524 Select all those items, that should be deleted in a list to flag them all 525 for deletion at the same time. 526 </para> 527 </tip> 528 <para> 529 Files and directories that are marked for deletion can be included in the list 530 by selecting 531 <guilabel>Removed</guilabel> 532 from the drop-down list with presets, see 533 <xref linkend="webclient.figures.viewpresets" /> 534 .Those which have been deleted are marked with a trash can icon in front of 535 their names. 536 </para> 537 </sect3> 538 <sect3 id="file_system.handling.remove.restore"> 539 <title>Restore</title> 540 <para> 541 Files and directories that have been marked for deletion, and not yet removed 542 from the trash can, can be restored again without any loss of information. To do 543 that, the removed items have to be made visible in the list and which is done by 544 selecting 545 <guilabel>Removed</guilabel> 546 in the drop down list of presets, see 547 <xref linkend="webclient.figures.viewpresets" /> 548 . 549 </para> 550 <para> 551 Select the file or directory that should be restored, by ticking the check box 552 to the left of the item. Then click on 553 <guibutton>Restore</guibutton> 554 in the toolbar to restore and remove the deletion flag. The trash can has now 555 disappeared in front of the item that was restored and it's possible to use the 556 item in BASE2 again. 557 </para> 558 <tip> 559 <title>Restoring multiple directories/files</title> 560 <para> 561 Multiple files and directories can be restored at the same time. This is 562 done by selecting all the items that should be restored before pressing the 563 restore button. 564 </para> 565 </tip> 566 </sect3> 567 <sect3 id="file_system.handling.remove.move_offline"> 568 <title>Move offline</title> 569 <para> 570 Moving a file offline means that the physical file is deleted from the server's 571 disk space but the file will still exist as an item in the database. This makes 572 it possible to save disk space but still be able to associated the file with 573 other items in BASE2. 574 </para> 575 <para> 576 Tick the check-box for those files that should be moved offline and press then 488 489 <sect3 id="file_system.handling.move.directory"> 490 <title>To another directory</title> 491 <para> 492 Files and directories can be moved to other directories for re-organization. The 493 user need write permission on the target directory to be able to move the 494 files/directories to it. 495 </para> 496 <para> 497 First, select all files and directories in the current path that should be moved 498 and then click on 577 499 <menuchoice> 578 500 <guibutton>Move…</guibutton> 579 <guisubmenu> Offline…</guisubmenu>501 <guisubmenu>To another directory</guisubmenu> 580 502 </menuchoice> 581 in the toolbar . The selected files will be moved immediately and disk space 582 will be released. 503 in the toolbar to open a window with the directory tree where the target directory 504 can be picked. 505 </para> 506 <para> 507 Choose a directory which the selected items should be moved to. It 508 is possible to create new subdirectories with the 509 <guibutton>New…</guibutton> button. 510 </para> 511 <para> 512 Click on 513 <guibutton>Ok</guibutton> 514 to carry out the move or 515 <guibutton>Cancel</guibutton> 516 to abort. 583 517 </para> 584 518 </sect3> 519 520 <sect3 id="file_system.handling.move.offline"> 521 <title>Offline</title> 522 <para> 523 Moving a file offline means that the actual file contents is deleted from the 524 server's disk space but information about the file will still exist as an item 525 in the database. This makes it possible to save disk space but still be 526 able to associated the file with other items in BASE. 527 </para> 528 <para> 529 First, select all files in current path that should be moved offline 530 and then click on 531 <menuchoice> 532 <guibutton>Move…</guibutton> 533 <guisubmenu>Offline</guisubmenu> 534 </menuchoice> 535 in the toolbar. 536 </para> 537 <note> 538 Be careful! The selected files will be moved immediately without 539 warning. The only way to recover the files again is to re-upload 540 them. 541 </note> 542 </sect3> 543 544 <sect3 id="file_system.handling.move.secondary"> 545 <title>To the secondary storage</title> 546 547 <para> 548 This option is only available if the server administrator 549 has enabled it. 550 </para> 551 552 <para> 553 The secondary storage is a kind of storage were it is appropriate 554 to store files that have been used and no longer requires immediate 555 access. Moving a file to and from the secondary storage is the job 556 of a plug-in, which is usually executed once or twice a day. 557 </para> 558 559 <para> 560 First, select all files in the current path that should be moved 561 and then click on 562 <menuchoice> 563 <guibutton>Move…</guibutton> 564 <guisubmenu>To secondary location</guisubmenu> 565 </menuchoice> 566 in the toolbar. The only thing that will happen is that BASE sets a flag 567 on each file. The next time the secondary storage plug-in 568 is executed, the files will be moved to the secondary storage. The 569 actual file contents is deleted from the server's disk. 570 </para> 571 572 <para> 573 While the file is in the secondary storage BASE behaves in the same way as 574 if the file is offline. Th file can't be used to import data from, or 575 other things. To use the file again, the file must be moved back to 576 the primary storage. 577 </para> 578 579 <para> 580 To bring files back from the secondary storage, select the files 581 and then click on 582 <menuchoice> 583 <guibutton>Move…</guibutton> 584 <guisubmenu>To primary location</guisubmenu> 585 </menuchoice> in the toolbar. The files will be moved back the next 586 time the secondary storage plug-in is executed. 587 </para> 588 589 <note> 590 <title>Don't forget to set quota for the secondary storage</title> 591 <para> 592 The default installation doesn't assign quota for the 593 secondary storage. Unless the administrator assigns quota 594 the move will silently fail. 595 </para> 596 </note> 597 </sect3> 598 585 599 </sect2> 600 586 601 <sect2 id="file_system.handling.actions"> 587 <title> Actions</title>602 <title>Viewing and downloading files</title> 588 603 <para> 589 Actions is a separate column in the list with files and sub directories. In this 590 column are a couple of icons to click on to perform different kinds of actions on a 591 file, like downloading the file, viewing the file or upload a file that has been 592 moved offline. Each one of these actions are described below. 604 In <guilabel>Actions</guilabel> column in the list view there 605 are icons you can click on to perform different kinds of actions on a 606 file, like downloading the file and viewing the file. The same icons appear 607 on the single-item view and in most other places where files are used. 608 You can't view or download files that have been moved offline or to the 609 secondary storage. 593 610 </para> 594 611 <sect3 id="file_system.handling.actions.download"> 595 <title>Download </title>612 <title>Download a file</title> 596 613 <para> 597 614 This will let the user to download the contents of a file to a path on a local … … 609 626 <para> 610 627 Close the pop-up window and return to file page with 611 <guibutton>Close</guibutton> 628 <guibutton>Close</guibutton>. 612 629 </para> 613 630 </sect3> 614 631 <sect3 id="file_system.handling.actions.view"> 615 <title>View contents of file</title> 616 <para> 617 A file's contents can be displayed directly in the web browser if current 618 browser supports the file's miame type. Click on the icon to view the contents 619 in a new window. If the miame-type isn't supported by the browser there will be 620 a dialog-window to download the file with instead. 621 </para> 622 </sect3> 623 <sect3 id="file_system.handling.actions.reupload"> 624 <title>Re-upload a file</title> 625 <para> 626 A file that has been moved offline can be uploaded again by clicking on the icon 627 in the actions-column, see number 7 in 628 <xref linkend="file.system.figures.filepage" /> 629 . The procedure to upload the file is the same as described in 630 <xref linkend="file_system.handling.upload" /> 631 <important> 632 <para> 633 There is no check to confirm that the file that is going to be uploaded 634 is the same that was originally stored in BASE2. 635 </para> 636 </important> 632 <title>View the contents of file</title> 633 <para> 634 A file's contents can be displayed directly in the web browser if the 635 browser supports displaying that kind of files. Typically all HTML, text 636 files and images are supported. Click on the icon to view the contents 637 in a new window. If the type isn't supported by the browser there will be 638 a dialog-window to download the file instead. 637 639 </para> 638 640 </sect3> … … 641 643 <title>Directories</title> 642 644 <para> 643 Directories in BASE 2are folders where files can be organized into. Click on645 Directories in BASE are folders where files can be organized into. Click on 644 646 <guibutton>New directory…</guibutton> 645 647 in the toolbar to create a directory in current path and edit the properties as … … 664 666 This property is read-only in the edit window but can be 665 667 change instead by moving the directory, described in 666 <xref linkend="file_system.handling.move" /> 668 <xref linkend="file_system.handling.move" />. 667 669 </para> 668 670 </listitem> … … 698 700 <para> 699 701 The editing process is completed with either 700 <guibutton>Save</guibutton> 701 , to save the properties into the database, or with 702 <guibutton>Save</guibutton>, to save the properties into the database, or with 702 703 <guibutton>Cancel</guibutton> 703 704 to discard the changes. Both of the buttons will close the edit window and … … 705 706 new properties. 706 707 </para> 708 709 <note> 710 The new directory doesn't appear in the navigation tree 711 to the left automatically. You must click on the 712 <guibutton>Refresh</guibutton> button. 713 </note> 714 707 715 </helptext> 708 716 </sect3> 709 717 </sect2> 710 <sect2 id="file_system.handling.move"> 711 <title>Move file/directory</title> 712 <para> 713 Files and directories can be moved to other directories for re-organization. The 714 user need to have write permission on the target directory to be able to move the 715 files/directories to it. 716 </para> 717 <para> 718 Select first of all those files and directories in current path that should be moved 719 and click then on 720 <menuchoice> 721 <guibutton>Move…</guibutton> 722 <guisubmenu>To another directory</guisubmenu> 723 </menuchoice> 724 in the toolbar to open a window with the directory tree where the target directory 725 can be picked. 726 </para> 727 <para> 728 Choose a directory where the selected items should be moved to. Doesn't the 729 directory exist, it can be created in the pop-up window's current path, with 730 <guibutton>New…</guibutton> 731 . 732 </para> 733 <para> 734 Click on 735 <guibutton>Ok</guibutton> 736 to carry out the move or 737 <guibutton>Cancel</guibutton> 738 to abort. 739 </para> 740 </sect2> 718 741 719 </sect1> 742 720 … … 744 722 <title>File types</title> 745 723 <para> 746 A file can be associated with one of the file types that exists in BASE2. File types 747 make it possible to sort the files depending of what kind of file it is. 724 A file can be associated with one of the file types that exists in BASE 2. File types 725 make it possible to filter the files depending of what kind of file it is. Here 726 is a list of file types that are defined in BASE. 727 <menuchoice> 728 <guimenu>Administrate</guimenu> 729 <guisubmenu>Types</guisubmenu> 730 <guimenuitem>File types</guimenuitem> 731 </menuchoice> 748 732 </para> 749 733 <variablelist> 750 734 <title>File types</title> 751 <para>Following file types exists in BASE2.</para>752 735 <varlistentry> 753 736 <term>Image</term> … … 803 786 <term>Spot images</term> 804 787 <listitem> 805 <para>A zip-file containing generated spot images in pngformat.</para>788 <para>A zip-file containing generated spot images in JPEG format.</para> 806 789 </listitem> 807 790 </varlistentry>
Note: See TracChangeset
for help on using the changeset viewer.