Page History
Panel | ||
---|---|---|
| ||
|
Branding NBIA Classic
The NBIA Classic application is currently in production, primarily to provide administrative tools. The NBIA Client is the new search interface for NBIA and is also in production.
To 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:
...
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, edit the edit install.properties and the defaultAHP3.properties files in the /software/build directory. Specifically Specify the branding properties need to be specified, here is an . An example for naming an application "NCIA" follows.
Code Block |
---|
############################################## ### New Branding Properties ### ############################################## branding.appname=NCIA branding.folder=ncia |
...
Name | Purpose |
---|---|
logo.png | A logo (41 pixels high) |
footer.html | A snippet of HTML that is at the bottom. If included, %VERSION% will be replaced with the client version number (versionSuffix.txt, below), and %HOST_NAME% will be replaced with the server name. |
newAccountUrl.txt | URL for "New account" button on the login screen |
accountHelpUrl.txt | URL for "Account help" button on the login screen |
downloaderUrl.txt | URL for "Get Data Retriever" button in the Download popup |
versionSuffix.txt | An optional string that will be appended to the version number, if the version number is included in the footer. |
customMenu.json | This is the top horizontal menu. Look at the default (nbia) for an example. |
...
Name | Purpose |
---|---|
"entryTitle" | The text of the top level menu item |
"menuData" | "target" within "menuData" is the URL of the top-level menu item if you don't use a dropdown menu for this top-level item |
"menuDataDropdown"
| an array of dropdown menu items:
|
Example of Branded Properties
Code Block |
---|
[ { "entryTitle": "Home", "menuData": { "target": "httphttps://www.cancerimagingarchive.net" } }, { "entryTitle": "News", "menuData": { "target": "httphttps://www.cancerimagingarchive.net/news/" } }, { "entryTitle": "About Us", "menuDataDropdown": [ { "menuText": "About The Cancer Imaging Archive (TCIA)", "target": "httphttps://www.cancerimagingarchive.net/about-the-cancer-imaging-archive-tcia" }, { "menuText": "About the Cancer Imaging Program (CIP)", "target": "httphttps://www.cancerimagingarchive.net/about-the-cancer-imaging-program-cip/" }, { "menuText": "About the University of Arkansas for Medical Sciences (UAMS)", "target": "httphttps://www.cancerimagingarchive.net/about-the-university-of-arkansas-for-medical-sciences-uams/" } ] }, ... |