Difference between revisions of "BioUML user interface"

From BioUML platform
Jump to: navigation, search
m (Handling files)
m
 
(7 intermediate revisions by 2 users not shown)
Line 44: Line 44:
  
 
===Viewparts area===
 
===Viewparts area===
*[[File:Edit_description_icon.png|20px]] Edit
+
*[[File:Edit_description_icon.png]] Edit
 
*[[File:WebAction-toolbar-save_document-icon.png]] Save
 
*[[File:WebAction-toolbar-save_document-icon.png]] Save
 
*[[File:Add_element_icon.png]] Add a new element
 
*[[File:Add_element_icon.png]] Add a new element
 +
*[[File:Recalculate_doc_icon.png]] Recalculate the document
 
*[[File:Search icon.png]] Start search
 
*[[File:Search icon.png]] Start search
 
*[[File:Discard_icon.png]] Discard changes / clear elements
 
*[[File:Discard_icon.png]] Discard changes / clear elements
*[[File:Execute_icon.png|20px]] Execute
+
*[[File:Execute_icon.png]] Execute
*[[File:Add2docpane_icon.png|20px]] Add/ apply to the item in the document pane
+
*[[File:Add2docpane_icon.png]] Add/ apply to the item in the document pane
 
*[[File:Add2newdia_icon.png]] Add to a new diagram
 
*[[File:Add2newdia_icon.png]] Add to a new diagram
*[[File:Stop_icon.png|20px]] Stop (the selected tasks)
+
*[[File:Stop_icon.png]] Stop (the selected tasks)
*[[File:Accept2viewparts_icon.png|20px]] Accept the layout edited in the document pane to the viewparts area
+
*[[File:Accept2viewparts_icon.png]] Accept the layout edited in the document pane to the viewparts area
 
*[[File:WebAction-tree-remove_element-icon.png]] Remove
 
*[[File:WebAction-tree-remove_element-icon.png]] Remove
*[[File:Add2clipboard_icon.png|20px]] Add to clipboard
+
*[[File:Add2clipboard_icon.png]] Add to clipboard
*[[File:Insertin2dia_icon.png|20px]] Insert into the diagram
+
*[[File:Insertin2dia_icon.png]] Insert into the diagram
  
 
===General control panel===
 
===General control panel===
Line 64: Line 65:
  
 
==Basic operations==
 
==Basic operations==
===Navigating the file tree===
 
  
Menu items containing one or more files (file collections) can be expanded/collapsed to show/hide their sublevels. Any such item, like a database, a folder, a track or a matrix library, has a white horizontal arrowhead to the left of its icon and name in the file tree area.
+
For information about '''handling files''' within the repository pane [[Repository pane|see the page]].
  
To expand an item
+
For information about working with '''tables''' in the [[document pane]] [[Table document|see the page]].
*click on the white arrowhead (the arrowhead will become black and downward),or
+
*click on the item name and then on the '''Expand/collapse''' icon in the [[repository pane toolbar]] above, or
+
*right-click on the item and select the '''Expand/collapse''' option from the context menu.
+
  
To collapse an item
+
For information about working with '''diagrams''' in the [[document pane]] [[Diagram document|see the page]].
*click on the black downward arrowhead next to the icon and name of the expanded item, or
+
*click on the item name and then on the '''Expand/collapse''' icon in the [[repository pane toolbar]] above, or
+
*right-click on the item and select the '''Expand/collapse''' option from the context menu
+
+
If the menu expands beyond the current visible area, use the horizontal and vertical scrollbars.
+
  
===Handling files===
 
When the mouse pointer hovers over a file, the file name will gain a faint-bluish background.
 
  
Upon a single click on a file name, its background will turn into a persistent light blue, and '''information about this file''' will be displayed in the property inspector tab of the Info Box.
 
 
Double-clicking on a file name will '''open''' it under a new tab in the document pane, and the file name will be emphasized in bold as long as the corresponding tab is in the document pane’s foreground. Only files with an icon attached can be opened this way.
 
 
Files can also be opened by:
 
*clicking on the file name and pressing the '''Open...''' icon in the [[repository pane toolbar]], or
 
