 |
Page History
...
Branding NBIA Classic
In order to brand the NBIA Classic application, the developer will need to download the code from GitHub https://github.com/CBIIT/national-biomedical-image-archive and build the application using the ant target build:all. You will need to have the following required software:
Required Software Name and Version | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
Be sure to download the correct Java SDK for your operating environment. For example, for Linux AMD 64, you would download jdk-8u101-linux-x64.tar.gz and for Windows, jdk-8u101-windows-x64.exe. You must also factor in if the system is 32 or 64-bit. A 32-bit system cannot install 64-bit software. It is recommended that you install 32-bit Java SDK in a Windows environment even if your system is 64-bit because generating CTP thumbnail image only works properly with the 32-bit JDK in Windows. | The J2SE Development Kit (JDK) supports creating J2SE applications. | ||||||||
Apache Ant 1.8.4
| Apache Ant is a Java-based build tool. |
Branding in NBIA is accomplished by editing and or replacing the objects in the branding folders found in /software/common/resources/branding. The nbia folder contained within is the default branding for NBIA. The sub folder subfolder called images contains the customizable images for the application, ; they include:
| Name | Dimensions |
|---|---|
| FNLfCR-LOGO.png | 200 x 39 |
| footer_usagov.gif | 127 x 31 |
| Logo-NCIA.jpg | 500 x 53 |
| nci-header.png | 300 x 38 |
| nci-link.png | 300 x 38 |
| NCI-logo-white.png | 54 x 32 |
| NCICBLOGO.gif | 126 x 43 |
| white-ncilogo.gif | 263 x 39 |
| white-nciurl.gif | 99 x 39 |
| white-nihtext.gif | 208 x 39 |
To use your own images, simply replace the image while keeping the same name as the original one in your new folder, and ; the build will update it accordingly. At the base level of the folder are the XHTML/properties files that allow customization. Those files are listed in the following table.
| Name | Purpose |
|---|---|
| appFooter.xhtml | The footer of the application |
| appHeader.xhtml | The header of the application |
| branding.properties | Contains the application name property |
| ccHeader.xhtml | Legacy file for cancer center logos, to be removed |
| footer.xhtml | Legacy file for footers, to me removed |
| legalRules.xhtml | Legal rules when signing up |
| mainLayout.xhtml | Layout with session timer |
| mainLayoutTemplate.xhtml | Overall layout of the application |
| mainLayoutWithoutSessionTimeout.xhtml | Layout without session timer |
| mainMenu.xhtml | Top menu bar |
| ncia_messages.properties | Various messages used in the application |
| nciHeader.xhtml | Application header |
| quickLinks.xhtml | External links |
| sessionExpired.jsp | Page shown when session expires |
| siteMap.xhtml | Site map at bottom of page |
| slideshow.css | CSS for the slideshow page |
| styleSheet.css | Main CSS for the application |
| subMenu.xhtml | Sub menus in the menu bar |
| welcome.xhtml | Main login page |
| welcomeText.xhtml | Legacy welcome page, to be removed |
Building a Branded Version
To create and build a branded version copy the example nbia folder to a new folder. As an example assume the copied folder is ncia and you plan to make a version named NCIA. Copy and name the folder and edit accordingly. Note the ncia_messages.properties contains much of the applications textual information and branding.properties contains the application names. Once you have edited the files the edit install.properties and the defaultAHP3.properties in the /software/build directory. Specifically the branding properties need to be specified, here is an example for naming an application NCIA.
...
