IGB Developer's Guide
Page tree

Versions Compared

Old Version 8

changes.mady.by.user Ann Loraine

Saved on

compared with

New Version 9

changes.mady.by.user Ann Loraine

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Beginning version 6.7, IGB has a welcome screen that shows icons for species data sets.  Clicking on the icons should take the user to the latest data set images representing species and their latest genome version.  When a user clicks on an image representing a species, IGB displays the latest genome for that species. 

To add a new data set image to the welcome screen follow these directions:

The term $IGB_HOME is used to refer refers to the root directory where you placed IGB's source code.  Refer to Get the code for instruction instructions on getting IGB's source code.

The welcome screen reads its data set configuration from $IGB_HOME/common/resources/display_species.txt.
The text file is tab-separated.  Each line corresponds to a data set an image to be displayed by the welcome screen.   Lines beginning with the pound sign (#) are ignored as comment lines.  

  • The file should have three entries separated by a tab character.
    <picture_path><tab><species data set name><tab><display label name><tab><color>
  • picture_namepath:  the picture path is relative to $IGB_HOME/common/resources/images.  The specifications for the picture should be:** PNG format** 400x266 (height x width) full-bleed ANN's NOTE: Change this to 250 pixels height and variable width.  See IGB Images DropBox for images created by Ann and a PowerPoint presentation with URLs to the images.
  • The species data set name can be taken from the version combo box in IGB.  This key is important for the welcome component to tell IGB which data set should be loaded when the user clicks on it.  If IGB displays "Species name Not Available" on the status bar, there could be a typo on this field, or the data source may not be loaded.
  • The label should be the name of the species.  This value is not used as key, so you should not worry about this setting when troubleshooting. But obviously it should be realistic.
  • Color for the text:  make sure to pick a color that contrasts with the bottom part of the picture.  The color is set following html rules ( of format: #123FAD) without alpha channel.

...