*right-clicking on the file name and selecting the '''Open...''' option from the context menu.
 
 
Similarly, you can '''delete''' chosen files by clicking on the '''Remove''' option in the [[repository pane toolbar]] or the context menu.
 
 
Most files can be '''exported'''. When the function is activated, a selection of different formats is provided for the export file to be generated. It is also available through the icon [[File:WebAction-tree-export_element-icon.png]] in the [[repository pane toolbar]]
 
 
While the Open, Remove and Export options are present and work for nearly any file, the rest of the available operations is different among distinct file types.
 
 
===Selecting input files===
 
All analysis tools, and likewise all prepared workflows, require input data from a file in the [[repository pane]]. The respective file can be loaded into an analysis tool
 
*by simple drag-and-drop of the file from the repository area into the corresponding field in the document pane, or
 
*by clicking into this field and making the selection from the directory which opens.
 
 
Multiple selections can be done only in the second way.
 
  
 
==See also==
 
==See also==
 
*[[Perspective]]s
 
*[[Perspective]]s
 +
*[[Features]]
  
 
[[Category:User interface]]
 
[[Category:User interface]]

Latest revision as of 13:09, 19 June 2013

BioUML workbench interface.
This page or section is a stub. Please add more information here!

In either version the platform has a WIMP graphical user interface.

Both in the BioUML workbench and BioUML web edition the following areas can be found (see the figures):

A — the tabbed repository pane, where you find a collection of Databases, the uploaded Data files and the available Analyses methods (under the corresponding tabs), organized in a hierarchical tree structure. Here you can also see a list of Users involved with the current project.

B — the document pane (aka main pane or workspace), which is the part of the window where contents of projects and databases are viewed and handled. There can be as many tabs in the pane as there are diagrams, workflows, tables etc. opened in the workbench at the moment.

C — the information box containing tabs for the property inspector, which displays information about the data file or analysis method selected in the navigation pane above, and the text search engine.

D — the viewparts area, providing a number of options under the different tabs in a context-dependent manner.

E — the general control panel, the topmost bar showing a context-dependent set of icons for the available operations.

F — the repository pane toolbar containing a set of icons for the available operations depending on the item selected in the tree structure of the navigation pane.

Contents

[edit] List of icons

[edit] Repository pane

[edit] Tree actions (web edition)

  • WebAction-tree-run workflow-icon.png Run workflow
  • WebAction-tree-open external url-icon.png Open external link
  • WebAction-tree-open diagram 2-icon.png Open diagram
  • WebAction-tree-open tree table-icon.png Open view
  • WebAction-tree-open genome browser-icon.png Open track
  • WebAction-tree-open sequence-icon.png Open sequence
  • WebAction-tree-open table-icon.png Open table
  • WebAction-tree-open text-icon.png Open text document
  • WebAction-tree-open optimization-icon.png Open optimization
  • WebAction-tree-open analysis-icon.png Open analysis
  • WebAction-tree-open script-icon.png Open script
  • WebAction-tree-open web-icon.png Open document
  • WebAction-tree-open image-icon.png Open image
  • WebAction-tree-open plot-icon.png Open plot
  • WebAction-tree-open structures-icon.png Open as table
  • WebAction-tree-download file-icon.png Download file
  • WebAction-tree-open chat-icon.png Start chat
  • WebAction-tree-open group chat-icon.png Group chat
  • WebAction-tree-open work-icon.png Edit work
  • WebAction-tree-expand-icon.png Expand/collapse
  • WebAction-tree-new element-icon.png New element
  • WebAction-tree-new script-icon.png New JS script
  • WebAction-tree-new r script-icon.png New R script
  • WebAction-tree-new workflow-icon.png New workflow
  • WebAction-tree-new diagram-icon.png New diagram
  • WebAction-tree-new work-icon.png New work
  • WebAction-tree-new folder-icon.png New folder
  • WebAction-tree-open new optimization-icon.png New optimization
  • WebAction-tree-view plot-icon.png View
  • WebAction-tree-import element-icon.png Import
  • WebAction-tree-export element-icon.png Export
  • WebAction-tree-save element as-icon.png Save a copy
  • WebAction-tree-save folder as-icon.png Copy folder
  • WebAction-tree-remove element-icon.png Remove
  • WebAction-tree-remove project-icon.png Remove project
  • WebAction-tree-find project-icon.png Find project

[edit] Database types

  • PublicDB icon.png Public database with read access
  • ProtectedDB R icon.png Protected database with read access enabled
  • PublicDB R icon.png Public database with read access, write access disabled
  • PublicDB W icon.png Public database with read access, write access enabled
  • PublicDB RW icon.png Public database with read and write access
  • LocalDB icon.png Local database
  • RemoteDB R icon.png Remote protected read-only database (no access)
  • RemoteDB RW icon.png Remote protected read-and-write database (no access)

[edit] Element types

[edit] Information box

  • View separately icon.png View the information in a new window / browser tab
  • Edit description icon.png Edit the element description displayed in the Info tab (only for users' own files; fields highlighted in pink are editable)
  • Search icon.png Launch search for the entered term in the selected database

[edit] Viewparts area

  • Edit description icon.png Edit
  • WebAction-toolbar-save document-icon.png Save
  • Add element icon.png Add a new element
  • Recalculate doc icon.png Recalculate the document
  • Search icon.png Start search
  • Discard icon.png Discard changes / clear elements
  • Execute icon.png Execute
  • Add2docpane icon.png Add/ apply to the item in the document pane
  • Add2newdia icon.png Add to a new diagram
  • Stop icon.png Stop (the selected tasks)
  • Accept2viewparts icon.png Accept the layout edited in the document pane to the viewparts area
  • WebAction-tree-remove element-icon.png Remove
  • Add2clipboard icon.png Add to clipboard
  • Insertin2dia icon.png Insert into the diagram

[edit] General control panel

[edit] Toolbar actions (web edition)

  • WebAction-toolbar-logout-icon.png Log-out
  • WebAction-toolbar-login-icon.png Log-in
  • WebAction-toolbar-home-icon.png Start page
  • WebAction-toolbar-home ge-icon.png Start page
  • WebAction-toolbar-toggle ui-icon.png Toggle UI mode
  • WebAction-toolbar-toggle repository-icon.png Toggle repository
  • WebAction-toolbar-account info-icon.png Account info
  • WebAction-toolbar-project properties-icon.png Project properties
  • WebAction-toolbar-help-icon.png Help


  • WebAction-toolbar-save document-icon.png Save document
  • WebAction-toolbar-save document as-icon.png Save a copy
  • WebAction-toolbar-revert-icon.png Revert to saved
  • WebAction-toolbar-export-icon.png Export
  • WebAction-toolbar-import document-icon.png Import

  • WebAction-toolbar-undo in-icon.png Undo in
  • WebAction-toolbar-redo in-icon.png Redo in

  • WebAction-toolbar-zoom out-icon.png Zoom out
  • WebAction-toolbar-zoom in-icon.png Zoom in
  • WebAction-toolbar-fit to screen-icon.png Fit to screen
  • WebAction-toolbar-run script-icon.png Run script
  • WebAction-toolbar-generate script-icon.png Generate script

  • WebAction-toolbar-set auto layout-icon.png Set auto layout
  • WebAction-toolbar-clear auto layout-icon.png Clear auto layout
  • WebAction-toolbar-edit view options-icon.png View options

  • WebAction-toolbar-semantic zoom out-icon.png Semantic zoom out
  • WebAction-toolbar-semantic zoom in-icon.png Semantic zoom in

  • WebAction-toolbar-semantic overview-icon.png Overview
  • WebAction-toolbar-semantic default-icon.png Default
  • WebAction-toolbar-semantic detailed-icon.png Detailed

  • WebAction-toolbar-page-backward-icon.png Page backward
  • WebAction-toolbar-page-forward-icon.png Page forward

  • WebAction-toolbar-open-as-track-icon.png Open as track

  • WebAction-toolbar-pf highlight-icon.png Highlight/dehighlight originally loaded nodes


[edit] Basic operations

For information about handling files within the repository pane see the page.

For information about working with tables in the document pane see the page.

For information about working with diagrams in the document pane see the page.


[edit] See also

Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox